Package 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:

Collector

Direct Known Subclasses:

MergingBucketsDeferringCollector

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

Modifier and Type	Field	Description
protected PackedLongValues.Builder	bucketsBuilder
protected BucketCollector	collector
protected LeafReaderContext	context
protected PackedLongValues.Builder	docDeltasBuilder
protected List<org.elasticsearch.search.aggregations.bucket.BestBucketsDeferringCollector.Entry>	entries
protected boolean	finished
protected boolean	isGlobal
protected long	maxBucket
protected SearchContext	searchContext
protected LongHash	selectedBuckets

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

NO_OP_COLLECTOR

Constructor Summary

Constructors

Constructor	Description
BestBucketsDeferringCollector(SearchContext context, boolean isGlobal)	Sole constructor.

Method Summary

Modifier and Type	Method	Description
LeafBucketCollector	getLeafCollector(LeafReaderContext ctx)	Create a new collector to collect the given context.
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.
ScoreMode	scoreMode()	Indicates what features are required from the scorer.
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 java.lang.Object

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

Field Detail

entries

protected List<org.elasticsearch.search.aggregations.bucket.BestBucketsDeferringCollector.Entry> entries

collector

protected BucketCollector collector

searchContext

protected final SearchContext searchContext

isGlobal

protected final boolean isGlobal

context

protected LeafReaderContext context

docDeltasBuilder

protected PackedLongValues.Builder docDeltasBuilder

bucketsBuilder

protected PackedLongValues.Builder bucketsBuilder

maxBucket

protected long maxBucket

finished

protected boolean finished

selectedBuckets

protected LongHash selectedBuckets

Constructor Detail

BestBucketsDeferringCollector

public BestBucketsDeferringCollector(SearchContext context,
                                     boolean isGlobal)

Sole constructor.

Parameters:

context - The search context

isGlobal - Whether this collector visits all documents (global context)

Method Detail

scoreMode

public ScoreMode scoreMode()

Description copied from interface: Collector

Indicates what features are required from the scorer.

setDeferredCollector

public void setDeferredCollector(Iterable<BucketCollector> deferredCollectors)

Set the deferred collectors.

Specified by:

setDeferredCollector in class DeferringBucketCollector

getLeafCollector

public LeafBucketCollector getLeafCollector(LeafReaderContext ctx)
                                     throws IOException

Description copied from interface: Collector

Create a new collector to collect the given context.

Specified by:

getLeafCollector in interface Collector

Specified by:

getLeafCollector in class BucketCollector

Parameters:

ctx - next atomic reader context

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