Package org.apache.poi.hssf.record

Class OldFormulaRecord

java.lang.Object

org.apache.poi.hssf.record.OldCellRecord

org.apache.poi.hssf.record.OldFormulaRecord

All Implemented Interfaces:

GenericRecord

public final class OldFormulaRecord
extends OldCellRecord

Formula Record (0x0006 / 0x0206 / 0x0406) - holds a formula in encoded form, along with the value if a number

Field Summary

Fields

Modifier and Type	Field	Description
static short	biff2_sid
static short	biff3_sid
static short	biff4_sid
static short	biff5_sid

Constructor Summary

Constructors

Constructor	Description
OldFormulaRecord(RecordInputStream ris)

Method Summary

Modifier and Type	Method	Description
boolean	getCachedBooleanValue()
int	getCachedErrorValue()
int	getCachedResultType()	Deprecated. POI 5.0.0, will be removed in 5.0, use getCachedResultTypeEnum until switch to enum is fully done
CellType	getCachedResultTypeEnum()	Returns the type of the cached result
Formula	getFormula()
Map<String,Supplier<?>>	getGenericProperties()
HSSFRecordTypes	getGenericRecordType()
short	getOptions()	get the option flags
Ptg[]	getParsedExpression()
double	getValue()	get the calculated value of the formula

Methods inherited from class org.apache.poi.hssf.record.OldCellRecord

getCellAttrs, getColumn, getRow, getSid, getXFIndex, isBiff2, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.apache.poi.common.usermodel.GenericRecord

getGenericChildren

Field Detail

biff2_sid

public static final short biff2_sid

See Also:

Constant Field Values

biff3_sid

public static final short biff3_sid

See Also:

Constant Field Values

biff4_sid

public static final short biff4_sid

See Also:

Constant Field Values

biff5_sid

public static final short biff5_sid

See Also:

Constant Field Values

Constructor Detail

OldFormulaRecord

public OldFormulaRecord(RecordInputStream ris)

Method Detail

getCachedResultType

@Deprecated
public int getCachedResultType()

Deprecated.

POI 5.0.0, will be removed in 5.0, use getCachedResultTypeEnum until switch to enum is fully done

getCachedResultTypeEnum

public CellType getCachedResultTypeEnum()

Returns the type of the cached result

Returns:

A CellType

Since:

POI 5.0.0

getCachedBooleanValue

public boolean getCachedBooleanValue()

getCachedErrorValue

public int getCachedErrorValue()

getValue

public double getValue()

get the calculated value of the formula

Returns:

calculated value

getOptions

public short getOptions()

get the option flags

Returns:

bitmask

getParsedExpression

public Ptg[] getParsedExpression()

Returns:

the formula tokens. never null

getFormula

public Formula getFormula()

getGenericRecordType

public HSSFRecordTypes getGenericRecordType()

getGenericProperties

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

Specified by:

getGenericProperties in interface GenericRecord

Overrides:

getGenericProperties in class OldCellRecord