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 void
Append specific debug info (used byCellRecord.toString()
for the value contained in this record.clone()
boolean
int
int
short
get the option flagsPtg[]
protected String
Gets the debug info BIFF record type name (used byCellRecord.toString()
.short
getSid()
return the non static version of the id for this record.double
getValue()
get the calculated value of the formulaprotected int
boolean
boolean
boolean
boolean
protected void
writes out the value data for this cell recordvoid
setAlwaysCalc
(boolean flag) void
setCachedResultBoolean
(boolean value) void
setCachedResultErrorCode
(int errorCode) void
void
void
setCalcOnLoad
(boolean flag) void
setOptions
(short options) set the option flagsvoid
setParsedExpression
(Ptg[] ptgs) void
setSharedFormula
(boolean flag) void
setValue
(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, toString
Methods inherited from class org.apache.poi.hssf.record.StandardRecord
getRecordSize, serialize
Methods 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:
true
if thisFormulaRecord
is followed by aStringRecord
representing 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:Record
return the non static version of the id for this record. -
getValueDataSize
protected int getValueDataSize()- Specified by:
getValueDataSize
in classCellRecord
- Returns:
- the size (in bytes) of the value data for this cell record
-
serializeValue
Description copied from class:CellRecord
writes out the value data for this cell record- Specified by:
serializeValue
in classCellRecord
- Parameters:
out
- the output
-
getRecordName
Description copied from class:CellRecord
Gets the debug info BIFF record type name (used byCellRecord.toString()
.- Specified by:
getRecordName
in classCellRecord
- Returns:
- the record type name
-
appendValueText
Description copied from class:CellRecord
Append 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:
appendValueText
in classCellRecord
- Parameters:
sb
- the StringBuilder to write to
-
clone
-