Package org.elasticsearch.search.aggregations

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 LeafBucketCollector	NO_OP_COLLECTOR

Constructor Summary

Constructors

Constructor	Description
LeafBucketCollector()

Method Summary

Modifier and Type	Method	Description
void	collect(int doc)	Called once for every document matching a query, with the unbased document number.
abstract void	collect(int doc, long bucket)	Collect the given doc in the given bucket.
void	setScorer(Scorable scorer)	Called before successive calls to LeafCollector.collect(int).
static LeafBucketCollector	wrap(Iterable<LeafBucketCollector> collectors)

Methods inherited from class java.lang.Object

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

Field Detail

NO_OP_COLLECTOR

public static final LeafBucketCollector NO_OP_COLLECTOR

Constructor Detail

LeafBucketCollector

public LeafBucketCollector()

Method Detail

wrap

public static LeafBucketCollector wrap(Iterable<LeafBucketCollector> collectors)

collect

public abstract void collect(int doc,
                             long bucket)
                      throws IOException

Collect the given doc in the given bucket.

Throws:

IOException

collect

public final void collect(int doc)
                   throws IOException

Description copied from interface: LeafCollector

Called 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 current LeafReaderContext will be skipped and IndexSearcher will 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) or IndexReader.document(int) on every hit. Doing so can slow searches by an order of magnitude or more.

Specified by:

collect in interface LeafCollector

Throws:

IOException

setScorer

public void setScorer(Scorable scorer)
               throws IOException

Description copied from interface: LeafCollector

Called before successive calls to LeafCollector.collect(int). Implementations that need the score of the current document (passed-in to LeafCollector.collect(int)), should save the passed-in Scorer and call scorer.score() when needed.

Specified by:

setScorer in interface LeafCollector

Throws:

IOException