Package org.apache.lucene.spatial.query
Class SpatialOperation
java.lang.Object
org.apache.lucene.spatial.query.SpatialOperation
- All Implemented Interfaces:
Serializable
A predicate that compares a stored geometry to a supplied geometry. It's enum-like. For more
explanation of each predicate, consider looking at the source implementation of
evaluate(org.locationtech.spatial4j.shape.Shape, org.locationtech.spatial4j.shape.Shape). It's
important to be aware that Lucene-spatial makes no distinction of shape boundaries, unlike many
standardized definitions. Nor does it make dimensional distinctions (e.g. line vs polygon). You
can lookup a predicate by "Covers" or "Contains", for example, and you will get the same
underlying predicate implementation.- See Also:
- WARNING: This API is experimental and might change in incompatible ways in the next release.
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final SpatialOperationBounding box of the *indexed* shape, thenIntersects.static final SpatialOperationBounding box of the *indexed* shape, thenIsWithin.static final SpatialOperationMeets the "Covers" OGC definition (boundary-neutral).static final SpatialOperationMeets the "Intersects" OGC definition.static final SpatialOperationMeets the "Disjoint" OGC definition.static final SpatialOperationMeets the "Equals" OGC definition.static final SpatialOperationMeets the "CoveredBy" OGC definition (boundary-neutral).static final SpatialOperationAlmost meets the "Overlaps" OGC definition, but boundary-neutral (boundary==interior). -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionabstract booleanevaluate(org.locationtech.spatial4j.shape.Shape indexedShape, org.locationtech.spatial4j.shape.Shape queryShape) Returns whether the relationship between indexedShape and queryShape is satisfied by this operation.static SpatialOperationgetName()static booleanis(SpatialOperation op, SpatialOperation... tst) protected voidtoString()static List<SpatialOperation> values()
-
Field Details
-
BBoxIntersects
Bounding box of the *indexed* shape, thenIntersects. -
BBoxWithin
Bounding box of the *indexed* shape, thenIsWithin. -
Contains
Meets the "Covers" OGC definition (boundary-neutral). -
Intersects
Meets the "Intersects" OGC definition. -
IsEqualTo
Meets the "Equals" OGC definition. -
IsDisjointTo
Meets the "Disjoint" OGC definition. -
IsWithin
Meets the "CoveredBy" OGC definition (boundary-neutral). -
Overlaps
Almost meets the "Overlaps" OGC definition, but boundary-neutral (boundary==interior).
-
-
Constructor Details
-
SpatialOperation
-
-
Method Details
-
register
-
get
-
values
-
is
-
evaluate
public abstract boolean evaluate(org.locationtech.spatial4j.shape.Shape indexedShape, org.locationtech.spatial4j.shape.Shape queryShape) Returns whether the relationship between indexedShape and queryShape is satisfied by this operation. -
getName
-
toString
-