Package org.apache.poi.hssf.record
Class FormulaRecord
java.lang.Object
org.apache.poi.hssf.record.RecordBase
org.apache.poi.hssf.record.Record
org.apache.poi.hssf.record.StandardRecord
org.apache.poi.hssf.record.CellRecord
org.apache.poi.hssf.record.FormulaRecord
- All Implemented Interfaces:
Cloneable,CellValueRecordInterface
Formula Record (0x0006).
REFERENCE: PG 317/444 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)
- Author:
- Andrew C. Oliver (acoliver at apache dot org), Jason Height (jheight at chariot dot net dot au)
-
Field Summary
Fields -
Constructor Summary
ConstructorsConstructorDescriptionCreates new FormulaRecord -
Method Summary
Modifier and TypeMethodDescriptionprotected voidAppend specific debug info (used byCellRecord.toString()for the value contained in this record.clone()booleanintintshortget the option flagsPtg[]protected StringGets the debug info BIFF record type name (used byCellRecord.toString().shortgetSid()return the non static version of the id for this record.doublegetValue()get the calculated value of the formulaprotected intbooleanbooleanbooleanbooleanprotected voidwrites out the value data for this cell recordvoidsetAlwaysCalc(boolean flag) voidsetCachedResultBoolean(boolean value) voidsetCachedResultErrorCode(int errorCode) voidvoidvoidsetCalcOnLoad(boolean flag) voidsetOptions(short options) set the option flagsvoidsetParsedExpression(Ptg[] ptgs) voidsetSharedFormula(boolean flag) voidsetValue(double value) set the calculated value of the formulaMethods inherited from class org.apache.poi.hssf.record.CellRecord
copyBaseFields, getColumn, getDataSize, getRow, getXFIndex, serialize, setColumn, setRow, setXFIndex, toStringMethods inherited from class org.apache.poi.hssf.record.StandardRecord
getRecordSize, serializeMethods inherited from class org.apache.poi.hssf.record.Record
cloneViaReserialise, serialize
-
Field Details
-
sid
public static final short sid- See Also:
-
-
Constructor Details
-
FormulaRecord
public FormulaRecord()Creates new FormulaRecord -
FormulaRecord
-
-
Method Details
-
setValue
public void setValue(double value) set the calculated value of the formula- Parameters:
value- calculated value
-
setCachedResultTypeEmptyString
public void setCachedResultTypeEmptyString() -
setCachedResultTypeString
public void setCachedResultTypeString() -
setCachedResultErrorCode
public void setCachedResultErrorCode(int errorCode) -
setCachedResultBoolean
public void setCachedResultBoolean(boolean value) -
hasCachedResultString
public boolean hasCachedResultString()- Returns:
trueif thisFormulaRecordis followed by aStringRecordrepresenting the cached text result of the formula evaluation.
-
getCachedResultType
public int getCachedResultType() -
getCachedBooleanValue
public boolean getCachedBooleanValue() -
getCachedErrorValue
public int getCachedErrorValue() -
setOptions
public void setOptions(short options) set the option flags- Parameters:
options- bitmask
-
getValue
public double getValue()get the calculated value of the formula- Returns:
- calculated value
-
getOptions
public short getOptions()get the option flags- Returns:
- bitmask
-
isAlwaysCalc
public boolean isAlwaysCalc() -
setAlwaysCalc
public void setAlwaysCalc(boolean flag) -
isCalcOnLoad
public boolean isCalcOnLoad() -
setCalcOnLoad
public void setCalcOnLoad(boolean flag) -
getParsedExpression
- Returns:
- the formula tokens. never
null
-
getFormula
-
setParsedExpression
-
getSid
public short getSid()Description copied from class:Recordreturn the non static version of the id for this record. -
getValueDataSize
protected int getValueDataSize()- Specified by:
getValueDataSizein classCellRecord- Returns:
- the size (in bytes) of the value data for this cell record
-
serializeValue
Description copied from class:CellRecordwrites out the value data for this cell record- Specified by:
serializeValuein classCellRecord- Parameters:
out- the output
-
getRecordName
Description copied from class:CellRecordGets the debug info BIFF record type name (used byCellRecord.toString().- Specified by:
getRecordNamein classCellRecord- Returns:
- the record type name
-
appendValueText
Description copied from class:CellRecordAppend specific debug info (used byCellRecord.toString()for the value contained in this record. Trailing new-line should not be appended (superclass does that).- Specified by:
appendValueTextin classCellRecord- Parameters:
sb- the StringBuilder to write to
-
clone
-