org.locationtech.geowave.core.geotime.store.query.filter.expression.spatial

Interface SpatialExpression

All Superinterfaces:

Expression<FilterGeometry>, Persistable

All Known Implementing Classes:

SpatialFieldValue, SpatialLiteral, TextToSpatialExpression

public interface SpatialExpression
extends Expression<FilterGeometry>

Interface for expressions that resolve to spatial geometry objects.

Method Summary

Modifier and Type	Method and Description
default Predicate	bbox(double minX, double minY, double maxX, double maxY) Create a predicate that tests this expression against the provided bounding box.
default Predicate	bbox(double minX, double minY, double maxX, double maxY, org.opengis.referencing.crs.CoordinateReferenceSystem crs) Create a predicate that tests this expression against the provided bounding box in the given coordinate reference system.
default Predicate	bboxLoose(double minX, double minY, double maxX, double maxY) Create a predicate that loosely tests this expression against the provided bounding box.
default Predicate	bboxLoose(double minX, double minY, double maxX, double maxY, org.opengis.referencing.crs.CoordinateReferenceSystem crs) Create a predicate that loosely tests this expression against the provided bounding box in the given coordinate reference system.
default Predicate	contains(Object other) Create a predicate that tests to see if this expression contains the provided spatial object.
default Predicate	crosses(Object other) Create a predicate that tests to see if this expression crosses the provided spatial object.
default Predicate	disjoint(Object other) Create a predicate that tests to see if this expression is disjoint to the provided spatial object.
default Predicate	disjointLoose(Object other) Create a predicate that tests to see if this expression is disjoint to the provided spatial object.
org.opengis.referencing.crs.CoordinateReferenceSystem	getCRS(DataTypeAdapter<?> adapter) Get the coordinate reference system for this expression.
default Predicate	intersects(Object other) Create a predicate that tests to see if this expression intersects the provided spatial object.
default Predicate	intersectsLoose(Object other) Create a predicate that tests to see if this expression intersects the provided spatial object.
default Predicate	isEqualTo(Object other) Create a predicate that tests to see if this expression is topologically equal to the provided spatial object.
default Predicate	isNotEqualTo(Object other) Create a predicate that tests to see if this expression is not topologically equal to the provided spatial object.
default Predicate	overlaps(Object other) Create a predicate that tests to see if this expression overlaps the provided spatial object.
static SpatialExpression	toSpatialExpression(Object obj) Convert the given object into a spatial expression, if it is not already one.
default Predicate	touches(Object other) Create a predicate that tests to see if this expression touches the provided spatial object.
default Predicate	within(Object other) Create a predicate that tests to see if this expression is within the provided spatial object.

Methods inherited from interface org.locationtech.geowave.core.store.query.filter.expression.Expression

addReferencedFields, evaluateValue, evaluateValue, isLiteral, isNotNull, isNull

Methods inherited from interface org.locationtech.geowave.core.index.persist.Persistable

fromBinary, toBinary

Method Detail

getCRS

org.opengis.referencing.crs.CoordinateReferenceSystem getCRS(DataTypeAdapter<?> adapter)

Get the coordinate reference system for this expression. In cases where a field value geometry is not indexed, the CRS will be derived from the field descriptor of the adapter.

Parameters:

adapter - the adapter being filtered

Returns:

the coordinate reference system of this expression

bbox

default Predicate bbox(double minX,
                       double minY,
                       double maxX,
                       double maxY)

Create a predicate that tests this expression against the provided bounding box.

Parameters:

minX - the minimum X value

minY - the minimum Y value

maxX - the maximum X value

maxY - the maximum Y value

Returns:

the bounding box predicate

bbox

default Predicate bbox(double minX,
                       double minY,
                       double maxX,
                       double maxY,
                       org.opengis.referencing.crs.CoordinateReferenceSystem crs)

Create a predicate that tests this expression against the provided bounding box in the given coordinate reference system.

Parameters:

minX - the minimum X value

minY - the minimum Y value

maxX - the maximum X value

maxY - the maximum Y value

crs - the coordinate reference system of the bounding box

Returns:

the bounding box predicate

bboxLoose

default Predicate bboxLoose(double minX,
                            double minY,
                            double maxX,
                            double maxY)

Create a predicate that loosely tests this expression against the provided bounding box. This is meant to be a faster implementation for situations where exact accuracy is not needed.

Parameters:

minX - the minimum X value

minY - the minimum Y value

maxX - the maximum X value

maxY - the maximum Y value

Returns:

the bounding box predicate

bboxLoose

default Predicate bboxLoose(double minX,
                            double minY,
                            double maxX,
                            double maxY,
                            org.opengis.referencing.crs.CoordinateReferenceSystem crs)

Create a predicate that loosely tests this expression against the provided bounding box in the given coordinate reference system. This is meant to be a faster implementation for situations where exact accuracy is not needed.

Parameters:

minX - the minimum X value

minY - the minimum Y value

maxX - the maximum X value

maxY - the maximum Y value

crs - the coordinate reference system of the bounding box

Returns:

the bounding box predicate

intersects

default Predicate intersects(Object other)

Create a predicate that tests to see if this expression intersects the provided spatial object. The operand can be either another spatial expression, or any object that can be converted to a spatial literal.

Parameters:

other - the spatial object to test against

Returns:

the intersection predicate

intersectsLoose

default Predicate intersectsLoose(Object other)

Create a predicate that tests to see if this expression intersects the provided spatial object. This is meant to be a faster implementation for situations where accuracy is not needed. The operand can be either another spatial expression, or any object that can be converted to a spatial literal.

Parameters:

other - the spatial object to test against

Returns:

the intersection predicate

disjoint

default Predicate disjoint(Object other)

Create a predicate that tests to see if this expression is disjoint to the provided spatial object. The operand can be either another spatial expression, or any object that can be converted to a spatial literal.

Parameters:

other - the spatial object to test against

Returns:

the disjoint predicate

disjointLoose

default Predicate disjointLoose(Object other)

Create a predicate that tests to see if this expression is disjoint to the provided spatial object. This is meant to be a faster implementation for situations where accuracy is not needed. The operand can be either another spatial expression, or any object that can be converted to a spatial literal.

Parameters:

other - the spatial object to test against

Returns:

the disjoint predicate

contains

default Predicate contains(Object other)

Create a predicate that tests to see if this expression contains the provided spatial object. The operand can be either another spatial expression, or any object that can be converted to a spatial literal.

Parameters:

other - the spatial object to test against

Returns:

the contains predicate

within

default Predicate within(Object other)

Create a predicate that tests to see if this expression is within the provided spatial object. The operand can be either another spatial expression, or any object that can be converted to a spatial literal.

Parameters:

other - the spatial object to test against

Returns:

the within predicate

touches

default Predicate touches(Object other)

Create a predicate that tests to see if this expression touches the provided spatial object. The operand can be either another spatial expression, or any object that can be converted to a spatial literal.

Parameters:

other - the spatial object to test against

Returns:

the touches predicate

crosses

default Predicate crosses(Object other)

Create a predicate that tests to see if this expression crosses the provided spatial object. The operand can be either another spatial expression, or any object that can be converted to a spatial literal.

Parameters:

other - the spatial object to test against

Returns:

the crosses predicate

overlaps

default Predicate overlaps(Object other)

Create a predicate that tests to see if this expression overlaps the provided spatial object. The operand can be either another spatial expression, or any object that can be converted to a spatial literal.

Parameters:

other - the spatial object to test against

Returns:

the overlaps predicate

isEqualTo

default Predicate isEqualTo(Object other)

Create a predicate that tests to see if this expression is topologically equal to the provided spatial object. The operand can be either another spatial expression, or any object that can be converted to a spatial literal.

Specified by:

isEqualTo in interface Expression<FilterGeometry>

Parameters:

other - the spatial object to test against

Returns:

the equals predicate

isNotEqualTo

default Predicate isNotEqualTo(Object other)

Create a predicate that tests to see if this expression is not topologically equal to the provided spatial object. The operand can be either another spatial expression, or any object that can be converted to a spatial literal.

Specified by:

isNotEqualTo in interface Expression<FilterGeometry>

Parameters:

other - the spatial object to test against

Returns:

the not equals predicate

toSpatialExpression

static SpatialExpression toSpatialExpression(Object obj)

Convert the given object into a spatial expression, if it is not already one.

Parameters:

obj - the object to convert

Returns:

the spatial expression