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

java.lang.Object
  extended by org.apache.poi.hssf.record.Record
      extended by 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), Jason Height (jheight at chariot dot net dot au)

Nested Class Summary
 class ValueRecordsAggregate.MyIterator
           
 
Field Summary
static short sid
           
 
Constructor Summary
ValueRecordsAggregate()
          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(RecordInputStream in)
          You never fill an aggregate
 int getFirstCellNum()
           
 java.util.Iterator getIterator()
           
 int getLastCellNum()
           
 int getPhysicalNumberOfCells()
           
 int getRecordSize()
          gives the current serialized size of the record.
 int getRowCellBlockSize(int startRow, int endRow)
          Tallies a count of the size of the cell records that are attached to the rows in the range specified.
 short getSid()
          return the non static version of the id for this record.
 void insertCell(CellValueRecordInterface cell)
           
 void removeCell(CellValueRecordInterface cell)
           
 boolean rowHasCells(int row)
          Returns true if the row has cells attached to it
 int serialize(int offset, byte[] data)
          called by the class that is responsible for writing this sucker.
 int serializeCellRow(int row, int offset, byte[] data)
          Serializes the cells that are allocated to a certain row range
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
cloneViaReserialise, isInValueSection, isValue, serialize, toString
 
Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

sid

public static final short sid
See Also:
Constant Field Values
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.

Specified by:
serialize in class Record
Parameters:
offset - to begin writing at
data - byte array containing instance data
Returns:
number of bytes written

getRowCellBlockSize

public int getRowCellBlockSize(int startRow,
                               int endRow)
Tallies a count of the size of the cell records that are attached to the rows in the range specified.


rowHasCells

public boolean rowHasCells(int row)
Returns true if the row has cells attached to it


serializeCellRow

public int serializeCellRow(int row,
                            int offset,
                            byte[] data)
Serializes the cells that are allocated to a certain row range


fillFields

protected void fillFields(RecordInputStream in)
You never fill an aggregate

Specified by:
fillFields in class Record
Parameters:
in - the RecordInputstream to read the record from

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


Copyright 2008 The Apache Software Foundation or its licensors, as applicable.