Package org.elasticsearch.search.aggregations.bucket

Class DeferringBucketCollector.WrappedAggregator

java.lang.Object

org.elasticsearch.search.aggregations.BucketCollector

org.elasticsearch.search.aggregations.Aggregator

org.elasticsearch.search.aggregations.bucket.DeferringBucketCollector.WrappedAggregator

All Implemented Interfaces:

Closeable, AutoCloseable, org.apache.lucene.search.Collector, org.elasticsearch.core.Releasable

Enclosing class:

DeferringBucketCollector

protected class DeferringBucketCollector.WrappedAggregator
extends Aggregator

Nested Class Summary

Nested classes/interfaces inherited from class org.elasticsearch.search.aggregations.Aggregator

Aggregator.BucketComparator, Aggregator.Parser, Aggregator.SubAggCollectionMode

Field Summary

Fields inherited from class org.elasticsearch.search.aggregations.BucketCollector

NO_OP_COLLECTOR

Method Summary

Modifier and Type	Method	Description
Aggregator.BucketComparator	bucketComparator(String key, SortOrder order)	Builds a comparator that compares two buckets aggregated by this Aggregator.
InternalAggregation[]	buildAggregations(long[] owningBucketOrds)	Build the results of this aggregation.
InternalAggregation	buildEmptyAggregation()	Build an empty aggregation.
void	close()
void	collectDebugInfo(BiConsumer<String,Object> add)	Collect debug information to add to the profiling results.
LeafBucketCollector	getLeafCollector(org.apache.lucene.index.LeafReaderContext ctx)
String	name()	Return the name of this aggregator.
Aggregator	parent()	Return the parent aggregator.
void	postCollection()	Post-collection callback.
void	preCollection()	Pre collection callback.
Aggregator	resolveSortPath(AggregationPath.PathElement next, Iterator<AggregationPath.PathElement> path)	Resolve a sort path to the target.
org.apache.lucene.search.ScoreMode	scoreMode()
Aggregator	subAggregator(String name)	Return the sub aggregator with the provided name.
Aggregator[]	subAggregators()	Get the aggregators running under this one.

Methods inherited from class org.elasticsearch.search.aggregations.Aggregator

buildTopLevel, resolveSortPathOnValidAgg

Methods inherited from class java.lang.Object

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

Method Details

scoreMode

public org.apache.lucene.search.ScoreMode scoreMode()

close

public void close()

name

public String name()

Description copied from class: Aggregator

Return the name of this aggregator.

Specified by:

name in class Aggregator

parent

public Aggregator parent()

Description copied from class: Aggregator

Return the parent aggregator.

Specified by:

parent in class Aggregator

subAggregator

public Aggregator subAggregator(String name)

Description copied from class: Aggregator

Return the sub aggregator with the provided name.

Specified by:

subAggregator in class Aggregator

buildAggregations

public InternalAggregation[] buildAggregations(long[] owningBucketOrds)
                                        throws IOException

Description copied from class: Aggregator

Build the results of this aggregation.

Specified by:

buildAggregations in class Aggregator

Parameters:

owningBucketOrds - the ordinals of the buckets that we want to collect from this aggregation

Returns:

the results for each ordinal, in the same order as the array of ordinals

Throws:

IOException

buildEmptyAggregation

public InternalAggregation buildEmptyAggregation()

Description copied from class: Aggregator

Build an empty aggregation.

Specified by:

buildEmptyAggregation in class Aggregator

collectDebugInfo

public void collectDebugInfo(BiConsumer<String,Object> add)

Description copied from class: Aggregator

Collect debug information to add to the profiling results. This will only be called if the aggregation is being profiled.

Well behaved implementations will always call the superclass implementation just in case it has something interesting. They will also only add objects which can be serialized with StreamOutput.writeGenericValue(Object) and XContentBuilder.value(Object). And they'll have an integration test.

Overrides:

collectDebugInfo in class Aggregator

getLeafCollector

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

Specified by:

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

Specified by:

getLeafCollector in class BucketCollector

Throws:

IOException

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

resolveSortPath

public Aggregator resolveSortPath(AggregationPath.PathElement next,
 Iterator<AggregationPath.PathElement> path)

Description copied from class: Aggregator

Resolve a sort path to the target.

The default implementation throws an exception but we override it on aggregations that support sorting.

Overrides:

resolveSortPath in class Aggregator

bucketComparator

public Aggregator.BucketComparator bucketComparator(String key,
 SortOrder order)

Description copied from class: Aggregator

Builds a comparator that compares two buckets aggregated by this Aggregator.

The default implementation throws an exception but we override it on aggregations that support sorting.

Overrides:

bucketComparator in class Aggregator

subAggregators

public Aggregator[] subAggregators()

Description copied from class: Aggregator

Get the aggregators running under this one.

Specified by:

subAggregators in class Aggregator