io.orchestrate.client

Class AggregateResult

java.lang.Object

io.orchestrate.client.AggregateResult

Direct Known Subclasses:

DistanceAggregateResult, RangeAggregateResult, StatsAggregateResult, TimeSeriesAggregateResult, TopValuesAggregateResult

public abstract class AggregateResult
extends java.lang.Object

This abstract class represents the result of an arbitrary aggregate function. All AggregateResult objects operate over a particular field name, with a particular kind of aggregate function, and provide a count of the number of field values included in the aggregate calculation. Individual subclass implementations will augment this basic information with specific details relevant to the kind of aggregation performed.

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String	getAggregateKind() Returns the kind of aggregate represented in this result.
java.lang.String	getFieldName() Returns the fully-qualified name of the field used by this aggregate.
long	getValueCount() Returns the total number of database field values included in this aggregate.

Methods inherited from class java.lang.Object

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

Method Detail

getFieldName

public java.lang.String getFieldName()

Returns the fully-qualified name of the field used by this aggregate.

Returns:

the field name

getAggregateKind

public java.lang.String getAggregateKind()

Returns the kind of aggregate represented in this result. Possible values include: stats, range, distance, and time_series

Returns:

the aggregate kind

getValueCount

public long getValueCount()

Returns the total number of database field values included in this aggregate. It's important to note that this is a count of the field values, rather than a count of database records, since each record can contain multiple values for each field.

Returns:

the total value count