Package org.apache.poi.hssf.record
Class CellRecord
java.lang.Object
org.apache.poi.hssf.record.RecordBase
org.apache.poi.hssf.record.Record
org.apache.poi.hssf.record.StandardRecord
org.apache.poi.hssf.record.CellRecord
- All Implemented Interfaces:
CellValueRecordInterface
- Direct Known Subclasses:
BoolErrRecord
,FormulaRecord
,LabelSSTRecord
,NumberRecord
,RKRecord
Base class for all cell value records (implementors of
CellValueRecordInterface
).
Subclasses are expected to manage the cell data values (of various types).-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionprotected abstract void
Append specific debug info (used bytoString()
for the value contained in this record.protected final void
copyBaseFields
(CellRecord rec) final short
protected final int
protected abstract String
Gets the debug info BIFF record type name (used bytoString()
.final int
getRow()
protected abstract int
final short
get the index to the ExtendedFormatfinal void
Write the data content of this BIFF record.protected abstract void
writes out the value data for this cell recordfinal void
setColumn
(short col) final void
setRow
(int row) final void
setXFIndex
(short xf) set the index to the ExtendedFormatfinal 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
-
Constructor Details
-
CellRecord
protected CellRecord() -
CellRecord
-
-
Method Details
-
setRow
public final void setRow(int row) - Specified by:
setRow
in interfaceCellValueRecordInterface
- Parameters:
row
- the row this cell occurs within
-
setColumn
public final void setColumn(short col) - Specified by:
setColumn
in interfaceCellValueRecordInterface
- Parameters:
col
- the column this cell defines
-
setXFIndex
public final void setXFIndex(short xf) set the index to the ExtendedFormat- Specified by:
setXFIndex
in interfaceCellValueRecordInterface
- Parameters:
xf
- index to the XF record- See Also:
-
getRow
public final int getRow()- Specified by:
getRow
in interfaceCellValueRecordInterface
- Returns:
- the row this cell occurs on
-
getColumn
public final short getColumn()- Specified by:
getColumn
in interfaceCellValueRecordInterface
- Returns:
- the column this cell defines within the row
-
getXFIndex
public final short getXFIndex()get the index to the ExtendedFormat- Specified by:
getXFIndex
in interfaceCellValueRecordInterface
- Returns:
- index to the XF record
- See Also:
-
toString
Description copied from class:Record
get a string representation of the record (for biffview/debugging) -
appendValueText
Append specific debug info (used bytoString()
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
Gets the debug info BIFF record type name (used bytoString()
.- Returns:
- the record type name
-
serializeValue
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
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 classStandardRecord
- Parameters:
out
- the output object
-
getDataSize
protected final int getDataSize()- Specified by:
getDataSize
in classStandardRecord
-
copyBaseFields
-