io.starter.formats.XLS.formulas

Class PtgMemFunc

java.lang.Object

io.starter.formats.XLS.formulas.GenericPtg

io.starter.formats.XLS.formulas.PtgMemFunc

All Implemented Interfaces:

Ptg, XLSConstants, Serializable, Cloneable

public class PtgMemFunc
extends GenericPtg

PtgMemFunc refers to a reference subexpression that doesn't evaluate to a constant reference. This is still somewhat unclear to me how it functions, or why it exists for that matter. This token encapsulates a reference subexpression that results in a non-constant cell address, cell range address, or cell range list. For A little update on it. Apparently this is used in situations where a record only contains one ptg, but needs to refer to a whole stack of them. An example is in the Name record. For a built in name that has both row & col repeat regions, the name expression is a ptgmemfunc, but contains 2 ptgArea3d's. Also used in Ai's (Chart Series Range Refs) when non-contiguous range refs are required PtgMemFunc basically represents a complex range and is used where only one PtgRef-type ptg is expected NOTE: that this represents a NON-CONSTANT expression while PtgMemArea represents a CONSTANT expression

        OFFSET          NAME            SIZE            CONTENTS
-------------------------------------------------------
        0                       cce                     2                       The length of the reference subexpression

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static long	serialVersionUID

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
PtgMemFunc()

Method Summary

Modifier and Type	Method and Description
void	close() clear out object references in prep for closing workbook
Ptg[]	getColComponents(int colNum) return the ptg components for a certain column within a ptgArea()
Ptg[]	getComponents() Returns all of the cells of this range as PtgRef's.
Ptg	getFirstloc()
boolean	getIsOperand()
boolean	getIsReference()
int	getLength() return the length of the Ptg
byte[]	getRecord() update the record internally for ptgmemfunc
Boundsheet[]	getSheets(WorkBook b) return the boundsheet associated with this complex range NOTE: since complex ranges may contain more than one sheet, this is incomplete for those instanaces
Stack<?>	getSubExpression()
boolean	getUseReferenceTracker()
Object	getValue() returns the value of an operand ptg.
void	init(byte[] b)
void	setLocation(String complexrange) given a complex range, parse and set this PtgMemFunc's associated ptgs
void	setUseReferenceTracker(boolean b)
String	toString() traverse through expression to retrieve set of ranges either discontiguous union (,), intersected ( ) or regular range (:)

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

calculatePtg, clone, evaluate, getArrayLen, getDoubleVal, getDoubleValue, getDoubleValueFromObject, getIntLocation, getIntVal, getIsArray, getIsBinaryOperator, getIsControl, getIsFunction, getIsOperator, getIsPrimitiveOperator, getIsStandAloneOperator, getIsUnaryOperator, getLocation, getLocationPolicy, getLock, getNumParams, getOpcode, getParentRec, getPtgVal, getString, getString2, getStringValuesFromPtgs, getTextString, getTrackercell, getValuesFromObjects, getValuesFromPtgs, initTrackerCell, isBlank, qualifyCellAddress, qualifySheetname, readRow, setLocationPolicy, setLock, setParentRec, setTrackercell, setVars, updateAddressFromTrackerCell, updateRecord

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

serialVersionUID

public static final long serialVersionUID

See Also:

Constant Field Values

Constructor Detail

PtgMemFunc

public PtgMemFunc()

Method Detail

getIsOperand

public boolean getIsOperand()

Specified by:

getIsOperand in interface Ptg

Overrides:

getIsOperand in class GenericPtg

getIsReference

public boolean getIsReference()

Specified by:

getIsReference in interface Ptg

Overrides:

getIsReference in class GenericPtg

init

public void init(byte[] b)

Overrides:

init in class GenericPtg

getRecord

public byte[] getRecord()

update the record internally for ptgmemfunc

Specified by:

getRecord in interface Ptg

Overrides:

getRecord in class GenericPtg

Returns:

byte[] containing the whole ptg, including identifying opcode

getLength

public int getLength()

Description copied from interface: Ptg

return the length of the Ptg

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.

getColComponents

public Ptg[] getColComponents(int colNum)

return the ptg components for a certain column within a ptgArea()

Parameters:

colNum -

Returns:

all Ptg's within colNum

getComponents

public Ptg[] getComponents()

Returns all of the cells of this range as PtgRef's. This includes empty cells, values, formulas, etc. Note the setting of parent-rec requires finding the cell the PtgRef refer's to. If that is null then the PtgRef will exist, just with a null value. This could cause issues when programatically populating cells.

Specified by:

getComponents in interface Ptg

Overrides:

getComponents in class GenericPtg

getFirstloc

public Ptg getFirstloc()

Returns:

Returns the firstPtg.

setUseReferenceTracker

public void setUseReferenceTracker(boolean b)

getUseReferenceTracker

public boolean getUseReferenceTracker()

getSubExpression

public Stack<?> getSubExpression()

Returns:

Returns the lastPtg.

setLocation

public void setLocation(String complexrange)

given a complex range, parse and set this PtgMemFunc's associated ptgs

Specified by:

setLocation in interface Ptg

Overrides:

setLocation in class GenericPtg

Parameters:

String - complexrange String representing a complex range

toString

public String toString()

traverse through expression to retrieve set of ranges either discontiguous union (,), intersected ( ) or regular range (:)

Overrides:

toString in class Object

getSheets

public Boundsheet[] getSheets(WorkBook b)

return the boundsheet associated with this complex range
NOTE: since complex ranges may contain more than one sheet, this is incomplete for those instanaces

Parameters:

b -

Returns:

close

public void close()

Description copied from class: GenericPtg

clear out object references in prep for closing workbook

Specified by:

close in interface Ptg

Overrides:

close in class GenericPtg