Package loci.poi.hssf.record
Class BlankRecord
java.lang.Object
loci.poi.hssf.record.Record
loci.poi.hssf.record.BlankRecord
- All Implemented Interfaces:
Comparable,CellValueRecordInterface
Title: Blank cell record
Description: Represents a column in a row with no value but with styling.
REFERENCE: PG 287 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
Fields -
Constructor Summary
ConstructorsConstructorDescriptionCreates a new instance of BlankRecordConstructs a BlankRecord and sets its fields appropriately -
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.shortget the index of the extended format record to style this cell withbooleanreturns 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 yesbooleanisValue()tells whether this type of record contains a valueintserialize(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 rowvoidsetRow(int row) set the row this cell occurs onvoidsetXFIndex(short xf) set the index of the extended format record to style this cell withtoString()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
-
BlankRecord
public BlankRecord()Creates a new instance of BlankRecord -
BlankRecord
Constructs a BlankRecord and sets its fields appropriately- Parameters:
in- the RecordInputstream to read the record from
-
-
Method Details
-
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
-
validateSid
protected void validateSid(short id) called 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
-
setRow
public void setRow(int row) set the row this cell occurs on- Specified by:
setRowin interfaceCellValueRecordInterface- Parameters:
row- the row this cell occurs within
-
getRow
public int getRow()get the row this cell occurs on- Specified by:
getRowin interfaceCellValueRecordInterface- Returns:
- the row
-
getColumn
public short getColumn()get the column this cell defines within the row- Specified by:
getColumnin interfaceCellValueRecordInterface- Returns:
- the column
-
setXFIndex
public void setXFIndex(short xf) set the index of the extended format record to style this cell with- Specified by:
setXFIndexin interfaceCellValueRecordInterface- Parameters:
xf- - the 0-based index of the extended format- See Also:
-
getXFIndex
public short getXFIndex()get the index of the extended format record to style this cell with- Specified by:
getXFIndexin interfaceCellValueRecordInterface- Returns:
- extended format index
-
setColumn
public void setColumn(short col) set the column this cell defines within the row- Specified by:
setColumnin interfaceCellValueRecordInterface- Parameters:
col- the column this cell defines
-
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
-
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
-
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.
-
isInValueSection
public boolean isInValueSection()Description copied from class:RecordDBCELL, ROW, VALUES all say yes- Overrides:
isInValueSectionin classRecord
-
isValue
public boolean isValue()Description copied from class:Recordtells whether this type of record contains a value -
getSid
public short getSid()return the non static version of the id for this record. -
toString
Description copied from class:Recordget a string representation of the record (for biffview/debugging) -
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()Description copied from class:Recordgives the current serialized size of the record. Should include the sid and reclength (4 bytes).- Overrides:
getRecordSizein classRecord
-
compareTo
- Specified by:
compareToin interfaceComparable
-
equals
-
clone
- Specified by:
clonein interfaceCellValueRecordInterface- Overrides:
clonein classRecord
-