Package org.apache.poi.hssf.record

Class EmbeddedObjectRefSubRecord

java.lang.Object

org.apache.poi.hssf.record.SubRecord

org.apache.poi.hssf.record.EmbeddedObjectRefSubRecord

All Implemented Interfaces:

Duplicatable, GenericRecord

public final class EmbeddedObjectRefSubRecord
extends SubRecord

ftPictFmla (0x0009)

A sub-record within the OBJ record which stores a reference to an object stored in a separate entry within the OLE2 compound file.

Nested Class Summary

Nested classes/interfaces inherited from class org.apache.poi.hssf.record.SubRecord

SubRecord.SubRecordTypes

Field Summary

Fields

Modifier and Type	Field	Description
static short	sid

Constructor Summary

Constructors

Constructor	Description
EmbeddedObjectRefSubRecord()
EmbeddedObjectRefSubRecord(EmbeddedObjectRefSubRecord other)
EmbeddedObjectRefSubRecord(LittleEndianInput in, int size)

Method Summary

Modifier and Type	Method	Description
EmbeddedObjectRefSubRecord	copy()
protected int	getDataSize()
Map<String,Supplier<?>>	getGenericProperties()
SubRecord.SubRecordTypes	getGenericRecordType()
byte[]	getObjectData()
String	getOLEClassName()
short	getSid()
Integer	getStreamId()	Gets the stream ID containing the actual data.
void	serialize(LittleEndianOutput out)
void	setOleClassname(String oleClassname)
void	setStorageId(int storageId)
void	setUnknownFormulaData(byte[] formularData)

Methods inherited from class org.apache.poi.hssf.record.SubRecord

createSubRecord, getMaxRecordLength, isTerminating, serialize, setMaxRecordLength, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.poi.common.usermodel.GenericRecord

getGenericChildren

Field Detail

sid

public static final short sid

See Also:

Constant Field Values

Constructor Detail

EmbeddedObjectRefSubRecord

public EmbeddedObjectRefSubRecord()

EmbeddedObjectRefSubRecord

public EmbeddedObjectRefSubRecord(EmbeddedObjectRefSubRecord other)

EmbeddedObjectRefSubRecord

public EmbeddedObjectRefSubRecord(LittleEndianInput in,
                                  int size)

Method Detail

getSid

public short getSid()

getDataSize

protected int getDataSize()

Specified by:

getDataSize in class SubRecord

Returns:

the size of the data for this record (which is always 4 bytes less than the total record size). Note however, that ushort encoded after the record sid is usually but not always the data size.

serialize

public void serialize(LittleEndianOutput out)

Specified by:

serialize in class SubRecord

getStreamId

public Integer getStreamId()

Gets the stream ID containing the actual data. The data itself can be found under a top-level directory entry in the OLE2 filesystem under the name "MBDxxxxxxxx" where xxxxxxxx is this ID converted into hex (in big endian order, funnily enough.)

Returns:

the data stream ID. Possibly null

getOLEClassName

public String getOLEClassName()

getObjectData

public byte[] getObjectData()

copy

public EmbeddedObjectRefSubRecord copy()

Specified by:

copy in interface Duplicatable

Specified by:

copy in class SubRecord

Returns:

a deep copy of the implementing class / instance

setUnknownFormulaData

public void setUnknownFormulaData(byte[] formularData)

setOleClassname

public void setOleClassname(String oleClassname)

setStorageId

public void setStorageId(int storageId)

getGenericRecordType

public SubRecord.SubRecordTypes getGenericRecordType()

Specified by:

getGenericRecordType in interface GenericRecord

Specified by:

getGenericRecordType in class SubRecord

getGenericProperties

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