loci.poi.ddf

Class EscherBlipRecord

java.lang.Object

loci.poi.ddf.EscherRecord

loci.poi.ddf.EscherBlipRecord

Direct Known Subclasses:

EscherBitmapBlip, EscherBlipWMFRecord, EscherMetafileBlip, EscherPictBlip

public class EscherBlipRecord
extends EscherRecord

Version:

$Id: EscherBlipRecord.java 569827 2007-08-26 15:26:29Z yegor $

Author:

Glen Stampoultzis

Nested Class Summary

Nested classes/interfaces inherited from class loci.poi.ddf.EscherRecord

EscherRecord.EscherRecordHeader

Field Summary

Fields

Modifier and Type	Field and Description
protected byte[]	field_pictureData
private static int	HEADER_SIZE
static String	RECORD_DESCRIPTION
static short	RECORD_ID_END
static short	RECORD_ID_START

Constructor Summary

Constructors

Constructor and Description
EscherBlipRecord()

Method Summary

Methods

Modifier and Type	Method and Description
int	fillFields(byte[] data, int offset, EscherRecordFactory recordFactory) This method deserializes the record from a byte array.
byte[]	getPicturedata()
String	getRecordName() The short name for this record
int	getRecordSize() Returns the number of bytes that are required to serialize this record.
int	serialize(int offset, byte[] data, EscherSerializationListener listener) Serializes the record to an existing byte array.
void	setPictureData(byte[] pictureData)
String	toString()

Methods inherited from class loci.poi.ddf.EscherRecord

clone, display, fillFields, getChild, getChildRecords, getInstance, getOptions, getRecordId, isContainerRecord, readHeader, serialize, serialize, setChildRecords, setOptions, setRecordId

Methods inherited from class java.lang.Object

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

Field Detail

RECORD_ID_START

public static final short RECORD_ID_START

See Also:

Constant Field Values

RECORD_ID_END

public static final short RECORD_ID_END

See Also:

Constant Field Values

RECORD_DESCRIPTION

public static final String RECORD_DESCRIPTION

See Also:

Constant Field Values

HEADER_SIZE

private static final int HEADER_SIZE

See Also:

Constant Field Values

field_pictureData

protected byte[] field_pictureData

Constructor Detail

EscherBlipRecord

public EscherBlipRecord()

Method Detail

fillFields

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

This method deserializes the record from a byte array.

Specified by:

fillFields in class EscherRecord

Parameters:

data - The byte array containing the escher record information

offset - The starting offset into data.

recordFactory - May be null since this is not a container record.

Returns:

The number of bytes read from the byte array.

serialize

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

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()

Returns the number of bytes that are required to serialize this record.

Specified by:

getRecordSize in class EscherRecord

Returns:

Number of bytes

getRecordName

public String getRecordName()

The short name for this record

Specified by:

getRecordName in class EscherRecord

getPicturedata

public byte[] getPicturedata()

setPictureData

public void setPictureData(byte[] pictureData)

toString

public String toString()

Overrides:

toString in class Object