Top Description Fields Constructors Methods
org.apache.poi.hssf.record

public final Class IndexRecord

extends StandardRecord
Class Inheritance
Imports
java.util.Map, java.util.function.Supplier, org.apache.poi.util.GenericRecordUtil, .IntList, .LittleEndianOutput, .RecordFormatException
Occurs right after BOF, tells you where the DBCELL records are for a sheet Important for locating cells

Field Summary

Modifier and TypeField and Description
private int
field_2_first_row

private int
field_3_last_row_add1

private int
field_4_zero

private IntList
field_5_dbcells

public static final short
sid

Constructor Summary

AccessConstructor and Description
public
IndexRecord()

public
IndexRecord(IndexRecord other)

public
IndexRecord(RecordInputStream in)

Method Summary

Modifier and TypeMethod and Description
public void
addDbcell(int cell)

public IndexRecord
copy()

Implements abstract org.apache.poi.hssf.record.StandardRecord.copy.

Implements org.apache.poi.common.Duplicatable.copy.

protected int
getDataSize()

Implements abstract org.apache.poi.hssf.record.StandardRecord.getDataSize.

public int
getDbcellAt(int cellnum)

public int
getFirstRow()

public Map<String, Supplier<?>>
getGenericProperties()

Implements org.apache.poi.common.usermodel.GenericRecord.getGenericProperties.

public HSSFRecordTypes
getGenericRecordType()

Overrides default org.apache.poi.common.usermodel.GenericRecord.getGenericRecordType.

Implements abstract org.apache.poi.hssf.record.Record.getGenericRecordType.

public int
getLastRowAdd1()

public int
getNumDbcells()

public static int

Returns:

the size of an IndexRecord when it needs to index the specified number of blocks
getRecordSizeForBlockCount(int
the number of blocks to be indexed
blockCount)

public short
getSid()

Implements abstract org.apache.poi.hssf.record.Record.getSid.

return the non static version of the id for this record.

public void
serialize(LittleEndianOutput
the output object
out)

Implements abstract org.apache.poi.hssf.record.StandardRecord.serialize.

Write the data content of this BIFF record.

public void
setDbcell(int cell, int value)

public void
setFirstRow(int row)

public void
setLastRowAdd1(int row)

Inherited from org.apache.poi.hssf.record.StandardRecord:
getRecordSizeserialize

Field Detail

field_2_first_rowback to summary
private int field_2_first_row
field_3_last_row_add1back to summary
private int field_3_last_row_add1
field_4_zeroback to summary
private int field_4_zero
field_5_dbcellsback to summary
private IntList field_5_dbcells
sidback to summary
public static final short sid

Constructor Detail

IndexRecordback to summary
public IndexRecord()
IndexRecordback to summary
public IndexRecord(IndexRecord other)
IndexRecordback to summary
public IndexRecord(RecordInputStream in)

Method Detail

addDbcellback to summary
public void addDbcell(int cell)
copyback to summary
public IndexRecord copy()

Implements abstract org.apache.poi.hssf.record.StandardRecord.copy.

Implements org.apache.poi.common.Duplicatable.copy.

Returns:IndexRecord

Doc from org.apache.poi.common.Duplicatable.copy.

a deep copy of the implementing class / instance

Annotations
@Override
getDataSizeback to summary
protected int getDataSize()

Implements abstract org.apache.poi.hssf.record.StandardRecord.getDataSize.

Annotations
@Override
getDbcellAtback to summary
public int getDbcellAt(int cellnum)
getFirstRowback to summary
public int getFirstRow()
getGenericPropertiesback to summary
public Map<String, Supplier<?>> getGenericProperties()

Implements org.apache.poi.common.usermodel.GenericRecord.getGenericProperties.

Annotations
@Override
getGenericRecordTypeback to summary
public HSSFRecordTypes getGenericRecordType()

Overrides default org.apache.poi.common.usermodel.GenericRecord.getGenericRecordType.

Implements abstract org.apache.poi.hssf.record.Record.getGenericRecordType.

Annotations
@Override
getLastRowAdd1back to summary
public int getLastRowAdd1()
getNumDbcellsback to summary
public int getNumDbcells()
getRecordSizeForBlockCountback to summary
public static int getRecordSizeForBlockCount(int blockCount)
Parameters
blockCount:int

the number of blocks to be indexed

Returns:int

the size of an IndexRecord when it needs to index the specified number of blocks

getSidback to summary
public short getSid()

Implements abstract org.apache.poi.hssf.record.Record.getSid.

Doc from org.apache.poi.hssf.record.Record.getSid.

return the non static version of the id for this record.

Returns:short

he id for this record

Annotations
@Override
serializeback to summary
public void serialize(LittleEndianOutput out)

Implements abstract org.apache.poi.hssf.record.StandardRecord.serialize.

Doc from org.apache.poi.hssf.record.StandardRecord.serialize.

Write the data content of this BIFF record. The 'ushort sid' and 'ushort size' header fields have already been written by the superclass.

The number of bytes written must equal the record size reported by org.apache.poi.hssf.record.Record#getRecordSize()} minus four ( record header consisting of a 'ushort sid' and 'ushort reclength' has already been written by their superclass).

Parameters
out:LittleEndianOutput

the output object

Annotations
@Override
setDbcellback to summary
public void setDbcell(int cell, int value)
setFirstRowback to summary
public void setFirstRow(int row)
setLastRowAdd1back to summary
public void setLastRowAdd1(int row)