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
public abstract class RecordAggregate extends RecordBase
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.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
RecordAggregate.PositionTrackingVisitor
A wrapper forRecordAggregate.RecordVisitor
which accumulates the sizes of all records visited.static interface
RecordAggregate.RecordVisitor
-
Constructor Summary
Constructors Constructor Description RecordAggregate()
-
Method Summary
All Methods Instance Methods Abstract Methods Concrete Methods Modifier and Type Method Description int
getRecordSize()
gives the current serialized size of the record.int
serialize(int offset, byte[] data)
called by the class that is responsible for writing this sucker.abstract void
visitContainedRecords(RecordAggregate.RecordVisitor rv)
Visit each of the atomic BIFF records contained in thisRecordAggregate
in the order that they should be written to file.
-
-
-
Method Detail
-
visitContainedRecords
public abstract void visitContainedRecords(RecordAggregate.RecordVisitor rv)
Visit each of the atomic BIFF records contained in thisRecordAggregate
in the order that they should be written to file. Implementors may or may not return the actualRecord
s being used to manage POI's internal implementation. Callers should not assume either way, and therefore only attempt to modify thoseRecord
s after cloning
-
serialize
public final int serialize(int offset, byte[] data)
Description copied from class:RecordBase
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.- Specified by:
serialize
in 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:RecordBase
gives the current serialized size of the record. Should include the sid and reclength (4 bytes).- Specified by:
getRecordSize
in classRecordBase
- Returns:
- the record size
-
-