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 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:
  • Field Details

  • Constructor Details

    • EscherBSERecord

      public EscherBSERecord()
  • Method Details

    • 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:
    • 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.