io.orchestrate.client

Class TopValuesAggregateResult

java.lang.Object

io.orchestrate.client.AggregateResult

io.orchestrate.client.TopValuesAggregateResult

public class TopValuesAggregateResult
extends AggregateResult

This class represents the results of a TopValuesAggregate function, providing the minimum, maximum, mean, sum, sum-of-squares, variance, and standard deviation for all numeric field values of the designated database field.

Method Summary

Modifier and Type	Method and Description
java.util.List<CountedValue>	getEntries() Returns the paged list of entries for this top-values aggregate, with paging corresponding to the offset and limit parameters of the original request.
double	getLimit() Returns the limit parameter for this top-values aggregate, as designated in the original request.
int	getOffset() Returns the offset parameter for this top-values aggregate, as designated in the original request.

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

getEntries

public java.util.List<CountedValue> getEntries()

Returns the paged list of entries for this top-values aggregate, with paging corresponding to the offset and limit parameters of the original request.

Returns:

getOffset

public int getOffset()

Returns the offset parameter for this top-values aggregate, as designated in the original request. This param represents the index of the first top-values result entry to return in this paged result set. If the full aggregate result set contains fewer unique values than requested, this paged aggregate result set will be empty.

Returns:

the offset parameter

getLimit

public double getLimit()

Returns the limit parameter for this top-values aggregate, as designated in the original request. This param represents the maximum number of entries to return in this paged result set. However, if the full aggregate result set contains fewer unique values than the sum of the offset plus limit, then the paged aggregate result may have fewer items than requested.

Returns:

the limit parameter