public class NearQuery extends Object
Modifier and Type | Method and Description |
---|---|
NearQuery |
distanceMultiplier(double distanceMultiplier)
Configures a
CustomMetric with the given multiplier. |
NearQuery |
distanceMultiplier(Metric metric)
Deprecated.
use
in(Metric) instead. |
Distance |
getMaxDistance()
Returns the maximum
Distance . |
Metric |
getMetric()
Returns the
Metric underlying the actual query. |
NearQuery |
in(Metric metric)
Will cause the results' distances being returned in the given metric.
|
NearQuery |
inKilometers()
Will cause the results' distances being returned in kilometers.
|
NearQuery |
inMiles()
Will cause the results' distances being returned in miles.
|
boolean |
isSpherical()
Returns whether spharical values will be returned.
|
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)
|
static NearQuery |
near(Point point)
|
static NearQuery |
near(Point point,
Metric metric)
|
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.
|
com.mongodb.DBObject |
toDBObject()
Returns the
DBObject built by the NearQuery . |
public static NearQuery near(double x, double y)
NearQuery
starting near the given coordinates.i
- j
- public static NearQuery near(double x, double y, Metric metric)
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
.x
- y
- metric
- public static NearQuery near(Point point, Metric metric)
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
.point
- must not be null.metric
- public Metric getMetric()
Metric
underlying the actual query. If no metric was set explicitly Metrics.NEUTRAL
will be returned.public NearQuery num(int num)
num
- public NearQuery maxDistance(double maxDistance)
Metric
was set before the given
value will be interpreted as being a value in that metric. E.g.
NearQuery query = near(10.0, 20.0, Metrics.KILOMETERS).maxDistance(150);Will set the maximum distance to 150 kilometers.
maxDistance
- public NearQuery maxDistance(double maxDistance, Metric metric)
Metric
if one was configured before.maxDistance
- metric
- must not be null.public NearQuery maxDistance(Distance distance)
Distance
. Will set the returned Metric
to be the one of the
given Distance
if no Metric
was set before.distance
- must not be null.public NearQuery distanceMultiplier(double distanceMultiplier)
CustomMetric
with the given multiplier.distanceMultiplier
- @Deprecated public NearQuery distanceMultiplier(Metric metric)
in(Metric)
instead.Metric
.metric
- must not be null.public NearQuery spherical(boolean spherical)
spherical
- public boolean isSpherical()
public NearQuery inKilometers()
distanceMultiplier(double)
and
spherical(boolean)
accordingly.public NearQuery inMiles()
distanceMultiplier(double)
and
spherical(boolean)
accordingly.public NearQuery in(Metric metric)
distanceMultiplier(double)
accordingly as well as spherical(boolean)
if the given Metric
is not Metrics.NEUTRAL
.metric
- the metric the results shall be returned in. Uses Metrics.NEUTRAL
if null is
passed.public NearQuery query(Query query)
NearQuery
to restrict the objects considered for the actual near operation.query
- public com.mongodb.DBObject toDBObject()
DBObject
built by the NearQuery
.Copyright © 2011-2013-2013 SpringSource. All Rights Reserved.