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

public final Class OldFormulaRecord

extends OldCellRecord
Class Inheritance
Imports
java.util.Map, java.util.function.Supplier, org.apache.poi.ss.formula.Formula, org.apache.poi.ss.formula.ptg.Ptg, org.apache.poi.ss.usermodel.CellType, org.apache.poi.util.GenericRecordUtil
Formula Record (0x0006 / 0x0206 / 0x0406) - holds a formula in encoded form, along with the value if a number

Field Summary

Modifier and TypeField and Description
public static final short
biff2_sid

public static final short
biff3_sid

public static final short
biff4_sid

public static final short
biff5_sid

private double
field_4_value

private short
field_5_options

private Formula
field_6_parsed_expr

private FormulaSpecialCachedValue
specialCachedValue

Constructor Summary

AccessConstructor and Description
public
OldFormulaRecord(RecordInputStream ris)

Method Summary

Modifier and TypeMethod and Description
public boolean
getCachedBooleanValue()

public int
getCachedErrorValue()

public int
getCachedResultType()
Deprecated POI 5.0.0, will be removed in 5.0, use getCachedResultTypeEnum until switch to enum is fully done

public CellType

Returns:

A CellType
getCachedResultTypeEnum()

Returns the type of the cached result

public Formula
getFormula()

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

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

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

public HSSFRecordTypes
getGenericRecordType()

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

public short

Returns:

bitmask
getOptions()

get the option flags

public Ptg[]

Returns:

the formula tokens. never null
getParsedExpression()

public double

Returns:

calculated value
getValue()

get the calculated value of the formula

Inherited from org.apache.poi.hssf.record.OldCellRecord:
getCellAttrsgetColumngetRowgetSidgetXFIndexisBiff2toString

Field Detail

biff2_sidback to summary
public static final short biff2_sid
biff3_sidback to summary
public static final short biff3_sid
biff4_sidback to summary
public static final short biff4_sid
biff5_sidback to summary
public static final short biff5_sid
field_4_valueback to summary
private double field_4_value
field_5_optionsback to summary
private short field_5_options
field_6_parsed_exprback to summary
private Formula field_6_parsed_expr
specialCachedValueback to summary
private FormulaSpecialCachedValue specialCachedValue

Constructor Detail

OldFormulaRecordback to summary
public OldFormulaRecord(RecordInputStream ris)

Method Detail

getCachedBooleanValueback to summary
public boolean getCachedBooleanValue()
getCachedErrorValueback to summary
public int getCachedErrorValue()
getCachedResultTypeback to summary
public int getCachedResultType()

Deprecated

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

Annotations
@Deprecated
getCachedResultTypeEnumback to summary
public CellType getCachedResultTypeEnum()

Returns the type of the cached result

Returns:CellType

A CellType

Since
POI 5.0.0
getFormulaback to summary
public Formula getFormula()
getGenericPropertiesback to summary
public Map<String, Supplier<?>> getGenericProperties()

Overrides org.apache.poi.hssf.record.OldCellRecord.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.

Annotations
@Override
getOptionsback to summary
public short getOptions()

get the option flags

Returns:short

bitmask

getParsedExpressionback to summary
public Ptg[] getParsedExpression()
Returns:Ptg[]

the formula tokens. never null

getValueback to summary
public double getValue()

get the calculated value of the formula

Returns:double

calculated value