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

Class AggregationCommand

java.lang.Object

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

Direct Known Subclasses:

MaxAggregation, SignificantTermsAggregation, TermsAggregation, TopHitsAggregation

public abstract class AggregationCommand
extends Object

This class is meant as a part of SearchServerCommand. It expresses data aggregation commands for the search server. In some cases, aggregations can be seen as a 'group by'-like feature, however the approach is more general. For example, the 'maximum' aggregation only returns the maximum value of a field (or even the document score), the 'terms' aggregation is basically the term facets approach. This is heavily modeled after ElasticSearch aggregations.

Aggregations can be nested, so this class serves as a common super type for aggregation commands to allow flexible, general nesting.

Author:

faessler

See Also:

http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/search-aggregations.html

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	AggregationCommand.OrderCommand

Field Summary

Fields

Modifier and Type	Field and Description
String	name The name of this aggregation to identify it in the results.
Map<String,AggregationCommand>	subaggregations A list of sub-aggregations of this aggregation.

Constructor Summary

Constructors

Constructor and Description
AggregationCommand()

Method Summary

Modifier and Type	Method and Description
void	addSubaggregation(AggregationCommand aggregation)
AggregationCommand	getSubaggregation(String name)

Methods inherited from class java.lang.Object

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

Field Detail

name

public String name

The name of this aggregation to identify it in the results.

subaggregations

public Map<String,AggregationCommand> subaggregations

A list of sub-aggregations of this aggregation. May be null.

Constructor Detail

AggregationCommand

public AggregationCommand()

Method Detail

addSubaggregation

public void addSubaggregation(AggregationCommand aggregation)

getSubaggregation

public AggregationCommand getSubaggregation(String name)