Package org.apache.poi.hssf.record
Class IndexRecord
- java.lang.Object
-
- org.apache.poi.hssf.record.RecordBase
-
- org.apache.poi.hssf.record.Record
-
- org.apache.poi.hssf.record.StandardRecord
-
- org.apache.poi.hssf.record.IndexRecord
-
- All Implemented Interfaces:
java.lang.Cloneable
public final class IndexRecord extends StandardRecord implements java.lang.Cloneable
Title: Index Record (0x020B)Description: Occurs right after BOF, tells you where the DBCELL records are for a sheet Important for locating cells
REFERENCE: PG 323 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)
-
-
Field Summary
Fields Modifier and Type Field Description static shortsid
-
Constructor Summary
Constructors Constructor Description IndexRecord()IndexRecord(RecordInputStream in)
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description voidaddDbcell(int cell)IndexRecordclone()intgetDbcellAt(int cellnum)intgetFirstRow()intgetLastRowAdd1()intgetNumDbcells()static intgetRecordSizeForBlockCount(int blockCount)shortgetSid()return the non static version of the id for this record.voidserialize(LittleEndianOutput out)voidsetDbcell(int cell, int value)voidsetFirstRow(int row)voidsetLastRowAdd1(int row)java.lang.StringtoString()get a string representation of the record (for biffview/debugging)-
Methods inherited from class org.apache.poi.hssf.record.StandardRecord
getRecordSize, serialize
-
Methods inherited from class org.apache.poi.hssf.record.Record
cloneViaReserialise, serialize
-
-
-
-
Field Detail
-
sid
public static final short sid
- See Also:
- Constant Field Values
-
-
Constructor Detail
-
IndexRecord
public IndexRecord()
-
IndexRecord
public IndexRecord(RecordInputStream in)
-
-
Method Detail
-
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
public java.lang.String toString()
Description copied from class:Recordget a string representation of the record (for biffview/debugging)
-
serialize
public void serialize(LittleEndianOutput out)
-
getRecordSizeForBlockCount
public static int getRecordSizeForBlockCount(int blockCount)
- Parameters:
blockCount- the number of blocks to be indexed- 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
public IndexRecord clone()
-
-