Top Description Fields Constructors Methods

org.apache.poi.ss.formula.functions

public abstract Class LogicalFunction

Class Inheritance

extends Fixed1ArgFunction
implements ArrayFunction

java.lang.Object
org.apache.poi.ss.formula.functions.Fixed1ArgFunction
org.apache.poi.ss.formula.functions.LogicalFunction

All Implemented Interfaces

org.apache.poi.ss.formula.functions.ArrayFunction

Imports

org.apache.poi.ss.formula.eval.*

Implementation of the various ISxxx Logical Functions, which take a single expression argument, and return True or False.

Field Summary

Modifier and Type	Field and Description
public static final Function	ISBLANK
public static final Function	ISERR Implementation of Excel `ISERR()` function.
public static final Function	ISERROR
public static final Function	ISLOGICAL
public static final Function	ISNA Implementation for Excel ISNA() function.
public static final Function	ISNONTEXT
public static final Function	ISNUMBER
public static final Function	ISREF
public static final Function	ISTEXT

Constructor Summary

Access	Constructor and Description
public	LogicalFunction()

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 boolean	evaluate(ValueEval any `ValueEval`, potentially `BlankEval` or `ErrorEval`. arg)
public ValueEval	evaluateArray(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.ArrayFunction.evaluateArray.

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

Field Detail

ISBLANK	back to summary
public static final Function ISBLANK

ISERR back to summary

public static final Function ISERR

Implementation of Excel ISERR() function.

Syntax:
ISERR(value)

value The value to be tested

Returns the logical value TRUE if value refers to any error value except '#N/A'; otherwise, it returns FALSE.

ISERROR	back to summary
public static final Function ISERROR

ISLOGICAL	back to summary
public static final Function ISLOGICAL

ISNA back to summary

public static final Function ISNA

Implementation for Excel ISNA() function.

Syntax:
ISNA(value)

value The value to be tested

Returns TRUE if the specified value is '#N/A', FALSE otherwise.

ISNONTEXT	back to summary
public static final Function ISNONTEXT

ISNUMBER	back to summary
public static final Function ISNUMBER

ISREF	back to summary
public static final Function ISREF

ISTEXT	back to summary
public static final Function ISTEXT

Constructor Detail

LogicalFunction	back to summary
public LogicalFunction()

Method Detail

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
@SuppressWarnings:unused

evaluate	back to summary
protected abstract boolean evaluate(ValueEval arg) Parameters arg:ValueEval any `ValueEval`, potentially `BlankEval` or `ErrorEval`.

evaluateArray back to summary

public ValueEval evaluateArray(ValueEval[] args, int srcRowIndex, int srcColumnIndex)

Implements org.apache.poi.ss.formula.functions.ArrayFunction.evaluateArray.

Parameters

args:ValueEval[]

Doc from org.apache.poi.ss.formula.functions.ArrayFunction.evaluateArray.

the evaluated function arguments. Empty values are represented with BlankEval or MissingArgEval, never null.

srcRowIndex:int

Doc from org.apache.poi.ss.formula.functions.ArrayFunction.evaluateArray.

row index of the cell containing the formula under evaluation

srcColumnIndex:int

Doc from org.apache.poi.ss.formula.functions.ArrayFunction.evaluateArray.

column index of the cell containing the formula under evaluation

Returns:ValueEval

Doc from org.apache.poi.ss.formula.functions.ArrayFunction.evaluateArray.

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