Package org.geotools.api.filter

Filters features according their properties. A filter expression is a construct used to constraints the property values of an object type for the purpose of identifying a subset of object instances to be operated upon in some manner.

The following is adapted from the OpenGIS® Filter Encoding Implementation Specification:

• 02-059 1.0 Filter Encoding
• 04-095 1.1 Filter Encoding Implementation Specification

Comparison operators

A comparison operator is used to form expressions that evaluate the mathematical comparison between two arguments. If the arguments satisfy the comparison then the expression evaluates to true. Otherwise the expression evaluates to false.

In addition to the standard set (=,<,>, >=,<=,<>) of comparison operators, this package defines the elements PropertyIsLike, PropertyIsBetween and PropertyIsNull.

Logical operators

A logical operator can be used to combine one or more conditional expressions. The logical operator And evaluates to true if all the combined expressions evaluate to true. The operator Or operator evaluates to true is any of the combined expressions evaluate to true. The Not operator reverses the logical value of an expression. The elements And, Or and Not can be used to combine scalar, spatial and other logical expressions to form more complex compound expressions.

Identity

Identity can be checked using Id, selected objects will are matched against a set of org.geotools.api.filter.identiy.Identifier.

Interface Summary

Interface	Description
And	Evaluates to true if all the combined expressions evaluate to true.
BinaryComparisonOperator	Abstract base class for filters that compare exactly two values against each other.
BinaryLogicOperator	Abstract super-interface for logical operators that accept two or more other logical values as inputs.
Filter	Defines a constraint that can be checked against an instance of an object (Usually a Feature).
FilterFactory	Interface whose methods allow the caller to create instances of the various Filter and Expression subclasses.
FilterVisitor	Visitor with visit methods to be called by Filter.accept(...).
Id	A filter that passes only the Identifiers listed.
MultiValuedFilter	Defines a filter that supports filtering on multi-valued attributes.
NativeFilter	This filter should be treated as an extension point that allows the injection of a complex filtering expression defined in the language of the target data store.
Not	Reverses the logical value of an expression.
Or	Evaluates to true if any of the combined expressions evaluate to true.
PropertyIsBetween	A compact way of encoding a range check.
PropertyIsEqualTo	Filter operator that compares that its two sub-expressions are equal to each other.
PropertyIsGreaterThan	Filter operator that checks that its first sub-expression is greater than its second subexpression.
PropertyIsGreaterThanOrEqualTo	Filter operator that checks that its first sub-expression is greater or equal to its second subexpression.
PropertyIsLessThan	Filter operator that checks that its first sub-expression is less than its second subexpression.
PropertyIsLessThanOrEqualTo	Filter operator that checks that its first sub-expression is less than or equal to its second subexpression.
PropertyIsLike	Filter operator that performs the equivalent of the SQL "like" operator on properties of a feature.
PropertyIsNil	Filter operator that checks if an expression's value is nil.
PropertyIsNotEqualTo	Filter operator that compares that its two sub-expressions are not equal to each other.
PropertyIsNull	Filter operator that checks if an expression's value is null.

Class Summary

Class	Description
ExcludeFilter	Indicating "filter all", evaluates to false.
IncludeFilter	Indicating "no filtering", evaluates to true.

Enum Summary

Enum	Description
MultiValuedFilter.MatchAction	Enumerated type for MatchAction property (used by comparison and geometry operations): When one or more of the operands evaluates to multiple values rather than a single value, which action should be taken?