Package loci.poi.hssf.record

Class BoolErrRecord

  • All Implemented Interfaces:
    java.lang.Comparable, CellValueRecordInterface
    public class BoolErrRecord
extends Record
implements CellValueRecordInterface, java.lang.Comparable
    Creates new BoolErrRecord.

    REFERENCE: PG ??? Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)

    Version:
    2.0-pre
    Author:
    Michael P. Harhen, 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.
      boolean getBooleanValue()
      get the value for the cell
      short getColumn()
      get the column this cell defines within the row
      byte getErrorValue()
      get the error value for the cell
      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 to the ExtendedFormat
      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 isBoolean()
      Indicates whether the call holds a boolean value
      boolean isEqual​(CellValueRecordInterface i)
      returns whether this cell represents the same cell (NOT VALUE)
      boolean isError()
      Indicates whether the call holds an error 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 setError​(boolean val)
      manually indicate this is an error rather than a boolean
      void setRow​(int row)
      set the row this cell occurs on
      void setValue​(boolean value)
      set the boolean value for the cell
      void setValue​(byte value)
      set the error value for the cell
      void setXFIndex​(short xf)
      set the index to the ExtendedFormat
      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

      • BoolErrRecord

        public BoolErrRecord()
        Creates new BoolErrRecord

      • BoolErrRecord

        public BoolErrRecord​(RecordInputStream in)
        Constructs a BoolErr record 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

      • setValue

        public void setValue​(boolean value)
        set the boolean value for the cell
        Parameters:
        value - representing the boolean value

      • setValue

        public void setValue​(byte value)
        set the error value for the cell
        Parameters:
        value - error representing the error value this value can only be 0,7,15,23,29,36 or 42 see bugzilla bug 16560 for an explanation

      • getBooleanValue

        public boolean getBooleanValue()
        get the value for the cell
        Returns:
        boolean representing the boolean value

      • getErrorValue

        public byte getErrorValue()
        get the error value for the cell
        Returns:
        byte representing the error value

      • isBoolean

        public boolean isBoolean()
        Indicates whether the call holds a boolean value
        Returns:
        boolean true if the cell holds a boolean value

      • setError

        public void setError​(boolean val)
        manually indicate this is an error rather than a boolean

      • isError

        public boolean isError()
        Indicates whether the call holds an error value
        Returns:
        boolean true if the cell holds an error value

      • 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

      • 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

      • 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