org.apache.poi.hssf.record
Class EmbeddedObjectRefSubRecord

java.lang.Object
  extended by org.apache.poi.hssf.record.RecordBase
      extended by org.apache.poi.hssf.record.Record
          extended by org.apache.poi.hssf.record.SubRecord
              extended by org.apache.poi.hssf.record.EmbeddedObjectRefSubRecord

public final class EmbeddedObjectRefSubRecord
extends SubRecord

ftPictFmla (0x0009)
A sub-record within the OBJ record which stores a reference to an object stored in a separate entry within the OLE2 compound file.

Author:
Daniel Noll

Field Summary
static short sid
           
 
Constructor Summary
EmbeddedObjectRefSubRecord(RecordInputStream in)
           
 
Method Summary
 byte[] getObjectData()
           
 java.lang.String getOLEClassName()
           
 int getRecordSize()
          gives the current serialized size of the record.
 short getSid()
          return the non static version of the id for this record.
 java.lang.Integer getStreamId()
          Gets the stream ID containing the actual data.
 int serialize(int base, byte[] data)
          called by the class that is responsible for writing this sucker.
 java.lang.String toString()
          get a string representation of the record (for biffview/debugging)
 
Methods inherited from class org.apache.poi.hssf.record.SubRecord
createSubRecord
 
Methods inherited from class org.apache.poi.hssf.record.Record
clone, cloneViaReserialise, serialize
 
Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

sid

public static final short sid
See Also:
Constant Field Values
Constructor Detail

EmbeddedObjectRefSubRecord

public EmbeddedObjectRefSubRecord(RecordInputStream in)
Method Detail

getSid

public short getSid()
Description copied from class: Record
return the non static version of the id for this record.

Specified by:
getSid in class Record

serialize

public int serialize(int base,
                     byte[] data)
Description copied from class: RecordBase
called by the class that is responsible for writing this sucker. Subclasses should implement this so that their data is passed back in a byte array.

Specified by:
serialize in class RecordBase
Parameters:
base - to begin writing at
data - byte array containing instance data
Returns:
number of bytes written

getRecordSize

public int getRecordSize()
Description copied from class: Record
gives the current serialized size of the record. Should include the sid and reclength (4 bytes).

Overrides:
getRecordSize in class Record

getStreamId

public java.lang.Integer getStreamId()
Gets the stream ID containing the actual data. The data itself can be found under a top-level directory entry in the OLE2 filesystem under the name "MBDxxxxxxxx" where xxxxxxxx is this ID converted into hex (in big endian order, funnily enough.)

Returns:
the data stream ID. Possibly null

getOLEClassName

public java.lang.String getOLEClassName()

getObjectData

public byte[] getObjectData()

toString

public java.lang.String toString()
Description copied from class: Record
get a string representation of the record (for biffview/debugging)

Overrides:
toString in class Record


Copyright 2008 The Apache Software Foundation or its licensors, as applicable.