Modifier and Type	Class and Description
private static class	TextFunction.LeftRight
private static class	TextFunction.SearchFind
private abstract static class	TextFunction.SingleArgTextFunc

Field Summary

Modifier and Type	Field and Description
public static final Function	CHAR Returns the character specified by a number.
public static final Function	CLEAN An implementation of the CLEAN function: In Excel, the Clean function removes all non-printable characters from a string.
public static final FreeRefFunction	CONCAT
public static final Function	CONCATENATE
public static final Function	EXACT
public static final Function	FIND Implementation of the FIND() function.
protected static final DataFormatter	formatter
public static final Function	LEFT
public static final Function	LEN
public static final Function	LOWER
public static final Function	MID An implementation of the MID function MID returns a specific number of characters from a text string, starting at the specified position.
public static final Function	PROPER Implementation of the PROPER function: Normalizes all words (separated by non-word characters) by making the first letter upper and the rest lower case.
public static final Function	RIGHT
public static final Function	SEARCH Implementation of the FIND() function.
public static final Function	TEXT An implementation of the TEXT function TEXT returns a number value formatted with the given number formatting string.
public static final Function	TRIM An implementation of the TRIM function: Removes leading and trailing spaces from value if evaluated operand value is string.
public static final Function	UPPER

Constructor Summary

Access	Constructor and Description
public	TextFunction()

Method Summary

Modifier and Type	Method 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 srcCellRow, int column index of the cell containing the formula under evaluation srcCellCol) Implements org.apache.poi.ss.formula.functions.Function.evaluate.
protected static double	evaluateDoubleArg(ValueEval arg, int srcCellRow, int srcCellCol)
protected abstract ValueEval	evaluateFunc(ValueEval[] args, int srcCellRow, int srcCellCol)
protected static int	evaluateIntArg(ValueEval arg, int srcCellRow, int srcCellCol)
protected static String	evaluateStringArg(ValueEval eval, int srcRow, int srcCol)

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

CHAR	back to summary
public static final Function CHAR Returns the character specified by a number.

CLEAN	back to summary
public static final Function CLEAN An implementation of the CLEAN function: In Excel, the Clean function removes all non-printable characters from a string. Author: Aniket Banerjee([email protected])

CONCAT	back to summary
public static final FreeRefFunction CONCAT

CONCATENATE	back to summary
public static final Function CONCATENATE

EXACT	back to summary
public static final Function EXACT

FIND back to summary

FIND	back to summary
public static final Function FIND Implementation of the FIND() function. Syntax: FIND(find_text, within_text, start_num) FIND returns the character position of the first (case sensitive) occurrence of `find_text` inside `within_text`. The third parameter, `start_num`, is optional (default=1) and specifies where to start searching from. Character positions are 1-based. Author: Torstein Tauno Svendsen ([email protected])

public static final Function FIND

Implementation of the FIND() function.

Syntax:
FIND(find_text, within_text, start_num)

FIND returns the character position of the first (case sensitive) occurrence of find_text inside within_text. The third parameter, start_num, is optional (default=1) and specifies where to start searching from. Character positions are 1-based.

Author: Torstein Tauno Svendsen ([email protected])

formatter	back to summary
protected static final DataFormatter formatter

LEFT	back to summary
public static final Function LEFT

LEN	back to summary
public static final Function LEN

LOWER	back to summary
public static final Function LOWER

MID	back to summary
public static final Function MID An implementation of the MID function MID returns a specific number of characters from a text string, starting at the specified position. Syntax: MID(text, start_num, num_chars) Author: Manda Wilson < wilson at c bio dot msk cc dot org >

MID

back to summary

public static final Function MID

An implementation of the MID function
MID returns a specific number of characters from a text string, starting at the specified position.

Syntax:
MID(text, start_num, num_chars)
Author: Manda Wilson < wilson at c bio dot msk cc dot org >

PROPER	back to summary
public static final Function PROPER Implementation of the PROPER function: Normalizes all words (separated by non-word characters) by making the first letter upper and the rest lower case. This is nearly equivalent to toTitleCase if the Java language had it

RIGHT	back to summary
public static final Function RIGHT

SEARCH	back to summary
public static final Function SEARCH Implementation of the FIND() function. Syntax: SEARCH(find_text, within_text, start_num) SEARCH is a case-insensitive version of FIND()

back to summary

public static final Function SEARCH

Implementation of the FIND() function.

Syntax:
SEARCH(find_text, within_text, start_num)

SEARCH is a case-insensitive version of FIND()

TEXT back to summary

TEXT	back to summary
public static final Function TEXT An implementation of the TEXT function TEXT returns a number value formatted with the given number formatting string. This function is not a complete implementation of the Excel function, but handles most of the common cases. All work is passed down to `DataFormatter` to be done, as this works much the same as the display focused work that that does. Syntax: TEXT(value, format_text)

public static final Function TEXT

An implementation of the TEXT function
TEXT returns a number value formatted with the given number formatting string. This function is not a complete implementation of the Excel function, but handles most of the common cases. All work is passed down to DataFormatter to be done, as this works much the same as the display focused work that that does. Syntax:
TEXT(value, format_text)

TRIM	back to summary
public static final Function TRIM An implementation of the TRIM function: Removes leading and trailing spaces from value if evaluated operand value is string. Since POI 5.1.0, this also trims double spaces so that only 1 is kept (https://bz.apache.org/bugzilla/show_bug.cgi?id=65230). Author: Manda Wilson < wilson at c bio dot msk cc dot org >

UPPER	back to summary
public static final Function UPPER

Constructor Detail

TextFunction	back to summary
public TextFunction()

Method Detail

evaluate back to summary

evaluate	back to summary
public final ValueEval evaluate(ValueEval[] args, int srcCellRow, int srcCellCol) 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`. srcCellRow:int Doc from org.apache.poi.ss.formula.functions.Function.evaluate. row index of the cell containing the formula under evaluation srcCellCol: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`. Annotations @Override

public final ValueEval evaluate(ValueEval[] args, int srcCellRow, int srcCellCol)

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.

srcCellRow:int

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

row index of the cell containing the formula under evaluation

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

Annotations

@Override

evaluateDoubleArg	back to summary
protected static double evaluateDoubleArg(ValueEval arg, int srcCellRow, int srcCellCol) throws EvaluationException

evaluateFunc	back to summary
protected abstract ValueEval evaluateFunc(ValueEval[] args, int srcCellRow, int srcCellCol) throws EvaluationException

evaluateIntArg	back to summary
protected static int evaluateIntArg(ValueEval arg, int srcCellRow, int srcCellCol) throws EvaluationException

evaluateStringArg	back to summary
protected static String evaluateStringArg(ValueEval eval, int srcRow, int srcCol) throws EvaluationException

org.apache.poi.ss.formula.functions back to summary

private final Class TextFunction.LeftRight

Class Inheritance

extends Var1or2ArgFunction

java.lang.Object
org.apache.poi.ss.formula.functions.Var1or2ArgFunction
org.apache.poi.ss.formula.functions.TextFunction.LeftRight

Field Summary

Modifier and Type	Field and Description
private final boolean	_isLeft
private static final ValueEval	DEFAULT_ARG1

Constructor Summary

Access	Constructor and Description
protected	LeftRight(boolean isLeft)

Method Summary

Modifier and Type	Method and Description
public ValueEval	evaluate(int srcRowIndex, int srcColumnIndex, ValueEval arg0) Implements org.apache.poi.ss.formula.functions.Function1Arg.evaluate. see `Function#evaluate(ValueEval[], int, int)`
public ValueEval	evaluate(int srcRowIndex, int srcColumnIndex, ValueEval arg0, ValueEval arg1) Implements org.apache.poi.ss.formula.functions.Function2Arg.evaluate. see `Function#evaluate(ValueEval[], int, int)`

Inherited from org.apache.poi.ss.formula.functions.Var1or2ArgFunction:: evaluate

Field Detail

_isLeft	back to summary
private final boolean _isLeft

DEFAULT_ARG1	back to summary
private static final ValueEval DEFAULT_ARG1

Constructor Detail

LeftRight	back to summary
protected LeftRight(boolean isLeft)

Method Detail

evaluate back to summary

evaluate	back to summary
public ValueEval evaluate(int srcRowIndex, int srcColumnIndex, ValueEval arg0) Implements org.apache.poi.ss.formula.functions.Function1Arg.evaluate. Doc from org.apache.poi.ss.formula.functions.Function1Arg.evaluate. see `Function#evaluate(ValueEval[], int, int)` Annotations @Override

public ValueEval evaluate(int srcRowIndex, int srcColumnIndex, ValueEval arg0)

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

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

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

Annotations

@Override

evaluate back to summary

evaluate	back to summary
public ValueEval evaluate(int srcRowIndex, int srcColumnIndex, ValueEval arg0, ValueEval arg1) Implements org.apache.poi.ss.formula.functions.Function2Arg.evaluate. Doc from org.apache.poi.ss.formula.functions.Function2Arg.evaluate. see `Function#evaluate(ValueEval[], int, int)` Annotations @Override

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

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

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

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

Annotations

@Override

org.apache.poi.ss.formula.functions back to summary

private final Class TextFunction.SearchFind

Class Inheritance

extends Var2or3ArgFunction

java.lang.Object
org.apache.poi.ss.formula.functions.Var2or3ArgFunction
org.apache.poi.ss.formula.functions.TextFunction.SearchFind

Field Summary

Modifier and Type	Field and Description
private final boolean	_isCaseSensitive

Constructor Summary

Access	Constructor and Description
public	SearchFind(boolean isCaseSensitive)

Method Summary

Modifier and Type	Method and Description
private ValueEval	eval(String haystack, String needle, int startIndex)
public ValueEval	evaluate(int srcRowIndex, int srcColumnIndex, ValueEval arg0, ValueEval arg1) Implements org.apache.poi.ss.formula.functions.Function2Arg.evaluate. see `Function#evaluate(ValueEval[], int, int)`
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)`

Inherited from org.apache.poi.ss.formula.functions.Var2or3ArgFunction:: evaluate

Field Detail

_isCaseSensitive	back to summary
private final boolean _isCaseSensitive

Constructor Detail

SearchFind	back to summary
public SearchFind(boolean isCaseSensitive)

Method Detail

eval	back to summary
private ValueEval eval(String haystack, String needle, int startIndex)

evaluate back to summary

evaluate	back to summary
public ValueEval evaluate(int srcRowIndex, int srcColumnIndex, ValueEval arg0, ValueEval arg1) Implements org.apache.poi.ss.formula.functions.Function2Arg.evaluate. Doc from org.apache.poi.ss.formula.functions.Function2Arg.evaluate. see `Function#evaluate(ValueEval[], int, int)` Annotations @Override

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

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

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

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

Annotations

@Override

evaluate back to summary

evaluate	back 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)` Annotations @Override

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)

Annotations

@Override

org.apache.poi.ss.formula.functions back to summary

private abstract Class TextFunction.SingleArgTextFunc

Class Inheritance

extends Fixed1ArgFunction

java.lang.Object
org.apache.poi.ss.formula.functions.Fixed1ArgFunction
org.apache.poi.ss.formula.functions.TextFunction.SingleArgTextFunc

Constructor Summary

Access	Constructor and Description
protected	SingleArgTextFunc()

Method Summary

Modifier and Type	Method and Description
public ValueEval	evaluate(int srcRowIndex, int srcColumnIndex, ValueEval arg0) Implements org.apache.poi.ss.formula.functions.Function1Arg.evaluate. see `Function#evaluate(ValueEval[], int, int)`
protected abstract ValueEval	evaluate(String arg)

Inherited from org.apache.poi.ss.formula.functions.Fixed1ArgFunction:: evaluate

Constructor Detail

SingleArgTextFunc	back to summary
protected SingleArgTextFunc()

Method Detail

evaluate back to summary

evaluate	back to summary
public ValueEval evaluate(int srcRowIndex, int srcColumnIndex, ValueEval arg0) Implements org.apache.poi.ss.formula.functions.Function1Arg.evaluate. Doc from org.apache.poi.ss.formula.functions.Function1Arg.evaluate. see `Function#evaluate(ValueEval[], int, int)` Annotations @Override

public ValueEval evaluate(int srcRowIndex, int srcColumnIndex, ValueEval arg0)

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

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

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

Annotations

@Override

evaluate	back to summary
protected abstract ValueEval evaluate(String arg)

public abstract Class TextFunction

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

private final Class TextFunction.LeftRight

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

private final Class TextFunction.SearchFind

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

private abstract Class TextFunction.SingleArgTextFunc

Constructor Summary

Method Summary

Constructor Detail

Method Detail