org.elasticsearch.search.aggregations.bucket

Class DeferringBucketCollector

java.lang.Object

org.elasticsearch.search.aggregations.BucketCollector

org.elasticsearch.search.aggregations.bucket.DeferringBucketCollector

All Implemented Interfaces:

AutoCloseable, Releasable, ReaderContextAware

public class DeferringBucketCollector
extends BucketCollector
implements Releasable

Buffers the matches in a collect stream and can replay a subset of the collected buckets to a deferred set of collectors. The rationale for not bundling all this logic into RecordingBucketCollector is to allow the possibility of alternative recorder impl choices while keeping the logic in here for setting AggregationContext's setNextReader method and preparing the appropriate choice of filtering logic for stream replay. These felt like agg-specific functions that should be kept away from the RecordingBucketCollector impl which is concentrated on efficient storage of doc and bucket IDs

Nested Class Summary

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

BucketCollector.BucketAnalysisCollector

Field Summary

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

NO_OP_COLLECTOR

Constructor Summary

Constructors

Constructor and Description
DeferringBucketCollector(BucketCollector deferred, AggregationContext context)

Method Summary

Modifier and Type	Method and Description
void	close()
void	collect(int docId, long bucketOrdinal) Called during the query phase, to collect & aggregate the given document.
void	gatherAnalysis(BucketCollector.BucketAnalysisCollector analysisCollector, long bucketOrdinal) Called post-collection to gather the results from surviving buckets.
void	postCollection() Post collection callback.
void	prepareSelectedBuckets(long... survivingBucketOrds) Plays a selection of the data cached from previous collect calls to the deferred collector.
void	setNextReader(org.apache.lucene.index.AtomicReaderContext reader)

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

DeferringBucketCollector

public DeferringBucketCollector(BucketCollector deferred,
                                AggregationContext context)

Method Detail

setNextReader

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

Specified by:

setNextReader in interface ReaderContextAware

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

postCollection

public void postCollection()
                    throws IOException

Description copied from class: BucketCollector

Post collection callback.

Specified by:

postCollection in class BucketCollector

Throws:

IOException

prepareSelectedBuckets

public void prepareSelectedBuckets(long... survivingBucketOrds)

Plays a selection of the data cached from previous collect calls to the deferred collector.

Parameters:

survivingBucketOrds - the valid bucket ords for which deferred collection should be attempted

close

public void close()
           throws ElasticsearchException

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Releasable

Throws:

ElasticsearchException

gatherAnalysis

public void gatherAnalysis(BucketCollector.BucketAnalysisCollector analysisCollector,
                           long bucketOrdinal)

Description copied from class: BucketCollector

Called post-collection to gather the results from surviving buckets.

Specified by:

gatherAnalysis in class BucketCollector