Class BOFRecord


  • public class BOFRecord
    extends Record
    Title: Beginning Of File

    Description: Somewhat of a misnomer, its used for the beginning of a set of records that have a particular pupose or subject. Used in sheets and workbooks.

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

    Version:
    2.0-pre
    Author:
    Andrew C. Oliver, Jason Height (jheight at chariot dot net dot au)
    • Constructor Detail

      • BOFRecord

        public BOFRecord()
        Constructs an empty BOFRecord with no fields set.
      • BOFRecord

        public BOFRecord​(RecordInputStream in)
        Constructs a BOFRecord 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
      • setVersion

        public void setVersion​(short version)
        Version number - for BIFF8 should be 0x06
        Parameters:
        version - version to be set
        See Also:
        VERSION
      • setBuild

        public void setBuild​(short build)
        build that wrote this file
        Parameters:
        build - build number to set
        See Also:
        BUILD
      • setBuildYear

        public void setBuildYear​(short year)
        Year of the build that wrote this file
        Parameters:
        year - build year to set
        See Also:
        BUILD_YEAR
      • setHistoryBitMask

        public void setHistoryBitMask​(int bitmask)
        set the history bit mask (not very useful)
        Parameters:
        bitmask - bitmask to set for the history
        See Also:
        HISTORY_MASK
      • setRequiredVersion

        public void setRequiredVersion​(int version)
        set the minimum version required to read this file
        Parameters:
        version - version to set
        See Also:
        VERSION
      • getVersion

        public short getVersion()
        Version number - for BIFF8 should be 0x06
        Returns:
        short version number of the generator of this file
        See Also:
        VERSION
      • getBuild

        public short getBuild()
        get the build that wrote this file
        Returns:
        short build number of the generator of this file
        See Also:
        BUILD
      • getBuildYear

        public short getBuildYear()
        Year of the build that wrote this file
        Returns:
        short build year of the generator of this file
        See Also:
        BUILD_YEAR
      • getHistoryBitMask

        public int getHistoryBitMask()
        get the history bit mask (not very useful)
        Returns:
        int bitmask showing the history of the file (who cares!)
        See Also:
        HISTORY_MASK
      • getRequiredVersion

        public int getRequiredVersion()
        get the minimum version required to read this file
        Returns:
        int least version that can read the file
        See Also:
        VERSION
      • 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
      • 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