org.apache.poi.ddf

Class EscherClientDataRecord

java.lang.Object

org.apache.poi.ddf.EscherRecord

org.apache.poi.ddf.EscherClientDataRecord

All Implemented Interfaces:

Duplicatable, GenericRecord

Direct Known Subclasses:

HSLFEscherClientDataRecord

public class EscherClientDataRecord
extends EscherRecord

The EscherClientDataRecord is used to store client specific data about the position of a shape within a container.

Field Summary

Fields

Modifier and Type	Field and Description
static short	RECORD_ID

Constructor Summary

Constructors

Constructor and Description
EscherClientDataRecord()
EscherClientDataRecord(EscherClientDataRecord other)

Method Summary

Modifier and Type	Method and Description
EscherClientDataRecord	copy()
int	fillFields(byte[] data, int offset, EscherRecordFactory recordFactory) The contract of this method is to deserialize an escher record including its children.
java.util.Map<java.lang.String,java.util.function.Supplier<?>>	getGenericProperties()
java.lang.Enum	getGenericRecordType()
static int	getMaxRecordLength()
short	getRecordId() Return the current record id.
java.lang.String	getRecordName() Subclasses should return the short name for this escher record.
int	getRecordSize() Subclasses should effeciently return the number of bytes required to serialize the record.
byte[]	getRemainingData() Any data recording this record.
int	serialize(int offset, byte[] data, EscherSerializationListener listener) Serializes the record to an existing byte array.
static void	setMaxRecordLength(int length)
void	setRemainingData(byte[] remainingData) Any data recording this record.

Methods inherited from class org.apache.poi.ddf.EscherRecord

display, fillFields, getChild, getChildRecords, getGenericChildren, getInstance, getOptions, getVersion, isContainerRecord, readHeader, readInstance, serialize, serialize, setChildRecords, setInstance, setOptions, setRecordId, setVersion, toString, toXml, toXml

Methods inherited from class java.lang.Object

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

Field Detail

RECORD_ID

public static final short RECORD_ID

Constructor Detail

EscherClientDataRecord

public EscherClientDataRecord()

EscherClientDataRecord

public EscherClientDataRecord(EscherClientDataRecord other)

Method Detail

setMaxRecordLength

public static void setMaxRecordLength(int length)

Parameters:

length - the max record length allowed for EscherClientDataRecord

getMaxRecordLength

public static int getMaxRecordLength()

Returns:

the max record length allowed for EscherClientDataRecord

fillFields

public int fillFields(byte[] data,
                      int offset,
                      EscherRecordFactory recordFactory)

Description copied from class: EscherRecord

The contract of this method is to deserialize an escher record including its children.

Specified by:

fillFields in class EscherRecord

Parameters:

data - The byte array containing the serialized escher records.

offset - The offset into the byte array.

recordFactory - A factory for creating new escher records.

Returns:

The number of bytes written.

serialize

public int serialize(int offset,
                     byte[] data,
                     EscherSerializationListener listener)

Description copied from class: EscherRecord

Serializes the record to an existing byte array.

Specified by:

serialize in class EscherRecord

Parameters:

offset - the offset within the byte array

data - the data array to serialize to

listener - a listener for begin and end serialization events. This is useful because the serialization is hierarchical/recursive and sometimes you need to be able break into that.

Returns:

the number of bytes written.

getRecordSize

public int getRecordSize()

Description copied from class: EscherRecord

Subclasses should effeciently return the number of bytes required to serialize the record.

Specified by:

getRecordSize in class EscherRecord

Returns:

number of bytes

getRecordId

public short getRecordId()

Description copied from class: EscherRecord

Return the current record id.

Overrides:

getRecordId in class EscherRecord

Returns:

The 16 bit record id.

getRecordName

public java.lang.String getRecordName()

Description copied from class: EscherRecord

Subclasses should return the short name for this escher record.

Specified by:

getRecordName in class EscherRecord

Returns:

the short name for this escher record

getRemainingData

public byte[] getRemainingData()

Any data recording this record.

Returns:

the remaining bytes

setRemainingData

public void setRemainingData(byte[] remainingData)

Any data recording this record.

Parameters:

remainingData - the remaining bytes

getGenericProperties

public java.util.Map<java.lang.String,java.util.function.Supplier<?>> getGenericProperties()

Specified by:

getGenericProperties in interface GenericRecord

Overrides:

getGenericProperties in class EscherRecord

getGenericRecordType

public java.lang.Enum getGenericRecordType()

copy

public EscherClientDataRecord copy()

Specified by:

copy in interface Duplicatable

Specified by:

copy in class EscherRecord

Returns:

a deep copy of the implementing class / instance