org.apache.poi.ss.formula.functions

Class LogicalFunction

java.lang.Object

org.apache.poi.ss.formula.functions.Fixed1ArgFunction

org.apache.poi.ss.formula.functions.LogicalFunction

All Implemented Interfaces:

ArrayFunction, Function, Function1Arg

public abstract class LogicalFunction
extends Fixed1ArgFunction
implements ArrayFunction

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

Field Summary

Fields

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

Constructor Summary

Constructors

Constructor and Description
LogicalFunction()

Method Summary

Modifier and Type	Method and Description
ValueEval	evaluate(int srcRowIndex, int srcColumnIndex, ValueEval arg0) see Function.evaluate(ValueEval[], int, int)
protected abstract boolean	evaluate(ValueEval arg)
ValueEval	evaluateArray(ValueEval[] args, int srcRowIndex, int srcColumnIndex)

Methods inherited from class org.apache.poi.ss.formula.functions.Fixed1ArgFunction

evaluate

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.apache.poi.ss.formula.functions.ArrayFunction

evaluateOneArrayArg, evaluateTwoArrayArgs

Field Detail

ISLOGICAL

public static final Function ISLOGICAL

ISNONTEXT

public static final Function ISNONTEXT

ISNUMBER

public static final Function ISNUMBER

ISTEXT

public static final Function ISTEXT

ISBLANK

public static final Function ISBLANK

ISERROR

public static final Function ISERROR

ISERR

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.

ISNA

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.

ISREF

public static final Function ISREF

Constructor Detail

LogicalFunction

public LogicalFunction()

Method Detail

evaluate

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

Description copied from interface: Function1Arg

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

Specified by:

evaluate in interface Function1Arg

evaluateArray

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

Specified by:

evaluateArray in interface ArrayFunction

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 evaluation

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

evaluate

protected abstract boolean evaluate(ValueEval arg)

Parameters:

arg - any ValueEval, potentially BlankEval or ErrorEval.