Apache POI - Common 5.3.0 · org.apache.poi.hssf.record.chart.LinkedDataRecord

Field Summary

Modifier and Type	Field and Description
private static final BitField	customNumberFormat
private byte	field_1_linkType
private byte	field_2_referenceType
private short	field_3_options
private short	field_4_indexNumberFmtRecord
private Formula	field_5_formulaOfLink
public static final byte	LINK_TYPE_CATEGORIES
public static final byte	LINK_TYPE_SECONDARY_CATEGORIES
public static final byte	LINK_TYPE_TITLE_OR_TEXT
public static final byte	LINK_TYPE_VALUES
public static final byte	REFERENCE_TYPE_DEFAULT_CATEGORIES
public static final byte	REFERENCE_TYPE_DIRECT
public static final byte	REFERENCE_TYPE_ERROR_REPORTED
public static final byte	REFERENCE_TYPE_NOT_USED
public static final byte	REFERENCE_TYPE_WORKSHEET
public static final short	sid

Constructor Summary

Access	Constructor and Description
public	LinkedDataRecord()
public	LinkedDataRecord(LinkedDataRecord other)
public	LinkedDataRecord(RecordInputStream in)

Method Summary

Modifier and Type	Method and Description
public LinkedDataRecord	copy() Implements abstract org.apache.poi.hssf.record.StandardRecord.copy. Implements org.apache.poi.common.Duplicatable.copy.
protected int	getDataSize() Implements abstract org.apache.poi.hssf.record.StandardRecord.getDataSize.
public Ptg[]	getFormulaOfLink() Get the formula of link field for the LinkedData record.
public Map<String, Supplier<?>>	getGenericProperties() Implements org.apache.poi.common.usermodel.GenericRecord.getGenericProperties.
public HSSFRecordTypes	getGenericRecordType() Overrides default org.apache.poi.common.usermodel.GenericRecord.getGenericRecordType. Implements abstract org.apache.poi.hssf.record.Record.getGenericRecordType.
public short	getIndexNumberFmtRecord() Get the index number fmt record field for the LinkedData record.
public byte	Returns: One of `LINK_TYPE_TITLE_OR_TEXT`, `LINK_TYPE_VALUES`, `LINK_TYPE_CATEGORIES`, or `LINK_TYPE_SECONDARY_CATEGORIES` getLinkType() Get the link type field for the LinkedData record.
public short	getOptions() Get the options field for the LinkedData record.
public byte	Returns: One of `REFERENCE_TYPE_DEFAULT_CATEGORIES` `REFERENCE_TYPE_DIRECT` `REFERENCE_TYPE_WORKSHEET` `REFERENCE_TYPE_NOT_USED` `REFERENCE_TYPE_ERROR_REPORTED` getReferenceType() Get the reference type field for the LinkedData record.
public short	getSid() Implements abstract org.apache.poi.hssf.record.Record.getSid. return the non static version of the id for this record.
public boolean	Returns: the custom number format field value. isCustomNumberFormat() true if this object has a custom number format
public void	serialize(LittleEndianOutput the output object out) Implements abstract org.apache.poi.hssf.record.StandardRecord.serialize. Write the data content of this BIFF record.
public void	setCustomNumberFormat(boolean value) Sets the custom number format field value.
public void	setFormulaOfLink(Ptg[] ptgs) Set the formula of link field for the LinkedData record.
public void	setIndexNumberFmtRecord(short field_4_indexNumberFmtRecord) Set the index number fmt record field for the LinkedData record.
public void	setLinkType(byte One of `LINK_TYPE_TITLE_OR_TEXT`, `LINK_TYPE_VALUES`, `LINK_TYPE_CATEGORIES`, or `LINK_TYPE_SECONDARY_CATEGORIES` field_1_linkType) Set the link type field for the LinkedData record.
public void	setOptions(short field_3_options) Set the options field for the LinkedData record.
public void	setReferenceType(byte One of `REFERENCE_TYPE_DEFAULT_CATEGORIES` `REFERENCE_TYPE_DIRECT` `REFERENCE_TYPE_WORKSHEET` `REFERENCE_TYPE_NOT_USED` `REFERENCE_TYPE_ERROR_REPORTED` field_2_referenceType) Set the reference type field for the LinkedData record.

Inherited from org.apache.poi.hssf.record.StandardRecord:: getRecordSize serialize

Field Detail

customNumberFormat	back to summary
private static final BitField customNumberFormat

field_1_linkType	back to summary
private byte field_1_linkType

field_2_referenceType	back to summary
private byte field_2_referenceType

field_3_options	back to summary
private short field_3_options

field_4_indexNumberFmtRecord	back to summary
private short field_4_indexNumberFmtRecord

field_5_formulaOfLink	back to summary
private Formula field_5_formulaOfLink

LINK_TYPE_CATEGORIES	back to summary
public static final byte LINK_TYPE_CATEGORIES

LINK_TYPE_SECONDARY_CATEGORIES	back to summary
public static final byte LINK_TYPE_SECONDARY_CATEGORIES

LINK_TYPE_TITLE_OR_TEXT	back to summary
public static final byte LINK_TYPE_TITLE_OR_TEXT

LINK_TYPE_VALUES	back to summary
public static final byte LINK_TYPE_VALUES

REFERENCE_TYPE_DEFAULT_CATEGORIES	back to summary
public static final byte REFERENCE_TYPE_DEFAULT_CATEGORIES

REFERENCE_TYPE_DIRECT	back to summary
public static final byte REFERENCE_TYPE_DIRECT

REFERENCE_TYPE_ERROR_REPORTED	back to summary
public static final byte REFERENCE_TYPE_ERROR_REPORTED

REFERENCE_TYPE_NOT_USED	back to summary
public static final byte REFERENCE_TYPE_NOT_USED

REFERENCE_TYPE_WORKSHEET	back to summary
public static final byte REFERENCE_TYPE_WORKSHEET

sid	back to summary
public static final short sid

Constructor Detail

LinkedDataRecord	back to summary
public LinkedDataRecord()

LinkedDataRecord	back to summary
public LinkedDataRecord(LinkedDataRecord other)

LinkedDataRecord	back to summary
public LinkedDataRecord(RecordInputStream in)

Method Detail

copy	back to summary
public LinkedDataRecord copy() Implements abstract org.apache.poi.hssf.record.StandardRecord.copy. Implements org.apache.poi.common.Duplicatable.copy. Returns:LinkedDataRecord Doc from org.apache.poi.common.Duplicatable.copy. a deep copy of the implementing class / instance Annotations @Override

copy

back to summary

public LinkedDataRecord copy()

Implements abstract org.apache.poi.hssf.record.StandardRecord.copy.

Implements org.apache.poi.common.Duplicatable.copy.

Returns:LinkedDataRecord

Doc from org.apache.poi.common.Duplicatable.copy.

a deep copy of the implementing class / instance

Annotations

@Override

getDataSize	back to summary
protected int getDataSize() Implements abstract org.apache.poi.hssf.record.StandardRecord.getDataSize.

getFormulaOfLink	back to summary
public Ptg[] getFormulaOfLink() Get the formula of link field for the LinkedData record.

getGenericProperties	back to summary
public Map<String, Supplier<?>> getGenericProperties() Implements org.apache.poi.common.usermodel.GenericRecord.getGenericProperties. Annotations @Override

getGenericProperties

back to summary

public Map<String, Supplier<?>> getGenericProperties()

Implements org.apache.poi.common.usermodel.GenericRecord.getGenericProperties.

Annotations

@Override

getGenericRecordType	back to summary
public HSSFRecordTypes getGenericRecordType() Overrides default org.apache.poi.common.usermodel.GenericRecord.getGenericRecordType. Implements abstract org.apache.poi.hssf.record.Record.getGenericRecordType. Annotations @Override

getGenericRecordType

back to summary

public HSSFRecordTypes getGenericRecordType()

Overrides default org.apache.poi.common.usermodel.GenericRecord.getGenericRecordType.

Implements abstract org.apache.poi.hssf.record.Record.getGenericRecordType.

Annotations

@Override

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

getLinkType back to summary

getLinkType	back to summary
public byte getLinkType() Get the link type field for the LinkedData record. Returns:byte One of `LINK_TYPE_TITLE_OR_TEXT`, `LINK_TYPE_VALUES`, `LINK_TYPE_CATEGORIES`, or `LINK_TYPE_SECONDARY_CATEGORIES`

public byte getLinkType()

Get the link type field for the LinkedData record.

Returns:byte: One of LINK_TYPE_TITLE_OR_TEXT, LINK_TYPE_VALUES, LINK_TYPE_CATEGORIES, or LINK_TYPE_SECONDARY_CATEGORIES

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

getReferenceType back to summary

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

public byte getReferenceType()

Get the reference type field for the LinkedData record.

Returns:byte: One of REFERENCE_TYPE_DEFAULT_CATEGORIES REFERENCE_TYPE_DIRECT REFERENCE_TYPE_WORKSHEET REFERENCE_TYPE_NOT_USED REFERENCE_TYPE_ERROR_REPORTED

getSid	back to summary
public short getSid() Implements abstract org.apache.poi.hssf.record.Record.getSid. Doc from org.apache.poi.hssf.record.Record.getSid. return the non static version of the id for this record. Returns:short he id for this record

getSid

back to summary

public short getSid()

Implements abstract org.apache.poi.hssf.record.Record.getSid.

Doc from org.apache.poi.hssf.record.Record.getSid.

return the non static version of the id for this record.

Returns:short: he id for this record

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

isCustomNumberFormat

back to summary

public boolean isCustomNumberFormat()

true if this object has a custom number format

Returns:boolean: the custom number format field value.

serialize back to summary

serialize	back to summary
public void serialize(LittleEndianOutput out) Implements abstract org.apache.poi.hssf.record.StandardRecord.serialize. Doc from org.apache.poi.hssf.record.StandardRecord.serialize. Write the data content of this BIFF record. The 'ushort sid' and 'ushort size' header fields have already been written by the superclass. The number of bytes written must equal the record size reported by `org.apache.poi.hssf.record.Record#getRecordSize()`} minus four ( record header consisting of a 'ushort sid' and 'ushort reclength' has already been written by their superclass). Parameters out:LittleEndianOutput the output object

public void serialize(LittleEndianOutput out)

Implements abstract org.apache.poi.hssf.record.StandardRecord.serialize.

Doc from org.apache.poi.hssf.record.StandardRecord.serialize.

Write the data content of this BIFF record. The 'ushort sid' and 'ushort size' header fields have already been written by the superclass.

The number of bytes written must equal the record size reported by org.apache.poi.hssf.record.Record#getRecordSize()} minus four ( record header consisting of a 'ushort sid' and 'ushort reclength' has already been written by their superclass).

Parameters

out:LittleEndianOutput: the output object

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

setFormulaOfLink	back to summary
public void setFormulaOfLink(Ptg[] ptgs) Set the formula of link field for the LinkedData record.

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

setLinkType back to summary

setLinkType	back to summary
public void setLinkType(byte field_1_linkType) Set the link type field for the LinkedData record. Parameters field_1_linkType:byte One of `LINK_TYPE_TITLE_OR_TEXT`, `LINK_TYPE_VALUES`, `LINK_TYPE_CATEGORIES`, or `LINK_TYPE_SECONDARY_CATEGORIES`

public void setLinkType(byte field_1_linkType)

Set the link type field for the LinkedData record.

Parameters

field_1_linkType:byte: One of LINK_TYPE_TITLE_OR_TEXT, LINK_TYPE_VALUES, LINK_TYPE_CATEGORIES, or LINK_TYPE_SECONDARY_CATEGORIES

setOptions	back to summary
public void setOptions(short field_3_options) Set the options field for the LinkedData record.

setReferenceType back to summary

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

public void setReferenceType(byte field_2_referenceType)

Set the reference type field for the LinkedData record.

Parameters

field_2_referenceType:byte: One of REFERENCE_TYPE_DEFAULT_CATEGORIES REFERENCE_TYPE_DIRECT REFERENCE_TYPE_WORKSHEET REFERENCE_TYPE_NOT_USED REFERENCE_TYPE_ERROR_REPORTED

public final Class LinkedDataRecord

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail