Package loci.poi.hssf.record
Class IndexRecord
java.lang.Object
loci.poi.hssf.record.Record
loci.poi.hssf.record.IndexRecord
Title: Index Record
Description: Occurs right after BOF, tells you where the DBCELL records are for a sheet Important for locating cells
NOT USED IN THIS RELEASE REFERENCE: PG 323 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
FieldsModifier and TypeFieldDescriptionstatic final intintintintintstatic final short -
Constructor Summary
ConstructorsConstructorDescriptionConstructs an Index record and sets its fields appropriately. -
Method Summary
Modifier and TypeMethodDescriptionvoidaddDbcell(int cell) clone()protected voidcalled by the constructor, should set class level fields.intgetDbcellAt(int cellnum) intintintintgives the current serialized size of the record.static intgetRecordSizeForBlockCount(int blockCount) Returns the size of an INdexRecord when it needs to index the specified number of blocksshortgetSid()return the non static version of the id for this record.intserialize(int offset, byte[] data) called by the class that is responsible for writing this sucker.voidsetDbcell(int cell, int value) voidsetFirstRow(int row) voidsetLastRowAdd1(int row) 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.Methods inherited from class loci.poi.hssf.record.Record
isInValueSection, isValue, serialize
-
Field Details
-
sid
public static final short sid- See Also:
-
DBCELL_CAPACITY
public static final int DBCELL_CAPACITY- See Also:
-
field_1_zero
public int field_1_zero -
field_2_first_row
public int field_2_first_row -
field_3_last_row_add1
public int field_3_last_row_add1 -
field_4_zero
public int field_4_zero -
field_5_dbcells
-
-
Constructor Details
-
IndexRecord
public IndexRecord() -
IndexRecord
Constructs an Index record 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
-
setFirstRow
public void setFirstRow(int row) -
setLastRowAdd1
public void setLastRowAdd1(int row) -
addDbcell
public void addDbcell(int cell) -
setDbcell
public void setDbcell(int cell, int value) -
getFirstRow
public int getFirstRow() -
getLastRowAdd1
public int getLastRowAdd1() -
getNumDbcells
public int getNumDbcells() -
getDbcellAt
public int getDbcellAt(int cellnum) -
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
-
getRecordSizeForBlockCount
public static int getRecordSizeForBlockCount(int blockCount) Returns the size of an INdexRecord when it needs to index the specified number of blocks -
getSid
public short getSid()Description copied from class:Recordreturn the non static version of the id for this record. -
clone
-