Package loci.poi.hssf.record
Class DBCellRecord
java.lang.Object
loci.poi.hssf.record.Record
loci.poi.hssf.record.DBCellRecord
Title: DBCell Record
Description: Used by Excel and other MS apps to quickly find rows in the sheets.
REFERENCE: PG 299/440 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
-
Field Summary
Fields -
Constructor Summary
ConstructorsConstructorDescriptionConstructs a DBCellRecord and sets its fields appropriately -
Method Summary
Modifier and TypeMethodDescriptionvoidaddCellOffset(short offset) protected voidcalled by the constructor, should set class level fields.shortgetCellOffsetAt(int index) return the cell offset in the arrayintget the number of cell offsets in the celloffset arrayintgives the current serialized size of the record.static intgetRecordSizeForRows(int rows) Returns the size of a DBCellRecord when it needs to reference a certain number of rowsintgets offset from the start of this DBCellRecord to the start of the first cell in the next DBCell block.shortgetSid()return the non static version of the id for this record.booleanDBCELL, ROW, VALUES all say yesintserialize(int offset, byte[] data) called by the class that is responsible for writing this sucker.voidsetRowOffset(int offset) sets offset from the start of this DBCellRecord to the start of the first cell in the next DBCell block.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
-
BLOCK_SIZE
public static final int BLOCK_SIZE- See Also:
-
sid
public static final short sid- See Also:
-
-
Constructor Details
-
DBCellRecord
public DBCellRecord() -
DBCellRecord
Constructs a DBCellRecord and sets its fields appropriately- Parameters:
in- the RecordInputstream to read the record from
-
-
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
-
setRowOffset
public void setRowOffset(int offset) sets offset from the start of this DBCellRecord to the start of the first cell in the next DBCell block.- Parameters:
offset- offset to the start of the first cell in the next DBCell block
-
addCellOffset
public void addCellOffset(short offset) -
getRowOffset
public int getRowOffset()gets offset from the start of this DBCellRecord to the start of the first cell in the next DBCell block.- Returns:
- rowoffset to the start of the first cell in the next DBCell block
-
getCellOffsetAt
public short getCellOffsetAt(int index) return the cell offset in the array- Parameters:
index- of the cell offset to retrieve- Returns:
- celloffset from the celloffset array
-
getNumCellOffsets
public int getNumCellOffsets()get the number of cell offsets in the celloffset array- Returns:
- number of cell offsets
-
toString
Description copied from class:Recordget a string representation of the record (for biffview/debugging) -
serialize
public int serialize(int offset, byte[] data) Description copied from class:Recordcalled 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
-
getRecordSizeForRows
public static int getRecordSizeForRows(int rows) Returns the size of a DBCellRecord when it needs to reference a certain number of rows -
getSid
public short getSid()Description copied from class:Recordreturn the non static version of the id for this record. -
isInValueSection
public boolean isInValueSection()Description copied from class:RecordDBCELL, ROW, VALUES all say yes- Overrides:
isInValueSectionin classRecord
-