Top Description Constructors Methods
org.apache.poi.hssf.record

public abstract Class StandardRecord

extends Record
Class Inheritance
Known Direct Subclasses
org.apache.poi.hssf.record.StyleRecord, org.apache.poi.hssf.record.SupBookRecord, org.apache.poi.hssf.record.TableStylesRecord, org.apache.poi.hssf.record.TopMarginRecord, org.apache.poi.hssf.record.UncalcedRecord, org.apache.poi.hssf.record.UnknownRecord, org.apache.poi.hssf.record.UserSViewBegin, org.apache.poi.hssf.record.UserSViewEnd, org.apache.poi.hssf.record.UseSelFSRecord, org.apache.poi.hssf.record.VCenterRecord, org.apache.poi.hssf.record.WindowOneRecord, org.apache.poi.hssf.record.WindowProtectRecord, org.apache.poi.hssf.record.WindowTwoRecord, org.apache.poi.hssf.record.WriteAccessRecord, org.apache.poi.hssf.record.WriteProtectRecord, org.apache.poi.hssf.record.WSBoolRecord, org.apache.poi.hssf.record.chart.ChartRecord, org.apache.poi.hssf.record.chart.AreaFormatRecord, org.apache.poi.hssf.record.chart.AreaRecord, org.apache.poi.hssf.record.chart.AxisLineFormatRecord, org.apache.poi.hssf.record.chart.AxisOptionsRecord, org.apache.poi.hssf.record.chart.AxisParentRecord, org.apache.poi.hssf.record.chart.AxisRecord, org.apache.poi.hssf.record.chart.AxisUsedRecord, org.apache.poi.hssf.record.chart.BarRecord, org.apache.poi.hssf.record.chart.BeginRecord, org.apache.poi.hssf.record.chart.CategorySeriesAxisRecord, org.apache.poi.hssf.record.chart.CatLabRecord, org.apache.poi.hssf.record.chart.ChartEndBlockRecord, org.apache.poi.hssf.record.chart.ChartEndObjectRecord, org.apache.poi.hssf.record.chart.ChartFormatRecord, org.apache.poi.hssf.record.chart.ChartFRTInfoRecord, org.apache.poi.hssf.record.chart.ChartStartBlockRecord, org.apache.poi.hssf.record.chart.ChartStartObjectRecord, org.apache.poi.hssf.record.chart.ChartTitleFormatRecord, org.apache.poi.hssf.record.chart.DataFormatRecord, org.apache.poi.hssf.record.chart.DataLabelExtensionRecord, org.apache.poi.hssf.record.chart.DatRecord, org.apache.poi.hssf.record.chart.DefaultDataLabelTextPropertiesRecord, org.apache.poi.hssf.record.chart.EndRecord, org.apache.poi.hssf.record.chart.FontBasisRecord, org.apache.poi.hssf.record.chart.FontIndexRecord, org.apache.poi.hssf.record.chart.FrameRecord, org.apache.poi.hssf.record.chart.LegendRecord, org.apache.poi.hssf.record.chart.LineFormatRecord, org.apache.poi.hssf.record.chart.LinkedDataRecord, org.apache.poi.hssf.record.chart.NumberFormatIndexRecord, org.apache.poi.hssf.record.chart.ObjectLinkRecord, org.apache.poi.hssf.record.chart.PlotAreaRecord, org.apache.poi.hssf.record.chart.PlotGrowthRecord, org.apache.poi.hssf.record.chart.SeriesChartGroupIndexRecord, org.apache.poi.hssf.record.chart.SeriesIndexRecord, org.apache.poi.hssf.record.chart.SeriesLabelsRecord, org.apache.poi.hssf.record.chart.SeriesListRecord, org.apache.poi.hssf.record.chart.SeriesRecord, org.apache.poi.hssf.record.chart.SeriesTextRecord, org.apache.poi.hssf.record.chart.SheetPropertiesRecord, org.apache.poi.hssf.record.chart.TextRecord, org.apache.poi.hssf.record.chart.TickRecord, org.apache.poi.hssf.record.chart.UnitsRecord, org.apache.poi.hssf.record.chart.ValueRangeRecord, org.apache.poi.hssf.record.pivottable.DataItemRecord, org.apache.poi.hssf.record.pivottable.ExtendedPivotTableViewFieldsRecord, org.apache.poi.hssf.record.pivottable.PageItemRecord, org.apache.poi.hssf.record.pivottable.StreamIDRecord, org.apache.poi.hssf.record.pivottable.ViewDefinitionRecord, org.apache.poi.hssf.record.pivottable.ViewFieldsRecord, org.apache.poi.hssf.record.pivottable.ViewSourceRecord, org.apache.poi.hssf.record.AutoFilterInfoRecord, org.apache.poi.hssf.record.BackupRecord, org.apache.poi.hssf.record.BlankRecord, org.apache.poi.hssf.record.BOFRecord, org.apache.poi.hssf.record.BookBoolRecord, org.apache.poi.hssf.record.BottomMarginRecord, org.apache.poi.hssf.record.BoundSheetRecord, org.apache.poi.hssf.record.CalcCountRecord, org.apache.poi.hssf.record.CalcModeRecord, org.apache.poi.hssf.record.CellRecord, org.apache.poi.hssf.record.CFRuleBase, org.apache.poi.hssf.record.CodepageRecord, org.apache.poi.hssf.record.ColumnInfoRecord, org.apache.poi.hssf.record.ContinueRecord, org.apache.poi.hssf.record.CountryRecord, org.apache.poi.hssf.record.CRNCountRecord, org.apache.poi.hssf.record.CRNRecord, org.apache.poi.hssf.record.DateWindow1904Record, org.apache.poi.hssf.record.DBCellRecord, org.apache.poi.hssf.record.DConRefRecord, org.apache.poi.hssf.record.DefaultColWidthRecord, org.apache.poi.hssf.record.DefaultRowHeightRecord, org.apache.poi.hssf.record.DimensionsRecord, org.apache.poi.hssf.record.DrawingRecord, org.apache.poi.hssf.record.DrawingSelectionRecord, org.apache.poi.hssf.record.DSFRecord, org.apache.poi.hssf.record.DVALRecord, org.apache.poi.hssf.record.DVRecord, org.apache.poi.hssf.record.EOFRecord, org.apache.poi.hssf.record.ExtendedFormatRecord, org.apache.poi.hssf.record.ExternalNameRecord, org.apache.poi.hssf.record.ExternSheetRecord, org.apache.poi.hssf.record.FeatRecord, org.apache.poi.hssf.record.FilePassRecord, org.apache.poi.hssf.record.FileSharingRecord, org.apache.poi.hssf.record.FnGroupCountRecord, org.apache.poi.hssf.record.FontRecord, org.apache.poi.hssf.record.FormatRecord, org.apache.poi.hssf.record.GridsetRecord, org.apache.poi.hssf.record.GutsRecord, org.apache.poi.hssf.record.HCenterRecord, org.apache.poi.hssf.record.CFHeaderBase, org.apache.poi.hssf.record.DeltaRecord, org.apache.poi.hssf.record.FeatHdrRecord, org.apache.poi.hssf.record.HeaderFooterBase, org.apache.poi.hssf.record.MMSRecord, org.apache.poi.hssf.record.PaneRecord, org.apache.poi.hssf.record.RightMarginRecord, org.apache.poi.hssf.record.TabIdRecord, org.apache.poi.hssf.record.HeaderFooterRecord, org.apache.poi.hssf.record.HideObjRecord, org.apache.poi.hssf.record.HyperlinkRecord, org.apache.poi.hssf.record.IndexRecord, org.apache.poi.hssf.record.InterfaceEndRecord, org.apache.poi.hssf.record.InterfaceHdrRecord, org.apache.poi.hssf.record.IterationRecord, org.apache.poi.hssf.record.LeftMarginRecord, org.apache.poi.hssf.record.MergeCellsRecord, org.apache.poi.hssf.record.MulBlankRecord, org.apache.poi.hssf.record.MulRKRecord, org.apache.poi.hssf.record.NameCommentRecord, org.apache.poi.hssf.record.NoteRecord, org.apache.poi.hssf.record.ObjectProtectRecord, org.apache.poi.hssf.record.PageBreakRecord, org.apache.poi.hssf.record.PaletteRecord, org.apache.poi.hssf.record.PasswordRecord, org.apache.poi.hssf.record.PasswordRev4Record, org.apache.poi.hssf.record.PrecisionRecord, org.apache.poi.hssf.record.PrintGridlinesRecord, org.apache.poi.hssf.record.PrintHeadersRecord, org.apache.poi.hssf.record.PrintSetupRecord, org.apache.poi.hssf.record.ProtectionRev4Record, org.apache.poi.hssf.record.ProtectRecord, org.apache.poi.hssf.record.RecalcIdRecord, org.apache.poi.hssf.record.RefModeRecord, org.apache.poi.hssf.record.RefreshAllRecord, org.apache.poi.hssf.record.RowRecord, org.apache.poi.hssf.record.SaveRecalcRecord, org.apache.poi.hssf.record.ScenarioProtectRecord, org.apache.poi.hssf.record.SCLRecord, org.apache.poi.hssf.record.SelectionRecord, org.apache.poi.hssf.record.SharedValueRecordBase
Imports
java.io.IOException, org.apache.poi.util.LittleEndianByteArrayOutputStream, .LittleEndianOutput

Subclasses of this class (the majority of BIFF records) are non-continuable. This allows for some simplification of serialization logic

Constructor Summary

AccessConstructor and Description
protected
protected

Method Summary

Modifier and TypeMethod and Description
public abstract StandardRecord
protected abstract int
public final int
getRecordSize()

Implements abstract org.apache.poi.hssf.record.RecordBase.getRecordSize.

gives the current serialized size of the record.

public final int
serialize(int
to begin writing at
offset
,
byte[]
byte array containing instance data
data
)

Implements abstract org.apache.poi.hssf.record.RecordBase.serialize.

Write the data content of this BIFF record including the sid and record length.

protected abstract void
serialize(LittleEndianOutput
the output object
out
)

Write the data content of this BIFF record.

Inherited from org.apache.poi.hssf.record.Record:
cloneViaReserialisegetGenericRecordTypegetSidserializetoString

Constructor Detail

StandardRecordback to summary
protected StandardRecord()
StandardRecordback to summary
protected StandardRecord(StandardRecord other)

Method Detail

copyback to summary
public abstract StandardRecord copy()

Redeclares org.apache.poi.common.Duplicatable.copy.

Implements abstract org.apache.poi.hssf.record.Record.copy.

Returns:StandardRecord

Doc from org.apache.poi.common.Duplicatable.copy.

a deep copy of the implementing class / instance

getDataSizeback to summary
protected abstract int getDataSize()
getRecordSizeback to summary
public final int getRecordSize()

Implements abstract org.apache.poi.hssf.record.RecordBase.getRecordSize.

Doc from org.apache.poi.hssf.record.RecordBase.getRecordSize.

gives the current serialized size of the record. Should include the sid and reclength (4 bytes).

Returns:int

the record size

Annotations
@Override
serializeback to summary
public final int serialize(int offset, byte[] data)

Implements abstract org.apache.poi.hssf.record.RecordBase.serialize.

Write the data content of this BIFF record including the sid and record length.

The subclass must write the exact number of bytes as reported by org.apache.poi.hssf.record.Record#getRecordSize()}

Parameters
offset:int

Doc from org.apache.poi.hssf.record.RecordBase.serialize.

to begin writing at

data:byte[]

Doc from org.apache.poi.hssf.record.RecordBase.serialize.

byte array containing instance data

Returns:int

Doc from org.apache.poi.hssf.record.RecordBase.serialize.

number of bytes written

Annotations
@Override
serializeback to summary
protected abstract void serialize(LittleEndianOutput out)

Write the data content of this BIFF record. The 'ushort sid' and 'ushort size' header fields have already been written by the superclass.

The number of bytes written must equal the record size reported by org.apache.poi.hssf.record.Record#getRecordSize()} minus four ( record header consisting of a 'ushort sid' and 'ushort reclength' has already been written by their superclass).

Parameters
out:LittleEndianOutput

the output object