org.opengis.filter

Interface Filter

All Known Subinterfaces:

And, BBOX, Beyond, BinaryComparisonOperator, BinaryLogicOperator, BinarySpatialOperator, Contains, Crosses, Disjoint, DistanceBufferOperator, DWithin, Equals, FeatureId, Intersects, Not, Or, Overlaps, PropertyIsBetween, PropertyIsEqualTo, PropertyIsGreaterThan, PropertyIsGreaterThanOrEqualTo, PropertyIsLessThan, PropertyIsLessThanOrEqualTo, PropertyIsLike, PropertyIsNull, SpatialOperator, Touches, Within

@XmlElement(value="Filter")
public interface Filter

The abstract base class for filters.

A filter defines a constraint that can be checked against an instance of an Object.

Often a filter is used to to define a set feature instances that are to be operated upon. The operating set can be comprised of one or more enumerated features or a set of features defined by specifying spatial and non-spatial constraints on the geometric and scalar properties of a feature type.

Roughly speaking, a filter encodes the information present in the WHERE clause of a SQL statement. There are various subclasses of this class that implement many types of filters, such as simple property comparisons or spatial queries.

The second use of Filter focuses on expressing constraints (or Facets). This use places restrictions on the allowable and is captured as part of schema information (@linkplain FeatureType). This is similar to the XML concept of "facets".

Since:

GeoAPI 2.0

Method Summary

Modifier and Type	Method and Description
java.lang.Object	accept(FilterVisitor visitor, java.lang.Object extraData) Accepts a visitor.
boolean	evaluate(Feature feature) Given a feature, this method determines whether the feature passes the test(s) represented by this filter object.
boolean	evaulate(java.lang.Object object) Give an object, this method determines if the test(s) represented by this filter object are passed.

Method Detail

evaluate

@Extension
boolean evaluate(Feature feature)

Given a feature, this method determines whether the feature passes the test(s) represented by this filter object.

Parameters:

feature -

Returns:

true if feature passes test(s) represented by this filter

evaulate

boolean evaulate(java.lang.Object object)

Give an object, this method determines if the test(s) represented by this filter object are passed.

This ability is used to allow Queries against non feature data (such as Record) and to express constraints on permissable data values.

Parameters:

object -

Returns:

true if the test(s) are passed for the provided object

accept

@Extension
java.lang.Object accept(FilterVisitor visitor,
                                   java.lang.Object extraData)

Accepts a visitor.

Implementations of all subinterfaces must have with a method whose content is the following:

return visitor.visit(this, extraData);