Package loci.poi.hssf.record

Class LinkedDataRecord

  • public class LinkedDataRecord
extends Record
    Describes a linked data record. This record referes to the series data or text. 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

      • LinkedDataRecord

        public LinkedDataRecord()

      • LinkedDataRecord

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

      • clone

        public java.lang.Object clone()
        Overrides:
        clone in class Record

      • getLinkType

        public byte getLinkType()
        Get the link type field for the LinkedData record.
        Returns:
        One of LINK_TYPE_TITLE_OR_TEXT LINK_TYPE_VALUES LINK_TYPE_CATEGORIES

      • setLinkType

        public void setLinkType​(byte field_1_linkType)
        Set the link type field for the LinkedData record.
        Parameters:
        field_1_linkType - One of LINK_TYPE_TITLE_OR_TEXT LINK_TYPE_VALUES LINK_TYPE_CATEGORIES

      • getReferenceType

        public byte getReferenceType()
        Get the reference type field for the LinkedData record.
        Returns:
        One of REFERENCE_TYPE_DEFAULT_CATEGORIES REFERENCE_TYPE_DIRECT REFERENCE_TYPE_WORKSHEET REFERENCE_TYPE_NOT_USED REFERENCE_TYPE_ERROR_REPORTED

      • setReferenceType

        public void setReferenceType​(byte field_2_referenceType)
        Set the reference type field for the LinkedData record.
        Parameters:
        field_2_referenceType - One of REFERENCE_TYPE_DEFAULT_CATEGORIES REFERENCE_TYPE_DIRECT REFERENCE_TYPE_WORKSHEET REFERENCE_TYPE_NOT_USED REFERENCE_TYPE_ERROR_REPORTED

      • getOptions

        public short getOptions()
        Get the options field for the LinkedData record.

      • setOptions

        public void setOptions​(short field_3_options)
        Set the options field for the LinkedData record.

      • getIndexNumberFmtRecord

        public short getIndexNumberFmtRecord()
        Get the index number fmt record field for the LinkedData record.

      • setIndexNumberFmtRecord

        public void setIndexNumberFmtRecord​(short field_4_indexNumberFmtRecord)
        Set the index number fmt record field for the LinkedData record.

      • getFormulaOfLink

        public LinkedDataFormulaField getFormulaOfLink()
        Get the formula of link field for the LinkedData record.

      • setFormulaOfLink

        public void setFormulaOfLink​(LinkedDataFormulaField field_5_formulaOfLink)
        Set the formula of link field for the LinkedData record.

      • setCustomNumberFormat

        public void setCustomNumberFormat​(boolean value)
        Sets the custom number format field value. true if this object has a custom number format

      • isCustomNumberFormat

        public boolean isCustomNumberFormat()
        true if this object has a custom number format
        Returns:
        the custom number format field value.