org.apache.poi.hssf.record.aggregates
Class RowRecordsAggregate

java.lang.Object
  org.apache.poi.hssf.record.RecordBase
      org.apache.poi.hssf.record.aggregates.RecordAggregate
          org.apache.poi.hssf.record.aggregates.RowRecordsAggregate

public final class RowRecordsAggregate
extends RecordAggregate

Author:

andy, Jason Height (jheight at chariot dot net dot au)

Nested Class Summary

Nested classes/interfaces inherited from class org.apache.poi.hssf.record.aggregates.RecordAggregate

RecordAggregate.RecordVisitor

Constructor Summary

RowRecordsAggregate()
Creates a new instance of ValueRecordsAggregate

Method Summary

void	collapseRow(int rowNumber)
void	constructCellValues(int offset, java.util.List records)
IndexRecord	createIndexRecord(int indexRecordOffset, int sizeOfInitialSheetRecords)
static RowRecord	createRow(int rowNumber) Create a row record.
void	expandRow(int rowNumber)
int	findEndOfRowOutlineGroup(int row)
int	findStartOfRowOutlineGroup(int row)
java.util.Iterator	getAllRecordsIterator()
int	getFirstRowNum()
java.util.Iterator	getIterator()
int	getLastRowNum()
int	getPhysicalNumberOfRows()
RowRecord	getRow(int rowIndex)
int	getRowBlockCount() Returns the number of row blocks.
int	getRowCountForBlock(int block) Returns the number of physical rows within a block
CellValueRecordInterface[]	getValueRecords()
void	insertCell(CellValueRecordInterface cvRec)
void	insertRow(RowRecord row)
boolean	isRowGroupCollapsed(int row)
boolean	isRowGroupHiddenByParent(int row)
void	removeCell(CellValueRecordInterface cvRec)
void	removeRow(RowRecord row)
void	visitContainedRecords(RecordAggregate.RecordVisitor rv)
int	writeHidden(RowRecord rowRecord, int row, boolean hidden)

Methods inherited from class org.apache.poi.hssf.record.aggregates.RecordAggregate

fillFields, getRecordSize, getSid, serialize, validateSid

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

RowRecordsAggregate

public RowRecordsAggregate()

Creates a new instance of ValueRecordsAggregate

Method Detail

insertRow

public void insertRow(RowRecord row)

removeRow

public void removeRow(RowRecord row)

getRow

public RowRecord getRow(int rowIndex)

getPhysicalNumberOfRows

public int getPhysicalNumberOfRows()

getFirstRowNum

public int getFirstRowNum()

getLastRowNum

public int getLastRowNum()

getRowBlockCount

public int getRowBlockCount()

Returns the number of row blocks.

The row blocks are goupings of rows that contain the DBCell record after them

getRowCountForBlock

public int getRowCountForBlock(int block)

Returns the number of physical rows within a block

visitContainedRecords

public void visitContainedRecords(RecordAggregate.RecordVisitor rv)

Specified by:

visitContainedRecords in class RecordAggregate

getIterator

public java.util.Iterator getIterator()

getAllRecordsIterator

public java.util.Iterator getAllRecordsIterator()

findStartOfRowOutlineGroup

public int findStartOfRowOutlineGroup(int row)

findEndOfRowOutlineGroup

public int findEndOfRowOutlineGroup(int row)

writeHidden

public int writeHidden(RowRecord rowRecord,
                       int row,
                       boolean hidden)

collapseRow

public void collapseRow(int rowNumber)

createRow

public static RowRecord createRow(int rowNumber)

Create a row record.

Parameters:

row - number

Returns:

RowRecord created for the passed in row number

See Also:

RowRecord

isRowGroupCollapsed

public boolean isRowGroupCollapsed(int row)

expandRow

public void expandRow(int rowNumber)

isRowGroupHiddenByParent

public boolean isRowGroupHiddenByParent(int row)

getValueRecords

public CellValueRecordInterface[] getValueRecords()

createIndexRecord

public IndexRecord createIndexRecord(int indexRecordOffset,
                                     int sizeOfInitialSheetRecords)

constructCellValues

public void constructCellValues(int offset,
                                java.util.List records)

insertCell

public void insertCell(CellValueRecordInterface cvRec)

removeCell

public void removeCell(CellValueRecordInterface cvRec)