public enum GeospatialOperator extends Enum<GeospatialOperator> implements Operator
Enum Constant and Description |
---|
GEO_WITHIN
Operator to return documents that are within a GeoJSON shape.
|
INTERSECT
Operator to return documents that intersect the GeoJSON shape.
|
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.
|
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 |
GEOMETRY
The name for the GeoJSON region with a
INTERSECT query. |
static String |
POLYGON
The name for the polygon region with a
WITHIN query. |
static Version |
POLYGON_VERSION
The version (2.0) of the MongoDB server that added support for the
"$polygon" modifier of
$within |
static String |
SPHERICAL_CIRCLE
The name for the circular region on a sphere with a
WITHIN
query. |
static String |
UNIQUE_DOCS_MODIFIER
Deprecated.
Support for "$uniqueDocs" was removed in MongoDB 2.6.
|
static Version |
UNIQUE_DOCS_REMOVED_VERSION
The version (2.5) of the MongoDB server that removed support for the
"$uniqueDocs" modifier.
|
Modifier and Type | Method and Description |
---|---|
String |
getToken()
The token for the operator that can be sent to the server.
|
Version |
getVersion()
Returns the first MongoDB version to support the operator.
|
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.
|
public static final GeospatialOperator GEO_WITHIN
public static final GeospatialOperator INTERSECT
public static final GeospatialOperator MAX_DISTANCE_MODIFIER
NEAR
operator to limit the documents
returned based on their distance from the the center point.public static final GeospatialOperator NEAR
public static final GeospatialOperator NEAR_SPHERE
public static final GeospatialOperator WITHIN
public static final String BOX
WITHIN
query.public static final String CIRCLE
WITHIN
query.public static final String GEOMETRY
INTERSECT
query.public static final String POLYGON
WITHIN
query.public static final Version POLYGON_VERSION
$within
public static final String SPHERICAL_CIRCLE
WITHIN
query.@Deprecated public static final String UNIQUE_DOCS_MODIFIER
WITHIN
operator to determine if duplicate
documents should be returned.public static final Version UNIQUE_DOCS_REMOVED_VERSION
public static GeospatialOperator[] values()
for (GeospatialOperator c : GeospatialOperator.values()) System.out.println(c);
public static GeospatialOperator valueOf(String name)
name
- the name of the enum constant to be returned.IllegalArgumentException
- if this enum type has no constant
with the specified nameNullPointerException
- if the argument is nullpublic String getToken()
public Version getVersion()
getVersion
in interface Operator
null
then the version is not known and can be
assumed to be all currently supported versions.Copyright © 2011–2014 Allanbank Consulting, Inc.. All rights reserved.