Top Description Fields Constructors Methods
org.apache.poi.hssf.record

public abstract Class CellRecord

extends StandardRecord
implements CellValueRecordInterface
Class Inheritance
All Implemented Interfaces
org.apache.poi.hssf.record.CellValueRecordInterface
Known Direct Subclasses
org.apache.poi.hssf.record.FormulaRecord, org.apache.poi.hssf.record.LabelSSTRecord, org.apache.poi.hssf.record.NumberRecord, org.apache.poi.hssf.record.RKRecord, org.apache.poi.hssf.record.BoolErrRecord
Imports
java.util.Map, java.util.function.Supplier, org.apache.poi.util.GenericRecordUtil, .LittleEndianOutput
Base class for all cell value records (implementors of CellValueRecordInterface). Subclasses are expected to manage the cell data values (of various types).

Field Summary

Modifier and TypeField and Description
private int
_columnIndex

private int
_formatIndex

private int
_rowIndex

Constructor Summary

AccessConstructor and Description
protected
CellRecord()

protected
CellRecord(CellRecord other)

protected
CellRecord(RecordInputStream in)

Method Summary

Modifier and TypeMethod and Description
public abstract CellRecord
copy()

Redeclares org.apache.poi.common.Duplicatable.copy.

Implements abstract org.apache.poi.hssf.record.StandardRecord.copy.

public final short
getColumn()

Implements org.apache.poi.hssf.record.CellValueRecordInterface.getColumn.

protected final int
getDataSize()

Implements abstract org.apache.poi.hssf.record.StandardRecord.getDataSize.

public Map<String, Supplier<?>>
getGenericProperties()

Implements org.apache.poi.common.usermodel.GenericRecord.getGenericProperties.

protected abstract String

Returns:

the record type name
getRecordName()

Gets the debug info BIFF record type name (used by toString().

public final int
getRow()

Implements org.apache.poi.hssf.record.CellValueRecordInterface.getRow.

protected abstract int

Returns:

the size (in bytes) of the value data for this cell record
getValueDataSize()

public final short

Returns:

index to the XF record
getXFIndex()

Implements org.apache.poi.hssf.record.CellValueRecordInterface.getXFIndex.

get the index to the ExtendedFormat

public final void
serialize(LittleEndianOutput
the output object
out)

Implements abstract org.apache.poi.hssf.record.StandardRecord.serialize.

Write the data content of this BIFF record.

protected abstract void
serializeValue(LittleEndianOutput
the output
out)

writes out the value data for this cell record

public final void
setColumn(short
the column this cell defines
col)

Implements org.apache.poi.hssf.record.CellValueRecordInterface.setColumn.

public final void
setRow(int
the row this cell occurs within
row)

Implements org.apache.poi.hssf.record.CellValueRecordInterface.setRow.

public final void
setXFIndex(short
index to the XF record
xf)

Implements org.apache.poi.hssf.record.CellValueRecordInterface.setXFIndex.

set the index to the ExtendedFormat

Inherited from org.apache.poi.hssf.record.StandardRecord:
getRecordSizeserialize

Field Detail

_columnIndexback to summary
private int _columnIndex
_formatIndexback to summary
private int _formatIndex
_rowIndexback to summary
private int _rowIndex

Constructor Detail

CellRecordback to summary
protected CellRecord()
CellRecordback to summary
protected CellRecord(CellRecord other)
CellRecordback to summary
protected CellRecord(RecordInputStream in)

Method Detail

copyback to summary
public abstract CellRecord copy()

Redeclares org.apache.poi.common.Duplicatable.copy.

Implements abstract org.apache.poi.hssf.record.StandardRecord.copy.

Returns:CellRecord

Doc from org.apache.poi.common.Duplicatable.copy.

a deep copy of the implementing class / instance

Annotations
@Override
getColumnback to summary
public final short getColumn()

Implements org.apache.poi.hssf.record.CellValueRecordInterface.getColumn.

Returns:short

Doc from org.apache.poi.hssf.record.CellValueRecordInterface.getColumn.

the column this cell defines within the row

Annotations
@Override
getDataSizeback to summary
protected final int getDataSize()

Implements abstract org.apache.poi.hssf.record.StandardRecord.getDataSize.

Annotations
@Override
getGenericPropertiesback to summary
public Map<String, Supplier<?>> getGenericProperties()

Implements org.apache.poi.common.usermodel.GenericRecord.getGenericProperties.

Annotations
@Override
getRecordNameback to summary
protected abstract String getRecordName()

Gets the debug info BIFF record type name (used by toString().

Returns:String

the record type name

getRowback to summary
public final int getRow()

Implements org.apache.poi.hssf.record.CellValueRecordInterface.getRow.

Returns:int

Doc from org.apache.poi.hssf.record.CellValueRecordInterface.getRow.

the row this cell occurs on

Annotations
@Override
getValueDataSizeback to summary
protected abstract int getValueDataSize()
Returns:int

the size (in bytes) of the value data for this cell record

getXFIndexback to summary
public final short getXFIndex()

Implements org.apache.poi.hssf.record.CellValueRecordInterface.getXFIndex.

get the index to the ExtendedFormat

Returns:short

index to the XF record

Annotations
@Override
See Also
org.apache.poi.hssf.record.ExtendedFormatRecord
serializeback to summary
public final void serialize(LittleEndianOutput out)

Implements abstract org.apache.poi.hssf.record.StandardRecord.serialize.

Doc from org.apache.poi.hssf.record.StandardRecord.serialize.

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 org.apache.poi.hssf.record.Record#getRecordSize()} minus four ( record header consisting of a 'ushort sid' and 'ushort reclength' has already been written by their superclass).

Parameters
out:LittleEndianOutput

the output object

Annotations
@Override
serializeValueback to summary
protected abstract void serializeValue(LittleEndianOutput out)

writes out the value data for this cell record

Parameters
out:LittleEndianOutput

the output

setColumnback to summary
public final void setColumn(short col)

Implements org.apache.poi.hssf.record.CellValueRecordInterface.setColumn.

Parameters
col:short

Doc from org.apache.poi.hssf.record.CellValueRecordInterface.setColumn.

the column this cell defines

Annotations
@Override
setRowback to summary
public final void setRow(int row)

Implements org.apache.poi.hssf.record.CellValueRecordInterface.setRow.

Parameters
row:int

Doc from org.apache.poi.hssf.record.CellValueRecordInterface.setRow.

the row this cell occurs within

Annotations
@Override
setXFIndexback to summary
public final void setXFIndex(short xf)

Implements org.apache.poi.hssf.record.CellValueRecordInterface.setXFIndex.

set the index to the ExtendedFormat

Parameters
xf:short

index to the XF record

Annotations
@Override
See Also
org.apache.poi.hssf.record.ExtendedFormatRecord