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

public abstract Class FinanceFunction

extends Object
implements Function3Arg, Function4Arg
Class Inheritance
All Implemented Interfaces
org.apache.poi.ss.formula.functions.Function4Arg, org.apache.poi.ss.formula.functions.Function, org.apache.poi.ss.formula.functions.Function3Arg
Imports
org.apache.poi.ss.formula.eval.BoolEval, .ErrorEval, .EvaluationException, .MissingArgEval, .NumberEval, .ValueEval

Field Summary

Modifier and TypeField and Description
private static final ValueEval
DEFAULT_ARG3

private static final ValueEval
DEFAULT_ARG4

public static final Function
FV

public static final Function
NPER

public static final Function
PMT

public static final Function
PV

Constructor Summary

AccessConstructor and Description
protected
FinanceFunction()

Method Summary

Modifier and TypeMethod and Description
public ValueEval
evaluate(int srcRowIndex, int srcColumnIndex, ValueEval arg0, ValueEval arg1, ValueEval arg2)

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

see Function#evaluate(ValueEval[], int, int)

public ValueEval
evaluate(int srcRowIndex, int srcColumnIndex, ValueEval arg0, ValueEval arg1, ValueEval arg2, ValueEval arg3)

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

see Function#evaluate(ValueEval[], int, int)

public ValueEval
evaluate(int srcRowIndex, int srcColumnIndex, ValueEval arg0, ValueEval arg1, ValueEval arg2, ValueEval arg3, ValueEval arg4)

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

protected double
evaluate(double[] ds)

protected abstract double
evaluate(double rate, double arg1, double arg2, double arg3, boolean type)

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

DEFAULT_ARG3back to summary
private static final ValueEval DEFAULT_ARG3
DEFAULT_ARG4back to summary
private static final ValueEval DEFAULT_ARG4
FVback to summary
public static final Function FV
NPERback to summary
public static final Function NPER
PMTback to summary
public static final Function PMT
PVback to summary
public static final Function PV

Constructor Detail

FinanceFunctionback to summary
protected FinanceFunction()

Method Detail

evaluateback to summary
public ValueEval evaluate(int srcRowIndex, int srcColumnIndex, ValueEval arg0, ValueEval arg1, ValueEval arg2)

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

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

see Function#evaluate(ValueEval[], int, int)

evaluateback to summary
public ValueEval evaluate(int srcRowIndex, int srcColumnIndex, ValueEval arg0, ValueEval arg1, ValueEval arg2, ValueEval arg3)

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

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

see Function#evaluate(ValueEval[], int, int)

evaluateback to summary
public ValueEval evaluate(int srcRowIndex, int srcColumnIndex, ValueEval arg0, ValueEval arg1, ValueEval arg2, ValueEval arg3, ValueEval arg4)
evaluateback to summary
public 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.

evaluateback to summary
protected double evaluate(double[] ds) throws EvaluationException
Annotations
@SuppressWarnings:fallthrough
evaluateback to summary
protected abstract double evaluate(double rate, double arg1, double arg2, double arg3, boolean type) throws EvaluationException