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:
org.apache.poi.common.Duplicatable
,GenericRecord
public final class IndexRecord extends StandardRecord
Occurs right after BOF, tells you where the DBCELL records are for a sheet Important for locating cells
-
-
Field Summary
Fields Modifier and Type Field Description static short
sid
-
Constructor Summary
Constructors Constructor Description IndexRecord()
IndexRecord(IndexRecord other)
IndexRecord(RecordInputStream in)
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description void
addDbcell(int cell)
IndexRecord
copy()
int
getDbcellAt(int cellnum)
int
getFirstRow()
java.util.Map<java.lang.String,java.util.function.Supplier<?>>
getGenericProperties()
HSSFRecordTypes
getGenericRecordType()
int
getLastRowAdd1()
int
getNumDbcells()
static int
getRecordSizeForBlockCount(int blockCount)
short
getSid()
return the non static version of the id for this record.void
serialize(LittleEndianOutput out)
void
setDbcell(int cell, int value)
void
setFirstRow(int row)
void
setLastRowAdd1(int row)
-
Methods inherited from class org.apache.poi.hssf.record.StandardRecord
getRecordSize, serialize
-
Methods inherited from class org.apache.poi.hssf.record.Record
cloneViaReserialise, serialize, toString
-
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
-
Methods inherited from interface org.apache.poi.common.usermodel.GenericRecord
getGenericChildren
-
-
-
-
Field Detail
-
sid
public static final short sid
- See Also:
- Constant Field Values
-
-
Constructor Detail
-
IndexRecord
public IndexRecord()
-
IndexRecord
public IndexRecord(IndexRecord other)
-
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)
-
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:Record
return the non static version of the id for this record.
-
copy
public IndexRecord copy()
- Specified by:
copy
in interfaceorg.apache.poi.common.Duplicatable
- Specified by:
copy
in classStandardRecord
-
getGenericRecordType
public HSSFRecordTypes getGenericRecordType()
- Specified by:
getGenericRecordType
in interfaceGenericRecord
- Specified by:
getGenericRecordType
in classRecord
-
getGenericProperties
public java.util.Map<java.lang.String,java.util.function.Supplier<?>> getGenericProperties()
-
-