PtgExp (OpenXLS Java Spreadsheet SDK 11.0.4 API)

java.lang.Object
- io.starter.formats.XLS.formulas.GenericPtg
- - io.starter.formats.XLS.formulas.PtgExp

All Implemented Interfaces:

Ptg, XLSConstants, Serializable, Cloneable
```
public class PtgExp
extends GenericPtg
implements Ptg
```
ptgExp indicates an Array Formula or Shared Formula When ptgExp occurs in a formula, it's the only token in the formula. this indicates that the cell containing the formula is part of an array or opartof a shared formula. The actual formula is found in an array record. The value for ptgExp consists of the row and the column of the upper-left corner of the array formula.

See Also:

Ptg, Formula, Array, Shrfmla, Serialized Form

Field Summary
- Fields inherited from class io.starter.formats.XLS.formulas.GenericPtg
  parent_rec
- Fields inherited from interface io.starter.formats.XLS.formulas.Ptg
  ARRAY, CALCULATED, PTG_ADD_LENGTH, PTG_AREA_LENGTH, PTG_AREA3D_LENGTH, PTG_AREAERR3D_LENGTH, PTG_ATR_LENGTH, PTG_BOOL_LENGTH, PTG_CONCAT_LENGTH, PTG_DIV_LENGTH, PTG_ENDSHEET_LENGTH, PTG_EQ_LENGTH, PTG_EXP_LENGTH, PTG_FUNC_LENGTH, PTG_FUNCVAR_LENGTH, PTG_GE_LENGTH, PTG_GT_LENGTH, PTG_INT, PTG_INT_LENGTH, PTG_ISECT_LENGTH, PTG_LE_LENGTH, PTG_LOCATION_POLICY_LOCKED, PTG_LOCATION_POLICY_TRACK, PTG_LOCATION_POLICY_UNLOCKED, PTG_LT_LENGTH, PTG_MEM_AREA_N_LENGTH, PTG_MEM_AREA_NV_LENGTH, PTG_MEMERR_LENGTH, PTG_MLT_LENGTH, PTG_MYSTERY_LENGTH, PTG_NAME_LENGTH, PTG_NAMEX_LENGTH, PTG_NE_LENGTH, PTG_NUM_LENGTH, PTG_PAREN_LENGTH, PTG_PERCENT_LENGTH, PTG_POWER_LENGTH, PTG_RANGE_LENGTH, PTG_REF_LENGTH, PTG_REF3D_LENGTH, PTG_REFERR_LENGTH, PTG_REFERR3D_LENGTH, PTG_SUB_LENGTH, PTG_TYPE_ARRAY, PTG_TYPE_SINGLE, PTG_UMINUS_LENGTH, PTG_UNION_LENGTH, PTG_UPLUS_LENGTH, REFERENCE, UNCALCULATED, VALUE
- Fields inherited from interface io.starter.formats.XLS.XLSConstants
  AI, ALLOWDUPES, ALRUNS, AREA, AREAFORMAT, ATTACHEDLABEL, AUTOFILTER, AXCENT, AXESUSED, AXIS, AXISLINEFORMAT, AXISPARENT, BACKUP, BAR, BEGIN, BLANK, BOF, BOOKBOOL, BOOLERR, BOPPOP, BOPPOPCUSTOM, BOTTOM_MARGIN, BOTTOMMARGIN, BOUNDSHEET, CALC_MODE_PROP, CALCCOUNT, CALCMODE, CALCULATE_ALWAYS, CALCULATE_AUTO, CALCULATE_EXPLICIT, CATLAB, CATSERRANGE, CF, CF12, CHART, CHART3DBARSHAPE, CHARTFORMAT, CHARTFORMATLINK, CHARTFRTINFO, CHARTLINE, CODENAME, COLINFO, CONDFMT, CONDFMT12, CONTINUE, COUNTRY, CRN, CRTLAYOUT12, CRTLAYOUT12A, DAT, DATAFORMAT, DATALABEXT, DATALABEXTCONTENTS, DATE1904, DBCELL, DCON, DCONBIN, DCONNAME, DCONREF, DEBUG_HIGH, DEBUG_LOW, DEBUG_MEDIUM, DEFAULTENCODING, DEFAULTROWHEIGHT, DEFAULTTEXT, DEFCOLWIDTH, DELTA, DIMENSIONS, DROPBAR, DSF, DV, DVAL, END, ENDBLOCK, ENDEXTSST, ENDOBJECT, EOF, EXCEL2K, EXTERNCOUNT, EXTERNNAME, EXTERNSHEET, EXTSST, FBI, FEATHEADR, FILE_LOCK, FILEPASS, FONT, FONTBASIS, FONTX, FOOTERREC, FORMAT, FORMULA, FRAME, FRTFONTLIST, FRTWRAPPER, GARBAGE, GELFRAME, GUTS, HCENTER, HEADERREC, HLINK, HORIZONTAL_PAGE_BREAKS, IFMT, INDEX, INTERFACE_HDR, ITERATION, LABEL, LABELSST, LEFT_MARGIN, LEFTMARGIN, LEGEND, LEGENDXN, LINE, LINEFORMAT, MARKERFORMAT, MAXCOLS, MAXCOLS_BIFF8, MAXRECLEN, MAXROWS, MAXROWS_BIFF8, MERGEDCELLS, MSODRAWING, MSODRAWINGGROUP, MSODRAWINGSELECTION, MULBLANK, MULRK, NAME, NOTE, NUMBER, OBJ, OBJECTLINK, OBJPROTECT, OBPROJ, PALETTE, PANE, PASSWORD, PHONETIC, PICF, PIE, PIEFORMAT, PIVOTCHARTBITS, PIVOTCHARTLINK, PLOTAREA, PLOTGROWTH, PLS, PLV, POS, PRECISION, PRINT_GRIDLINES, PRINT_ROW_HEADERS, PRINTGRID, PRINTROWCOL, PROT4REV, PROTECT, QSISXTAG, RADAR, RADARAREA, RANGEPROTECTION, REFMODE, REFTRACK_PROP, RIGHT_MARGIN, RIGHTMARGIN, RK, ROW, RRD_HEAD, RRD_INFO, RSTRING, RTENTEXU, RTMERGECELLS, SBASEREF, SCATTER, SCENPROTECT, SCL, SELECTION, SERAUXERRBAR, SERAUXTREND, SERFMT, SERIES, SERIESLIST, SERIESTEXT, SERPARENT, SERTOCRT, SETUP, SHAREDUPES, SHEETLAYOUT, SHEETPROTECTION, SHRFMLA, SHTPROPS, SIIINDEX, SST, STARTBLOCK, STARTOBJECT, STRING_ENCODING_AUTO, STRING_ENCODING_COMPRESSED, STRING_ENCODING_UNICODE, STRINGREC, STYLE, SUPBOOK, SURFACE, SXADDL, SXBOOL, SXDB, SXDBB, SXDBEX, SXDI, SXEX, SXFDB, SXFDBTYPE, SXFORMAT, SXIVD, SXLI, SXNUM, SXPI, SXSTREAMID, SXSTRING, SXVD, SXVDEX, SXVI, SXVIEW, SXVIEWEX9, SXVIEWLINK, SXVS, TABID, TABLE, TABLESTYLES, TEXTDISP, THREED, TICK, TOP_MARGIN, TOPMARGIN, TXO, TYPE_BLANK, TYPE_BOOLEAN, TYPE_DOUBLE, TYPE_FORMULA, TYPE_FP, TYPE_INT, TYPE_STRING, UNICODEENCODING, UNITS, USERBVIEW, USERSVIEWBEGIN, USERSVIEWEND, USETEMPFILE_PROP, USR_EXCL, VALIDATEWORKBOOK, VALUERANGE, VB_MODULE, VCENTER, VERTICAL_PAGE_BREAKS, WINDOW_PROTECT, WINDOW1, WINDOW2, WK_CHART, WK_FILE, WK_GLOBALS, WK_MACROSHEET, WK_WORKSHEET, WSBOOL, XCT, XF, XLS_MAX_COLS, YMULT

Constructor Summary

Constructors
Constructor and Description

PtgExp()

Constructors
Constructor and Description
`PtgExp()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Ptg`	`calculatePtg(Ptg[] parsething)` return a Ptg consisting of the calculated values of the ptg's passed in.
`int`	`getColFirst()`
`Ptg[]`	`getConvertedExpression()` Looks up into it's parent shared formula, and returns the expression as if it were a regular formula.
`boolean`	`getIsControl()`
`boolean`	`getIsStandAloneOperator()`
`int`	`getLength()` return the length of the Ptg
`String`	`getLocation()` return the location of this PtgExp 20060302 KSC
`String`	`getReferent()` Returns the location this PtgExp points to.
`int`	`getRwFirst()`
`String`	`getString()` return the human-readable String representation of the linked shared formula
`Object`	`getValue()` returns the value of an operand ptg.
`void`	`init(byte[] b)`
`void`	`init(int row, int col)` init from row, col
`void`	`setColFirst(int c)`
`void`	`setLocation(String s)` setLocation vars from address string
`void`	`setRowFirst(int r)`
`String`	`toString()`
`void`	`updateRecord()` updateRecord from local rwFirst and colFirst values

Methods inherited from class io.starter.formats.XLS.formulas.GenericPtg
clone, close, evaluate, getArrayLen, getComponents, getDoubleVal, getDoubleValue, getDoubleValueFromObject, getIntLocation, getIntVal, getIsArray, getIsBinaryOperator, getIsFunction, getIsOperand, getIsOperator, getIsPrimitiveOperator, getIsReference, getIsUnaryOperator, getLocationPolicy, getLock, getNumParams, getOpcode, getParentRec, getPtgVal, getRecord, getString2, getStringValuesFromPtgs, getTextString, getTrackercell, getValuesFromObjects, getValuesFromPtgs, initTrackerCell, isBlank, qualifyCellAddress, qualifySheetname, readRow, setLocationPolicy, setLock, setParentRec, setTrackercell, setVars, updateAddressFromTrackerCell

Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface io.starter.formats.XLS.formulas.Ptg
clone, close, evaluate, getComponents, getDoubleVal, getIntLocation, getIntVal, getIsArray, getIsBinaryOperator, getIsFunction, getIsOperand, getIsOperator, getIsPrimitiveOperator, getIsReference, getIsUnaryOperator, getLocationPolicy, getLock, getNumParams, getOpcode, getParentRec, getPtgVal, getRecord, getString2, getTextString, getTrackercell, initTrackerCell, isBlank, setLocationPolicy, setLock, setParentRec, setTrackercell, setVars, updateAddressFromTrackerCell

- Constructor Detail
  - PtgExp
```
public PtgExp()
```
- Method Detail
  - getIsControl
```
public boolean getIsControl()
```
    Specified by:
    
    getIsControl in interface Ptg
    
    Overrides:
    
    getIsControl in class GenericPtg
  - getIsStandAloneOperator
```
public boolean getIsStandAloneOperator()
```
    Specified by:
    
    getIsStandAloneOperator in interface Ptg
    
    Overrides:
    
    getIsStandAloneOperator in class GenericPtg
  - getLength
```
public int getLength()
```
    Description copied from interface: Ptg
    
    return the length of the Ptg
    
    Specified by:
    
    getLength in interface Ptg
  - getRwFirst
```
public int getRwFirst()
```
  - getColFirst
```
public int getColFirst()
```
  - init
```
public void init(int row,
                 int col)
```
    init from row, col
    
    Parameters:
    
    row -
    
    col -
  - init
```
public void init(byte[] b)
```
    Overrides:
    
    init in class GenericPtg
  - getReferent
```
public String getReferent()
```
    Returns the location this PtgExp points to.
  - getConvertedExpression
```
public Ptg[] getConvertedExpression()
```
    Looks up into it's parent shared formula, and returns the expression as if it were a regular formula.
    
    Returns:
    
    converted Calculation Expression
  - getValue
```
public Object getValue()
```
    Description copied from class: GenericPtg
    
    returns the value of an operand ptg.
    
    Specified by:
    
    getValue in interface Ptg
    
    Overrides:
    
    getValue in class GenericPtg
    
    Returns:
    
    null for non-operand Ptg.
  - calculatePtg
```
public Ptg calculatePtg(Ptg[] parsething)
```
    Description copied from class: GenericPtg
    
    return a Ptg consisting of the calculated values of the ptg's passed in. Returns null for any non-operand ptg.
    
    Specified by:
    
    calculatePtg in interface Ptg
    
    Overrides:
    
    calculatePtg in class GenericPtg
  - getLocation
```
public String getLocation()
                   throws FormulaNotFoundException
```
    return the location of this PtgExp 20060302 KSC
    
    Specified by:
    
    getLocation in interface Ptg
    
    Overrides:
    
    getLocation in class GenericPtg
    
    Returns:
    
    Location
    
    Throws:
    
    FormulaNotFoundException
  - getString
```
public String getString()
```
    return the human-readable String representation of the linked shared formula
    
    Specified by:
    
    getString in interface Ptg
    
    Overrides:
    
    getString in class GenericPtg
  - updateRecord
```
public void updateRecord()
```
    updateRecord from local rwFirst and colFirst values
    
    Specified by:
    
    updateRecord in interface Ptg
    
    Overrides:
    
    updateRecord in class GenericPtg
  - setLocation
```
public void setLocation(String s)
```
    setLocation vars from address string
    
    Specified by:
    
    setLocation in interface Ptg
    
    Overrides:
    
    setLocation in class GenericPtg
    
    Parameters:
    
    s - String address
  - setColFirst
```
public void setColFirst(int c)
```
  - setRowFirst
```
public void setRowFirst(int r)
```
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object

Class PtgExp

Field Summary

Fields inherited from class io.starter.formats.XLS.formulas.GenericPtg

Fields inherited from interface io.starter.formats.XLS.formulas.Ptg

Fields inherited from interface io.starter.formats.XLS.XLSConstants

Constructor Summary

Method Summary

Methods inherited from class io.starter.formats.XLS.formulas.GenericPtg

Methods inherited from class java.lang.Object

Methods inherited from interface io.starter.formats.XLS.formulas.Ptg

Constructor Detail

PtgExp

Method Detail

getIsControl

getIsStandAloneOperator

getLength

getRwFirst

getColFirst

init

init

getReferent

getConvertedExpression

getValue

calculatePtg

getLocation

getString

updateRecord

setLocation

setColFirst

setRowFirst

toString