EscherBSERecord (Bio-Formats API)

java.lang.Object
- loci.poi.ddf.EscherRecord
- - loci.poi.ddf.EscherBSERecord

```
public class EscherBSERecord
extends EscherRecord
```
The BSE record is related closely to the EscherBlipRecord 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

Nested Class Summary
- Nested classes/interfaces inherited from class loci.poi.ddf.EscherRecord
  EscherRecord.EscherRecordHeader

Field Summary

Fields
Modifier and Type	Field and Description
`static byte`	`BT_DIB`
`static byte`	`BT_EMF`
`static byte`	`BT_ERROR`
`static byte`	`BT_JPEG`
`static byte`	`BT_PICT`
`static byte`	`BT_PNG`
`static byte`	`BT_UNKNOWN`
`static byte`	`BT_WMF`
`private byte`	`field_1_blipTypeWin32`
`private byte`	`field_10_unused2`
`private byte`	`field_11_unused3`
`private EscherBlipRecord`	`field_12_blipRecord`
`private byte`	`field_2_blipTypeMacOS`
`private byte[]`	`field_3_uid`
`private short`	`field_4_tag`
`private int`	`field_5_size`
`private int`	`field_6_ref`
`private int`	`field_7_offset`
`private byte`	`field_8_usage`
`private byte`	`field_9_name`
`static String`	`RECORD_DESCRIPTION`
`static short`	`RECORD_ID`
`private byte[]`	`remainingData`

Constructor Summary

Constructors
Constructor and Description

EscherBSERecord()

Constructors
Constructor and Description
`EscherBSERecord()`

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.
`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 record
`int`	`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()` unused
`byte[]`	`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 type
`void`	`setBlipTypeWin32(byte blipTypeWin32)` Set the expected win32 blip type
`void`	`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)` unused
`void`	`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

Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- 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
  - field_1_blipTypeWin32
```
private byte field_1_blipTypeWin32
```
  - field_2_blipTypeMacOS
```
private byte field_2_blipTypeMacOS
```
  - field_3_uid
```
private byte[] field_3_uid
```
  - field_4_tag
```
private short field_4_tag
```
  - field_5_size
```
private int field_5_size
```
  - field_6_ref
```
private int field_6_ref
```
  - field_7_offset
```
private int field_7_offset
```
  - field_8_usage
```
private byte field_8_usage
```
  - field_9_name
```
private byte field_9_name
```
  - field_10_unused2
```
private byte field_10_unused2
```
  - field_11_unused3
```
private byte field_11_unused3
```
  - field_12_blipRecord
```
private EscherBlipRecord field_12_blipRecord
```
  - remainingData
```
private byte[] remainingData
```
- Constructor Detail
  - EscherBSERecord
```
public EscherBSERecord()
```
- 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)
```
    This method serializes this escher record into a byte array.
    
    Specified by:
    
    serialize in class EscherRecord
    
    Parameters:
    offset - The offset into data to start writing the record data to.
    data - The byte array to serialize to.
    listener - A listener to retrieve start and end callbacks. Use a NullEscherSerailizationListener 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 class EscherRecord
    
    Returns:
    Number of bytes
  - getRecordName
```
public String getRecordName()
```
    The short name for this record
    
    Specified by:
    
    getRecordName in class EscherRecord
  - 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
    
    Overrides:
    
    toString in class Object
  - getBlipType
```
public String getBlipType(byte b)
```
    Retrieve the string representation given a blip id.

Class EscherBSERecord

Nested Class Summary

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

Field Summary

Constructor Summary

Method Summary

Methods inherited from class loci.poi.ddf.EscherRecord

Methods inherited from class java.lang.Object

Field Detail

RECORD_ID

RECORD_DESCRIPTION

BT_ERROR

BT_UNKNOWN

BT_EMF

BT_WMF

BT_PICT

BT_JPEG

BT_PNG

BT_DIB

field_1_blipTypeWin32

field_2_blipTypeMacOS

field_3_uid

field_4_tag

field_5_size

field_6_ref

field_7_offset

field_8_usage

field_9_name

field_10_unused2

field_11_unused3

field_12_blipRecord

remainingData

Constructor Detail

EscherBSERecord

Method Detail

fillFields

serialize

getRecordSize

getRecordName

getBlipTypeWin32

setBlipTypeWin32

getBlipTypeMacOS

setBlipTypeMacOS

getUid

setUid

getTag

setTag

getSize

setSize

getRef

setRef

getOffset

setOffset

getUsage

setUsage

getName

setName

getUnused2

setUnused2

getUnused3

setUnused3

getBlipRecord

setBlipRecord

getRemainingData

setRemainingData

toString

getBlipType