Class RecordAggregate
java.lang.Object
org.apache.poi.hssf.record.RecordBase
org.apache.poi.hssf.record.aggregates.RecordAggregate
- Direct Known Subclasses:
CFRecordsAggregate,ChartSubstreamRecordAggregate,ColumnInfoRecordsAggregate,ConditionalFormattingTable,CustomViewSettingsRecordAggregate,DataValidityTable,FormulaRecordAggregate,MergedCellsTable,PageSettingsBlock,RowRecordsAggregate,WorksheetProtectionBlock
RecordAggregates are groups of of BIFF Records that are typically stored
together and/or updated together. Workbook / Sheet records are typically stored in a sequential
list, which does not provide much structure to coordinate updates.
- Author:
- Josh Micich
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic final classA wrapper forRecordAggregate.RecordVisitorwhich accumulates the sizes of all records visited.static interface -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionintgives the current serialized size of the record.final intserialize(int offset, byte[] data) called by the class that is responsible for writing this sucker.abstract voidVisit each of the atomic BIFF records contained in thisRecordAggregatein the order that they should be written to file.
-
Constructor Details
-
RecordAggregate
public RecordAggregate()
-
-
Method Details
-
visitContainedRecords
Visit each of the atomic BIFF records contained in thisRecordAggregatein the order that they should be written to file. Implementors may or may not return the actualRecords being used to manage POI's internal implementation. Callers should not assume either way, and therefore only attempt to modify thoseRecords after cloning -
serialize
public final int serialize(int offset, byte[] data) Description copied from class:RecordBasecalled 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.- Specified by:
serializein classRecordBase- Parameters:
offset- to begin writing atdata- byte array containing instance data- Returns:
- number of bytes written
-
getRecordSize
public int getRecordSize()Description copied from class:RecordBasegives the current serialized size of the record. Should include the sid and reclength (4 bytes).- Specified by:
getRecordSizein classRecordBase- Returns:
- the record size
-