Overview  Package   Class  Tree  Deprecated  Index  Help 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

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).

Constructor Summary
protected CellRecord()
           
protected CellRecord(RecordInputStream in)
           
 
Method Summary
protected abstract  void appendValueText(java.lang.StringBuilder sb)
          Append specific debug info (used by toString() for the value contained in this record.
protected  void copyBaseFields(CellRecord rec)
           
 short getColumn()
           
protected  int getDataSize()
           
protected abstract  java.lang.String getRecordName()
          Gets the debug info BIFF record type name (used by toString().
 int getRow()
           
protected abstract  int getValueDataSize()
           
 short getXFIndex()
          get the index to the ExtendedFormat
 void serialize(LittleEndianOutput out)
          Write the data content of this BIFF record.
protected abstract  void serializeValue(LittleEndianOutput out)
          writes out the value data for this cell 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, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

CellRecord

protected CellRecord()

CellRecord

protected CellRecord(RecordInputStream in)
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

appendValueText

protected abstract void appendValueText(java.lang.StringBuilder sb)
Append specific debug info (used by toString() for the value contained in this record. Trailing new-line should not be appended (superclass does that).

Parameters:
sb - the StringBuilder to write to

getRecordName

protected abstract java.lang.String getRecordName()
Gets the debug info BIFF record type name (used by toString().

Returns:
the record type name

serializeValue

protected abstract void serializeValue(LittleEndianOutput out)
writes out the value data for this cell record

Parameters:
out - the output

getValueDataSize

protected abstract int getValueDataSize()
Returns:
the size (in bytes) of the value data for this cell 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 number of bytes written must equal the record size reported by RecordBase.getRecordSize()} minus four ( record header consisting of a 'ushort sid' and 'ushort reclength' has already been written by their superclass).

Specified by:
serialize in class StandardRecord
Parameters:
out - the output object

getDataSize

protected final int getDataSize()
Specified by:
getDataSize in class StandardRecord

copyBaseFields

protected final void copyBaseFields(CellRecord rec)
Overview  Package   Class  Tree  Deprecated  Index  Help 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD