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

Class TopHitsAggregation

java.lang.Object

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

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

public class TopHitsAggregation
extends AggregationCommand

This aggregation collects the top document hits in its scope. This scope is given by the level of sub-aggregation this aggregation is located on. This means, if this aggregation is a top-level aggregation, it basically returns the main search result document list. As a sub-aggregation however, it returns the top scoring documents in the scope of its super aggregation.

Author:

faessler

See Also:

://www.elasticsearch.org/guide/en/elasticsearch/reference/current/search-aggregations-metrics-top-hits-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
List<String>	excludeFields The fields that should not be returned, even if in addIncludeField(String) a wildcard expression did match the field.
List<String>	includeFields The fields for which values are to be returned.
Integer	size For number of documents to return.

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

name, subaggregations

Constructor Summary

Constructors

Constructor and Description
TopHitsAggregation()

Method Summary

Modifier and Type	Method and Description
void	addIncludeField(String field)

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

includeFields

public List<String> includeFields

The fields for which values are to be returned. This is similar to the SearchServerCommand.fieldsToReturn parameter. The asterisk wildcard can be used to specify multiple or even all fields.

NOTE: In ElasticSearch, for any field value to be returned, the special _source field must be activated at index creation time. For some reason, one cannot just return the stored fields of a document.

excludeFields

public List<String> excludeFields

The fields that should not be returned, even if in addIncludeField(String) a wildcard expression did match the field. The asterisk wildcard can be used to specify multiple or even all fields.

size

public Integer size

For number of documents to return. This is similar to the SearchServerCommand.rows parameter.

Constructor Detail

TopHitsAggregation

public TopHitsAggregation()

Method Detail

addIncludeField

public void addIncludeField(String field)