Package org.geotools.filter.function
Class InFunction
-
- All Implemented Interfaces:
Expression
,Function
,FunctionExpression
,Factory
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 returnsfalse
.- Author:
- Stefano Costa, GeoSolutions
-
-
Field Summary
Fields Modifier and Type Field Description static FunctionName
NAME
-
Fields inherited from class FunctionExpressionImpl
fallback, functionName, name, params
-
Fields inherited from interface Expression
NIL
-
-
Constructor Summary
Constructors Constructor Description InFunction()
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description Object
evaluate(Object feature)
Subclass should override, default implementation returns null.int
getArgCount()
static FilterCapabilities
getInCapabilities()
Returns filter capabilities for all the "in" functionsString
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", ...void
setParameters(List<Expression> parameters)
Sets the function parameters.-
Methods inherited from class FunctionExpressionImpl
accept, equals, functionName, getExpression, getFallbackValue, getFunctionName, getImplementationHints, getParameters, hashCode, setFallbackValue, toString
-
Methods inherited from class DefaultExpression
isAttributeExpression, isExpression, isFunctionExpression, isGeometryExpression, isLiteralExpression, isMathExpression
-
Methods inherited from class ExpressionAbstract
evaluate
-
Methods inherited from interface Expression
evaluate
-
-
-
-
Field Detail
-
NAME
public static FunctionName NAME
-
-
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 interfaceFunction
- Overrides:
getName
in classFunctionExpressionImpl
- Returns:
- the name of the function.
-
getArgCount
public int getArgCount()
-
setParameters
public void setParameters(List<Expression> parameters)
Description copied from class:FunctionExpressionImpl
Sets the function parameters.- Specified by:
setParameters
in interfaceFunctionExpression
- Overrides:
setParameters
in classFunctionExpressionImpl
-
evaluate
public Object evaluate(Object feature)
Description copied from class:ExpressionAbstract
Subclass should override, default implementation returns null.- Specified by:
evaluate
in interfaceExpression
- Overrides:
evaluate
in classFunctionExpressionImpl
- Returns:
- default implementation returns null
-
-