Apache POI - Common 5.3.0 · org.apache.poi.ss.formula.OperandClassTransformer

This class performs 'operand class' transformation. Non-base tokens are classified into three operand classes:

reference
value
array

The final operand class chosen for each token depends on the formula type and the token's place in the formula. If POI gets the operand class wrong, Excel may interpret the formula incorrectly. This condition is typically manifested as a formula cell that displays as '#VALUE!', but resolves correctly when the user presses F2, enter.

The logic implemented here was partially inspired by the description in "OpenOffice.org's Documentation of the Microsoft Excel File Format". The model presented there seems to be inconsistent with observed Excel behaviour (These differences have not been fully investigated). The implementation in this class has been heavily modified in order to satisfy concrete examples of how Excel performs the same logic (see TestRVA).

Hopefully, as additional important test cases are identified and added to the test suite, patterns might become more obvious in this code and allow for simplification.

Field Summary

Modifier and Type	Field and Description
private final FormulaType	_formulaType

Constructor Summary

Access	Constructor and Description
public	OperandClassTransformer(FormulaType formulaType)

Method Summary

Modifier and Type	Method and Description
private static boolean	isSimpleValueFunction(Ptg token)
private static boolean	isSingleArgSum(Ptg token)
private void	setSimpleValueFuncClass(AbstractFunctionPtg afp, byte desiredOperandClass, boolean callerForceArrayFlag)
private byte	transformClass(byte currentOperandClass, byte desiredOperandClass, boolean callerForceArrayFlag)
public void	transformFormula(ParseNode rootNode) Traverses the supplied formula parse tree, calling `Ptg.setClass()` for each non-base token to set its operand class.
private void	transformFunctionNode(AbstractFunctionPtg afp, ParseNode[] children, byte desiredOperandClass, boolean callerForceArrayFlag)
private void	transformNode(ParseNode node, byte desiredOperandClass, boolean `true` if one of the current node's parents is a function Ptg which has been changed from default 'V' to 'A' type (due to requirements on the function return value). callerForceArrayFlag)

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

_formulaType	back to summary
private final FormulaType _formulaType

Constructor Detail

OperandClassTransformer	back to summary
public OperandClassTransformer(FormulaType formulaType)

Method Detail

isSimpleValueFunction	back to summary
private static boolean isSimpleValueFunction(Ptg token)

isSingleArgSum	back to summary
private static boolean isSingleArgSum(Ptg token)

setSimpleValueFuncClass	back to summary
private void setSimpleValueFuncClass(AbstractFunctionPtg afp, byte desiredOperandClass, boolean callerForceArrayFlag)

transformClass	back to summary
private byte transformClass(byte currentOperandClass, byte desiredOperandClass, boolean callerForceArrayFlag)

transformFormula	back to summary
public void transformFormula(ParseNode rootNode) Traverses the supplied formula parse tree, calling `Ptg.setClass()` for each non-base token to set its operand class.

transformFunctionNode	back to summary
private void transformFunctionNode(AbstractFunctionPtg afp, ParseNode[] children, byte desiredOperandClass, boolean callerForceArrayFlag)

transformNode	back to summary
private void transformNode(ParseNode node, byte desiredOperandClass, boolean callerForceArrayFlag) Parameters callerForceArrayFlag:boolean `true` if one of the current node's parents is a function Ptg which has been changed from default 'V' to 'A' type (due to requirements on the function return value).