Class IndexRecord

java.lang.Object
loci.poi.hssf.record.Record
loci.poi.hssf.record.IndexRecord

public class IndexRecord extends Record
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 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

      public IntList field_5_dbcells
  • Constructor Details

    • IndexRecord

      public IndexRecord()
    • IndexRecord

      public IndexRecord(RecordInputStream in)
      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: Record
      called by constructor, should throw runtime exception in the event of a record passed with a differing ID.
      Specified by:
      validateSid in class Record
      Parameters:
      id - alleged id for this record
    • fillFields

      protected void fillFields(RecordInputStream in)
      Description copied from class: Record
      called by the constructor, should set class level fields. Should throw runtime exception for bad/icomplete data.
      Specified by:
      fillFields in class Record
      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

      public String toString()
      Description copied from class: Record
      get a string representation of the record (for biffview/debugging)
      Overrides:
      toString in class Record
    • serialize

      public int serialize(int offset, byte[] data)
      Description copied from class: Record
      called 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.
      Specified by:
      serialize in class Record
      Parameters:
      offset - to begin writing at
      data - byte array containing instance data
      Returns:
      number of bytes written
    • getRecordSize

      public int getRecordSize()
      Description copied from class: Record
      gives the current serialized size of the record. Should include the sid and reclength (4 bytes).
      Overrides:
      getRecordSize in class Record
    • 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: Record
      return the non static version of the id for this record.
      Specified by:
      getSid in class Record
    • clone

      public Object clone()
      Overrides:
      clone in class Record