Module spring.data.mongodb

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

Class GeospatialIndex

java.lang.Object

org.springframework.data.mongodb.core.index.GeospatialIndex

All Implemented Interfaces:

IndexDefinition

public class GeospatialIndex
extends Object
implements IndexDefinition

Value object to capture data to create a geo index.

Author:

Jon Brisbin, Oliver Gierke, Laurent Canet, Christoph Strobl, Mark Paluch

Constructor Summary

Constructors

Constructor	Description
GeospatialIndex(String field)	Creates a new GeospatialIndex for the given field.

Method Summary

Modifier and Type	Method	Description
GeospatialIndex	collation(Collation collation)	Set the Collation to specify language-specific rules for string comparison, such as rules for lettercase and accent marks. NOTE: Only queries using the same Collation as the Index actually make use of the index.
org.bson.Document	getIndexKeys()	Get the Document containing properties covered by the index.
org.bson.Document	getIndexOptions()	Get the index properties such as unique,...
GeospatialIndex	named(String name)
GeospatialIndex	partial(IndexFilter filter)	Only index the documents in a collection that meet a specified filter expression.
String	toString()
GeospatialIndex	typed(GeoSpatialIndexType type)
GeospatialIndex	withAdditionalField(String fieldName)
GeospatialIndex	withBits(int bits)
GeospatialIndex	withBucketSize(double bucketSize)	Deprecated. since MongoDB server version 4.4
GeospatialIndex	withMax(int max)
GeospatialIndex	withMin(int min)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Details

GeospatialIndex

public GeospatialIndex(String field)

Creates a new GeospatialIndex for the given field.

Parameters:

field - must not be empty or null.

Method Details

named

public GeospatialIndex named(String name)

Parameters:

name - must not be null or empty.

Returns:

this.

withMin

public GeospatialIndex withMin(int min)

Parameters:

min -

Returns:

this.

withMax

public GeospatialIndex withMax(int max)

Parameters:

max -

Returns:

this.

withBits

public GeospatialIndex withBits(int bits)

Parameters:

bits -

Returns:

this.

typed

public GeospatialIndex typed(GeoSpatialIndexType type)

Parameters:

type - must not be null.

Returns:

this.

withBucketSize

@Deprecated
public GeospatialIndex withBucketSize(double bucketSize)

Deprecated.

since MongoDB server version 4.4

Parameters:

bucketSize -

Returns:

this.

withAdditionalField

public GeospatialIndex withAdditionalField(String fieldName)

Parameters:

fieldName -

Returns:

this.

partial

public GeospatialIndex partial(@Nullable
 IndexFilter filter)

Only index the documents in a collection that meet a specified filter expression.

Parameters:

filter - can be null.

Returns:

this.

Since:

1.10

See Also:

• https://docs.mongodb.com/manual/core/index-partial/

collation

public GeospatialIndex collation(@Nullable
 Collation collation)

Set the Collation to specify language-specific rules for string comparison, such as rules for lettercase and accent marks.
NOTE: Only queries using the same Collation as the Index actually make use of the index.

Parameters:

collation - can be null.

Returns:

this.

Since:

2.0

getIndexKeys

public org.bson.Document getIndexKeys()

Description copied from interface: IndexDefinition

Get the Document containing properties covered by the index.

Specified by:

getIndexKeys in interface IndexDefinition

Returns:

never null.

getIndexOptions

public org.bson.Document getIndexOptions()

Description copied from interface: IndexDefinition

Get the index properties such as unique,...

Specified by:

getIndexOptions in interface IndexDefinition

Returns:

never null.

toString

public String toString()

Overrides:

toString in class Object