org.apache.poi.hssf.record
Class CellRecord

java.lang.Object
  extended by org.apache.poi.hssf.record.RecordBase
      extended by org.apache.poi.hssf.record.Record
          extended by org.apache.poi.hssf.record.StandardRecord
              extended by org.apache.poi.hssf.record.CellRecord
All Implemented Interfaces:
CellValueRecordInterface
Direct Known Subclasses:
BoolErrRecord, FormulaRecord, LabelSSTRecord, NumberRecord, RKRecord

public abstract class CellRecord
extends StandardRecord
implements CellValueRecordInterface

Base class for all cell value records (implementors of CellValueRecordInterface). Subclasses are expected to manage the cell data values (of various types).

Author:
Josh Micich

Method Summary
 short getColumn()
           
 int getRow()
           
 short getXFIndex()
          get the index to the ExtendedFormat
 void serialize(LittleEndianOutput out)
          Write the data content of this BIFF record.
 void setColumn(short col)
           
 void setRow(int row)
           
 void setXFIndex(short xf)
          set the index to the ExtendedFormat
 java.lang.String toString()
          get a string representation of the record (for biffview/debugging)
 
Methods inherited from class org.apache.poi.hssf.record.StandardRecord
getRecordSize, serialize
 
Methods inherited from class org.apache.poi.hssf.record.Record
clone, cloneViaReserialise, getSid, serialize
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Method Detail

setRow

public final void setRow(int row)
Specified by:
setRow in interface CellValueRecordInterface
Parameters:
row - the row this cell occurs within

setColumn

public final void setColumn(short col)
Specified by:
setColumn in interface CellValueRecordInterface
Parameters:
col - the column this cell defines

setXFIndex

public final void setXFIndex(short xf)
set the index to the ExtendedFormat

Specified by:
setXFIndex in interface CellValueRecordInterface
Parameters:
xf - index to the XF record
See Also:
ExtendedFormatRecord

getRow

public final int getRow()
Specified by:
getRow in interface CellValueRecordInterface
Returns:
the row this cell occurs on

getColumn

public final short getColumn()
Specified by:
getColumn in interface CellValueRecordInterface
Returns:
the column this cell defines within the row

getXFIndex

public final short getXFIndex()
get the index to the ExtendedFormat

Specified by:
getXFIndex in interface CellValueRecordInterface
Returns:
index to the XF record
See Also:
ExtendedFormatRecord

toString

public final java.lang.String toString()
Description copied from class: Record
get a string representation of the record (for biffview/debugging)

Overrides:
toString in class Record

serialize

public final void serialize(LittleEndianOutput out)
Description copied from class: StandardRecord
Write the data content of this BIFF record. The 'ushort sid' and 'ushort size' header fields have already been written by the superclass.
The subclass must write the exact number of bytes as reported by RecordBase.getRecordSize()}