org.elasticsearch.search.aggregations

Class RecordingPerReaderBucketCollector

java.lang.Object

org.elasticsearch.search.aggregations.BucketCollector

org.elasticsearch.search.aggregations.RecordingBucketCollector

org.elasticsearch.search.aggregations.RecordingPerReaderBucketCollector

All Implemented Interfaces:

AutoCloseable, Releasable, ReaderContextAware

public class RecordingPerReaderBucketCollector
extends RecordingBucketCollector

Records a "collect" stream for subsequent play-back using a per-segment object to collect matches. Playback is fast because each collection contains only the required matches for the current reader.

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
RecordingPerReaderBucketCollector(AggregationContext context)

Method Summary

Modifier and Type	Method and Description
void	close()
void	collect(int doc, long owningBucketOrdinal) Called during the query phase, to collect & aggregate the given document.
void	postCollection() Post collection callback.
void	replayCollection(BucketCollector collector) Replay a previously executed set of calls to the BucketCollector.collect(int, long) method
void	setNextReader(org.apache.lucene.index.AtomicReaderContext reader)

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

gatherAnalysis

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

RecordingPerReaderBucketCollector

public RecordingPerReaderBucketCollector(AggregationContext context)

Method Detail

setNextReader

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

collect

public void collect(int doc,
                    long owningBucketOrdinal)
             throws IOException

Description copied from class: BucketCollector

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

Specified by:

collect in class BucketCollector

owningBucketOrdinal - 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

replayCollection

public void replayCollection(BucketCollector collector)
                      throws IOException

Description copied from class: RecordingBucketCollector

Replay a previously executed set of calls to the BucketCollector.collect(int, long) method

Specified by:

replayCollection in class RecordingBucketCollector

Parameters:

collector - the object which will be called to handle the playback

Throws:

IOException

postCollection

public void postCollection()
                    throws IOException

Description copied from class: BucketCollector

Post collection callback.

Specified by:

postCollection in class BucketCollector

Throws:

IOException

close

public void close()
           throws ElasticsearchException

Throws:

ElasticsearchException