io.starter.formats.XLS.formulas

Class GenericPtg

java.lang.Object

io.starter.formats.XLS.formulas.GenericPtg

All Implemented Interfaces:

Ptg, XLSConstants, Serializable, Cloneable

Direct Known Subclasses:

PtgAdd, PtgArray, PtgAtr, PtgBool, PtgConcat, PtgDiv, PtgEndSheet, PtgEQ, PtgErr, PtgExp, PtgFunc, PtgFuncVar, PtgGE, PtgGT, PtgInt, PtgIsect, PtgLE, PtgLT, PtgMemArea, PtgMemAreaN, PtgMemErr, PtgMemFunc, PtgMissArg, PtgMlt, PtgMystery, PtgName, PtgNE, PtgNumber, PtgParen, PtgPercent, PtgPower, PtgRange, PtgRef, PtgStr, PtgSub, PtgUMinus, PtgUnion, PtgUPlus

public abstract class GenericPtg
extends Object
implements Ptg, Cloneable

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected XLSRecord	parent_rec
static long	serialVersionUID

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

Method Summary

Modifier and Type	Method and Description
Ptg	calculatePtg(Ptg[] parsething) return a Ptg consisting of the calculated values of the ptg's passed in.
Object	clone() Creates a deep clone of this Ptg.
void	close() clear out object references in prep for closing workbook
Object	evaluate(Object[] obj) pass in arbitrary number of values (probably other Ptgs) and return the resultant value.
static int	getArrayLen(Object o)
Ptg[]	getComponents() If a record consists of multiple sub records (ie PtgArea) return those records, else return null;
double	getDoubleVal() Gets the value of the ptg represented as an double.
static double	getDoubleValue(Object o, XLSRecord parent) convert a value to a double, throws exception if cannot
static double	getDoubleValueFromObject(Object o) converts a single Ptg number-type value to a double
int[]	getIntLocation()
int	getIntVal() Gets the value of the ptg represented as an int.
boolean	getIsArray()
boolean	getIsBinaryOperator()
boolean	getIsControl()
boolean	getIsFunction()
boolean	getIsOperand()
boolean	getIsOperator() determine the general Ptg type
boolean	getIsPrimitiveOperator() determines whether this operator is a 'primitive' such as +,-,=,<,>,!=,==,etc.
boolean	getIsReference()
boolean	getIsStandAloneOperator()
boolean	getIsUnaryOperator()
String	getLocation() When the ptg is a reference to a location this returns that location
int	getLocationPolicy() returns the Location Policy of the Ptg is locked used during automated BiffRec movement updates
int	getLock() a locking mechanism so that Ptgs are not endlessly re-calculated
int	getNumParams() Returns the number of Params to pass to the Ptg
byte	getOpcode() return the byte header for the Ptg
XLSRecord	getParentRec()
Ptg	getPtgVal() Gets the (return) value of this Ptg as an operand Ptg.
byte[]	getRecord() So, here you see we can get the static type from the record itself then format the output record.
String	getString() return the human-readable String representation of this ptg -- if applicable
String	getString2() return the human-readable String representation of the "closing" portion of this Ptg such as a closing parenthesis.
protected static String[]	getStringValuesFromPtgs(Ptg[] pthings) returns an array of strings from ptg's sent in.
String	getTextString() return the human-readable String representation of this ptg -- if applicable
BiffRec	getTrackercell() if the Ptg needs to keep a handle to a cell, this is it...
Object	getValue() returns the value of an operand ptg.
protected static double[]	getValuesFromObjects(Object[] pthings) Returns an array of doubles from number-type ptg's sent in.
protected static Object[]	getValuesFromPtgs(Ptg[] pthings) Returns an array of doubles from number-type ptg's sent in.
void	init(byte[] b)
void	initTrackerCell() if the Ptg needs to keep a handle to a cell, this is it...
boolean	isBlank()
static String	qualifyCellAddress(String s) return cell address with $'s e.g.
static String	qualifySheetname(String s) return properly quoted sheetname
int	readRow(byte b0, byte b1) generic reading of a row byte pair with handling for Excel 2007 if necessary
void	setLocation(String s) setLocation moves a ptg that is a reference to a location, such as a ptg range being modified
void	setLocationPolicy(int b) lock the Location of the Ptg so that it will not be updated during automated BiffRec movement updates
void	setLock(int x) a locking mechanism so that Ptgs are not endlessly re-calculated
void	setParentRec(XLSRecord f) constructor must pass in 'parent' XLSRecord so that there is a handle for updating...
void	setTrackercell(BiffRec trackercell) if the Ptg needs to keep a handle to a cell, this is it...
void	setVars(Ptg[] parr) Operator Ptgs take other Ptgs as arguments so we need to pass them in to get a meaningful value.
void	updateAddressFromTrackerCell() if the Ptg needs to keep a handle to a cell, this is it...
void	updateRecord() update the Ptg

Methods inherited from class java.lang.Object

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

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

getLength

Field Detail

serialVersionUID

public static final long serialVersionUID

See Also:

Constant Field Values

parent_rec

protected XLSRecord parent_rec

Constructor Detail

GenericPtg

public GenericPtg()

Method Detail

clone

public Object clone()

Description copied from interface: Ptg

Creates a deep clone of this Ptg.

Specified by:

clone in interface Ptg

Overrides:

clone in class Object

getLock

public int getLock()

a locking mechanism so that Ptgs are not endlessly re-calculated

Specified by:

getLock in interface Ptg

Returns:

setLock

public void setLock(int x)

a locking mechanism so that Ptgs are not endlessly re-calculated

Specified by:

setLock in interface Ptg

getIsOperator

public boolean getIsOperator()

Description copied from interface: Ptg

determine the general Ptg type

Specified by:

getIsOperator in interface Ptg

getIsBinaryOperator

public boolean getIsBinaryOperator()

Specified by:

getIsBinaryOperator in interface Ptg

getIsUnaryOperator

public boolean getIsUnaryOperator()

Specified by:

getIsUnaryOperator in interface Ptg

getIsStandAloneOperator

public boolean getIsStandAloneOperator()

Specified by:

getIsStandAloneOperator in interface Ptg

getIsPrimitiveOperator

public boolean getIsPrimitiveOperator()

Description copied from interface: Ptg

determines whether this operator is a 'primitive' such as +,-,=,<,>,!=,==,etc. the upshot is that primitives go BETWEEN operands, and non-primitives encapsulate ie: SUM(A1:A4) non-primitive A1+A4 primitive

Specified by:

getIsPrimitiveOperator in interface Ptg

getIsOperand

public boolean getIsOperand()

Specified by:

getIsOperand in interface Ptg

getIsFunction

public boolean getIsFunction()

Specified by:

getIsFunction in interface Ptg

getIsControl

public boolean getIsControl()

Specified by:

getIsControl in interface Ptg

getIsArray

public boolean getIsArray()

Specified by:

getIsArray in interface Ptg

getIsReference

public boolean getIsReference()

Specified by:

getIsReference in interface Ptg

getLocationPolicy

public int getLocationPolicy()

returns the Location Policy of the Ptg is locked used during automated BiffRec movement updates

Specified by:

getLocationPolicy in interface Ptg

Returns:

int

setLocationPolicy

public void setLocationPolicy(int b)

lock the Location of the Ptg so that it will not be updated during automated BiffRec movement updates

Specified by:

setLocationPolicy in interface Ptg

Parameters:

b - setting of the lock the location policy for this Ptg

updateRecord

public void updateRecord()

update the Ptg

Specified by:

updateRecord in interface Ptg

getNumParams

public int getNumParams()

Returns the number of Params to pass to the Ptg

Specified by:

getNumParams in interface Ptg

setVars

public void setVars(Ptg[] parr)

Operator Ptgs take other Ptgs as arguments so we need to pass them in to get a meaningful value.

Specified by:

setVars in interface Ptg

getComponents

public Ptg[] getComponents()

Description copied from interface: Ptg

If a record consists of multiple sub records (ie PtgArea) return those records, else return null;

Specified by:

getComponents in interface Ptg

evaluate

public Object evaluate(Object[] obj)

pass in arbitrary number of values (probably other Ptgs) and return the resultant value. This effectively calculates the Expression.

Specified by:

evaluate in interface Ptg

getTextString

public String getTextString()

return the human-readable String representation of this ptg -- if applicable

Specified by:

getTextString in interface Ptg

getString

public String getString()

Description copied from interface: Ptg

return the human-readable String representation of this ptg -- if applicable

Specified by:

getString in interface Ptg

getString2

public String getString2()

return the human-readable String representation of the "closing" portion of this Ptg such as a closing parenthesis.

Specified by:

getString2 in interface Ptg

getOpcode

public byte getOpcode()

Description copied from interface: Ptg

return the byte header for the Ptg

Specified by:

getOpcode in interface Ptg

init

public void init(byte[] b)

calculatePtg

public Ptg calculatePtg(Ptg[] parsething)
                 throws FunctionNotSupportedException,
                        CalculationException

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

Throws:

CalculationException

FunctionNotSupportedException

getPtgVal

public Ptg getPtgVal()

Gets the (return) value of this Ptg as an operand Ptg.

Specified by:

getPtgVal in interface Ptg

getValue

public Object getValue()

returns the value of an operand ptg.

Specified by:

getValue in interface Ptg

Returns:

null for non-operand Ptg.

getIntVal

public int getIntVal()

Gets the value of the ptg represented as an int. This can result in loss of precision for floating point values. overridden in PtgInt to natively return value.

Specified by:

getIntVal in interface Ptg

Returns:

integer representing the ptg, or NAN

getDoubleVal

public double getDoubleVal()

Gets the value of the ptg represented as an double. This can result in loss of precision for floating point values. NAN will be returned for values that are not translateable to an double overrideen in PtgNumber

Specified by:

getDoubleVal in interface Ptg

Returns:

integer representing the ptg, or NAN

getRecord

public byte[] getRecord()

So, here you see we can get the static type from the record itself then format the output record. Some shorthand techniques are shown.

Specified by:

getRecord in interface Ptg

Returns:

byte[] containing the whole ptg, including identifying opcode

setLocation

public void setLocation(String s)

Description copied from interface: Ptg

setLocation moves a ptg that is a reference to a location, such as a ptg range being modified

Specified by:

setLocation in interface Ptg

getLocation

public String getLocation()
                   throws FormulaNotFoundException

Description copied from interface: Ptg

When the ptg is a reference to a location this returns that location

Specified by:

getLocation in interface Ptg

Returns:

Location

Throws:

FormulaNotFoundException

getIntLocation

public int[] getIntLocation()
                     throws FormulaNotFoundException

Specified by:

getIntLocation in interface Ptg

Throws:

FormulaNotFoundException

setParentRec

public void setParentRec(XLSRecord f)

Description copied from interface: Ptg

constructor must pass in 'parent' XLSRecord so that there is a handle for updating...

Specified by:

setParentRec in interface Ptg

getParentRec

public XLSRecord getParentRec()

Specified by:

getParentRec in interface Ptg

getValuesFromPtgs

protected static Object[] getValuesFromPtgs(Ptg[] pthings)

Returns an array of doubles from number-type ptg's sent in. This should only be referenced by sub-classes. Null values accessed are treated as 0. Within excel (empty cell values == 0) Tested! Sometimes as well you can get empty string values, "". These are NOT EQUAL ("" != 0)

Parameters:

pthings -

Returns:

getValuesFromObjects

protected static double[] getValuesFromObjects(Object[] pthings)
                                        throws NumberFormatException

Returns an array of doubles from number-type ptg's sent in. This should only be referenced by sub-classes. Null values accessed are treated as 0. Within excel (empty cell values == 0) Tested! Sometimes as well you can get empty string values, "". These are NOT EQUAL ("" != 0)

Parameters:

pthings -

Returns:

Throws:

NumberFormatException

getDoubleValue

public static double getDoubleValue(Object o,
                                    XLSRecord parent)
                             throws NumberFormatException

convert a value to a double, throws exception if cannot

Parameters:

o -

Returns:

double value if possible

Throws:

NumberFormatException

getDoubleValueFromObject

public static double getDoubleValueFromObject(Object o)

converts a single Ptg number-type value to a double

getStringValuesFromPtgs

protected static String[] getStringValuesFromPtgs(Ptg[] pthings)

returns an array of strings from ptg's sent in. This should only be referenced by sub-classes.

updateAddressFromTrackerCell

public void updateAddressFromTrackerCell()

if the Ptg needs to keep a handle to a cell, this is it... tells the Ptg to get it on its own...

Specified by:

updateAddressFromTrackerCell in interface Ptg

initTrackerCell

public void initTrackerCell()

if the Ptg needs to keep a handle to a cell, this is it... tells the Ptg to get it on its own...

Specified by:

initTrackerCell in interface Ptg

getTrackercell

public BiffRec getTrackercell()

Description copied from interface: Ptg

if the Ptg needs to keep a handle to a cell, this is it...

Specified by:

getTrackercell in interface Ptg

Returns:

Returns the trackercell.

setTrackercell

public void setTrackercell(BiffRec trackercell)

Description copied from interface: Ptg

if the Ptg needs to keep a handle to a cell, this is it...

Specified by:

setTrackercell in interface Ptg

Parameters:

trackercell - The trackercell to set.

isBlank

public boolean isBlank()

Specified by:

isBlank in interface Ptg

qualifySheetname

public static final String qualifySheetname(String s)

return properly quoted sheetname

Parameters:

s -

Returns:

qualifyCellAddress

public static String qualifyCellAddress(String s)

return cell address with $'s e.g. cell AB12 ==> $AB$12 cell Sheet1!C2=>Sheet1!$C$2 Does NOT handle ranges

Parameters:

s -

Returns:

getArrayLen

public static int getArrayLen(Object o)

readRow

public int readRow(byte b0,
                   byte b1)

generic reading of a row byte pair with handling for Excel 2007 if necessary

Parameters:

b0 -

b1 -

Returns:

int row

close

public void close()

clear out object references in prep for closing workbook

Specified by:

close in interface Ptg