org.apache.poi.hssf.record
Class SubRecord

java.lang.Object
  extended by org.apache.poi.hssf.record.SubRecord
Direct Known Subclasses:
CommonObjectDataSubRecord, EmbeddedObjectRefSubRecord, EndSubRecord, FtCblsSubRecord, GroupMarkerSubRecord, LbsDataSubRecord, NoteStructureSubRecord

public abstract class SubRecord
extends java.lang.Object

Subrecords are part of the OBJ class.


Method Summary
abstract  java.lang.Object clone()
           
static SubRecord createSubRecord(LittleEndianInput in, int cmoOt)
          read a sub-record from the supplied stream
 boolean isTerminating()
          Wether this record terminates the sub-record stream.
 byte[] serialize()
           
abstract  void serialize(LittleEndianOutput out)
           
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Method Detail

createSubRecord

public static SubRecord createSubRecord(LittleEndianInput in,
                                        int cmoOt)
read a sub-record from the supplied stream

Parameters:
in - the stream to read from
cmoOt - the objectType field of the containing CommonObjectDataSubRecord, we need it to propagate to next sub-records as it defines what data follows
Returns:
the created sub-record

serialize

public byte[] serialize()

serialize

public abstract void serialize(LittleEndianOutput out)

clone

public abstract java.lang.Object clone()
Overrides:
clone in class java.lang.Object

isTerminating

public boolean isTerminating()
Wether this record terminates the sub-record stream. There are two cases when this method must be overridden and return true - EndSubRecord (sid = 0x00) - LbsDataSubRecord (sid = 0x12)

Returns:
whether this record is the last in the sub-record stream