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

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.

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

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.