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

java.lang.Object
  |
  +--org.apache.poi.hssf.record.Record
        |
        +--org.apache.poi.hssf.record.aggregates.ValueRecordsAggregate

public class ValueRecordsAggregate

extends Record

Aggregate value records together. Things are easier to handle that way.

Author:

andy, Glen Stampoultzis (glens at apache.org)

Field Summary

static short

sid

Constructor Summary

ValueRecordsAggregate()
Creates a new instance of ValueRecordsAggregate

Method Summary

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	getFirstCellNum()
java.util.Iterator	getIterator()
int	getLastCellNum()
int	getPhysicalNumberOfCells()
int	getRecordSize() gives the current serialized size of the record.
short	getSid() return the non static version of the id for this record.
void	insertCell(CellValueRecordInterface cell)
void	removeCell(CellValueRecordInterface cell)
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

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

Field Detail

sid

public static final short sid

Constructor Detail

ValueRecordsAggregate

public ValueRecordsAggregate()

Creates a new instance of ValueRecordsAggregate

Method Detail

insertCell

public void insertCell(CellValueRecordInterface cell)

removeCell

public void removeCell(CellValueRecordInterface cell)

getPhysicalNumberOfCells

public int getPhysicalNumberOfCells()

getFirstCellNum

public int getFirstCellNum()

getLastCellNum

public int getLastCellNum()

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.

Overrides:

serialize in class Record

Parameters:

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.

Overrides:

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.

Overrides:

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.

Overrides:

getSid in class Record

getRecordSize

public int getRecordSize()

Description copied from class: Record

gives the current serialized size of the record.

Overrides:

getRecordSize in class Record

getIterator

public java.util.Iterator getIterator()