Package loci.poi.hssf.record

Class RecalcIdRecord

  • public class RecalcIdRecord
extends Record
    Title: Recalc Id Record

    Description: This record contains an ID that marks when a worksheet was last recalculated. It's an optimization Excel uses to determine if it needs to recalculate the spreadsheet when it's opened. So far, only the two values 0xC1 0x01 0x00 0x00 0x80 0x38 0x01 0x00 (do not recalculate) and 0xC1 0x01 0x00 0x00 0x60 0x69 0x01 0x00 have been seen. If the field isNeeded is set to false (default), then this record is swallowed during the serialization process

    REFERENCE: http://chicago.sourceforge.net/devel/docs/excel/biff8.html

    Version:
    2.0-pre
    Author:
    Luc Girardin (luc dot girardin at macrofocus dot com)
    See Also:
    Workbook

    • Field Summary

      Fields 
      Modifier and Type Field Description
      short[] field_1_recalcids  
      static short sid  

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      protected void fillFields​(RecordInputStream in)
      called by the constructor, should set class level fields.
      short[] getRecalcIdArray()
      get the recalc array.
      int getRecordSize()
      gives the current serialized size of the record.
      short getSid()
      return the non static version of the id for this record.
      boolean isNeeded()  
      int serialize​(int offset, byte[] data)
      called by the class that is responsible for writing this sucker.
      void setIsNeeded​(boolean isNeeded)  
      void setRecalcIdArray​(short[] array)
      set the recalc array.
      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

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

    • Field Detail

      • field_1_recalcids

        public short[] field_1_recalcids

    • Constructor Detail

      • RecalcIdRecord

        public RecalcIdRecord()

      • RecalcIdRecord

        public RecalcIdRecord​(RecordInputStream in)
        Constructs a RECALCID 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

      • setRecalcIdArray

        public void setRecalcIdArray​(short[] array)
        set the recalc array.
        Parameters:
        array - of recalc id's

      • getRecalcIdArray

        public short[] getRecalcIdArray()
        get the recalc array.
        Returns:
        array of recalc id's

      • setIsNeeded

        public void setIsNeeded​(boolean isNeeded)

      • isNeeded

        public boolean isNeeded()

      • 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