org.elasticsearch.search.aggregations.bucket

Class BestBucketsDeferringCollector

java.lang.Object

org.elasticsearch.search.aggregations.BucketCollector

org.elasticsearch.search.aggregations.bucket.DeferringBucketCollector

org.elasticsearch.search.aggregations.bucket.BestBucketsDeferringCollector

All Implemented Interfaces:

org.apache.lucene.search.Collector

public class BestBucketsDeferringCollector
extends DeferringBucketCollector

A specialization of DeferringBucketCollector that collects all matches and then is able to replay a given subset of buckets which represent the survivors from a pruning process performed by the aggregator that owns this collector.

Nested Class Summary

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

DeferringBucketCollector.WrappedAggregator

Field Summary

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

NO_OP_COLLECTOR

Constructor Summary

Constructors

Constructor and Description
BestBucketsDeferringCollector() Sole constructor.

Method Summary

Methods

Modifier and Type	Method and Description
LeafBucketCollector	getLeafCollector(org.apache.lucene.index.LeafReaderContext ctx)
boolean	needsScores()
void	postCollection() Post-collection callback.
void	preCollection() Pre collection callback.
void	prepareSelectedBuckets(long... selectedBuckets) Replay the wrapped collector, but only on a selection of buckets.
void	setDeferredCollector(Iterable<BucketCollector> deferredCollectors) Set the deferred collectors.
Aggregator	wrap(Aggregator in) Wrap the provided aggregator so that it behaves (almost) as if it had been collected directly.

Methods inherited from class org.elasticsearch.search.aggregations.bucket.DeferringBucketCollector

replay

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

BestBucketsDeferringCollector

public BestBucketsDeferringCollector()

Sole constructor.

Method Detail

needsScores

public boolean needsScores()

setDeferredCollector

public void setDeferredCollector(Iterable<BucketCollector> deferredCollectors)

Set the deferred collectors.

Overrides:

setDeferredCollector in class DeferringBucketCollector

getLeafCollector

public LeafBucketCollector getLeafCollector(org.apache.lucene.index.LeafReaderContext ctx)
                                     throws IOException

Specified by:

getLeafCollector in interface org.apache.lucene.search.Collector

Specified by:

getLeafCollector in class BucketCollector

Throws:

IOException

preCollection

public void preCollection()
                   throws IOException

Description copied from class: BucketCollector

Pre collection callback.

Specified by:

preCollection in class BucketCollector

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... selectedBuckets)
                            throws IOException

Replay the wrapped collector, but only on a selection of buckets.

Specified by:

prepareSelectedBuckets in class DeferringBucketCollector

Throws:

IOException

wrap

public Aggregator wrap(Aggregator in)

Wrap the provided aggregator so that it behaves (almost) as if it had been collected directly.

Overrides:

wrap in class DeferringBucketCollector