com.allanbank.mongodb.builder

Enum GeospatialOperator

java.lang.Object

java.lang.Enum<GeospatialOperator>

com.allanbank.mongodb.builder.GeospatialOperator

All Implemented Interfaces:

Operator, Serializable, Comparable<GeospatialOperator>

public enum GeospatialOperator
extends Enum<GeospatialOperator>
implements Operator

GeospatialOperator provides the enumeration of geospatial operators.

API Notice:

This enumeration is part of the driver's API. Public and protected members will be deprecated for at least 1 non-bugfix release (version numbers are <major>.<minor>.<bugfix>) before being removed or modified.

Copyright ©:

2012, Allanbank Consulting, Inc., All Rights Reserved

Enum Constant Summary

Enum Constants

Enum Constant and Description
MAX_DISTANCE_MODIFIER The modifier for the NEAR operator to limit the documents returned based on their distance from the the center point.
NEAR Operator to return documents near a given point.
NEAR_SPHERE Operator to return documents near a given point.
WITHIN Operator to return documents within a bounding shape.

Field Summary

Fields

Modifier and Type	Field and Description
static String	BOX The name for the rectangular region with a WITHIN query.
static String	CIRCLE The name for the circular region with a WITHIN query.
static String	POLYGON The name for the polygon region with a WITHIN query.
static String	SPHERICAL_CIRCLE The name for the circular region on a sphere with a WITHIN query.
static String	UNIQUE_DOCS_MODIFIER The modifier for the WITHIN operator to determine if duplicate documents should be returned.

Method Summary

Methods

Modifier and Type	Method and Description
String	getToken() The token for the operator that can be sent to the server.
static GeospatialOperator	valueOf(String name) Returns the enum constant of this type with the specified name.
static GeospatialOperator[]	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

MAX_DISTANCE_MODIFIER

public static final GeospatialOperator MAX_DISTANCE_MODIFIER

The modifier for the NEAR operator to limit the documents returned based on their distance from the the center point.

NEAR

public static final GeospatialOperator NEAR

Operator to return documents near a given point.

NEAR_SPHERE

public static final GeospatialOperator NEAR_SPHERE

Operator to return documents near a given point.

WITHIN

public static final GeospatialOperator WITHIN

Operator to return documents within a bounding shape.

Field Detail

BOX

public static final String BOX

The name for the rectangular region with a WITHIN query.

See Also:

Constant Field Values

CIRCLE

public static final String CIRCLE

The name for the circular region with a WITHIN query.

See Also:

Constant Field Values

POLYGON

public static final String POLYGON

The name for the polygon region with a WITHIN query.

See Also:

Constant Field Values

SPHERICAL_CIRCLE

public static final String SPHERICAL_CIRCLE

The name for the circular region on a sphere with a WITHIN query.

See Also:

Constant Field Values

UNIQUE_DOCS_MODIFIER

public static final String UNIQUE_DOCS_MODIFIER

The modifier for the WITHIN operator to determine if duplicate documents should be returned.

See Also:

Constant Field Values

Method Detail

values

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

Returns:

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

valueOf

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

getToken

public String getToken()

The token for the operator that can be sent to the server.

Specified by:

getToken in interface Operator

Returns:

The token for the operator.