|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.apache.poi.hssf.record.Record
org.apache.poi.hssf.record.AbstractEscherHolderRecord
The escher container record is used to hold escher records. It is abstract and must be subclassed for maximum benefit.
Constructor Summary | |
AbstractEscherHolderRecord()
|
|
AbstractEscherHolderRecord(short id,
short size,
byte[] data)
Constructs a Bar record and sets its fields appropriately. |
|
AbstractEscherHolderRecord(short id,
short size,
byte[] data,
int offset)
Constructs a Bar record and sets its fields appropriately. |
Method Summary | |
boolean |
addEscherRecord(EscherRecord element)
|
void |
addEscherRecord(int index,
EscherRecord element)
|
void |
clearEscherRecords()
|
java.lang.Object |
clone()
|
protected void |
fillFields(byte[] data,
short size,
int offset)
called by the constructor, should set class level fields. |
EscherRecord |
getEscherRecord(int index)
|
java.util.List |
getEscherRecords()
|
protected abstract java.lang.String |
getRecordName()
|
int |
getRecordSize()
Size of record (including 4 byte header) |
abstract short |
getSid()
return the non static version of the id for this record. |
int |
serialize(int offset,
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) |
protected void |
validateSid(short id)
Checks the sid matches the expected side for this record |
Methods inherited from class org.apache.poi.hssf.record.Record |
fillFields, isInValueSection, isValue, processContinueRecord, serialize |
Methods inherited from class java.lang.Object |
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Constructor Detail |
public AbstractEscherHolderRecord()
public AbstractEscherHolderRecord(short id, short size, byte[] data)
id
- id must be 0x1017 or an exception
will be throw upon validationsize
- size the size of the data area of the recorddata
- data of the record (should not contain sid/len)public AbstractEscherHolderRecord(short id, short size, byte[] data, int offset)
id
- id must be 0x1017 or an exception
will be throw upon validationsize
- size the size of the data area of the recorddata
- data of the record (should not contain sid/len)offset
- of the record's dataMethod Detail |
protected void validateSid(short id)
validateSid
in class Record
id
- the expected sid.protected void fillFields(byte[] data, short size, int offset)
Record
fillFields
in class Record
data
- raw datasize
- size of dataoffset
- of the record's data (provided a big array of the file)public java.lang.String toString()
Record
toString
in class Record
protected abstract java.lang.String getRecordName()
public int serialize(int offset, byte[] data)
Record
serialize
in class Record
offset
- to begin writing atdata
- byte array containing instance data
public int getRecordSize()
getRecordSize
in class Record
public abstract short getSid()
Record
getSid
in class Record
public java.lang.Object clone()
clone
in class Record
public void addEscherRecord(int index, EscherRecord element)
public boolean addEscherRecord(EscherRecord element)
public java.util.List getEscherRecords()
public void clearEscherRecords()
public EscherRecord getEscherRecord(int index)
|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |