Top Description Constructors Methods
org.apache.poi.ss.formula.functions

public abstract Class Fixed1ArgFunction

extends Object
implements Function1Arg
Class Inheritance
All Implemented Interfaces
org.apache.poi.ss.formula.functions.Function1Arg, org.apache.poi.ss.formula.functions.Function
Known Direct Subclasses
org.apache.poi.ss.formula.functions.Code, org.apache.poi.ss.formula.functions.Errortype, org.apache.poi.ss.formula.functions.NormSInv, org.apache.poi.ss.formula.functions.Hex2Dec, org.apache.poi.ss.formula.functions.Imaginary, org.apache.poi.ss.formula.functions.ImReal, org.apache.poi.ss.formula.functions.LogicalFunction, org.apache.poi.ss.formula.functions.MatrixFunction.OneArrayArg, org.apache.poi.ss.formula.functions.NormSDist, org.apache.poi.ss.formula.functions.Oct2Dec, org.apache.poi.ss.formula.functions.Rows, org.apache.poi.ss.formula.functions.T, org.apache.poi.ss.formula.functions.TextFunction.SingleArgTextFunc, org.apache.poi.ss.formula.functions.TimeValue, org.apache.poi.ss.formula.functions.Value, org.apache.poi.ss.formula.eval.PercentEval, org.apache.poi.ss.formula.eval.UnaryMinusEval, org.apache.poi.ss.formula.eval.UnaryPlusEval, org.apache.poi.ss.formula.functions.Bin2Dec, org.apache.poi.ss.formula.functions.CalendarFieldFunction, org.apache.poi.ss.formula.functions.Columns, org.apache.poi.ss.formula.functions.Countblank, org.apache.poi.ss.formula.functions.DateValue, org.apache.poi.ss.formula.functions.FactDouble
Imports
org.apache.poi.ss.formula.eval.ErrorEval, .ValueEval

Convenience base class for functions that must take exactly one argument.

Constructor Summary

AccessConstructor and Description
public

Method Summary

Modifier and TypeMethod and Description
public final ValueEval
evaluate(ValueEval[]
the evaluated function arguments. Empty values are represented with BlankEval or MissingArgEval, never null.
args
,
int
row index of the cell containing the formula under evaluation
srcRowIndex
,
int
column index of the cell containing the formula under evaluation
srcColumnIndex
)

Implements org.apache.poi.ss.formula.functions.Function.evaluate.

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Constructor Detail

Fixed1ArgFunctionback to summary
public Fixed1ArgFunction()

Method Detail

evaluateback to summary
public final ValueEval evaluate(ValueEval[] args, int srcRowIndex, int srcColumnIndex)

Implements org.apache.poi.ss.formula.functions.Function.evaluate.

Parameters
args:ValueEval[]

Doc from org.apache.poi.ss.formula.functions.Function.evaluate.

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

srcRowIndex:int

Doc from org.apache.poi.ss.formula.functions.Function.evaluate.

row index of the cell containing the formula under evaluation

srcColumnIndex:int

Doc from org.apache.poi.ss.formula.functions.Function.evaluate.

column index of the cell containing the formula under evaluation

Returns:ValueEval

Doc from org.apache.poi.ss.formula.functions.Function.evaluate.

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.