org.hibernate.spatial
Enum SpatialFunction

java.lang.Object
  extended by java.lang.Enum<SpatialFunction>
      extended by org.hibernate.spatial.SpatialFunction
All Implemented Interfaces:
java.io.Serializable, java.lang.Comparable<SpatialFunction>

public enum SpatialFunction
extends java.lang.Enum<SpatialFunction>

Spatial functions that users generally expect in a database.


Enum Constant Summary
asbinary
           
astext
           
boundary
           
buffer
           
contains
           
convexhull
           
crosses
           
difference
           
dimension
           
disjoint
           
distance
           
dwithin
           
envelope
           
equals
           
geometrytype
           
geomunion
           
intersection
           
intersects
           
isempty
           
issimple
           
overlaps
           
relate
           
srid
           
symdifference
           
touches
           
transform
           
within
           
 
Method Summary
static SpatialFunction valueOf(java.lang.String name)
          Returns the enum constant of this type with the specified name.
static SpatialFunction[] values()
          Returns an array containing the constants of this enum type, in the order they are declared.
 
Methods inherited from class java.lang.Enum
compareTo, equals, getDeclaringClass, hashCode, name, ordinal, toString, valueOf
 
Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait
 

Enum Constant Detail

dimension

public static final SpatialFunction dimension

geometrytype

public static final SpatialFunction geometrytype

srid

public static final SpatialFunction srid

envelope

public static final SpatialFunction envelope

astext

public static final SpatialFunction astext

asbinary

public static final SpatialFunction asbinary

isempty

public static final SpatialFunction isempty

issimple

public static final SpatialFunction issimple

boundary

public static final SpatialFunction boundary

equals

public static final SpatialFunction equals

disjoint

public static final SpatialFunction disjoint

intersects

public static final SpatialFunction intersects

touches

public static final SpatialFunction touches

crosses

public static final SpatialFunction crosses

within

public static final SpatialFunction within

contains

public static final SpatialFunction contains

overlaps

public static final SpatialFunction overlaps

relate

public static final SpatialFunction relate

distance

public static final SpatialFunction distance

buffer

public static final SpatialFunction buffer

convexhull

public static final SpatialFunction convexhull

intersection

public static final SpatialFunction intersection

geomunion

public static final SpatialFunction geomunion

difference

public static final SpatialFunction difference

symdifference

public static final SpatialFunction symdifference

dwithin

public static final SpatialFunction dwithin

transform

public static final SpatialFunction transform
Method Detail

values

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

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

valueOf

public static SpatialFunction valueOf(java.lang.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:
java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
java.lang.NullPointerException - if the argument is null