Module org.elasticsearch.server
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,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.WrappedAggregatorNested classes/interfaces inherited from class org.elasticsearch.search.aggregations.BucketCollector
BucketCollector.BucketCollectorWrapper -
Field Summary
Fields inherited from class org.elasticsearch.search.aggregations.BucketCollector
NO_OP_BUCKET_COLLECTOR, NO_OP_COLLECTOR -
Method Summary
Modifier and TypeMethodDescriptionvoidclose()protected org.apache.lucene.search.TopDocsCollector<? extends org.apache.lucene.search.ScoreDoc> createTopDocsCollector(int size) intgetDocCount(long parentBucket) protected longvoidPost-collection callback.voidPre collection callback.voidprepareSelectedBuckets(LongArray selectedBuckets) Replay the deferred hits on the selected buckets.org.apache.lucene.search.ScoreModeIndicates what features are required from the scorer.voidsetDeferredCollector(Iterable<BucketCollector> deferredCollectors) Set the deferred collectors.Methods inherited from class org.elasticsearch.search.aggregations.bucket.DeferringBucketCollector
wrapMethods inherited from class org.elasticsearch.search.aggregations.BucketCollector
asCollector
-
Method Details
-
scoreMode
public org.apache.lucene.search.ScoreMode scoreMode()Description copied from class:BucketCollectorIndicates what features are required from the scorer.- Specified by:
scoreModein classBucketCollector
-
setDeferredCollector
Set the deferred collectors.- Specified by:
setDeferredCollectorin classDeferringBucketCollector
-
getLeafCollector
- Specified by:
getLeafCollectorin classBucketCollector- Throws:
IOException
-
createTopDocsCollector
protected org.apache.lucene.search.TopDocsCollector<? extends org.apache.lucene.search.ScoreDoc> createTopDocsCollector(int size) throws IOException - Throws:
IOException
-
getPriorityQueueSlotSize
protected long getPriorityQueueSlotSize() -
preCollection
Description copied from class:BucketCollectorPre collection callback.- Specified by:
preCollectionin classBucketCollector- Throws:
IOException
-
postCollection
Description copied from class:BucketCollectorPost-collection callback.- Specified by:
postCollectionin classBucketCollector- Throws:
IOException
-
prepareSelectedBuckets
Description copied from class:DeferringBucketCollectorReplay the deferred hits on the selected buckets.- Specified by:
prepareSelectedBucketsin classDeferringBucketCollector
-
getDocCount
public int getDocCount(long parentBucket) -
close
- Specified by:
closein interfaceAutoCloseable- Specified by:
closein interfaceCloseable- Specified by:
closein interfaceReleasable- Throws:
ElasticsearchException
-