org.apache.poi.hssf.eventusermodel.dummyrecord
Class LastCellOfRowDummyRecord

java.lang.Object
  extended by org.apache.poi.hssf.record.Record
      extended by org.apache.poi.hssf.eventusermodel.dummyrecord.LastCellOfRowDummyRecord

public class LastCellOfRowDummyRecord
extends Record

A dummy record to indicate that we've now had the last cell record for this row.


Constructor Summary
LastCellOfRowDummyRecord(int row, int lastColumnNumber)
           
 
Method Summary
protected  void fillFields(RecordInputStream in)
          called by the constructor, should set class level fields.
 int getLastColumnNumber()
          Returns the (0 based) number of the last column seen for this row.
 int getRow()
          Returns the (0 based) number of the row we are currently working on.
 short getSid()
          return the non static version of the id for this record.
 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
clone, cloneViaReserialise, getRecordSize, isInValueSection, isValue, serialize, toString
 
Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

LastCellOfRowDummyRecord

public LastCellOfRowDummyRecord(int row,
                                int lastColumnNumber)
Method Detail

getRow

public int getRow()
Returns the (0 based) number of the row we are currently working on.


getLastColumnNumber

public int getLastColumnNumber()
Returns the (0 based) number of the last column seen for this row. You should have already been called with that record. This is -1 in the case of there being no columns for the row.


fillFields

protected void fillFields(RecordInputStream in)
Description copied from class: Record
called by the constructor, should set class level fields. Should throw runtime exception for bad/icomplete data.

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

getSid

public short getSid()
Description copied from class: Record
return the non static version of the id for this record.

Specified by:
getSid in class Record

serialize

public int serialize(int offset,
                     byte[] data)
Description copied from class: Record
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

validateSid

protected void validateSid(short id)
Description copied from class: Record
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


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