Package dev.vortex.api

Enum Class Expression.SpatialFunction

java.lang.Object

java.lang.Enum<Expression.SpatialFunction>

dev.vortex.api.Expression.SpatialFunction

All Implemented Interfaces:

Serializable, Comparable<Expression.SpatialFunction>, Constable

Enclosing class:

Expression

public static enum Expression.SpatialFunction
extends Enum<Expression.SpatialFunction>

Spatial functions over native geometries; codes must match the Rust spatial table.

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
AREA	Planar area of each geometry; zero for points and line strings.
COLLECT	Collect each list of homogeneous geometries into the matching multi-geometry.
CONTAINS	Whether the second geometry lies completely inside the first.
CONVEX_HULL	Convex hull of each multipoint, as a polygon.
DISTANCE	Planar (Euclidean) distance between two geometries.
ENVELOPE	Axis-aligned bounding box of each geometry.
INTERSECTS	Whether two geometries intersect; boundary contact counts.
LENGTH	Planar length of each lineal geometry.
MAKE_LINE	Line string from two points.

Method Summary

Modifier and Type	Method	Description
int	arity()
byte	code()
static Expression.SpatialFunction	valueOf(String name)	Returns the enum constant of this class with the specified name.
static Expression.SpatialFunction[]	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

AREA

public static final Expression.SpatialFunction AREA

Planar area of each geometry; zero for points and line strings.

COLLECT

public static final Expression.SpatialFunction COLLECT

Collect each list of homogeneous geometries into the matching multi-geometry.

CONTAINS

public static final Expression.SpatialFunction CONTAINS

Whether the second geometry lies completely inside the first.

CONVEX_HULL

public static final Expression.SpatialFunction CONVEX_HULL

Convex hull of each multipoint, as a polygon.

DISTANCE

public static final Expression.SpatialFunction DISTANCE

Planar (Euclidean) distance between two geometries.

ENVELOPE

public static final Expression.SpatialFunction ENVELOPE

Axis-aligned bounding box of each geometry.

INTERSECTS

public static final Expression.SpatialFunction INTERSECTS

Whether two geometries intersect; boundary contact counts.

LENGTH

public static final Expression.SpatialFunction LENGTH

Planar length of each lineal geometry.

MAKE_LINE

public static final Expression.SpatialFunction MAKE_LINE

Line string from two points.

Method Details

values

public static Expression.SpatialFunction[] 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 Expression.SpatialFunction 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

code

public byte code()

arity

public int arity()