Module org.opengis.geoapi

Package org.opengis.filter

Interface BetweenComparisonOperator<R>

Type Parameters:

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

All Superinterfaces:

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

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

A compact way of encoding a range check. The lower and upper boundary values are inclusive.

Since:

3.1

Method Summary

Modifier and Type	Method	Description
default Expression<? super R,?>	getExpression()	Returns the expression to be compared by this operator.
List<Expression<? super R,?>>	getExpressions()	Returns the expression to be compared by this operator, together with boundaries.
default Expression<? super R,?>	getLowerBoundary()	Returns the lower bound (inclusive) an an expression.
default ComparisonOperatorName	getOperatorType()	Returns the nature of the comparison.
default Expression<? super R,?>	getUpperBoundary()	Returns the upper bound (inclusive) as an expression.

Methods inherited from interface Filter

test

Methods inherited from interface Predicate

and, negate, or

Method Details

getOperatorType

default ComparisonOperatorName getOperatorType()

Returns the nature of the comparison. The default implementation returns PROPERTY_IS_BETWEEN.

Specified by:

getOperatorType in interface ComparisonOperator<R>

Specified by:

getOperatorType in interface Filter<R>

Returns:

the nature of the comparison.

getExpressions

List<Expression<? super R,?>> getExpressions()

Returns the expression to be compared by this operator, together with boundaries. The expressions can be of any kind.

Specified by:

getExpressions in interface Filter<R>

Returns:

a list of size 3 containing the expression to be compared, the lower boundary and the upper boundary in that order.

getExpression

@UML(identifier="expression",
     obligation=MANDATORY,
     specification=ISO_19143)
default Expression<? super R,?> getExpression()

Returns the expression to be compared by this operator. This is the element at index 0 in the expressions list.

Returns:

the expression to be compared.

getLowerBoundary

@UML(identifier="lowerBoundary",
     obligation=MANDATORY,
     specification=ISO_19143)
default Expression<? super R,?> getLowerBoundary()

Returns the lower bound (inclusive) an an expression. This is the element at index 1 in the expressions list.

Returns:

the lower bound, inclusive.

getUpperBoundary

@UML(identifier="upperBoundary",
     obligation=MANDATORY,
     specification=ISO_19143)
default Expression<? super R,?> getUpperBoundary()

Returns the upper bound (inclusive) as an expression. This is the element at index 2 in the expressions list.

Returns:

the upper bound, inclusive.