Package org.geotools.filter.function
Class InFunction
- All Implemented Interfaces:
Expression
,Function
,FunctionExpression
,Factory
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
FieldsFields inherited from class FunctionExpressionImpl
fallback, functionName, name, params
Fields inherited from interface Expression
NIL
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionSubclass should override, default implementation returns null.int
static FilterCapabilities
Returns filter capabilities for all the "in" functionsgetName()
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 Details
-
NAME
-
-
Constructor Details
-
InFunction
public InFunction()
-
-
Method Details
-
isInFunction
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
Returns filter capabilities for all the "in" functions- Returns:
- a
FilterCapabilities
with all the functions in the "in" family
-
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
Description copied from class:FunctionExpressionImpl
Sets the function parameters.- Specified by:
setParameters
in interfaceFunctionExpression
- Overrides:
setParameters
in classFunctionExpressionImpl
-
evaluate
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
-