org.apache.poi.ss.formula.functions
Class Fixed1ArgFunction

java.lang.Object
  extended by org.apache.poi.ss.formula.functions.Fixed1ArgFunction
All Implemented Interfaces:
Function, Function1Arg
Direct Known Subclasses:
CalendarFieldFunction, Columns, Countblank, Errortype, LogicalFunction, NumericFunction.OneArg, PercentEval, Rows, T, UnaryMinusEval, UnaryPlusEval, Value

public abstract class Fixed1ArgFunction
extends java.lang.Object
implements Function1Arg

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

Author:
Josh Micich

Constructor Summary
Fixed1ArgFunction()
           
 
Method Summary
 ValueEval evaluate(ValueEval[] args, 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.Function1Arg
evaluate
 

Constructor Detail

Fixed1ArgFunction

public Fixed1ArgFunction()
Method Detail

evaluate

public final 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.


Copyright 2012 The Apache Software Foundation or its licensors, as applicable.