org.geotools.filter.function

Class InFunction

Object

ExpressionAbstract

DefaultExpression

FunctionExpressionImpl

InFunction

All Implemented Interfaces:

FunctionExpression, Factory, Expression, Function

public class InFunction
extends FunctionExpressionImpl

The function checks whether a candidate value is contained in an arbitrary long list of user provided values.

If the candidate value is found, the function returns true; otherwise, it returns false.

Author:

Stefano Costa, GeoSolutions

Field Summary

Fields

Modifier and Type	Field and Description
static FunctionName	NAME

Fields inherited from class FunctionExpressionImpl

fallback, functionName, name, params

Fields inherited from interface Expression

NIL

Constructor Summary

Constructors

Constructor and Description
InFunction()

Method Summary

Modifier and Type	Method and Description
Object	evaluate(Object feature) Subclass should override, default implementation returns null.
int	getArgCount()
static FilterCapabilities	getInCapabilities() Returns filter capabilities for all the "in" functions
String	getName() Gets the name of this function.
static boolean	isInFunction(Expression expression) Returns true if the expression is a function in the "in" family, that is, "in", "in2", "in3", ...

Methods inherited from class FunctionExpressionImpl

accept, equals, functionName, getExpression, getFallbackValue, getFunctionName, getImplementationHints, getParameters, hashCode, setFallbackValue, setParameters, toString

Methods inherited from class DefaultExpression

isAttributeExpression, isExpression, isFunctionExpression, isGeometryExpression, isLiteralExpression, isMathExpression

Methods inherited from class ExpressionAbstract

evaluate

Methods inherited from class Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface Expression

evaluate

Field Detail

NAME

public static FunctionName NAME

Constructor Detail

InFunction

public InFunction()

Method Detail

isInFunction

public static boolean isInFunction(Expression expression)

Returns true if the expression is a function in the "in" family, that is, "in", "in2", "in3", ...

Parameters:

expression - The expression to be tested

getInCapabilities

public static FilterCapabilities getInCapabilities()

Returns filter capabilities for all the "in" functions

Returns:

a FilterCapabilities with all the functions in the "in" family

getName

public String getName()

Description copied from class: FunctionExpressionImpl

Gets the name of this function.

Specified by:

getName in interface Function

Overrides:

getName in class FunctionExpressionImpl

Returns:

the name of the function.

getArgCount

public int getArgCount()

evaluate

public Object evaluate(Object feature)

Description copied from class: ExpressionAbstract

Subclass should override, default implementation returns null.

Specified by:

evaluate in interface Expression

Overrides:

evaluate in class FunctionExpressionImpl

Returns:

default implementation returns null