Spring Data Document

org.springframework.data.mongodb.core.query
Class NearQuery

java.lang.Object
  extended by org.springframework.data.mongodb.core.query.NearQuery

public class NearQuery
extends Object

Builder class to build near-queries.

Author:
Oliver Gierke

Method Summary
 NearQuery distanceMultiplier(double distanceMultiplier)
          Configures a distance multiplier the resulting distances get applied.
 NearQuery distanceMultiplier(Metric metric)
          Configures the distance multiplier to the multiplier of the given Metric.
 Metric getMetric()
          Returns the Metric underlying the actual query.
 NearQuery inKilometers()
          Will cause the results' distances being returned in kilometers.
 NearQuery inMiles()
          Will cause the results' distances being returned in miles.
 NearQuery maxDistance(Distance distance)
          Sets the maximum distance to the given Distance.
 NearQuery maxDistance(double maxDistance)
          Sets the max distance results shall have from the configured origin.
 NearQuery maxDistance(double maxDistance, Metric metric)
          Sets the maximum distance supplied in a given metric.
static NearQuery near(double x, double y)
          Creates a new NearQuery starting near the given coordinates.
static NearQuery near(double x, double y, Metric metric)
          Creates a new NearQuery starting at the given coordinates using the given Metric to adapt given values to further configuration.
static NearQuery near(Point point)
          Creates a new NearQuery starting at the given Point.
static NearQuery near(Point point, Metric metric)
          Creates a NearQuery starting near the given Point using the given Metric to adapt given values to further configuration.
 NearQuery num(int num)
          Configures the number of results to return.
 NearQuery query(Query query)
          Adds an actual query to the NearQuery to restrict the objects considered for the actual near operation.
 NearQuery spherical(boolean spherical)
          Configures whether to return spherical values for the actual distance.
 DBObject toDBObject()
          Returns the DBObject built by the NearQuery.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Method Detail

near

public static NearQuery near(double x,
                             double y)
Creates a new NearQuery starting near the given coordinates.

Parameters:
i -
j -
Returns:

near

public static NearQuery near(double x,
                             double y,
                             Metric metric)
Creates a new NearQuery starting at the given coordinates using the given Metric to adapt given values to further configuration. E.g. setting a maxDistance(double) will be interpreted as a value of the initially set Metric.

Parameters:
x -
y -
metric -
Returns:

near

public static NearQuery near(Point point)
Creates a new NearQuery starting at the given Point.

Parameters:
point - must not be null.
Returns:

near

public static NearQuery near(Point point,
                             Metric metric)
Creates a NearQuery starting near the given Point using the given Metric to adapt given values to further configuration. E.g. setting a maxDistance(double) will be interpreted as a value of the initially set Metric.

Parameters:
point - must not be null.
metric -
Returns:

getMetric

public Metric getMetric()
Returns the Metric underlying the actual query.

Returns:

num

public NearQuery num(int num)
Configures the number of results to return.

Parameters:
num -
Returns:

maxDistance

public NearQuery maxDistance(double maxDistance)
Sets the max distance results shall have from the configured origin. Will normalize the given value using a potentially already configured Metric.

Parameters:
maxDistance -
Returns:

maxDistance

public NearQuery maxDistance(double maxDistance,
                             Metric metric)
Sets the maximum distance supplied in a given metric. Will normalize the distance but not reconfigure the query's Metric.

Parameters:
maxDistance -
metric - must not be null.
Returns:

maxDistance

public NearQuery maxDistance(Distance distance)
Sets the maximum distance to the given Distance.

Parameters:
distance -
Returns:

distanceMultiplier

public NearQuery distanceMultiplier(double distanceMultiplier)
Configures a distance multiplier the resulting distances get applied.

Parameters:
distanceMultiplier -
Returns:

distanceMultiplier

public NearQuery distanceMultiplier(Metric metric)
Configures the distance multiplier to the multiplier of the given Metric. Does not recalculate the maxDistance(double).

Parameters:
metric - must not be null.
Returns:

spherical

public NearQuery spherical(boolean spherical)
Configures whether to return spherical values for the actual distance.

Parameters:
spherical -
Returns:

inKilometers

public NearQuery inKilometers()
Will cause the results' distances being returned in kilometers. Sets distanceMultiplier(double) and spherical(boolean) accordingly.

Returns:

inMiles

public NearQuery inMiles()
Will cause the results' distances being returned in miles. Sets distanceMultiplier(double) and spherical(boolean) accordingly.

Returns:

query

public NearQuery query(Query query)
Adds an actual query to the NearQuery to restrict the objects considered for the actual near operation.

Parameters:
query -
Returns:

toDBObject

public DBObject toDBObject()
Returns the DBObject built by the NearQuery.

Returns:

Spring Data Document

Copyright © 2012. All Rights Reserved.