|
|||||||||||
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.aggregates.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).
Field Summary | |
static short |
sid
|
Constructor Summary | |
FormulaRecordAggregate(FormulaRecord formulaRecord,
StringRecord stringRecord)
|
|
FormulaRecordAggregate(FormulaRecord formulaRecord,
StringRecord stringRecord,
SharedFormulaRecord sharedRecord)
Used only in the clone |
Method Summary | |
java.lang.Object |
clone()
|
int |
compareTo(java.lang.Object o)
|
boolean |
equals(java.lang.Object obj)
|
protected void |
fillFields(byte[] data,
short size,
int offset)
called by the constructor, should set class level fields. |
short |
getColumn()
get the column this cell defines within the row |
FormulaRecord |
getFormulaRecord()
|
int |
getRecordSize()
gives the current serialized size of the record. |
int |
getRow()
get the row this cell occurs on |
SharedFormulaRecord |
getSharedFormulaRecord()
|
short |
getSid()
return the non static version of the id for this record. |
StringRecord |
getStringRecord()
|
java.lang.String |
getStringValue()
|
short |
getXFIndex()
|
boolean |
isAfter(CellValueRecordInterface i)
returns whether this cell is after the passed in cell |
boolean |
isBefore(CellValueRecordInterface i)
returns whether this cell is before the passed in cell |
boolean |
isEqual(CellValueRecordInterface i)
returns whether this cell represents the same cell (NOT VALUE) |
boolean |
isInValueSection()
DBCELL, ROW, VALUES all say yes |
int |
serialize(int offset,
byte[] data)
called by the class that is responsible for writing this sucker. |
void |
setColumn(short col)
set the column this cell defines within the row |
void |
setFormulaRecord(FormulaRecord formulaRecord)
|
void |
setRow(int row)
set the row this cell occurs on |
void |
setSharedFormulaRecord(SharedFormulaRecord sharedFormulaRecord)
Sets the sharedFormulaRecord, only set from RecordFactory since they are not generated by POI and are an Excel optimization |
void |
setStringRecord(StringRecord stringRecord)
|
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 |
fillFields, isValue, processContinueRecord, 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 FormulaRecordAggregate(FormulaRecord formulaRecord, StringRecord stringRecord)
public FormulaRecordAggregate(FormulaRecord formulaRecord, StringRecord stringRecord, SharedFormulaRecord sharedRecord)
formulaRecord
- stringRecord
- sharedRecord
- Method Detail |
protected void validateSid(short id)
Record
validateSid
in class Record
id
- alleged id for this recordprotected void fillFields(byte[] data, short size, int offset)
Record
fillFields
in class Record
data
- raw datasize
- size of dataoffset
- of the record's data (provided a big array of the file)public int serialize(int offset, byte[] data)
serialize
in class Record
offset
- to begin writing atdata
- byte array containing instance data
public int getRecordSize()
getRecordSize
in class Record
public short getSid()
getSid
in class Record
public void setStringRecord(StringRecord stringRecord)
public void setFormulaRecord(FormulaRecord formulaRecord)
public FormulaRecord getFormulaRecord()
public StringRecord getStringRecord()
public boolean isEqual(CellValueRecordInterface i)
CellValueRecordInterface
isEqual
in interface CellValueRecordInterface
i
- record to compare
public boolean isAfter(CellValueRecordInterface i)
CellValueRecordInterface
isAfter
in interface CellValueRecordInterface
i
- record to compare
public boolean isBefore(CellValueRecordInterface i)
CellValueRecordInterface
isBefore
in interface CellValueRecordInterface
i
- another cell interface record to compare
public short getXFIndex()
getXFIndex
in interface CellValueRecordInterface
public void setXFIndex(short xf)
setXFIndex
in interface CellValueRecordInterface
public void setColumn(short col)
CellValueRecordInterface
setColumn
in interface CellValueRecordInterface
col
- the column this cell definespublic void setRow(int row)
CellValueRecordInterface
setRow
in interface CellValueRecordInterface
row
- the row this cell occurs withinpublic short getColumn()
CellValueRecordInterface
getColumn
in interface CellValueRecordInterface
public int getRow()
CellValueRecordInterface
getRow
in interface CellValueRecordInterface
public int compareTo(java.lang.Object o)
compareTo
in interface java.lang.Comparable
public boolean equals(java.lang.Object obj)
public java.lang.String toString()
Record
toString
in class Record
public java.lang.Object clone()
clone
in interface CellValueRecordInterface
clone
in class Record
Object.clone()
public SharedFormulaRecord getSharedFormulaRecord()
public void setSharedFormulaRecord(SharedFormulaRecord sharedFormulaRecord)
sharedFormulaRecord
- The sharedFormulaRecord to setpublic boolean isInValueSection()
Record
isInValueSection
in class Record
public java.lang.String getStringValue()
|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |