Package loci.poi.hssf.record

Class BlankRecord

  • All Implemented Interfaces:
    java.lang.Comparable, CellValueRecordInterface
    public class BlankRecord
extends Record
implements CellValueRecordInterface, java.lang.Comparable
    Title: Blank cell record

    Description: Represents a column in a row with no value but with styling.

    REFERENCE: PG 287 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  

    • Constructor Summary

      Constructors 
      Constructor Description
      BlankRecord()
      Creates a new instance of BlankRecord
      BlankRecord​(RecordInputStream in)
      Constructs a BlankRecord and sets its fields appropriately

    • 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.
      short getXFIndex()
      get the index of the extended format record to style this cell with
      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 setXFIndex​(short xf)
      set the index of the extended format record to style this cell with
      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

      • BlankRecord

        public BlankRecord()
        Creates a new instance of BlankRecord

      • BlankRecord

        public BlankRecord​(RecordInputStream in)
        Constructs a BlankRecord and sets its fields appropriately
        Parameters:
        in - the RecordInputstream to read the record from

    • Method Detail

      • 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

      • validateSid

        protected void validateSid​(short id)
        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

      • setRow

        public void setRow​(int row)
        set the row this cell occurs on
        Specified by:
        setRow in interface CellValueRecordInterface
        Parameters:
        row - the row this cell occurs within

      • getColumn

        public short getColumn()
        get the column this cell defines within the row
        Specified by:
        getColumn in interface CellValueRecordInterface
        Returns:
        the column

      • setXFIndex

        public void setXFIndex​(short xf)
        set the index of the extended format record to style this cell with
        Specified by:
        setXFIndex in interface CellValueRecordInterface
        Parameters:
        xf - - the 0-based index of the extended format
        See Also:
        ExtendedFormatRecord

      • getXFIndex

        public short getXFIndex()
        get the index of the extended format record to style this cell with
        Specified by:
        getXFIndex in interface CellValueRecordInterface
        Returns:
        extended format index

      • setColumn

        public void setColumn​(short col)
        set the column this cell defines within the row
        Specified by:
        setColumn in interface CellValueRecordInterface
        Parameters:
        col - the column this cell defines

      • 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

      • getSid

        public short getSid()
        return the non static version of the id for this record.
        Specified by:
        getSid in class Record

      • 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)
        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:
        byte array containing instance data

      • 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

      • 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