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

java.lang.Object
  org.apache.poi.hssf.record.Record
      org.apache.poi.hssf.record.aggregates.RowRecordsAggregate

public class RowRecordsAggregate

extends Record

Author:

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

Field Summary

Fields inherited from class org.apache.poi.hssf.record.Record

sid

Constructor Summary

RowRecordsAggregate()
Creates a new instance of ValueRecordsAggregate

Method Summary

java.lang.Object	clone() Performs a deep clone of the record
int	construct(int offset, java.util.List records)
protected void	fillFields(byte[] data, short size, int offset) called by the constructor, should set class level fields.
int	getFirstRowNum()
java.util.Iterator	getIterator()
int	getLastRowNum()
int	getPhysicalNumberOfRows()
int	getRecordSize() gives the current serialized size of the record.
RowRecord	getRow(int rownum)
short	getSid() return the non static version of the id for this record.
void	insertRow(RowRecord row)
void	removeRow(RowRecord row)
int	serialize(int offset, byte[] data) called by the class that is responsible for writing this sucker.
protected void	validateSid(short id) called by constructor, should throw runtime exception in the event of a record passed with a differing ID.

Methods inherited from class org.apache.poi.hssf.record.Record

fillFields, isInValueSection, isValue, processContinueRecord, serialize, toString

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, 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 rownum)

getPhysicalNumberOfRows

public int getPhysicalNumberOfRows()

getFirstRowNum

public int getFirstRowNum()

getLastRowNum

public int getLastRowNum()

construct

public int construct(int offset,
                     java.util.List records)

serialize

public int serialize(int offset,
                     byte[] data)

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 class Record

Parameters:

offset - offset to begin writing at

data - byte array containing instance data

Returns:

number of bytes written

fillFields

protected void fillFields(byte[] data,
                          short size,
                          int offset)

called by the constructor, should set class level fields. Should throw runtime exception for bad/icomplete data.

Specified by:

fillFields in class Record

Parameters:

data - raw data

size - size of data

offset - of the record's data (provided a big array of the file)

validateSid

protected void validateSid(short id)

called by constructor, should throw runtime exception in the event of a record passed with a differing ID.

Specified by:

validateSid in class Record

Parameters:

id - alleged id for this record

getSid

public short getSid()

return the non static version of the id for this record.

Specified by:

getSid in class Record

getRecordSize

public int getRecordSize()

Description copied from class: Record

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

Overrides:

getRecordSize in class Record

getIterator

public java.util.Iterator getIterator()

clone

public java.lang.Object clone()

Performs a deep clone of the record

Overrides:

clone in class Record