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

Class Choose

java.lang.Object

org.apache.poi.ss.formula.functions.Choose

All Implemented Interfaces:

ArrayFunction, Function

public final class Choose
extends Object
implements Function, ArrayFunction

Constructor Summary

Constructors

Constructor	Description
Choose()

Method Summary

Modifier and Type	Method	Description
ValueEval	evaluate(ValueEval[] args, int srcRowIndex, int srcColumnIndex)
ValueEval	evaluateArray(ValueEval[] args, int srcRowIndex, int srcColumnIndex)
static int	evaluateFirstArg(ValueEval arg0, int srcRowIndex, int srcColumnIndex)

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.poi.ss.formula.functions.ArrayFunction

evaluateOneArrayArg, evaluateTwoArrayArgs

Constructor Detail

Choose

public Choose()

Method Detail

evaluate

public ValueEval evaluate(ValueEval[] args,
                          int srcRowIndex,
                          int srcColumnIndex)

Specified by:

evaluate in interface Function

Parameters:

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

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

srcColumnIndex - 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.

evaluateFirstArg

public static int evaluateFirstArg(ValueEval arg0,
                                   int srcRowIndex,
                                   int srcColumnIndex)
                            throws EvaluationException

Throws:

EvaluationException

evaluateArray

public ValueEval evaluateArray(ValueEval[] args,
                               int srcRowIndex,
                               int srcColumnIndex)

Specified by:

evaluateArray in interface ArrayFunction

Parameters:

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

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

srcColumnIndex - 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.