org.apache.poi.ss.formula.functions
Class Substitute
java.lang.Object
org.apache.poi.ss.formula.functions.Substitute
- All Implemented Interfaces:
- Function, Function3Arg, Function4Arg
public final class Substitute
- extends java.lang.Object
An implementation of the SUBSTITUTE function:
Substitutes text in a text string with new text, some number of times.
- Author:
- Manda Wilson < wilson at c bio dot msk cc dot org >
Method Summary |
ValueEval |
evaluate(int srcRowIndex,
int srcColumnIndex,
ValueEval arg0,
ValueEval arg1,
ValueEval arg2)
see Function.evaluate(ValueEval[], int, int) |
ValueEval |
evaluate(int srcRowIndex,
int srcColumnIndex,
ValueEval arg0,
ValueEval arg1,
ValueEval arg2,
ValueEval arg3)
see Function.evaluate(ValueEval[], int, int) |
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 |
Substitute
public Substitute()
evaluate
public ValueEval evaluate(int srcRowIndex,
int srcColumnIndex,
ValueEval arg0,
ValueEval arg1,
ValueEval arg2)
- Description copied from interface:
Function3Arg
- see
Function.evaluate(ValueEval[], int, int)
evaluate
public ValueEval evaluate(int srcRowIndex,
int srcColumnIndex,
ValueEval arg0,
ValueEval arg1,
ValueEval arg2,
ValueEval arg3)
- Description copied from interface:
Function4Arg
- see
Function.evaluate(ValueEval[], int, int)
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 evaluationsrcColumnIndex
- 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.