de.julielab.elastic.query.components.data.aggregation

Class TermsAggregation

java.lang.Object

de.julielab.elastic.query.components.data.aggregation.AggregationCommand

de.julielab.elastic.query.components.data.aggregation.TermsAggregation

public class TermsAggregation
extends AggregationCommand

The terms aggregation is basically faceting on term level.

Author:

faessler

See Also:

://www.elasticsearch.org/guide/en/elasticsearch/reference/current/search-aggregations-bucket-terms-aggregation .html

Nested Class Summary

Nested classes/interfaces inherited from class de.julielab.elastic.query.components.data.aggregation.AggregationCommand

AggregationCommand.OrderCommand

Field Summary

Fields

Modifier and Type	Field and Description
Object	exclude Either a string that will be interpreted as a regular expression matching terms to exclude or an instance of #Collection or an array containing field values (of type String, Long or Double) exactly enumerating the excluded items.
String	field The field from which to retrieve terms to aggregate over.
Object	include Either a string that will be interpreted as a regular expression matching terms to include or an instance of Collection or an array containing field values (of type String, Long or Double) exactly enumerating the included items.
List<AggregationCommand.OrderCommand>	order Specifies the ordering of the aggregation buckets.
Integer	size The number of top-terms to be used for aggregation.

Fields inherited from class de.julielab.elastic.query.components.data.aggregation.AggregationCommand

name, subaggregations

Constructor Summary

Constructors

Constructor and Description
TermsAggregation()

Method Summary

Modifier and Type	Method and Description
void	addOrder(AggregationCommand.OrderCommand orderItem)

Methods inherited from class de.julielab.elastic.query.components.data.aggregation.AggregationCommand

addSubaggregation, getSubaggregation

Methods inherited from class java.lang.Object

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

Field Detail

field

public String field

The field from which to retrieve terms to aggregate over.

order

public List<AggregationCommand.OrderCommand> order

Specifies the ordering of the aggregation buckets. Defaults to bucket size.

include

public Object include

Either a string that will be interpreted as a regular expression matching terms to include or an instance of Collection or an array containing field values (of type String, Long or Double) exactly enumerating the included items.

exclude

public Object exclude

Either a string that will be interpreted as a regular expression matching terms to exclude or an instance of #Collection or an array containing field values (of type String, Long or Double) exactly enumerating the excluded items.

size

public Integer size

The number of top-terms to be used for aggregation.

Constructor Detail

TermsAggregation

public TermsAggregation()

Method Detail

addOrder

public void addOrder(AggregationCommand.OrderCommand orderItem)