Package loci.poi.hssf.record

Class LabelSSTRecord

  • All Implemented Interfaces:
    java.lang.Comparable, CellValueRecordInterface
    public class LabelSSTRecord
extends Record
implements CellValueRecordInterface, java.lang.Comparable
    Title: Label SST Record

    Description: Refers to a string in the shared string table and is a column value.

    REFERENCE: PG 325 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 Summary

      Fields 
      Modifier and Type Field Description
      static short sid  

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      java.lang.Object clone()  
      int compareTo​(java.lang.Object obj)  
      boolean equals​(java.lang.Object obj)  
      protected void fillFields​(RecordInputStream in)
      called by the constructor, should set class level fields.
      short getColumn()
      get the column this cell defines within the row
      int getRecordSize()
      gives the current serialized size of the record.
      int getRow()
      get the row this cell occurs on
      short getSid()
      return the non static version of the id for this record.
      int getSSTIndex()
      get the index to the string in the SSTRecord
      short getXFIndex()
      get the index to the extended format record
      boolean isAfter​(CellValueRecordInterface i)
      returns whether this cell is after the passed in cell
      boolean isBefore​(CellValueRecordInterface i)
      returns whether this cell is before the passed in cell
      boolean isEqual​(CellValueRecordInterface i)
      returns whether this cell represents the same cell (NOT VALUE)
      boolean isInValueSection()
      DBCELL, ROW, VALUES all say yes
      boolean isValue()
      tells whether this type of record contains a value
      int serialize​(int offset, byte[] data)
      called by the class that is responsible for writing this sucker.
      void setColumn​(short col)
      set the column this cell defines within the row
      void setRow​(int row)
      set the row this cell occurs on
      void setSSTIndex​(int index)
      set the index to the string in the SSTRecord
      void setXFIndex​(short index)
      set the index to the extended format record
      java.lang.String toString()
      get a string representation of the record (for biffview/debugging)
      protected void validateSid​(short id)
      called by constructor, should throw runtime exception in the event of a record passed with a differing ID.

      • Methods inherited from class java.lang.Object

        finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

    • Constructor Detail

      • LabelSSTRecord

        public LabelSSTRecord()

      • LabelSSTRecord

        public LabelSSTRecord​(RecordInputStream in)
        Constructs an LabelSST record and sets its fields appropriately.
        Parameters:
        in - the RecordInputstream to read the record from

    • Method Detail

      • 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

      • setSSTIndex

        public void setSSTIndex​(int index)
        set the index to the string in the SSTRecord
        Parameters:
        index - - of string in the SST Table
        See Also:
        SSTRecord

      • getSSTIndex

        public int getSSTIndex()
        get the index to the string in the SSTRecord
        Returns:
        index of string in the SST Table
        See Also:
        SSTRecord

      • toString

        public java.lang.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

      • 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

      • isInValueSection

        public boolean isInValueSection()
        Description copied from class: Record
        DBCELL, ROW, VALUES all say yes
        Overrides:
        isInValueSection in class Record

      • isValue

        public boolean isValue()
        Description copied from class: Record
        tells whether this type of record contains a value
        Overrides:
        isValue in class Record

      • compareTo

        public int compareTo​(java.lang.Object obj)
        Specified by:
        compareTo in interface java.lang.Comparable

      • equals

        public boolean equals​(java.lang.Object obj)
        Overrides:
        equals in class java.lang.Object