|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.apache.poi.ddf.EscherRecord
public abstract class EscherRecord
The base abstract record from which all escher records are defined. Subclasses will need to define methods for serialization/deserialization and for determining the record size.
Constructor Summary | |
---|---|
EscherRecord()
Create a new instance |
Method Summary | |
---|---|
java.lang.Object |
clone()
Escher records may need to be clonable in the future. |
void |
display(java.io.PrintWriter w,
int indent)
The display methods allows escher variables to print the record names according to their hierarchy. |
abstract int |
fillFields(byte[] data,
int offset,
EscherRecordFactory recordFactory)
The contract of this method is to deserialize an escher record including it's children. |
EscherRecord |
getChild(int index)
Returns the indexed child record. |
java.util.List |
getChildRecords()
|
short |
getInstance()
Returns the instance part of the option record. |
short |
getOptions()
options is an internal field. |
short |
getRecordId()
Return the current record id. |
abstract java.lang.String |
getRecordName()
Subclasses should return the short name for this escher record. |
abstract int |
getRecordSize()
Subclasses should effeciently return the number of bytes required to serialize the record. |
short |
getVersion()
Returns the version part of the option record. |
boolean |
isContainerRecord()
Determine whether this is a container record by inspecting the option field. |
byte[] |
serialize()
Serializes to a new byte array. |
int |
serialize(int offset,
byte[] data)
Serializes to an existing byte array without serialization listener. |
abstract int |
serialize(int offset,
byte[] data,
EscherSerializationListener listener)
Serializes the record to an existing byte array. |
void |
setChildRecords(java.util.List childRecords)
Sets the child records for this record. |
void |
setInstance(short value)
Sets the instance part of record |
void |
setOptions(short options)
Set the options this this record. |
void |
setRecordId(short recordId)
Sets the record id for this record. |
void |
setVersion(short value)
Sets the version part of record |
Methods inherited from class java.lang.Object |
---|
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public EscherRecord()
Method Detail |
---|
public abstract int fillFields(byte[] data, int offset, EscherRecordFactory recordFactory)
data
- The byte array containing the serialized escher
records.offset
- The offset into the byte array.recordFactory
- A factory for creating new escher records.
public boolean isContainerRecord()
public short getOptions()
options is an internal field. Use setInstance(short)
()} and
setVersion(short)
()} to set the actual fields.
public void setOptions(short options)
options is an internal field. Use getInstance()
and
getVersion()
to access actual fields.
public byte[] serialize()
serialize(int, byte[])
public int serialize(int offset, byte[] data)
offset
- the offset within the data byte array.data
- the data array to serialize to.
serialize(int, byte[], org.apache.poi.ddf.EscherSerializationListener)
public abstract int serialize(int offset, byte[] data, EscherSerializationListener listener)
offset
- the offset within the byte arraydata
- the data array to serialize tolistener
- a listener for begin and end serialization events. This
is useful because the serialization is
hierarchical/recursive and sometimes you need to be able
break into that.
public abstract int getRecordSize()
public short getRecordId()
public void setRecordId(short recordId)
public java.util.List getChildRecords()
EscherContainerRecord
public void setChildRecords(java.util.List childRecords)
childRecords
- Not used in base implementation.public java.lang.Object clone()
clone
in class java.lang.Object
public EscherRecord getChild(int index)
public void display(java.io.PrintWriter w, int indent)
w
- The print writer to output to.indent
- The current indent level.public abstract java.lang.String getRecordName()
public short getInstance()
public void setInstance(short value)
value
- instance part valuepublic short getVersion()
public void setVersion(short value)
value
- version part value
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |