Package org.geotools.api.filter.spatial

A spatial operator determines whether its geometric arguments satisfy the stated spatial relationship. The operator evaluates to true if the spatial relationship is satisfied. Otherwise the operator evaluates to false. The following is adapted from Filter encoding implementation:

Spatial operators are used to test whether the value of a geometric property, potentially referenced using the name of the property, and a (potentially literal) geometric value satisfy the spatial relationship implied by the operator. For example, the org.opengis.filter.spatial.Overlaps operator evaluates whether the value of the specified geometric property and the specified literal geometric value spatially overlap.

The org.opengis.filter.spatial.BBOX element is defined as a convenient and more compact way of encoding the very common bounding box constraint based on the gml:Box geometry. The BBOX operator should identify all geometries that spatially interact with the box in some manner.

The spatial operators org.opengis.filter.spatial.DWithin and org.opengis.filter.spatial.Beyond test whether the value of a geometric property is within or beyond a specified distance of the specified literal geometric value. Distance values are expressed using the distance attribute. The content of the distance attribute represents the magnitude of the distance and the units attribute is used to specify the units of measure.

Interface Summary

Interface	Description
BBOX	Spatial operator that evaluates to true when the bounding box of the feature's geometry overlaps the bounding box provided in this object's properties.
BBOX3D	An extension to the general BBOX filter for supporting 3D Bounding Boxes that have a minimum and maximum Z-value.
Beyond	Concrete distance buffer operator that evaluates as true when all of a feature's geometry lies beyond (i.e. is more distant) than the given distance from this object's geometry.
BinarySpatialOperator	Abstract superclass for filter operators that perform some sort of spatial comparison on two geometric objects.
BoundedSpatialOperator	Marker interface for spatial operators that are a subset of the BBOX relationship.
Contains	Concrete binary spatial operator that evaluates to true if the the first geometric operand contains the second.
Crosses	Concrete binary spatial operator that evaluates to true if the first geometric operand crosses the second (in the sense defined by the OGC Simple Features specification).
Disjoint	Concrete binary spatial operator that evaluates to true if the first operand is disjoint from the second (in the sense defined in the OGC Simple Features specification).
DistanceBufferOperator	Abstract superclass for spatial operators that check that one shape satisfies some relation to a buffer around another shape.
DWithin	Concrete distance buffer operator that evaluates as true when any part of the first geometry lies within the given distance of the second geometry.
Equals	Concrete binary spatial operator that evaluates to true if the geometry of the two operands are equal.
Intersects	Concrete binary spatial operator that evaluates to true if the two geometric operands intersect.
Overlaps	Concrete binary spatial operator that evaluates to true if the interior of the first geometry somewhere overlaps the interior of the second geometry.
SpatialOperator	Abstract base class for operators that perform a spatial comparison on geometric attributes of a feature.
Touches	Concrete binary spatial operator that evaluates to true if the feature's geometry touches, but does not overlap with the geometry held by this object.
Within	Concrete binary spatial operator that evaluates to true if the feature's geometry is completely contained by the constant geometry held by this object.