Class DataFormatRecord


  • public class DataFormatRecord
    extends Record
    The data format record is used to index into a series. NOTE: This source is automatically generated please do not modify this file. Either subclass or remove the record in src/records/definitions.
    Author:
    Glen Stampoultzis (glens at apache.org)
    • Constructor Detail

      • DataFormatRecord

        public DataFormatRecord()
      • DataFormatRecord

        public DataFormatRecord​(RecordInputStream in)
        Constructs a DataFormat record and sets its fields appropriately.
        Parameters:
        in - the RecordInputstream to read the record from
    • Method Detail

      • validateSid

        protected void validateSid​(short id)
        Checks the sid matches the expected side for this record
        Specified by:
        validateSid in class Record
        Parameters:
        id - the expected sid.
      • 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
      • 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()
        Size of record (exluding 4 byte header)
        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
      • getPointNumber

        public short getPointNumber()
        Get the point number field for the DataFormat record.
      • setPointNumber

        public void setPointNumber​(short field_1_pointNumber)
        Set the point number field for the DataFormat record.
      • getSeriesIndex

        public short getSeriesIndex()
        Get the series index field for the DataFormat record.
      • setSeriesIndex

        public void setSeriesIndex​(short field_2_seriesIndex)
        Set the series index field for the DataFormat record.
      • getSeriesNumber

        public short getSeriesNumber()
        Get the series number field for the DataFormat record.
      • setSeriesNumber

        public void setSeriesNumber​(short field_3_seriesNumber)
        Set the series number field for the DataFormat record.
      • getFormatFlags

        public short getFormatFlags()
        Get the format flags field for the DataFormat record.
      • setFormatFlags

        public void setFormatFlags​(short field_4_formatFlags)
        Set the format flags field for the DataFormat record.
      • setUseExcel4Colors

        public void setUseExcel4Colors​(boolean value)
        Sets the use excel 4 colors field value. set true to use excel 4 colors.
      • isUseExcel4Colors

        public boolean isUseExcel4Colors()
        set true to use excel 4 colors.
        Returns:
        the use excel 4 colors field value.