Package loci.poi.hssf.record
Class LinkedDataRecord
java.lang.Object
loci.poi.hssf.record.Record
loci.poi.hssf.record.LinkedDataRecord
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)
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final bytestatic final bytestatic final bytestatic final bytestatic final bytestatic final bytestatic final bytestatic final bytestatic final short -
Constructor Summary
ConstructorsConstructorDescriptionConstructs a LinkedData record and sets its fields appropriately. -
Method Summary
Modifier and TypeMethodDescriptionclone()protected voidcalled by the constructor, should set class level fields.Get the formula of link field for the LinkedData record.shortGet the index number fmt record field for the LinkedData record.byteGet the link type field for the LinkedData record.shortGet the options field for the LinkedData record.intSize of record (exluding 4 byte header)byteGet the reference type field for the LinkedData record.shortgetSid()return the non static version of the id for this record.booleantrue if this object has a custom number formatintserialize(int offset, byte[] data) called by the class that is responsible for writing this sucker.voidsetCustomNumberFormat(boolean value) Sets the custom number format field value.voidsetFormulaOfLink(LinkedDataFormulaField field_5_formulaOfLink) Set the formula of link field for the LinkedData record.voidsetIndexNumberFmtRecord(short field_4_indexNumberFmtRecord) Set the index number fmt record field for the LinkedData record.voidsetLinkType(byte field_1_linkType) Set the link type field for the LinkedData record.voidsetOptions(short field_3_options) Set the options field for the LinkedData record.voidsetReferenceType(byte field_2_referenceType) Set the reference type field for the LinkedData record.toString()get a string representation of the record (for biffview/debugging)protected voidvalidateSid(short id) Checks the sid matches the expected side for this recordMethods inherited from class loci.poi.hssf.record.Record
isInValueSection, isValue, serialize
-
Field Details
-
sid
public static final short sid- See Also:
-
LINK_TYPE_TITLE_OR_TEXT
public static final byte LINK_TYPE_TITLE_OR_TEXT- See Also:
-
LINK_TYPE_VALUES
public static final byte LINK_TYPE_VALUES- See Also:
-
LINK_TYPE_CATEGORIES
public static final byte LINK_TYPE_CATEGORIES- See Also:
-
REFERENCE_TYPE_DEFAULT_CATEGORIES
public static final byte REFERENCE_TYPE_DEFAULT_CATEGORIES- See Also:
-
REFERENCE_TYPE_DIRECT
public static final byte REFERENCE_TYPE_DIRECT- See Also:
-
REFERENCE_TYPE_WORKSHEET
public static final byte REFERENCE_TYPE_WORKSHEET- See Also:
-
REFERENCE_TYPE_NOT_USED
public static final byte REFERENCE_TYPE_NOT_USED- See Also:
-
REFERENCE_TYPE_ERROR_REPORTED
public static final byte REFERENCE_TYPE_ERROR_REPORTED- See Also:
-
-
Constructor Details
-
LinkedDataRecord
public LinkedDataRecord() -
LinkedDataRecord
Constructs a LinkedData record and sets its fields appropriately.- Parameters:
in- the RecordInputstream to read the record from
-
-
Method Details
-
validateSid
protected void validateSid(short id) Checks the sid matches the expected side for this record- Specified by:
validateSidin classRecord- Parameters:
id- the expected sid.
-
fillFields
Description copied from class:Recordcalled by the constructor, should set class level fields. Should throw runtime exception for bad/icomplete data.- Specified by:
fillFieldsin classRecord- Parameters:
in- the RecordInputstream to read the record from
-
toString
Description copied from class:Recordget a string representation of the record (for biffview/debugging) -
serialize
public int serialize(int offset, byte[] data) Description copied from class:Recordcalled 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. -
getRecordSize
public int getRecordSize()Size of record (exluding 4 byte header)- Overrides:
getRecordSizein classRecord
-
getSid
public short getSid()Description copied from class:Recordreturn the non static version of the id for this record. -
clone
-
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
Get the formula of link field for the LinkedData record. -
setFormulaOfLink
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.
-