org.elasticsearch.search.aggregations.metrics.tophits

Class TopHitsAggregator

java.lang.Object

org.elasticsearch.search.aggregations.BucketCollector

org.elasticsearch.search.aggregations.Aggregator

org.elasticsearch.search.aggregations.metrics.MetricsAggregator

org.elasticsearch.search.aggregations.metrics.tophits.TopHitsAggregator

All Implemented Interfaces:

AutoCloseable, Releasable, ReaderContextAware, ScorerAware

public class TopHitsAggregator
extends MetricsAggregator
implements ScorerAware

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	TopHitsAggregator.Factory

Nested classes/interfaces inherited from class org.elasticsearch.search.aggregations.Aggregator

Aggregator.BucketAggregationMode, Aggregator.Parser, Aggregator.SubAggCollectionMode

Nested classes/interfaces inherited from class org.elasticsearch.search.aggregations.BucketCollector

BucketCollector.BucketAnalysisCollector

Field Summary

Fields inherited from class org.elasticsearch.search.aggregations.Aggregator

bigArrays, bucketAggregationMode, COLLECT_MODE, collectableSubAggregators, context, depth, estimatedBucketCount, factories, name, parent, subAggregators

Fields inherited from class org.elasticsearch.search.aggregations.BucketCollector

NO_OP_COLLECTOR

Constructor Summary

Constructors

Constructor and Description
TopHitsAggregator(FetchPhase fetchPhase, SubSearchContext subSearchContext, String name, long estimatedBucketsCount, AggregationContext context, Aggregator parent)

Method Summary

Modifier and Type	Method and Description
InternalAggregation	buildAggregation(long owningBucketOrdinal)
InternalAggregation	buildEmptyAggregation()
void	collect(int docId, long bucketOrdinal) Called during the query phase, to collect & aggregate the given document.
protected void	doClose() Release instance-specific data.
void	setNextReader(org.apache.lucene.index.AtomicReaderContext context)
void	setScorer(org.apache.lucene.search.Scorer scorer)
boolean	shouldCollect()

Methods inherited from class org.elasticsearch.search.aggregations.Aggregator

bucketAggregationMode, buildEmptySubAggregations, close, context, depth, doPostCollection, estimatedBucketCount, gatherAnalysis, hasParentBucketAggregator, name, parent, postCollection, preCollection, runDeferredCollections, shouldDefer, subAggregator, subAggregators

Methods inherited from class org.elasticsearch.search.aggregations.BucketCollector

wrap

Methods inherited from class java.lang.Object

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

Constructor Detail

TopHitsAggregator

public TopHitsAggregator(FetchPhase fetchPhase,
                         SubSearchContext subSearchContext,
                         String name,
                         long estimatedBucketsCount,
                         AggregationContext context,
                         Aggregator parent)

Method Detail

shouldCollect

public boolean shouldCollect()

Specified by:

shouldCollect in class Aggregator

Returns:

Whether this aggregator is in the state where it can collect documents. Some aggregators can do their aggregations without actually collecting documents, for example, an aggregator that computes stats over unmapped fields doesn't need to collect anything as it knows to just return "empty" stats as the aggregation result.

buildAggregation

public InternalAggregation buildAggregation(long owningBucketOrdinal)

Specified by:

buildAggregation in class Aggregator

Returns:

The aggregated & built aggregation

buildEmptyAggregation

public InternalAggregation buildEmptyAggregation()

Specified by:

buildEmptyAggregation in class Aggregator

collect

public void collect(int docId,
                    long bucketOrdinal)
             throws IOException

Description copied from class: BucketCollector

Called during the query phase, to collect & aggregate the given document.

Specified by:

collect in class BucketCollector

bucketOrdinal - The ordinal of the bucket this aggregator belongs to, assuming this aggregator is not a top level aggregator. Typically, aggregators with #bucketAggregationMode set to Aggregator.BucketAggregationMode.MULTI_BUCKETS will heavily depend on this ordinal. Other aggregators may or may not use it and can see this ordinal as just an extra information for the aggregation context. For top level aggregators, the ordinal will always be equal to 0.

Throws:

IOException

setNextReader

public void setNextReader(org.apache.lucene.index.AtomicReaderContext context)

Specified by:

setNextReader in interface ReaderContextAware

setScorer

public void setScorer(org.apache.lucene.search.Scorer scorer)

Specified by:

setScorer in interface ScorerAware

doClose

protected void doClose()

Description copied from class: Aggregator

Release instance-specific data.

Overrides:

doClose in class Aggregator