org.apache.poi.hssf.record
Class FormulaRecord

java.lang.Object
  extended by org.apache.poi.hssf.record.RecordBase
      extended by org.apache.poi.hssf.record.Record
          extended by org.apache.poi.hssf.record.StandardRecord
              extended by org.apache.poi.hssf.record.FormulaRecord
All Implemented Interfaces:
CellValueRecordInterface

public final class FormulaRecord
extends StandardRecord
implements CellValueRecordInterface

Formula Record (0x0006). REFERENCE: PG 317/444 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)

Version:
2.0-pre
Author:
Andrew C. Oliver (acoliver at apache dot org), Jason Height (jheight at chariot dot net dot au)

Field Summary
static short sid
           
 
Constructor Summary
FormulaRecord()
          Creates new FormulaRecord
FormulaRecord(RecordInputStream ris)
           
 
Method Summary
 java.lang.Object clone()
           
 boolean getCachedBooleanValue()
           
 int getCachedErrorValue()
           
 int getCachedResultType()
           
 short getColumn()
           
protected  int getDataSize()
           
 Formula getFormula()
           
 short getOptions()
          get the option flags
 Ptg[] getParsedExpression()
           
 int getRow()
           
 short getSid()
          return the non static version of the id for this record.
 double getValue()
          get the calculated value of the formula
 short getXFIndex()
           
 boolean hasCachedResultString()
           
 boolean isAlwaysCalc()
           
 boolean isCalcOnLoad()
           
 boolean isSharedFormula()
           
 void serialize(LittleEndianOutput out)
          Write the data content of this BIFF record.
 void setAlwaysCalc(boolean flag)
           
 void setCachedResultBoolean(boolean value)
           
 void setCachedResultErrorCode(int errorCode)
           
 void setCachedResultTypeEmptyString()
           
 void setCachedResultTypeString()
           
 void setCalcOnLoad(boolean flag)
           
 void setColumn(short column)
           
 void setOptions(short options)
          set the option flags
 void setParsedExpression(Ptg[] ptgs)
           
 void setRow(int row)
           
 void setSharedFormula(boolean flag)
           
 void setValue(double value)
          set the calculated value of the formula
 void setXFIndex(short xf)
           
 java.lang.String toString()
          get a string representation of the record (for biffview/debugging)
 
Methods inherited from class org.apache.poi.hssf.record.StandardRecord
getRecordSize, serialize
 
Methods inherited from class org.apache.poi.hssf.record.Record
cloneViaReserialise, serialize
 
Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

sid

public static final short sid
See Also:
Constant Field Values
Constructor Detail

FormulaRecord

public FormulaRecord()
Creates new FormulaRecord


FormulaRecord

public FormulaRecord(RecordInputStream ris)
Method Detail

setRow

public void setRow(int row)
Specified by:
setRow in interface CellValueRecordInterface
Parameters:
row - the row this cell occurs within

setColumn

public void setColumn(short column)
Specified by:
setColumn in interface CellValueRecordInterface
Parameters:
column - the column this cell defines

setXFIndex

public void setXFIndex(short xf)
Specified by:
setXFIndex in interface CellValueRecordInterface

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 this FormulaRecord is followed by a StringRecord 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

getRow

public int getRow()
Specified by:
getRow in interface CellValueRecordInterface
Returns:
the row this cell occurs on

getColumn

public short getColumn()
Specified by:
getColumn in interface CellValueRecordInterface
Returns:
the column this cell defines within the row

getXFIndex

public short getXFIndex()
Specified by:
getXFIndex in interface CellValueRecordInterface

getValue

public double getValue()
get the calculated value of the formula

Returns:
calculated value

getOptions

public short getOptions()
get the option flags

Returns:
bitmask

isSharedFormula

public boolean isSharedFormula()

setSharedFormula

public void setSharedFormula(boolean flag)

isAlwaysCalc

public boolean isAlwaysCalc()

setAlwaysCalc

public void setAlwaysCalc(boolean flag)

isCalcOnLoad

public boolean isCalcOnLoad()

setCalcOnLoad

public void setCalcOnLoad(boolean flag)

getParsedExpression

public Ptg[] getParsedExpression()
Returns:
the formula tokens. never null

getFormula

public Formula getFormula()

setParsedExpression

public void setParsedExpression(Ptg[] ptgs)

getSid

public short getSid()
Description copied from class: Record
return the non static version of the id for this record.

Specified by:
getSid in class Record

getDataSize

protected int getDataSize()
Specified by:
getDataSize in class StandardRecord

serialize

public void serialize(LittleEndianOutput out)
Description copied from class: StandardRecord
Write the data content of this BIFF record. The 'ushort sid' and 'ushort size' header fields have already been written by the superclass.
The subclass must write the exact number of bytes as reported by Record#getDataSize()

Specified by:
serialize in class StandardRecord

toString

public java.lang.String toString()
Description copied from class: Record
get a string representation of the record (for biffview/debugging)

Overrides:
toString in class Record

clone

public java.lang.Object clone()
Overrides:
clone in class Record


Copyright 2009 The Apache Software Foundation or its licensors, as applicable.