Package loci.poi.hssf.record.aggregates
Class FormulaRecordAggregate
java.lang.Object
loci.poi.hssf.record.Record
loci.poi.hssf.record.aggregates.FormulaRecordAggregate
- All Implemented Interfaces:
Comparable,CellValueRecordInterface
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).
- Author:
- Glen Stampoultzis (glens at apache.org)
-
Field Summary
Fields -
Constructor Summary
ConstructorsConstructorDescriptionFormulaRecordAggregate(FormulaRecord formulaRecord, StringRecord stringRecord) -
Method Summary
Modifier and TypeMethodDescriptionclone()intbooleanprotected voidcalled by the constructor, should set class level fields.shortget the column this cell defines within the rowintgives the current serialized size of the record.intgetRow()get the row this cell occurs onshortgetSid()return the non static version of the id for this record.shortbooleanreturns whether this cell is after the passed in cellbooleanreturns whether this cell is before the passed in cellbooleanreturns whether this cell represents the same cell (NOT VALUE)booleanDBCELL, ROW, VALUES all say yesintserialize(int offset, byte[] data) called by the class that is responsible for writing this sucker.voidsetColumn(short col) set the column this cell defines within the rowvoidsetFormulaRecord(FormulaRecord formulaRecord) voidsetRow(int row) set the row this cell occurs onvoidsetStringRecord(StringRecord stringRecord) voidsetXFIndex(short xf) toString()get a string representation of the record (for biffview/debugging)protected voidvalidateSid(short id) called by constructor, should throw runtime exception in the event of a record passed with a differing ID.
-
Field Details
-
sid
public static final short sid- See Also:
-
-
Constructor Details
-
FormulaRecordAggregate
-
-
Method Details
-
validateSid
protected void validateSid(short id) Description copied from class:Recordcalled by constructor, should throw runtime exception in the event of a record passed with a differing ID.- Specified by:
validateSidin classRecord- Parameters:
id- alleged id for this record
-
fillFields
Description copied from class:Recordcalled by the constructor, should set class level fields. Should throw runtime exception for bad/icomplete data.- Specified by:
fillFieldsin classRecord- Parameters:
in- the RecordInputstream to read the record from
-
serialize
public int serialize(int offset, byte[] data) called by the class that is responsible for writing this sucker. Subclasses should implement this so that their data is passed back in a byte array. -
getRecordSize
public int getRecordSize()gives the current serialized size of the record. Should include the sid and reclength (4 bytes).- Overrides:
getRecordSizein classRecord
-
getSid
public short getSid()return the non static version of the id for this record. -
setStringRecord
-
setFormulaRecord
-
getFormulaRecord
-
getStringRecord
-
isEqual
Description copied from interface:CellValueRecordInterfacereturns whether this cell represents the same cell (NOT VALUE)- Specified by:
isEqualin interfaceCellValueRecordInterface- Parameters:
i- record to compare- Returns:
- true if the cells are the same cell (positionally), false if not.
-
isAfter
Description copied from interface:CellValueRecordInterfacereturns whether this cell is after the passed in cell- Specified by:
isAfterin interfaceCellValueRecordInterface- Parameters:
i- record to compare- Returns:
- true if the cell is after, false if not
-
isBefore
Description copied from interface:CellValueRecordInterfacereturns whether this cell is before the passed in cell- Specified by:
isBeforein interfaceCellValueRecordInterface- Parameters:
i- another cell interface record to compare- Returns:
- true if the cells is before, or false if not
-
getXFIndex
public short getXFIndex()- Specified by:
getXFIndexin interfaceCellValueRecordInterface
-
setXFIndex
public void setXFIndex(short xf) - Specified by:
setXFIndexin interfaceCellValueRecordInterface
-
setColumn
public void setColumn(short col) Description copied from interface:CellValueRecordInterfaceset the column this cell defines within the row- Specified by:
setColumnin interfaceCellValueRecordInterface- Parameters:
col- the column this cell defines
-
setRow
public void setRow(int row) Description copied from interface:CellValueRecordInterfaceset the row this cell occurs on- Specified by:
setRowin interfaceCellValueRecordInterface- Parameters:
row- the row this cell occurs within
-
getColumn
public short getColumn()Description copied from interface:CellValueRecordInterfaceget the column this cell defines within the row- Specified by:
getColumnin interfaceCellValueRecordInterface- Returns:
- the column
-
getRow
public int getRow()Description copied from interface:CellValueRecordInterfaceget the row this cell occurs on- Specified by:
getRowin interfaceCellValueRecordInterface- Returns:
- the row
-
compareTo
- Specified by:
compareToin interfaceComparable
-
equals
-
toString
Description copied from class:Recordget a string representation of the record (for biffview/debugging) -
clone
- Specified by:
clonein interfaceCellValueRecordInterface- Overrides:
clonein classRecord- See Also:
-
isInValueSection
public boolean isInValueSection()Description copied from class:RecordDBCELL, ROW, VALUES all say yes- Overrides:
isInValueSectionin classRecord
-
getStringValue
-