org.apache.sedona.core.enums

Enum SpatialJoinOptimizationMode

java.lang.Object

java.lang.Enum<SpatialJoinOptimizationMode>

org.apache.sedona.core.enums.SpatialJoinOptimizationMode

All Implemented Interfaces:

Serializable, Comparable<SpatialJoinOptimizationMode>

public enum SpatialJoinOptimizationMode
extends Enum<SpatialJoinOptimizationMode>

Enum Constant Summary

Enum Constants

Enum Constant and Description
ALL Optimize all spatial joins, even though the join is an equi-join.
NONE Don't optimize spatial joins, just leave them as they are (cartesian join or broadcast nested loop join).
NONEQUI Optimize spatial joins that are not equi-join, this is the default mode.

Method Summary

Modifier and Type	Method and Description
static SpatialJoinOptimizationMode	getSpatialJoinOptimizationMode(String str)
static SpatialJoinOptimizationMode	valueOf(String name) Returns the enum constant of this type with the specified name.
static SpatialJoinOptimizationMode[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

NONE

public static final SpatialJoinOptimizationMode NONE

Don't optimize spatial joins, just leave them as they are (cartesian join or broadcast nested loop join).

ALL

public static final SpatialJoinOptimizationMode ALL

Optimize all spatial joins, even though the join is an equi-join. For example, for a range join like this:

SELECT * FROM A, B WHERE A.x = B.x AND ST_Contains(A.geom, B.geom)

The join will still be optimized to a spatial range join.

NONEQUI

public static final SpatialJoinOptimizationMode NONEQUI

Optimize spatial joins that are not equi-join, this is the default mode.

For example, for a range join like this:

SELECT * FROM A, B WHERE A.x = B.x AND ST_Contains(A.geom, B.geom)

It won't be optimized as a spatial join, since it is an equi-join (with equi-condition: A.x = B.x), and could be executed by a sort-merge join or hash join.

Method Detail

values

public static SpatialJoinOptimizationMode[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (SpatialJoinOptimizationMode c : SpatialJoinOptimizationMode.values())
    System.out.println(c);

Returns:

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

valueOf

public static SpatialJoinOptimizationMode valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (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 type has no constant with the specified name

NullPointerException - if the argument is null

getSpatialJoinOptimizationMode

public static SpatialJoinOptimizationMode getSpatialJoinOptimizationMode(String str)