Module spring.data.mongodb

Package org.springframework.data.mongodb.core.aggregation

Class GeoNearOperation

java.lang.Object

org.springframework.data.mongodb.core.aggregation.GeoNearOperation

All Implemented Interfaces:

AggregationOperation

public class GeoNearOperation
extends Object
implements AggregationOperation

Represents a geoNear aggregation operation.

We recommend to use the static factory method Aggregation.geoNear(NearQuery, String) instead of creating instances of this class directly.

Since:

1.3

Author:

Thomas Darimont, Christoph Strobl

See Also:

• MongoDB Aggregation Framework: $geoNear

Constructor Summary

Constructors

Constructor	Description
GeoNearOperation(NearQuery nearQuery, String distanceField)	Creates a new GeoNearOperation from the given NearQuery and the given distance field.

Method Summary

Modifier and Type	Method	Description
String	getOperator()	Return the MongoDB operator that is used for this AggregationOperation.
org.bson.Document	toDocument(AggregationOperationContext context)	Turns the AggregationOperation into a Document by using the given AggregationOperationContext.
List<org.bson.Document>	toPipelineStages(AggregationOperationContext context)	Turns the AggregationOperation into list of stages by using the given AggregationOperationContext.
GeoNearOperation	useIndex(String key)	Optionally specify the geospatial index to use via the field to use in the calculation.

Methods inherited from class java.lang.Object

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

Constructor Details

GeoNearOperation

public GeoNearOperation(NearQuery nearQuery,
 String distanceField)

Creates a new GeoNearOperation from the given NearQuery and the given distance field. The distanceField defines output field that contains the calculated distance.

Parameters:

nearQuery - must not be null.

distanceField - must not be null.

Method Details

useIndex

public GeoNearOperation useIndex(String key)

Optionally specify the geospatial index to use via the field to use in the calculation.
NOTE: Requires MongoDB 4.0 or later.

Parameters:

key - the geospatial index field to use when calculating the distance.

Returns:

new instance of GeoNearOperation.

Since:

2.1

toDocument

public org.bson.Document toDocument(AggregationOperationContext context)

Description copied from interface: AggregationOperation

Turns the AggregationOperation into a Document by using the given AggregationOperationContext.

Specified by:

toDocument in interface AggregationOperation

Parameters:

context - the AggregationOperationContext to operate within. Must not be null.

Returns:

the Document

getOperator

public String getOperator()

Description copied from interface: AggregationOperation

Return the MongoDB operator that is used for this AggregationOperation. Aggregation operations should implement this method to avoid document rendering.

Specified by:

getOperator in interface AggregationOperation

Returns:

the operator used for this AggregationOperation.

toPipelineStages

public List<org.bson.Document> toPipelineStages(AggregationOperationContext context)

Description copied from interface: AggregationOperation

Turns the AggregationOperation into list of stages by using the given AggregationOperationContext. This allows a single AggregationOptions to add additional stages for eg. $sort or $limit.

Specified by:

toPipelineStages in interface AggregationOperation

Parameters:

context - the AggregationOperationContext to operate within. Must not be null.

Returns:

the pipeline stages to run through. Never null.