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:
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 Details

  • Constructor Details

    • IndexRecord

      public IndexRecord()

    • IndexRecord

      public IndexRecord(IndexRecord other)

    • IndexRecord

      public IndexRecord(RecordInputStream in)

  • Method Details

    • 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)
      Description copied from class: StandardRecord
      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 RecordBase.getRecordSize()} minus four ( record header consisting of a 'ushort sid' and 'ushort reclength' has already been written by their superclass).

      Specified by:
      serialize in class StandardRecord
      Parameters:
      out - the output object

    • getDataSize

      protected int getDataSize()
      Specified by:
      getDataSize in class StandardRecord

    • 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.
      Specified by:
      getSid in class Record
      Returns:
      he id for this record

    • copy

      public IndexRecord copy()
      Specified by:
      copy in interface Duplicatable
      Specified by:
      copy in class StandardRecord
      Returns:
      a deep copy of the implementing class / instance

    • getGenericRecordType

      public HSSFRecordTypes getGenericRecordType()
      Specified by:
      getGenericRecordType in interface GenericRecord
      Specified by:
      getGenericRecordType in class Record

    • getGenericProperties

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