Class BlankRecord

java.lang.Object
loci.poi.hssf.record.Record
loci.poi.hssf.record.BlankRecord
All Implemented Interfaces:
Comparable, CellValueRecordInterface

public class BlankRecord extends Record implements CellValueRecordInterface, 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 final short
     
  • Constructor Summary

    Constructors
    Constructor
    Description
    Creates a new instance of BlankRecord
    Constructs a BlankRecord and sets its fields appropriately
  • Method Summary

    Modifier and Type
    Method
    Description
     
    int
     
    boolean
     
    protected void
    called by the constructor, should set class level fields.
    short
    get the column this cell defines within the row
    int
    gives the current serialized size of the record.
    int
    get the row this cell occurs on
    short
    return the non static version of the id for this record.
    short
    get the index of the extended format record to style this cell with
    boolean
    returns whether this cell is after the passed in cell
    boolean
    returns whether this cell is before the passed in cell
    boolean
    returns whether this cell represents the same cell (NOT VALUE)
    boolean
    DBCELL, ROW, VALUES all say yes
    boolean
    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
    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 loci.poi.hssf.record.Record

    serialize

    Methods inherited from class java.lang.Object

    finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
  • Field Details

  • Constructor Details

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

    • 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
    • getRow

      public int getRow()
      get the row this cell occurs on
      Specified by:
      getRow in interface CellValueRecordInterface
      Returns:
      the row
    • 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:
    • 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
    • isBefore

      public boolean isBefore(CellValueRecordInterface i)
      Description copied from interface: CellValueRecordInterface
      returns whether this cell is before the passed in cell
      Specified by:
      isBefore in interface CellValueRecordInterface
      Parameters:
      i - another cell interface record to compare
      Returns:
      true if the cells is before, or false if not
    • isAfter

      public boolean isAfter(CellValueRecordInterface i)
      Description copied from interface: CellValueRecordInterface
      returns whether this cell is after the passed in cell
      Specified by:
      isAfter in interface CellValueRecordInterface
      Parameters:
      i - record to compare
      Returns:
      true if the cell is after, false if not
    • isEqual

      public boolean isEqual(CellValueRecordInterface i)
      Description copied from interface: CellValueRecordInterface
      returns whether this cell represents the same cell (NOT VALUE)
      Specified by:
      isEqual in interface CellValueRecordInterface
      Parameters:
      i - record to compare
      Returns:
      true if the cells are the same cell (positionally), false if not.
    • 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 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(Object obj)
      Specified by:
      compareTo in interface Comparable
    • equals

      public boolean equals(Object obj)
      Overrides:
      equals in class Object
    • clone

      public Object clone()
      Specified by:
      clone in interface CellValueRecordInterface
      Overrides:
      clone in class Record