Class LeafBucketCollector
- java.lang.Object
-
- org.elasticsearch.search.aggregations.LeafBucketCollector
-
- All Implemented Interfaces:
LeafCollector
- Direct Known Subclasses:
LeafBucketCollectorBase,ProfilingLeafBucketCollector
public abstract class LeafBucketCollector extends Object implements LeafCollector
Per-leaf bucket collector.
-
-
Field Summary
Fields Modifier and Type Field Description static LeafBucketCollectorNO_OP_COLLECTOR
-
Constructor Summary
Constructors Constructor Description LeafBucketCollector()
-
Method Summary
All Methods Static Methods Instance Methods Abstract Methods Concrete Methods Modifier and Type Method Description voidcollect(int doc)Called once for every document matching a query, with the unbased document number.abstract voidcollect(int doc, long bucket)Collect the given doc in the given bucket.voidsetScorer(Scorable scorer)Called before successive calls toLeafCollector.collect(int).static LeafBucketCollectorwrap(Iterable<LeafBucketCollector> collectors)
-
-
-
Field Detail
-
NO_OP_COLLECTOR
public static final LeafBucketCollector NO_OP_COLLECTOR
-
-
Method Detail
-
wrap
public static LeafBucketCollector wrap(Iterable<LeafBucketCollector> collectors)
-
collect
public abstract void collect(int doc, long bucket) throws IOExceptionCollect the given doc in the given bucket.- Throws:
IOException
-
collect
public final void collect(int doc) throws IOExceptionDescription copied from interface:LeafCollectorCalled once for every document matching a query, with the unbased document number.Note: The collection of the current segment can be terminated by throwing a
CollectionTerminatedException. In this case, the last docs of the currentLeafReaderContextwill be skipped andIndexSearcherwill swallow the exception and continue collection with the next leaf.Note: This is called in an inner search loop. For good search performance, implementations of this method should not call
IndexSearcher.doc(int)orIndexReader.document(int)on every hit. Doing so can slow searches by an order of magnitude or more.- Specified by:
collectin interfaceLeafCollector- Throws:
IOException
-
setScorer
public void setScorer(Scorable scorer) throws IOException
Description copied from interface:LeafCollectorCalled before successive calls toLeafCollector.collect(int). Implementations that need the score of the current document (passed-in toLeafCollector.collect(int)), should save the passed-in Scorer and call scorer.score() when needed.- Specified by:
setScorerin interfaceLeafCollector- Throws:
IOException
-
-