org.hibernate.search.annotations

Enum SpatialMode

java.lang.Object

java.lang.Enum<SpatialMode>

org.hibernate.search.annotations.SpatialMode

All Implemented Interfaces:

Serializable, Comparable<SpatialMode>

public enum SpatialMode
extends Enum<SpatialMode>

Defines the index structure mode used for spatial information

Author:

Hardy Ferentschik

Enum Constant Summary

Enum Constants

Enum Constant and Description
HASH Hash mode : Spatial hash index query + distance filer
RANGE Range mode : double range query + distance filter

Method Summary

Methods

Modifier and Type	Method and Description
static SpatialMode	valueOf(String name) Returns the enum constant of this type with the specified name.
static SpatialMode[]	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

RANGE

public static final SpatialMode RANGE

Range mode : double range query + distance filter

HASH

public static final SpatialMode HASH

Hash mode : Spatial hash index query + distance filer

Method Detail

values

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

Returns:

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

valueOf

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