org.apache.poi.hssf.record
Class Record
java.lang.Object
org.apache.poi.hssf.record.RecordBase
org.apache.poi.hssf.record.Record
- Direct Known Subclasses:
- AbstractEscherHolderRecord, AreaFormatRecord, AreaRecord, AxisLineFormatRecord, AxisOptionsRecord, AxisParentRecord, AxisRecord, AxisUsedRecord, BackupRecord, BarRecord, BeginRecord, BlankRecord, BOFRecord, BookBoolRecord, BoolErrRecord, BottomMarginRecord, BoundSheetRecord, CalcCountRecord, CalcModeRecord, CategorySeriesAxisRecord, CFHeaderRecord, CFRuleRecord, ChartFormatRecord, ChartRecord, ChartTitleFormatRecord, CodepageRecord, ColumnInfoRecord, ContinueRecord, CountryRecord, CRNCountRecord, CRNRecord, DataFormatRecord, DateWindow1904Record, DatRecord, DBCellRecord, DefaultColWidthRecord, DefaultDataLabelTextPropertiesRecord, DefaultRowHeightRecord, DeltaRecord, DimensionsRecord, DrawingRecord, DSFRecord, DVALRecord, DVRecord, EndRecord, EOFRecord, ExtendedFormatRecord, ExternalNameRecord, ExternSheetRecord, ExtSSTInfoSubRecord, ExtSSTRecord, FilePassRecord, FileSharingRecord, FnGroupCountRecord, FontBasisRecord, FontIndexRecord, FontRecord, FooterRecord, FormatRecord, FormulaRecord, FrameRecord, GridsetRecord, GutsRecord, HCenterRecord, HeaderRecord, HideObjRecord, HyperlinkRecord, IndexRecord, InterfaceEndRecord, InterfaceHdrRecord, IterationRecord, LabelRecord, LabelSSTRecord, LastCellOfRowDummyRecord, LeftMarginRecord, LegendRecord, LineFormatRecord, LinkedDataRecord, MergeCellsRecord, MissingCellDummyRecord, MissingRowDummyRecord, MMSRecord, MulBlankRecord, MulRKRecord, NameRecord, NoteRecord, NumberFormatIndexRecord, NumberRecord, ObjectLinkRecord, ObjectProtectRecord, ObjRecord, PageBreakRecord, PaletteRecord, PaneRecord, PasswordRecord, PasswordRev4Record, PlotAreaRecord, PlotGrowthRecord, PrecisionRecord, PrintGridlinesRecord, PrintHeadersRecord, PrintSetupRecord, ProtectionRev4Record, ProtectRecord, RecalcIdRecord, RefModeRecord, RefreshAllRecord, RightMarginRecord, RKRecord, RowRecord, SaveRecalcRecord, ScenarioProtectRecord, SCLRecord, SelectionRecord, SeriesChartGroupIndexRecord, SeriesIndexRecord, SeriesLabelsRecord, SeriesListRecord, SeriesRecord, SeriesTextRecord, SeriesToChartGroupRecord, SharedValueRecordBase, SheetPropertiesRecord, SSTRecord, StringRecord, StyleRecord, SubRecord, SupBookRecord, TabIdRecord, TextObjectRecord, TextRecord, TickRecord, TopMarginRecord, UncalcedRecord, UnitsRecord, UnknownRecord, UseSelFSRecord, ValueRangeRecord, VCenterRecord, WindowOneRecord, WindowProtectRecord, WindowTwoRecord, WriteAccessRecord, WriteProtectRecord, WSBoolRecord
public abstract class Record
- extends RecordBase
Title: Record
Description: All HSSF Records inherit from this class. It
populates the fields common to all records (id, size and data).
Subclasses should be sure to validate the id,
Company:
- Version:
- 2.0-pre
- Author:
- Andrew C. Oliver, Marc Johnson (mjohnson at apache dot org), Jason Height (jheight at chariot dot net dot au)
Constructor Summary |
protected |
Record()
instantiates a blank record strictly for ID matching |
Method Summary |
java.lang.Object |
clone()
|
Record |
cloneViaReserialise()
Clone the current record, via a call to serialise
it, and another to create a new record from the
bytes. |
int |
getRecordSize()
gives the current serialized size of the record. |
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. |
java.lang.String |
toString()
get a string representation of the record (for biffview/debugging) |
Methods inherited from class java.lang.Object |
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Record
protected Record()
- instantiates a blank record strictly for ID matching
serialize
public 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
getRecordSize
public int getRecordSize()
- gives the current serialized size of the record. Should include the sid and reclength (4 bytes).
- Specified by:
getRecordSize
in class RecordBase
toString
public java.lang.String toString()
- get a string representation of the record (for biffview/debugging)
- Overrides:
toString
in class java.lang.Object
getSid
public abstract short getSid()
- return the non static version of the id for this record.
clone
public java.lang.Object clone()
- Overrides:
clone
in class java.lang.Object
cloneViaReserialise
public Record cloneViaReserialise()
- Clone the current record, via a call to serialise
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 record-aware serialise is needed, which
allocates new ids / counts as needed.
Copyright 2008 The Apache Software Foundation or
its licensors, as applicable.