Package org.apache.poi.ss.formula.functions

Class MultiOperandNumericFunction

java.lang.Object

org.apache.poi.ss.formula.functions.MultiOperandNumericFunction

All Implemented Interfaces:

Function

Direct Known Subclasses:

AggregateFunction, MatrixFunction.MutableValueCollector, MinaMaxa, Mirr

public abstract class MultiOperandNumericFunction
extends java.lang.Object
implements Function

This is the super class for all excel function evaluator classes that take variable number of operands, and where the order of operands does not matter

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	MultiOperandNumericFunction.Policy

Method Summary

Modifier and Type	Method	Description
ValueEval	evaluate(ValueEval[] args, int srcCellRow, int srcCellCol)
boolean	isHiddenRowCounted()
boolean	isSubtotalCounted()	Whether to count nested subtotals.
void	setBlankEvalPolicy(MultiOperandNumericFunction.Policy policy)
void	setMissingArgPolicy(MultiOperandNumericFunction.Policy policy)

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

setMissingArgPolicy

public void setMissingArgPolicy(MultiOperandNumericFunction.Policy policy)

setBlankEvalPolicy

public void setBlankEvalPolicy(MultiOperandNumericFunction.Policy policy)

evaluate

public final ValueEval evaluate(ValueEval[] args,
                                int srcCellRow,
                                int srcCellCol)

Specified by:

evaluate in interface Function

Parameters:

args - the evaluated function arguments. Empty values are represented with BlankEval or MissingArgEval, never null.

srcCellRow - row index of the cell containing the formula under evaluation

srcCellCol - column index of the cell containing the formula under evaluation

Returns:

The evaluated result, possibly an ErrorEval, never null. Note - Excel uses the error code #NUM! instead of IEEE NaN, so when numeric functions evaluate to Double.NaN be sure to translate the result to ErrorEval.NUM_ERROR.

isSubtotalCounted

public boolean isSubtotalCounted()

Whether to count nested subtotals.

isHiddenRowCounted

public boolean isHiddenRowCounted()

Returns:

true if values in hidden rows are counted

See Also:

Subtotal