| java.lang.Object org.apache.poi.hssf.record.Record
All known Subclasses: org.apache.poi.hssf.record.TextRecord, org.apache.poi.hssf.record.DateWindow1904Record, org.apache.poi.hssf.record.NumberRecord, org.apache.poi.hssf.record.ExtSSTInfoSubRecord, org.apache.poi.hssf.record.StyleRecord, org.apache.poi.hssf.record.SeriesListRecord, org.apache.poi.hssf.record.CategorySeriesAxisRecord, org.apache.poi.hssf.record.SeriesRecord, org.apache.poi.hssf.record.ChartRecord, org.apache.poi.hssf.record.PasswordRev4Record, org.apache.poi.hssf.record.DefaultRowHeightRecord, org.apache.poi.hssf.record.SeriesTextRecord, org.apache.poi.hssf.record.SaveRecalcRecord, org.apache.poi.hssf.record.FilePassRecord, org.apache.poi.hssf.record.LegendRecord, org.apache.poi.hssf.record.FontRecord, org.apache.poi.hssf.record.CountryRecord, org.apache.poi.hssf.record.RightMarginRecord, org.apache.poi.hssf.record.AreaFormatRecord, org.apache.poi.hssf.record.PrintSetupRecord, org.apache.poi.hssf.eventusermodel.dummyrecord.MissingCellDummyRecord, org.apache.poi.hssf.record.DBCellRecord, org.apache.poi.hssf.record.FnGroupCountRecord, org.apache.poi.hssf.record.UnknownRecord, org.apache.poi.hssf.record.DeltaRecord, org.apache.poi.hssf.record.TextObjectBaseRecord, org.apache.poi.hssf.record.SSTRecord, org.apache.poi.hssf.record.SeriesIndexRecord, org.apache.poi.hssf.record.DataFormatRecord, org.apache.poi.hssf.record.RefModeRecord, org.apache.poi.hssf.record.MulBlankRecord, org.apache.poi.hssf.record.PrintHeadersRecord, org.apache.poi.hssf.record.CalcCountRecord, org.apache.poi.hssf.record.ChartFormatRecord, org.apache.poi.hssf.record.StringRecord, org.apache.poi.hssf.record.ProtectRecord, org.apache.poi.hssf.record.RKRecord, org.apache.poi.hssf.record.HeaderRecord, org.apache.poi.hssf.record.aggregates.ColumnInfoRecordsAggregate, org.apache.poi.hssf.record.SubRecord, org.apache.poi.hssf.record.ExternSheetRecord, org.apache.poi.hssf.record.AxisRecord, org.apache.poi.hssf.record.IterationRecord, org.apache.poi.hssf.record.HCenterRecord, org.apache.poi.hssf.record.MMSRecord, org.apache.poi.hssf.record.ProtectionRev4Record, org.apache.poi.hssf.record.EndRecord, org.apache.poi.hssf.record.BoolErrRecord, org.apache.poi.hssf.record.MergeCellsRecord, org.apache.poi.hssf.record.WindowTwoRecord, org.apache.poi.hssf.record.RefreshAllRecord, org.apache.poi.hssf.record.EOFRecord, org.apache.poi.hssf.record.DimensionsRecord, org.apache.poi.hssf.record.ObjRecord, org.apache.poi.hssf.record.CalcModeRecord, org.apache.poi.hssf.record.SCLRecord, org.apache.poi.hssf.record.InterfaceEndRecord, org.apache.poi.hssf.record.FormulaRecord, org.apache.poi.hssf.record.VCenterRecord, org.apache.poi.hssf.record.RowRecord, org.apache.poi.hssf.record.NumberFormatIndexRecord, org.apache.poi.hssf.record.HideObjRecord, org.apache.poi.hssf.record.DrawingRecord, org.apache.poi.hssf.record.GutsRecord, org.apache.poi.hssf.record.InterfaceHdrRecord, org.apache.poi.hssf.record.TabIdRecord, org.apache.poi.hssf.record.DefaultColWidthRecord, org.apache.poi.hssf.record.RecalcIdRecord, org.apache.poi.hssf.record.ContinueRecord, org.apache.poi.hssf.record.NameRecord, org.apache.poi.hssf.record.WriteAccessRecord, org.apache.poi.hssf.record.ExtSSTRecord, org.apache.poi.hssf.record.LabelRecord, org.apache.poi.hssf.record.ObjectProtectRecord, org.apache.poi.hssf.record.TopMarginRecord, org.apache.poi.hssf.record.BarRecord, org.apache.poi.hssf.record.ChartTitleFormatRecord, org.apache.poi.hssf.record.AreaRecord, org.apache.poi.hssf.record.GridsetRecord, org.apache.poi.hssf.record.AxisLineFormatRecord, org.apache.poi.hssf.record.LeftMarginRecord, org.apache.poi.hssf.record.PlotAreaRecord, org.apache.poi.hssf.record.BOFRecord, org.apache.poi.hssf.record.PaletteRecord, org.apache.poi.hssf.record.AbstractEscherHolderRecord, org.apache.poi.hssf.record.PrintGridlinesRecord, org.apache.poi.hssf.record.PasswordRecord, org.apache.poi.hssf.record.BoundSheetRecord, org.apache.poi.hssf.record.SeriesToChartGroupRecord, org.apache.poi.hssf.record.ObjectLinkRecord, org.apache.poi.hssf.record.DSFRecord, org.apache.poi.hssf.record.FontIndexRecord, org.apache.poi.hssf.record.AxisParentRecord, org.apache.poi.hssf.record.aggregates.RowRecordsAggregate, org.apache.poi.hssf.record.DVRecord, org.apache.poi.hssf.eventusermodel.dummyrecord.MissingRowDummyRecord, org.apache.poi.hssf.record.FormatRecord, org.apache.poi.hssf.record.SharedFormulaRecord, org.apache.poi.hssf.record.UnitsRecord, org.apache.poi.hssf.record.BookBoolRecord, org.apache.poi.hssf.record.FileSharingRecord, org.apache.poi.hssf.record.AxisUsedRecord, org.apache.poi.hssf.record.WSBoolRecord, org.apache.poi.hssf.record.BackupRecord, org.apache.poi.hssf.record.DVALRecord, org.apache.poi.hssf.record.CodepageRecord, org.apache.poi.hssf.record.IndexRecord, org.apache.poi.hssf.record.UseSelFSRecord, org.apache.poi.hssf.record.PageBreakRecord, org.apache.poi.hssf.record.FrameRecord, org.apache.poi.hssf.record.WindowOneRecord, org.apache.poi.hssf.record.ExternSheetSubRecord, org.apache.poi.hssf.record.BlankRecord, org.apache.poi.hssf.record.BottomMarginRecord, org.apache.poi.hssf.record.ExtendedFormatRecord, org.apache.poi.hssf.record.LineFormatRecord, org.apache.poi.hssf.record.BeginRecord, org.apache.poi.hssf.record.FontBasisRecord, org.apache.poi.hssf.record.PlotGrowthRecord, org.apache.poi.hssf.record.PrecisionRecord, org.apache.poi.hssf.record.TickRecord, org.apache.poi.hssf.record.DefaultDataLabelTextPropertiesRecord, org.apache.poi.hssf.record.SelectionRecord, org.apache.poi.hssf.record.WriteProtectRecord, org.apache.poi.hssf.record.SeriesChartGroupIndexRecord, org.apache.poi.hssf.record.SupBookRecord, org.apache.poi.hssf.record.ValueRangeRecord, org.apache.poi.hssf.record.ColumnInfoRecord, org.apache.poi.hssf.record.NoteRecord, org.apache.poi.hssf.record.aggregates.FormulaRecordAggregate, org.apache.poi.hssf.record.WindowProtectRecord, org.apache.poi.hssf.record.LinkedDataRecord, org.apache.poi.hssf.record.MulRKRecord, org.apache.poi.hssf.record.ScenarioProtectRecord, org.apache.poi.hssf.record.DatRecord, org.apache.poi.hssf.record.AxisOptionsRecord, org.apache.poi.hssf.record.PaneRecord, org.apache.poi.hssf.eventusermodel.dummyrecord.LastCellOfRowDummyRecord, org.apache.poi.hssf.record.LabelSSTRecord, org.apache.poi.hssf.record.aggregates.ValueRecordsAggregate, org.apache.poi.hssf.record.FooterRecord, org.apache.poi.hssf.record.SeriesLabelsRecord, org.apache.poi.hssf.record.SheetPropertiesRecord,
Record | abstract public class Record (Code) | | 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:
author: Andrew C. Oliver author: Marc Johnson (mjohnson at apache dot org) author: Jason Height (jheight at chariot dot net dot au) version: 2.0-pre |
Method Summary | |
public Object | clone() | abstract protected void | fillFields(RecordInputStream in) called by the constructor, should set class level fields. | public int | getRecordSize() gives the current serialized size of the record. | abstract public short | getSid() return the non static version of the id for this record. | public boolean | isInValueSection() | public boolean | isValue() | public byte[] | serialize() called by the class that is responsible for writing this sucker. | abstract public int | serialize(int offset, byte[] data) called by the class that is responsible for writing this sucker. | public String | toString() | abstract protected void | validateSid(short id) called by constructor, should throw runtime exception in the event of a
record passed with a differing ID. |
Record | public Record()(Code) | | instantiates a blank record strictly for ID matching
|
Record | public Record(RecordInputStream in)(Code) | | Constructor Record
Parameters: in - the RecordInputstream to read the record from |
fillFields | abstract protected void fillFields(RecordInputStream in)(Code) | | called by the constructor, should set class level fields. Should throw
runtime exception for bad/icomplete data.
Parameters: in - the RecordInputstream to read the record from |
getRecordSize | public int getRecordSize()(Code) | | gives the current serialized size of the record. Should include the sid and reclength (4 bytes).
|
getSid | abstract public short getSid()(Code) | | return the non static version of the id for this record.
|
isInValueSection | public boolean isInValueSection()(Code) | | DBCELL, ROW, VALUES all say yes
|
isValue | public boolean isValue()(Code) | | tells whether this type of record contains a value
|
serialize | public byte[] serialize()(Code) | | 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.
byte array containing instance data |
serialize | abstract public int serialize(int offset, byte[] data)(Code) | | 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.
Parameters: offset - to begin writing at Parameters: data - byte array containing instance data number of bytes written |
toString | public String toString()(Code) | | get a string representation of the record (for biffview/debugging)
|
validateSid | abstract protected void validateSid(short id)(Code) | | called by constructor, should throw runtime exception in the event of a
record passed with a differing ID.
Parameters: id - alleged id for this record |
|
|