com.allanbank.mongodb.builder

Class AggregationGeoNear.Builder

java.lang.Object

com.allanbank.mongodb.builder.AggregationGeoNear.Builder

Enclosing class:

AggregationGeoNear

public static class AggregationGeoNear.Builder
extends Object

Helper for creating immutable Find queries.

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

Field Summary

Fields

Modifier and Type	Field and Description
protected String	myDistanceField The name of the field to place the distance from the source location.
protected Double	myDistanceMultiplier The distance multiplier to use in the $geoNear, if set.
protected Long	myLimit The maximum number of documents to return, if set.
protected Point2D	myLocation The location to find documents near.
protected String	myLocationField The name of the field to place the location information from the document, if set.
protected Double	myMaxDistance The maximum distance to return documents from the specified location, if set.
protected Document	myQuery The optional query for further refining the documents to add to the pipeline.
protected boolean	mySpherical If true the $geoNear should compute distances using spherical coordinates instead of planar coordinates.
protected boolean	myUniqueDocs If true the $geoNear should only return documents once.

Constructor Summary

Constructors

Constructor and Description
AggregationGeoNear.Builder() Creates a new Builder.

Method Summary

Methods

Modifier and Type	Method and Description
AggregationGeoNear	build() Constructs a new AggregationGeoNear object from the state of the builder.
AggregationGeoNear.Builder	distanceField(String distanceField) Sets the name of the field to place the distance from the source location.
AggregationGeoNear.Builder	distanceMultiplier(double distanceMultiplier) Sets the distance multiplier to use in the $geoNear.
AggregationGeoNear.Builder	limit(long limit) Sets the maximum number of documents to return.
AggregationGeoNear.Builder	location(Point2D location) Sets the location to find documents near.
AggregationGeoNear.Builder	locationField(String locationField) Sets the name of the field to place the location information from the document.
AggregationGeoNear.Builder	maxDistance(double maxDistance) Sets the maximum distance to return documents from the specified location.
AggregationGeoNear.Builder	query(DocumentAssignable query) Sets the optional query for further refining the documents to add to the pipeline.
AggregationGeoNear.Builder	reset() Resets the builder back to its initial state for reuse.
AggregationGeoNear.Builder	setDistanceField(String distanceField) Sets the name of the field to place the distance from the source location.
AggregationGeoNear.Builder	setDistanceMultiplier(double distanceMultiplier) Sets the distance multiplier to use in the $geoNear.
AggregationGeoNear.Builder	setLimit(long limit) Sets the maximum number of documents to return.
AggregationGeoNear.Builder	setLocation(Point2D location) Sets the location to find documents near.
AggregationGeoNear.Builder	setLocationField(String locationField) Sets the name of the field to place the location information from the document.
AggregationGeoNear.Builder	setMaxDistance(double maxDistance) Sets the maximum distance to return documents from the specified location.
AggregationGeoNear.Builder	setQuery(DocumentAssignable query) Sets the optional query for further refining the documents to add to the pipeline.
AggregationGeoNear.Builder	setSpherical(boolean spherical) Sets if (true) the $geoNear should compute distances using spherical coordinates instead of planar coordinates.
AggregationGeoNear.Builder	setUniqueDocs(boolean uniqueDocs) Sets if (true) the $geoNear should only return documents once.
AggregationGeoNear.Builder	spherical() Sets the $geoNear to compute distances using spherical coordinates instead of planar coordinates.
AggregationGeoNear.Builder	spherical(boolean spherical) Sets if (true) the $geoNear should compute distances using spherical coordinates instead of planar coordinates.
AggregationGeoNear.Builder	uniqueDocs(boolean uniqueDocs) Sets if (true) 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

Field Detail

myDistanceField

protected String myDistanceField

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

myDistanceMultiplier

protected Double myDistanceMultiplier

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

myLimit

protected Long myLimit

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

myLocation

protected Point2D myLocation

The location to find documents near.

myLocationField

protected String myLocationField

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

myMaxDistance

protected Double myMaxDistance

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

myQuery

protected Document myQuery

The optional query for further refining the documents to add to the pipeline.

mySpherical

protected boolean mySpherical

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

myUniqueDocs

protected boolean myUniqueDocs

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

Constructor Detail

AggregationGeoNear.Builder

public AggregationGeoNear.Builder()

Creates a new Builder.

Method Detail

build

public AggregationGeoNear build()

Constructs a new AggregationGeoNear object from the state of the builder.

Returns:

The new AggregationGeoNear object.

Throws:

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

distanceField

public AggregationGeoNear.Builder distanceField(String distanceField)

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

This method delegates to setDistanceField(String).

Parameters:

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

Returns:

This builder for chaining method calls.

distanceMultiplier

public AggregationGeoNear.Builder distanceMultiplier(double distanceMultiplier)

Sets the distance multiplier to use in the $geoNear.

This method delegates to setDistanceMultiplier(double).

Parameters:

distanceMultiplier - The new distance multiplier to use in the $geoNear .

Returns:

This builder for chaining method calls.

limit

public AggregationGeoNear.Builder limit(long limit)

Sets the maximum number of documents to return.

This method delegates to setLimit(long).

Parameters:

limit - The new maximum number of documents to return.

Returns:

This builder for chaining method calls.

location

public AggregationGeoNear.Builder location(Point2D location)

Sets the location to find documents near.

This method delegates to setLocation(Point2D).

Parameters:

location - The new location to find documents near.

Returns:

This builder for chaining method calls.

See Also:

GeoJson.p(double, double)

locationField

public AggregationGeoNear.Builder locationField(String locationField)

Sets the name of the field to place the location information from the document.

This method delegates to setLocationField(String).

Parameters:

locationField - The new name of the field to place the location information from the document.

Returns:

This builder for chaining method calls.

maxDistance

public AggregationGeoNear.Builder maxDistance(double maxDistance)

Sets the maximum distance to return documents from the specified location.

This method delegates to setMaxDistance(double).

Parameters:

maxDistance - The new maximum distance to return documents from the specified location.

Returns:

This builder for chaining method calls.

query

public AggregationGeoNear.Builder query(DocumentAssignable query)

Sets the optional query for further refining the documents to add to the pipeline.

This method delegates to setQuery(DocumentAssignable).

Parameters:

query - The new optional query for further refining the documents to add to the pipeline.

Returns:

This builder for chaining method calls.

reset

public AggregationGeoNear.Builder reset()

Resets the builder back to its initial state for reuse.

Returns:

This builder for chaining method calls.

setDistanceField

public AggregationGeoNear.Builder setDistanceField(String distanceField)

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

Parameters:

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

Returns:

This builder for chaining method calls.

setDistanceMultiplier

public AggregationGeoNear.Builder setDistanceMultiplier(double distanceMultiplier)

Sets the distance multiplier to use in the $geoNear.

Parameters:

distanceMultiplier - The new distance multiplier to use in the $geoNear .

Returns:

This builder for chaining method calls.

setLimit

public AggregationGeoNear.Builder setLimit(long limit)

Sets the maximum number of documents to return.

Parameters:

limit - The new maximum number of documents to return.

Returns:

This builder for chaining method calls.

setLocation

public AggregationGeoNear.Builder setLocation(Point2D location)

Sets the location to find documents near.

Parameters:

location - The new location to find documents near.

Returns:

This builder for chaining method calls.

See Also:

GeoJson.p(double, double)

setLocationField

public AggregationGeoNear.Builder setLocationField(String locationField)

Sets the name of the field to place the location information from the document.

Parameters:

locationField - The new name of the field to place the location information from the document.

Returns:

This builder for chaining method calls.

setMaxDistance

public AggregationGeoNear.Builder setMaxDistance(double maxDistance)

Sets the maximum distance to return documents from the specified location.

Parameters:

maxDistance - The new maximum distance to return documents from the specified location.

Returns:

This builder for chaining method calls.

setQuery

public AggregationGeoNear.Builder setQuery(DocumentAssignable query)

Sets the optional query for further refining the documents to add to the pipeline.

Parameters:

query - The new optional query for further refining the documents to add to the pipeline.

Returns:

This builder for chaining method calls.

setSpherical

public AggregationGeoNear.Builder setSpherical(boolean spherical)

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

Parameters:

spherical - The new value for if the $geoNear should compute distances using spherical coordinates instead of planar coordinates

Returns:

This builder for chaining method calls.

setUniqueDocs

public AggregationGeoNear.Builder setUniqueDocs(boolean uniqueDocs)

Sets if (true) the $geoNear should only return documents once. Defaults to true.

Parameters:

uniqueDocs - The new value for if the $geoNear should only return documents once.

Returns:

This builder for chaining method calls.

spherical

public AggregationGeoNear.Builder spherical()

Sets the $geoNear to compute distances using spherical coordinates instead of planar coordinates.

This method delegates to setSpherical(true).

Returns:

This builder for chaining method calls.

spherical

public AggregationGeoNear.Builder spherical(boolean spherical)

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

This method delegates to setSpherical(boolean).

Parameters:

spherical - The new value for if the $geoNear should compute distances using spherical coordinates instead of planar coordinates

Returns:

This builder for chaining method calls.

uniqueDocs

public AggregationGeoNear.Builder uniqueDocs(boolean uniqueDocs)

Sets if (true) the $geoNear should only return documents once. Defaults to true.

This method delegates to setUniqueDocs(boolean).

Parameters:

uniqueDocs - The new value for if the $geoNear should only return documents once.

Returns:

This builder for chaining method calls.