Package org.apache.poi.hssf.record

Class Record

java.lang.Object

org.apache.poi.hssf.record.RecordBase

org.apache.poi.hssf.record.Record

All Implemented Interfaces:

Duplicatable, GenericRecord

Direct Known Subclasses:

AbstractEscherHolderRecord, ContinuableRecord, LabelRecord, LastCellOfRowDummyRecord, MissingCellDummyRecord, MissingRowDummyRecord, ObjRecord, StandardRecord

public abstract class Record
extends RecordBase
implements Duplicatable, GenericRecord

All HSSF Records inherit from this class.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	Record()
protected	Record(Record other)

Method Summary

Modifier and Type	Method	Description
Record	cloneViaReserialise()	Clone the current record, via a call to serialize it, and another to create a new record from the bytes.
abstract Record	copy()
abstract HSSFRecordTypes	getGenericRecordType()
abstract short	getSid()	return the non static version of the id for this record.
byte[]	serialize()	called by the class that is responsible for writing this sucker.
String	toString()	get a string representation of the record (for biffview/debugging)

Methods inherited from class org.apache.poi.hssf.record.RecordBase

getRecordSize, serialize

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.apache.poi.common.usermodel.GenericRecord

getGenericChildren, getGenericProperties

Constructor Detail

Record

protected Record()

Record

protected Record(Record other)

Method Detail

serialize

public final byte[] serialize()

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.

Returns:

byte array containing instance data

toString

public final String toString()

get a string representation of the record (for biffview/debugging)

Overrides:

toString in class Object

getSid

public abstract short getSid()

return the non static version of the id for this record.

Returns:

he id for this record

cloneViaReserialise

public Record cloneViaReserialise()

Clone the current record, via a call to serialize it, and another to create a new record from the bytes. May only be used for classes which don't have internal counts / ids in them. For those which do, a full model-aware cloning is needed, which allocates new ids / counts as needed.

Returns:

the cloned current record

copy

public abstract Record copy()

Specified by:

copy in interface Duplicatable

Returns:

a deep copy of the implementing class / instance

getGenericRecordType

public abstract HSSFRecordTypes getGenericRecordType()

Specified by:

getGenericRecordType in interface GenericRecord