Module org.opengis.geoapi

Package org.opengis.filter

Interface BinaryComparisonOperator<R>

Type Parameters:

R - the type of resources (e.g. Feature) to filter.

All Superinterfaces:

ComparisonOperator<R>, Filter<R>, Predicate<R>

@UML(identifier="BinaryComparisonOperator",
     specification=ISO_19143)
public interface BinaryComparisonOperator<R>
extends ComparisonOperator<R>

An operator that evaluates the mathematical comparison between two arguments. If the arguments satisfy the comparison then the filter evaluates to true. Otherwise the filter evaluates to false.

The nature of the comparison is dependent on the operator type. A standard set of comparison operators is equal to, less than, greater than, less than or equal to, greater than or equal to and not equal to.

Since:

3.1

Method Summary

Modifier and Type	Method	Description
List<Expression<R,?>>	getExpressions()	Returns the two expressions to be compared by this operator.
default MatchAction	getMatchAction()	Specifies how the comparison predicate shall be evaluated for a collection of values.
default Expression<R,?>	getOperand1()	Returns the element on the left side of the comparison expression.
default Expression<R,?>	getOperand2()	Returns the element on the right side of the comparison expression.
default boolean	isMatchingCase()	Specifies how a filter expression processor should perform string comparisons.

Methods inherited from interface org.opengis.filter.ComparisonOperator

getOperatorType

Methods inherited from interface org.opengis.filter.Filter

getResourceClass, test

Methods inherited from interface java.util.function.Predicate

and, negate, or

Method Details

getExpressions

@UML(identifier="expression",
     obligation=MANDATORY,
     specification=ISO_19143)
List<Expression<R,?>> getExpressions()

Returns the two expressions to be compared by this operator. The expressions can be of any kind.

Specified by:

getExpressions in interface Filter<R>

Returns:

a list of size 2 containing the two expressions to be compared.

getOperand1

default Expression<R,?> getOperand1()

Returns the element on the left side of the comparison expression. This is the element at index 0 in the list of expressions.

Returns:

the first element in the list of expressions.

getOperand2

default Expression<R,?> getOperand2()

Returns the element on the right side of the comparison expression. This is the element at index 1 in the list of expressions.

Returns:

the second element in the list of expressions.

isMatchingCase

@UML(identifier="matchCase",
     obligation=OPTIONAL,
     specification=ISO_19143)
default boolean isMatchingCase()

Specifies how a filter expression processor should perform string comparisons. A value of true means that string comparisons shall match case. The value false means that string comparisons are performed caselessly. The default value true.

Returns:

true if comparisons are case sensitive, otherwise false.

getMatchAction

@UML(identifier="matchAction",
     obligation=OPTIONAL,
     specification=ISO_19143)
default MatchAction getMatchAction()

Specifies how the comparison predicate shall be evaluated for a collection of values. Values can be ALL if all values in the collection shall satisfy the predicate, ANY if any of the value in the collection can satisfy the predicate, or ONE if only one of the values in the collection shall satisfy the predicate. The default value is ANY.

Returns:

how the comparison predicate shall be evaluated for a collection of values. Shall not be null.