Package org.apache.sedona.core.spatialOperator

Enum Class SpatialPredicate

java.lang.Object

java.lang.Enum<SpatialPredicate>

org.apache.sedona.core.spatialOperator.SpatialPredicate

All Implemented Interfaces:

Serializable, Comparable<SpatialPredicate>, java.lang.constant.Constable

public enum SpatialPredicate
extends Enum<SpatialPredicate>

Spatial predicates for range queries and join queries. Please refer to Spatial predicates for the semantics of these spatial predicates.

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
CONTAINS
COVERED_BY
COVERS
CROSSES
EQUALS
INTERSECTS
KNN
OVERLAPS
TOUCHES
WITHIN

Method Summary

Modifier and Type	Method	Description
static SpatialPredicate	inverse(SpatialPredicate predicate)	Get inverse predicate of given spatial predicate
static SpatialPredicate	valueOf(String name)	Returns the enum constant of this class with the specified name.
static SpatialPredicate[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

CONTAINS

public static final SpatialPredicate CONTAINS

INTERSECTS

public static final SpatialPredicate INTERSECTS

WITHIN

public static final SpatialPredicate WITHIN

COVERS

public static final SpatialPredicate COVERS

COVERED_BY

public static final SpatialPredicate COVERED_BY

TOUCHES

public static final SpatialPredicate TOUCHES

OVERLAPS

public static final SpatialPredicate OVERLAPS

CROSSES

public static final SpatialPredicate CROSSES

EQUALS

public static final SpatialPredicate EQUALS

KNN

public static final SpatialPredicate KNN

Method Details

values

public static SpatialPredicate[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

an array containing the constants of this enum class, in the order they are declared

valueOf

public static SpatialPredicate valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum class has no constant with the specified name

NullPointerException - if the argument is null

inverse

public static SpatialPredicate inverse(SpatialPredicate predicate)

Get inverse predicate of given spatial predicate

Parameters:

predicate - spatial predicate

Returns:

inverse predicate