Package org.elasticsearch.search.aggregations.bucket.sampler

Class BestDocsDeferringCollector

java.lang.Object

org.elasticsearch.search.aggregations.BucketCollector

org.elasticsearch.search.aggregations.bucket.DeferringBucketCollector

org.elasticsearch.search.aggregations.bucket.sampler.BestDocsDeferringCollector

All Implemented Interfaces:

Closeable, AutoCloseable, Collector, Releasable

public class BestDocsDeferringCollector
extends DeferringBucketCollector
implements Releasable

A specialization of DeferringBucketCollector that collects all matches and then replays only the top scoring documents to child aggregations. The method createTopDocsCollector(int) is designed to be overridden and allows subclasses to choose a custom collector implementation for determining the top N matches.

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

Method Summary

Modifier and Type	Method	Description
void	close()
protected TopDocsCollector<? extends ScoreDoc>	createTopDocsCollector(int size)
int	getDocCount(long parentBucket)
LeafBucketCollector	getLeafCollector(LeafReaderContext ctx)	Create a new collector to collect the given context.
protected long	getPriorityQueueSlotSize()
void	postCollection()	Post-collection callback.
void	preCollection()	Pre collection callback.
void	prepareSelectedBuckets(long... selectedBuckets)
ScoreMode	scoreMode()	Indicates what features are required from the scorer.
void	setDeferredCollector(Iterable<BucketCollector> deferredCollectors)	Set the deferred collectors.

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

replay, wrap

Methods inherited from class java.lang.Object

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

Method Detail

scoreMode

public ScoreMode scoreMode()

Description copied from interface: Collector

Indicates what features are required from the scorer.

Specified by:

scoreMode in interface Collector

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

createTopDocsCollector

protected TopDocsCollector<? extends ScoreDoc> createTopDocsCollector(int size)
                                                               throws IOException

Throws:

IOException

getPriorityQueueSlotSize

protected long getPriorityQueueSlotSize()

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

Specified by:

prepareSelectedBuckets in class DeferringBucketCollector

Throws:

IOException

getDocCount

public int getDocCount(long parentBucket)

close

public void close()
           throws ElasticsearchException

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

Specified by:

close in interface Releasable

Throws:

ElasticsearchException