Package org.hibernate.spatial

Enum CommonSpatialFunction

java.lang.Object

java.lang.Enum<CommonSpatialFunction>

org.hibernate.spatial.CommonSpatialFunction

All Implemented Interfaces:

Serializable, Comparable<CommonSpatialFunction>

public enum CommonSpatialFunction
extends Enum<CommonSpatialFunction>

Functions commonly expected in databases, as defined by the SQL/MM specs

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	CommonSpatialFunction.Type

Enum Constant Summary

Enum Constants

Enum Constant	Description
ST_ASBINARY
ST_ASTEXT
ST_BOUNDARY
ST_BUFFER
ST_CONTAINS
ST_CONVEXHULL
ST_CROSSES
ST_DIFFERENCE
ST_DIMENSION
ST_DISJOINT
ST_DISTANCE
ST_ENVELOPE
ST_EQUALS
ST_GEOMETRYTYPE
ST_INTERSECTION
ST_INTERSECTS
ST_ISEMPTY
ST_ISSIMPLE
ST_OVERLAPS
ST_RELATE
ST_SRID
ST_SYMDIFFERENCE
ST_TOUCHES
ST_UNION
ST_WITHIN

Method Summary

Modifier and Type	Method	Description
FunctionKey	getKey()
int	getNumArgs()
BasicTypeReference<?>	getReturnType()
CommonSpatialFunction.Type	getType()
boolean	returnsGeometry()
static CommonSpatialFunction	valueOf(String name)	Returns the enum constant of this type with the specified name.
static CommonSpatialFunction[]	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

ST_ASTEXT

public static final CommonSpatialFunction ST_ASTEXT

ST_GEOMETRYTYPE

public static final CommonSpatialFunction ST_GEOMETRYTYPE

ST_DIMENSION

public static final CommonSpatialFunction ST_DIMENSION

ST_SRID

public static final CommonSpatialFunction ST_SRID

ST_ENVELOPE

public static final CommonSpatialFunction ST_ENVELOPE

ST_ASBINARY

public static final CommonSpatialFunction ST_ASBINARY

ST_ISEMPTY

public static final CommonSpatialFunction ST_ISEMPTY

ST_ISSIMPLE

public static final CommonSpatialFunction ST_ISSIMPLE

ST_BOUNDARY

public static final CommonSpatialFunction ST_BOUNDARY

ST_OVERLAPS

public static final CommonSpatialFunction ST_OVERLAPS

ST_INTERSECTS

public static final CommonSpatialFunction ST_INTERSECTS

ST_EQUALS

public static final CommonSpatialFunction ST_EQUALS

ST_CONTAINS

public static final CommonSpatialFunction ST_CONTAINS

ST_CROSSES

public static final CommonSpatialFunction ST_CROSSES

ST_DISJOINT

public static final CommonSpatialFunction ST_DISJOINT

ST_TOUCHES

public static final CommonSpatialFunction ST_TOUCHES

ST_WITHIN

public static final CommonSpatialFunction ST_WITHIN

ST_RELATE

public static final CommonSpatialFunction ST_RELATE

ST_DISTANCE

public static final CommonSpatialFunction ST_DISTANCE

ST_BUFFER

public static final CommonSpatialFunction ST_BUFFER

ST_CONVEXHULL

public static final CommonSpatialFunction ST_CONVEXHULL

ST_DIFFERENCE

public static final CommonSpatialFunction ST_DIFFERENCE

ST_INTERSECTION

public static final CommonSpatialFunction ST_INTERSECTION

ST_SYMDIFFERENCE

public static final CommonSpatialFunction ST_SYMDIFFERENCE

ST_UNION

public static final CommonSpatialFunction ST_UNION

Method Detail

values

public static CommonSpatialFunction[] 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 (CommonSpatialFunction c : CommonSpatialFunction.values())
    System.out.println(c);

Returns:

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

valueOf

public static CommonSpatialFunction 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

getKey

public FunctionKey getKey()

getReturnType

public BasicTypeReference<?> getReturnType()

returnsGeometry

public boolean returnsGeometry()

getNumArgs

public int getNumArgs()

getType

public CommonSpatialFunction.Type getType()