Package org.elasticsearch.search.aggregations

Class BucketCollector

java.lang.Object

org.elasticsearch.search.aggregations.BucketCollector

All Implemented Interfaces:

org.apache.lucene.search.Collector

Direct Known Subclasses:

Aggregator, DeferringBucketCollector

public abstract class BucketCollector
extends java.lang.Object
implements org.apache.lucene.search.Collector

A Collector that can collect data in separate buckets.

Field Summary

Fields

Modifier and Type	Field	Description
static BucketCollector	NO_OP_COLLECTOR

Constructor Summary

Constructors

Constructor	Description
BucketCollector()

Method Summary

Modifier and Type	Method	Description
abstract LeafBucketCollector	getLeafCollector(org.apache.lucene.index.LeafReaderContext ctx)
abstract void	postCollection()	Post-collection callback.
abstract void	preCollection()	Pre collection callback.
static BucketCollector	wrap(java.lang.Iterable<? extends BucketCollector> collectorList)	Wrap the given collectors into a single instance.

Methods inherited from interface org.apache.lucene.search.Collector

needsScores

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

Constructor Detail

BucketCollector

public BucketCollector()

Method Detail

wrap

public static BucketCollector wrap(java.lang.Iterable<? extends BucketCollector> collectorList)

Wrap the given collectors into a single instance.

getLeafCollector

public abstract LeafBucketCollector getLeafCollector(org.apache.lucene.index.LeafReaderContext ctx)
                                              throws java.io.IOException

Specified by:

getLeafCollector in interface org.apache.lucene.search.Collector

Throws:

java.io.IOException

preCollection

public abstract void preCollection()
                            throws java.io.IOException

Pre collection callback.

Throws:

java.io.IOException

postCollection

public abstract void postCollection()
                             throws java.io.IOException

Post-collection callback.

Throws:

java.io.IOException