|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
java.lang.Objectorg.apache.poi.hssf.record.RecordBase
org.apache.poi.hssf.record.aggregates.RecordAggregate
org.apache.poi.hssf.record.aggregates.FormulaRecordAggregate
public final class FormulaRecordAggregate
The formula record aggregate is used to join together the formula record and it's (optional) string record and (optional) Shared Formula Record (template reads, excel optimization).
| Nested Class Summary |
|---|
| Nested classes/interfaces inherited from class org.apache.poi.hssf.record.aggregates.RecordAggregate |
|---|
RecordAggregate.PositionTrackingVisitor, RecordAggregate.RecordVisitor |
| Constructor Summary | |
|---|---|
FormulaRecordAggregate(FormulaRecord formulaRec,
StringRecord stringRec,
SharedValueManager svm)
|
|
| Method Summary | |
|---|---|
CellRangeAddress |
getArrayFormulaRange()
|
short |
getColumn()
|
FormulaRecord |
getFormulaRecord()
|
Ptg[] |
getFormulaTokens()
|
int |
getRow()
|
StringRecord |
getStringRecord()
debug only TODO - encapsulate |
java.lang.String |
getStringValue()
|
short |
getXFIndex()
|
boolean |
isPartOfArrayFormula()
|
void |
notifyFormulaChanging()
Should be called by any code which is either deleting this formula cell, or changing its type. |
CellRangeAddress |
removeArrayFormula(int rowIndex,
int columnIndex)
Removes an array formula |
void |
setArrayFormula(CellRangeAddress r,
Ptg[] ptgs)
|
void |
setCachedBooleanResult(boolean value)
|
void |
setCachedDoubleResult(double value)
|
void |
setCachedErrorResult(int errorCode)
|
void |
setCachedStringResult(java.lang.String value)
|
void |
setColumn(short col)
|
void |
setParsedExpression(Ptg[] ptgs)
Also checks for a related shared formula and unlinks it if found |
void |
setRow(int row)
|
void |
setXFIndex(short xf)
|
java.lang.String |
toString()
|
void |
unlinkSharedFormula()
|
void |
visitContainedRecords(RecordAggregate.RecordVisitor rv)
Visit each of the atomic BIFF records contained in this RecordAggregate in the order
that they should be written to file. |
| Methods inherited from class org.apache.poi.hssf.record.aggregates.RecordAggregate |
|---|
getRecordSize, serialize |
| Methods inherited from class java.lang.Object |
|---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
| Constructor Detail |
|---|
public FormulaRecordAggregate(FormulaRecord formulaRec,
StringRecord stringRec,
SharedValueManager svm)
stringRec - may be null if this formula does not have a cached text
value.svm - the SharedValueManager for the current sheet| Method Detail |
|---|
public FormulaRecord getFormulaRecord()
public StringRecord getStringRecord()
public short getXFIndex()
getXFIndex in interface CellValueRecordInterfacepublic void setXFIndex(short xf)
setXFIndex in interface CellValueRecordInterfacepublic void setColumn(short col)
setColumn in interface CellValueRecordInterfacecol - the column this cell definespublic void setRow(int row)
setRow in interface CellValueRecordInterfacerow - the row this cell occurs withinpublic short getColumn()
getColumn in interface CellValueRecordInterfacepublic int getRow()
getRow in interface CellValueRecordInterfacepublic java.lang.String toString()
toString in class java.lang.Objectpublic void visitContainedRecords(RecordAggregate.RecordVisitor rv)
RecordAggregateRecordAggregate in the order
that they should be written to file. Implementors may or may not return the actual
Records being used to manage POI's internal implementation. Callers should not
assume either way, and therefore only attempt to modify those Records after cloning
visitContainedRecords in class RecordAggregatepublic java.lang.String getStringValue()
public void setCachedStringResult(java.lang.String value)
public void setCachedBooleanResult(boolean value)
public void setCachedErrorResult(int errorCode)
public void setCachedDoubleResult(double value)
public Ptg[] getFormulaTokens()
public void setParsedExpression(Ptg[] ptgs)
public void unlinkSharedFormula()
public void notifyFormulaChanging()
public boolean isPartOfArrayFormula()
public CellRangeAddress getArrayFormulaRange()
public void setArrayFormula(CellRangeAddress r,
Ptg[] ptgs)
public CellRangeAddress removeArrayFormula(int rowIndex,
int columnIndex)
null
|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||