io.orchestrate.client

Class DistanceAggregateResult

java.lang.Object

io.orchestrate.client.AggregateResult

io.orchestrate.client.DistanceAggregateResult

public class DistanceAggregateResult
extends AggregateResult

This class represents the results of a DistanceAggregate function. The list of RangeBucket objects included with this aggregate indicate how many geo-point objects in the designated database field were found within each distance interval from the central anchor point.

Method Summary

Modifier and Type	Method and Description
java.util.List<RangeBucket>	getBuckets() Returns a list of RangeBuckets representing the number of geo-point field values found within each distance interval from the central anchor point designated in the accompanying distance query (inside the mandatory NEAR clause).

Methods inherited from class io.orchestrate.client.AggregateResult

getAggregateKind, getFieldName, getValueCount

Methods inherited from class java.lang.Object

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

Method Detail

getBuckets

public java.util.List<RangeBucket> getBuckets()

Returns a list of RangeBuckets representing the number of geo-point field values found within each distance interval from the central anchor point designated in the accompanying distance query (inside the mandatory NEAR clause). Likewise, the bounds of the range are expressed in terms of the same distance units (miles, kilometers, etc) used within the accompanying distance query.

Returns:

The range buckets.