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

public final Class RKRecord

extends CellRecord
Class Inheritance
Imports
java.util.Map, java.util.function.Supplier, org.apache.poi.hssf.util.RKUtil, org.apache.poi.util.GenericRecordUtil, .LittleEndianOutput
An internal 32 bit number with the two most significant bits storing the type. This is part of a bizarre scheme to save disk space and memory (gee look at all the other whole records that are in the file just "cause".., far better to waste processor cycles on this then leave on of those "valuable" records out). We support this in READ-ONLY mode. HSSF converts these to NUMBER records
See Also
org.apache.poi.hssf.record.NumberRecord

Field Summary

Modifier and TypeField and Description
private final int
field_4_rk_number

public static final short
RK_IEEE_NUMBER

public static final short
RK_IEEE_NUMBER_TIMES_100

public static final short
RK_INTEGER

public static final short
RK_INTEGER_TIMES_100

public static final short
sid

Constructor Summary

AccessConstructor and Description
public
RKRecord(RKRecord other)

public
RKRecord(RecordInputStream in)

Method Summary

Modifier and TypeMethod and Description
public RKRecord
copy()

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

Implements org.apache.poi.common.Duplicatable.copy.

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

Overrides org.apache.poi.hssf.record.CellRecord.getGenericProperties.

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

public HSSFRecordTypes
getGenericRecordType()

Overrides default org.apache.poi.common.usermodel.GenericRecord.getGenericRecordType.

Implements abstract org.apache.poi.hssf.record.Record.getGenericRecordType.

protected String
getRecordName()

Implements abstract org.apache.poi.hssf.record.CellRecord.getRecordName.

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

public double

Returns:

the value as a proper double (hey, it could happen)
getRKNumber()

Extract the value of the number

The mechanism for determining the value is dependent on the two low order bits of the raw number.

public short
getSid()

Implements abstract org.apache.poi.hssf.record.Record.getSid.

return the non static version of the id for this record.

protected int
getValueDataSize()

Implements abstract org.apache.poi.hssf.record.CellRecord.getValueDataSize.

protected void
serializeValue(LittleEndianOutput
the output
out)

Implements abstract org.apache.poi.hssf.record.CellRecord.serializeValue.

writes out the value data for this cell record

Inherited from org.apache.poi.hssf.record.CellRecord:
getColumngetDataSizegetRowgetXFIndexserializesetColumnsetRowsetXFIndex

Field Detail

field_4_rk_numberback to summary
private final int field_4_rk_number
RK_IEEE_NUMBERback to summary
public static final short RK_IEEE_NUMBER
RK_IEEE_NUMBER_TIMES_100back to summary
public static final short RK_IEEE_NUMBER_TIMES_100
RK_INTEGERback to summary
public static final short RK_INTEGER
RK_INTEGER_TIMES_100back to summary
public static final short RK_INTEGER_TIMES_100
sidback to summary
public static final short sid

Constructor Detail

RKRecordback to summary
public RKRecord(RKRecord other)
RKRecordback to summary
public RKRecord(RecordInputStream in)

Method Detail

copyback to summary
public RKRecord copy()

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

Implements org.apache.poi.common.Duplicatable.copy.

Returns:RKRecord

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

a deep copy of the implementing class / instance

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

Overrides org.apache.poi.hssf.record.CellRecord.getGenericProperties.

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

Annotations
@Override
getGenericRecordTypeback to summary
public HSSFRecordTypes getGenericRecordType()

Overrides default org.apache.poi.common.usermodel.GenericRecord.getGenericRecordType.

Implements abstract org.apache.poi.hssf.record.Record.getGenericRecordType.

Annotations
@Override
getRecordNameback to summary
protected String getRecordName()

Implements abstract org.apache.poi.hssf.record.CellRecord.getRecordName.

Doc from org.apache.poi.hssf.record.CellRecord.getRecordName.

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

Returns:String

the record type name

Annotations
@Override
getRKNumberback to summary
public double getRKNumber()

Extract the value of the number

The mechanism for determining the value is dependent on the two low order bits of the raw number. If bit 1 is set, the number is an integer and can be cast directly as a double, otherwise, it's apparently the exponent and mantissa of a double (and the remaining low-order bits of the double's mantissa are 0's).

If bit 0 is set, the result of the conversion to a double is divided by 100; otherwise, the value is left alone.

[insert picture of Screwy Squirrel in full Napoleonic regalia]

Returns:double

the value as a proper double (hey, it could happen)

getSidback to summary
public short getSid()

Implements abstract org.apache.poi.hssf.record.Record.getSid.

Doc from org.apache.poi.hssf.record.Record.getSid.

return the non static version of the id for this record.

Returns:short

he id for this record

Annotations
@Override
getValueDataSizeback to summary
protected int getValueDataSize()

Implements abstract org.apache.poi.hssf.record.CellRecord.getValueDataSize.

Returns:int

Doc from org.apache.poi.hssf.record.CellRecord.getValueDataSize.

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

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

Implements abstract org.apache.poi.hssf.record.CellRecord.serializeValue.

Doc from org.apache.poi.hssf.record.CellRecord.serializeValue.

writes out the value data for this cell record

Parameters
out:LittleEndianOutput

the output

Annotations
@Override