io.orchestrate.client

Class Aggregate

java.lang.Object

io.orchestrate.client.Aggregate

public class Aggregate
extends java.lang.Object

This is a convenience class that helps build syntactically correct aggregate function clauses that can be added to a search query.

Method Summary

Modifier and Type	Method and Description
java.lang.String	build() Builds the final stringified version of your aggregate clause.
static Aggregate	builder() Creates a new empty Aggregate object, which can be used to build a collection of aggregate clauses and form them into a syntactically correct string.
Aggregate	distance(java.lang.String fieldName, Range range, Range... ranges) Adds a distance aggregate to the query for the given field name.
Aggregate	range(java.lang.String fieldName, Range range, Range... ranges) Adds a range aggregate to the query for the given field name
Aggregate	stats(java.lang.String fieldName) Adds a statistical aggregate to the query for the given field name
Aggregate	timeSeries(java.lang.String fieldName, TimeInterval interval) Adds a time-series aggregate to the query for the given field name, with bucket intervals based on the UTC time zone.
Aggregate	timeSeries(java.lang.String fieldName, TimeInterval interval, java.lang.String timeZone) Adds a time-series aggregate to the query for the given field name, with bucket intervals based on the designated time zone.
Aggregate	topValues(java.lang.String fieldName) Adds a top-values aggregate to the query for the given field name.
Aggregate	topValues(java.lang.String fieldName, int offset, int limit) Adds a top-values aggregate to the query for the given field name, with offset and limit parameters to allow paging through the aggregate results.

Methods inherited from class java.lang.Object

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

Method Detail

builder

public static Aggregate builder()

Creates a new empty Aggregate object, which can be used to build a collection of aggregate clauses and form them into a syntactically correct string.

Returns:

An instance of the builder.

build

public java.lang.String build()

Builds the final stringified version of your aggregate clause.

Returns:

The string representing the Aggregates query.

topValues

public Aggregate topValues(java.lang.String fieldName)

Adds a top-values aggregate to the query for the given field name. Uses a default offset of 0 and a default limit of 10, which retrieves the first ten of the top values. Use the method with offset and limit params to allow paging through the aggregate results.

client.searchCollection("someCollection") .aggregate(Aggregate.builder() .topValues("value.tags") .build() ) .get(String.class, "*") .get()

Parameters:

fieldName - The fully-qualified name of the field to aggregate upon

Returns:

This request.

topValues

public Aggregate topValues(java.lang.String fieldName,
                           int offset,
                           int limit)

Adds a top-values aggregate to the query for the given field name, with offset and limit parameters to allow paging through the aggregate results.

client.searchCollection("someCollection") .aggregate(Aggregate.builder() .topValues("value.tags", 20, 10) .build() ) .get(String.class, "*") .get()

Parameters:

fieldName - The fully-qualified name of the field to aggregate upon

offset - The offset of the first top-values result entry to include

limit - The maximum number of top-values result entries to retrieve

Returns:

This request.

stats

public Aggregate stats(java.lang.String fieldName)

Adds a statistical aggregate to the query for the given field name

client.searchCollection("someCollection") .aggregate(Aggregate.builder() .stats("value.cart.items.price") .build() ) .get(String.class, "*") .get()

Parameters:

fieldName - The fully-qualified name of the field to aggregate upon

Returns:

This request.

range

public Aggregate range(java.lang.String fieldName,
                       Range range,
                       Range... ranges)

Adds a range aggregate to the query for the given field name

client.searchCollection("someCollection") .aggregate(Aggregate.builder() .range( "value.inventory.quantity", Range.below(10), Range.between(10, 100), Range.above(100) ) .build() ) .get(String.class, "*") .get()

Parameters:

fieldName - The fully-qualified name of the field to aggregate upon

range - The first numeric range to use as a histogram bucket

ranges - A varargs list of zero or more additional numeric ranges to use as histogram buckets

Returns:

This request.

distance

public Aggregate distance(java.lang.String fieldName,
                          Range range,
                          Range... ranges)

Adds a distance aggregate to the query for the given field name. It's important to note that distance aggregates can only be used when the lucene query contains a NEAR clause.

client.searchCollection("someCollection") .aggregate(Aggregate.builder() .distance( "value.location.geo", Range.below(10), Range.between(10, 100), Range.above(100) ) .build() ) .get(String.class, "value.location:NEAR:{ lat: 12.34 lon: 56.78 dist: 1000km }") .get()

Parameters:

fieldName - The fully-qualified name of the field to aggregate upon

range - The first numeric range to use as a histogram bucket

ranges - A varargs list of zero or more additional numeric ranges to use as histogram buckets

Returns:

This request.

timeSeries

public Aggregate timeSeries(java.lang.String fieldName,
                            TimeInterval interval)

Adds a time-series aggregate to the query for the given field name, with bucket intervals based on the UTC time zone.

client.searchCollection("someCollection") .aggregate(Aggregate.builder() .timeSeries("value.date_of_birth", TimeInterval.MONTH) .build() ) .get(String.class, "*") .get()

Parameters:

fieldName - The fully-qualified name of the field to aggregate upon

interval - The time interval to bucket upon

Returns:

This request.

timeSeries

public Aggregate timeSeries(java.lang.String fieldName,
                            TimeInterval interval,
                            java.lang.String timeZone)

Adds a time-series aggregate to the query for the given field name, with bucket intervals based on the designated time zone. Time zone strings must begin with a "+" or "-" character, followed by four digits representing the hours and minutes of offset, relative to UTC. For example, Eastern Standard Time (EST) would be represented as "-0500", since the time in EST is five hours behind that of UTC.

client.searchCollection("someCollection") .aggregate(Aggregate.builder() .timeSeries("value.date_of_birth", TimeInterval.MONTH, "-0500") .build() ) .get(String.class, "*") .get()

Parameters:

fieldName - The fully-qualified name of the field to aggregate upon

interval - The time interval to bucket upon

timeZone - The time zone to use when computing interval bucket boundaries

Returns:

This request.