Package loci.poi.ddf
Class EscherBSERecord
- java.lang.Object
-
- loci.poi.ddf.EscherRecord
-
- loci.poi.ddf.EscherBSERecord
-
public class EscherBSERecord extends EscherRecord
The BSE record is related closely to theEscherBlipRecord
and stores extra information about the blip. A blip record is actually stored inside the BSE record even though the BSE record isn't actually a container record.- Author:
- Glen Stampoultzis
- See Also:
EscherBlipRecord
-
-
Constructor Summary
Constructors Constructor Description EscherBSERecord()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description int
fillFields(byte[] data, int offset, EscherRecordFactory recordFactory)
This method deserializes the record from a byte array.EscherBlipRecord
getBlipRecord()
String
getBlipType(byte b)
Retrieve the string representation given a blip id.byte
getBlipTypeMacOS()
The expected blip type under MacOS (failure to match this blip type will result in Excel converting to this format).byte
getBlipTypeWin32()
The expected blip type under windows (failure to match this blip type will result in Excel converting to this format).byte
getName()
The length in characters of the blip name.int
getOffset()
File offset in the delay stream.String
getRecordName()
The short name for this recordint
getRecordSize()
Returns the number of bytes that are required to serialize this record.int
getRef()
The reference count of this blip.byte[]
getRemainingData()
Any remaining data in this record.int
getSize()
Blip size in stream.short
getTag()
unusedbyte[]
getUid()
16 byte MD4 checksum.byte
getUnused2()
byte
getUnused3()
byte
getUsage()
Defines the way this blip is used.int
serialize(int offset, byte[] data, EscherSerializationListener listener)
This method serializes this escher record into a byte array.void
setBlipRecord(EscherBlipRecord field_12_blipRecord)
void
setBlipTypeMacOS(byte blipTypeMacOS)
Set the expected MacOS blip typevoid
setBlipTypeWin32(byte blipTypeWin32)
Set the expected win32 blip typevoid
setName(byte name)
The length in characters of the blip name.void
setOffset(int offset)
File offset in the delay stream.void
setRef(int ref)
The reference count of this blip.void
setRemainingData(byte[] remainingData)
Any remaining data in this record.void
setSize(int size)
Blip size in stream.void
setTag(short tag)
unusedvoid
setUid(byte[] uid)
16 byte MD4 checksum.void
setUnused2(byte unused2)
void
setUnused3(byte unused3)
void
setUsage(byte usage)
Defines the way this blip is used.String
toString()
Calculate the string representation of this object-
Methods inherited from class loci.poi.ddf.EscherRecord
clone, display, fillFields, getChild, getChildRecords, getInstance, getOptions, getRecordId, isContainerRecord, readHeader, serialize, serialize, setChildRecords, setOptions, setRecordId
-
-
-
-
Field Detail
-
RECORD_ID
public static final short RECORD_ID
- See Also:
- Constant Field Values
-
RECORD_DESCRIPTION
public static final String RECORD_DESCRIPTION
- See Also:
- Constant Field Values
-
BT_ERROR
public static final byte BT_ERROR
- See Also:
- Constant Field Values
-
BT_UNKNOWN
public static final byte BT_UNKNOWN
- See Also:
- Constant Field Values
-
BT_EMF
public static final byte BT_EMF
- See Also:
- Constant Field Values
-
BT_WMF
public static final byte BT_WMF
- See Also:
- Constant Field Values
-
BT_PICT
public static final byte BT_PICT
- See Also:
- Constant Field Values
-
BT_JPEG
public static final byte BT_JPEG
- See Also:
- Constant Field Values
-
BT_PNG
public static final byte BT_PNG
- See Also:
- Constant Field Values
-
BT_DIB
public static final byte BT_DIB
- See Also:
- Constant Field Values
-
-
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 classEscherRecord
- Parameters:
data
- The byte array containing the escher record informationoffset
- The starting offset intodata
.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)
This method serializes this escher record into a byte array.- Specified by:
serialize
in classEscherRecord
- Parameters:
offset
- The offset intodata
to start writing the record data to.data
- The byte array to serialize to.listener
- A listener to retrieve start and end callbacks. Use aNullEscherSerailizationListener
to ignore these events.- Returns:
- The number of bytes written.
- See Also:
NullEscherSerializationListener
-
getRecordSize
public int getRecordSize()
Returns the number of bytes that are required to serialize this record.- Specified by:
getRecordSize
in classEscherRecord
- Returns:
- Number of bytes
-
getRecordName
public String getRecordName()
The short name for this record- Specified by:
getRecordName
in classEscherRecord
-
getBlipTypeWin32
public byte getBlipTypeWin32()
The expected blip type under windows (failure to match this blip type will result in Excel converting to this format).
-
setBlipTypeWin32
public void setBlipTypeWin32(byte blipTypeWin32)
Set the expected win32 blip type
-
getBlipTypeMacOS
public byte getBlipTypeMacOS()
The expected blip type under MacOS (failure to match this blip type will result in Excel converting to this format).
-
setBlipTypeMacOS
public void setBlipTypeMacOS(byte blipTypeMacOS)
Set the expected MacOS blip type
-
getUid
public byte[] getUid()
16 byte MD4 checksum.
-
setUid
public void setUid(byte[] uid)
16 byte MD4 checksum.
-
getTag
public short getTag()
unused
-
setTag
public void setTag(short tag)
unused
-
getSize
public int getSize()
Blip size in stream.
-
setSize
public void setSize(int size)
Blip size in stream.
-
getRef
public int getRef()
The reference count of this blip.
-
setRef
public void setRef(int ref)
The reference count of this blip.
-
getOffset
public int getOffset()
File offset in the delay stream.
-
setOffset
public void setOffset(int offset)
File offset in the delay stream.
-
getUsage
public byte getUsage()
Defines the way this blip is used.
-
setUsage
public void setUsage(byte usage)
Defines the way this blip is used.
-
getName
public byte getName()
The length in characters of the blip name.
-
setName
public void setName(byte name)
The length in characters of the blip name.
-
getUnused2
public byte getUnused2()
-
setUnused2
public void setUnused2(byte unused2)
-
getUnused3
public byte getUnused3()
-
setUnused3
public void setUnused3(byte unused3)
-
getBlipRecord
public EscherBlipRecord getBlipRecord()
-
setBlipRecord
public void setBlipRecord(EscherBlipRecord field_12_blipRecord)
-
getRemainingData
public byte[] getRemainingData()
Any remaining data in this record.
-
setRemainingData
public void setRemainingData(byte[] remainingData)
Any remaining data in this record.
-
toString
public String toString()
Calculate the string representation of this object
-
getBlipType
public String getBlipType(byte b)
Retrieve the string representation given a blip id.
-
-