|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.apache.poi.hssf.record.Record
org.apache.poi.hssf.record.FormulaRecord
public class FormulaRecord
Formula Record. REFERENCE: PG 317/444 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)
Field Summary | |
---|---|
static short |
sid
|
Constructor Summary | |
---|---|
FormulaRecord()
Creates new FormulaRecord |
|
FormulaRecord(RecordInputStream in)
Constructs a Formula record and sets its fields appropriately. |
Method Summary | |
---|---|
java.lang.Object |
clone()
|
int |
compareTo(java.lang.Object obj)
|
boolean |
equals(java.lang.Object obj)
|
protected void |
fillFields(RecordInputStream in)
called by the constructor, should set class level fields. |
short |
getColumn()
get the column this cell defines within the row |
short |
getExpressionLength()
get the length (in number of tokens) of the expression |
int |
getNumberOfExpressionTokens()
get the size of the stack |
short |
getOptions()
get the option flags |
java.util.List |
getParsedExpression()
get the stack as a list |
int |
getRecordSize()
gives the current serialized size of the record. |
int |
getRow()
get the row this cell occurs on |
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 |
isAfter(CellValueRecordInterface i)
returns whether this cell is after the passed in cell |
boolean |
isAlwaysCalc()
|
boolean |
isBefore(CellValueRecordInterface i)
returns whether this cell is before the passed in cell |
boolean |
isCalcOnLoad()
|
boolean |
isEqual(CellValueRecordInterface i)
returns whether this cell represents the same cell (NOT VALUE) |
boolean |
isInValueSection()
DBCELL, ROW, VALUES all say yes |
boolean |
isSharedFormula()
|
boolean |
isValue()
tells whether this type of record contains a value |
Ptg |
peekExpressionToken()
peek at the token on the top of stack |
Ptg |
popExpressionToken()
pop a token off of the stack |
void |
pushExpressionToken(Ptg ptg)
push a token onto the stack |
int |
serialize(int offset,
byte[] data)
called by the class that is responsible for writing this sucker. |
void |
setAlwaysCalc(boolean flag)
|
void |
setCalcOnLoad(boolean flag)
|
void |
setColumn(short column)
set the column this cell defines within the row |
void |
setExpressionLength(short len)
set the length (in number of tokens) of the expression |
void |
setOptions(short options)
set the option flags |
void |
setParsedExpression(java.util.Stack ptgs)
|
void |
setRow(int row)
set the row this cell occurs on |
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) |
protected void |
validateSid(short id)
called by constructor, should throw runtime exception in the event of a record passed with a differing ID. |
Methods inherited from class org.apache.poi.hssf.record.Record |
---|
cloneViaReserialise, serialize |
Methods inherited from class java.lang.Object |
---|
finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Field Detail |
---|
public static final short sid
Constructor Detail |
---|
public FormulaRecord()
public FormulaRecord(RecordInputStream in)
in
- the RecordInputstream to read the record fromMethod Detail |
---|
protected void fillFields(RecordInputStream in)
Record
fillFields
in class Record
in
- the RecordInputstream to read the record frompublic void setRow(int row)
CellValueRecordInterface
setRow
in interface CellValueRecordInterface
row
- the row this cell occurs withinpublic void setColumn(short column)
CellValueRecordInterface
setColumn
in interface CellValueRecordInterface
column
- the column this cell definespublic void setXFIndex(short xf)
setXFIndex
in interface CellValueRecordInterface
public void setValue(double value)
value
- calculated valuepublic void setOptions(short options)
options
- bitmaskpublic void setExpressionLength(short len)
len
- lengthpublic int getRow()
CellValueRecordInterface
getRow
in interface CellValueRecordInterface
public short getColumn()
CellValueRecordInterface
getColumn
in interface CellValueRecordInterface
public short getXFIndex()
getXFIndex
in interface CellValueRecordInterface
public double getValue()
public short getOptions()
public boolean isSharedFormula()
public void setSharedFormula(boolean flag)
public boolean isAlwaysCalc()
public void setAlwaysCalc(boolean flag)
public boolean isCalcOnLoad()
public void setCalcOnLoad(boolean flag)
public short getExpressionLength()
public void pushExpressionToken(Ptg ptg)
ptg
- the tokenpublic Ptg popExpressionToken()
public Ptg peekExpressionToken()
public int getNumberOfExpressionTokens()
public java.util.List getParsedExpression()
public void setParsedExpression(java.util.Stack ptgs)
protected void validateSid(short id)
validateSid
in class Record
id
- alleged id for this recordpublic short getSid()
Record
getSid
in class Record
public int serialize(int offset, byte[] data)
serialize
in class Record
offset
- to begin writing atdata
- byte array containing instance data
public int getRecordSize()
Record
getRecordSize
in class Record
public boolean isBefore(CellValueRecordInterface i)
CellValueRecordInterface
isBefore
in interface CellValueRecordInterface
i
- another cell interface record to compare
public boolean isAfter(CellValueRecordInterface i)
CellValueRecordInterface
isAfter
in interface CellValueRecordInterface
i
- record to compare
public boolean isEqual(CellValueRecordInterface i)
CellValueRecordInterface
isEqual
in interface CellValueRecordInterface
i
- record to compare
public boolean isInValueSection()
Record
isInValueSection
in class Record
public boolean isValue()
Record
isValue
in class Record
public int compareTo(java.lang.Object obj)
compareTo
in interface java.lang.Comparable
public boolean equals(java.lang.Object obj)
equals
in class java.lang.Object
public java.lang.String toString()
Record
toString
in class Record
public java.lang.Object clone()
clone
in interface CellValueRecordInterface
clone
in class Record
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |