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

public final Class NotImplementedFunction

extends Object
implements Function
Class Inheritance
All Implemented Interfaces
org.apache.poi.ss.formula.functions.Function
Imports
org.apache.poi.ss.formula.eval.NotImplementedFunctionException, .ValueEval
This is the default implementation of a Function class. The default behaviour is to raise a POI internal error (NotImplementedFunctionException). This error should alert the user that the formula contained a function that is not yet implemented.

Field Summary

Modifier and TypeField and Description
private final String
_functionName

Constructor Summary

AccessConstructor and Description
protected
NotImplementedFunction()

public
NotImplementedFunction(String name)

Method Summary

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

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

public String
getFunctionName()

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

_functionNameback to summary
private final String _functionName

Constructor Detail

NotImplementedFunctionback to summary
protected NotImplementedFunction()
NotImplementedFunctionback to summary
public NotImplementedFunction(String name)

Method Detail

evaluateback to summary
public ValueEval evaluate(ValueEval[] operands, int srcRow, int srcCol)

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

Parameters
operands: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.

srcRow:int

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

row index of the cell containing the formula under evaluation

srcCol: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.

getFunctionNameback to summary
public String getFunctionName()