org.springframework.data.mongodb.core.index
Annotation Type GeoSpatialIndexed

@Target(value=FIELD)
@Retention(value=RUNTIME)
public @interface GeoSpatialIndexed

Mark a field to be indexed using MongoDB's geospatial indexing feature.

Author:

Jon Brisbin, Laurent Canet, Thomas Darimont

Optional Element Summary

String	additionalField The name of the additional field to use for GeoSpatialIndexType.GEO_HAYSTACK indexes
int	bits Bits of precision for boundary calculations.
double	bucketSize The bucket size for GeoSpatialIndexType.GEO_HAYSTACK indexes, in coordinate units.
String	collection Name of the collection in which to create the index.
int	max Maximum value for indexed values.
int	min Minimum value for indexed values.
String	name Index name.
GeoSpatialIndexType	type The type of the geospatial index.
boolean	useGeneratedName If set to true then MongoDB will ignore the given index name and instead generate a new name.

name

public abstract String name

Index name.

The name will only be applied as is when defined on root level. For usage on nested or embedded structures the provided name will be prefixed with the path leading to the entity.

The structure below

 
 @Document
 class Root {
   Hybrid hybrid;
   Nested nested;
 }
 
 @Document
 class Hybrid {
   @GeoSpatialIndexed(name="index") Point h1;
 }
 
 class Nested {
   @GeoSpatialIndexed(name="index") Point n1;
 }
 
 

resolves in the following index structures

 
 db.root.ensureIndex( { hybrid.h1: "2d" } , { name: "hybrid.index" } )
 db.root.ensureIndex( { nested.n1: "2d" } , { name: "nested.index" } )
 db.hybrid.ensureIndex( { h1: "2d" } , { name: "index" } )
 
 

Returns:

Default:

""

useGeneratedName

public abstract boolean useGeneratedName

If set to true then MongoDB will ignore the given index name and instead generate a new name. Defaults to false.

Returns:

Since:

1.5

Default:

false

collection

public abstract String collection

Name of the collection in which to create the index.

Returns:

Default:

""

min

public abstract int min

Minimum value for indexed values.

Returns:

Default:

-180

max

public abstract int max

Maximum value for indexed values.

Returns:

Default:

180

bits

public abstract int bits

Bits of precision for boundary calculations.

Returns:

Default:

26

type

public abstract GeoSpatialIndexType type

The type of the geospatial index. Default is GeoSpatialIndexType.GEO_2D

Returns:

Since:

1.4

Default:

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

bucketSize

public abstract double bucketSize

The bucket size for GeoSpatialIndexType.GEO_HAYSTACK indexes, in coordinate units.

Returns:

Since:

1.4

Default:

1.0

additionalField

public abstract String additionalField

The name of the additional field to use for GeoSpatialIndexType.GEO_HAYSTACK indexes

Returns:

Since:

1.4

Default:

""