com.allanbank.mongodb.builder

Class AggregationGeoNear

java.lang.Object

com.allanbank.mongodb.builder.AggregationGeoNear

All Implemented Interfaces:

DocumentAssignable

public class AggregationGeoNear
extends Object
implements DocumentAssignable

AggregationGeoNear provides the options for the $geoNear pipeline stage of an aggregation.

Since:

MongoDB 2.4

API Notice:

This class 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 ©:

2013, Allanbank Consulting, Inc., All Rights Reserved

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	AggregationGeoNear.Builder Helper for creating immutable Find queries.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AggregationGeoNear(AggregationGeoNear.Builder builder) Creates a new AggregationGeoNear.

Method Summary

Methods

Modifier and Type	Method and Description
Document	asDocument() Converts the object into a document.
static AggregationGeoNear.Builder	builder() Creates a new builder for an AggregationGeoNear.
String	getDistanceField() Returns the name of the field to place the distance from the source location.
Double	getDistanceMultiplier() If set returns the distance multiplier to use in the $geoNear.
Long	getLimit() If set returns the maximum number of documents to return.
Point2D	getLocation() Returns the location to find documents near.
String	getLocationField() If set returns the name of the field to place the location information from the document.
Double	getMaxDistance() If set returns the maximum distance to return documents from the specified location
Document	getQuery() If set returns the optional query for further refining the documents to add to the pipeline.
boolean	isSpherical() Returns true if the $geoNear should compute distances using spherical coordinates instead of planar coordinates.
boolean	isUniqueDocs() Returns true if the $geoNear should only return documents once.

Methods inherited from class java.lang.Object

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

Constructor Detail

AggregationGeoNear

protected AggregationGeoNear(AggregationGeoNear.Builder builder)
                      throws IllegalArgumentException

Creates a new AggregationGeoNear.

Parameters:

builder - he builder for the AggregationGeoNear stage.

Throws:

IllegalArgumentException - If the location or distance field have not been set.

Method Detail

builder

public static AggregationGeoNear.Builder builder()

Creates a new builder for an AggregationGeoNear.

Returns:

The builder to construct an AggregationGeoNear.

asDocument

public Document asDocument()

Converts the object into a document.

Overridden to return the $geoNear aggregation pipeline's options document. This does not include the $geoNear operator, just the options document.

Specified by:

asDocument in interface DocumentAssignable

Returns:

The object as a Document.

getDistanceField

public String getDistanceField()

Returns the name of the field to place the distance from the source location.

Returns:

The name of the field to place the distance from the source location.

getDistanceMultiplier

public Double getDistanceMultiplier()

If set returns the distance multiplier to use in the $geoNear.

Returns:

The distance multiplier to use in the $geoNear, if set. null otherwise.

getLimit

public Long getLimit()

If set returns the maximum number of documents to return.

Returns:

The maximum number of documents to return, if set. null otherwise.

getLocation

public Point2D getLocation()

Returns the location to find documents near.

Returns:

The location to find documents near.

getLocationField

public String getLocationField()

If set returns the name of the field to place the location information from the document.

Returns:

The name of the field to place the location information from the document, if set. null otherwise.

getMaxDistance

public Double getMaxDistance()

If set returns the maximum distance to return documents from the specified location

Returns:

The maximum distance to return documents from the specified location, if set. null otherwise.

getQuery

public Document getQuery()

If set returns the optional query for further refining the documents to add to the pipeline.

Returns:

The optional query for further refining the documents to add to the pipeline, if set. null otherwise.

isSpherical

public boolean isSpherical()

Returns true if the $geoNear should compute distances using spherical coordinates instead of planar coordinates. Defaults to false.

Returns:

True if the $geoNear should compute distances using spherical coordinates instead of planar coordinates.

isUniqueDocs

public boolean isUniqueDocs()

Returns true if the $geoNear should only return documents once. Defaults to true.

Returns:

True if the $geoNear should only return documents once.