Package org.springframework.data.mongodb.core.index

Enum Class GeoSpatialIndexType

java.lang.Object

java.lang.Enum<GeoSpatialIndexType>

org.springframework.data.mongodb.core.index.GeoSpatialIndexType

All Implemented Interfaces:

Serializable, Comparable<GeoSpatialIndexType>, Constable

public enum GeoSpatialIndexType
extends Enum<GeoSpatialIndexType>

Geoposatial index type.

Since:

1.4

Author:

Laurent Canet, Oliver Gierke

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
GEO_2D	Simple 2-Dimensional index for legacy-format points.
GEO_2DSPHERE	2D Index for GeoJSON-formatted data over a sphere.
GEO_HAYSTACK	An haystack index for grouping results over small results.

Method Summary

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

GEO_2D

public static final GeoSpatialIndexType GEO_2D

Simple 2-Dimensional index for legacy-format points.

GEO_2DSPHERE

public static final GeoSpatialIndexType GEO_2DSPHERE

2D Index for GeoJSON-formatted data over a sphere. Only available in Mongo 2.4.

GEO_HAYSTACK

public static final GeoSpatialIndexType GEO_HAYSTACK

An haystack index for grouping results over small results.

Method Details

values

public static GeoSpatialIndexType[] 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 GeoSpatialIndexType 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