Package org.elasticsearch.search.aggregations

Class AdaptingAggregator

java.lang.Object

org.elasticsearch.search.aggregations.BucketCollector

org.elasticsearch.search.aggregations.Aggregator

org.elasticsearch.search.aggregations.AdaptingAggregator

All Implemented Interfaces:

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

Direct Known Subclasses:

StringTermsAggregatorFromFilters

public abstract class AdaptingAggregator
extends Aggregator

An Aggregator that delegates collection to another Aggregator and then translates its results into the results you'd expect from another aggregation.

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

Constructor Summary

Constructors

Constructor	Description
AdaptingAggregator(Aggregator parent, AggregatorFactories subAggregators, org.elasticsearch.core.CheckedFunction<AggregatorFactories,? extends Aggregator,IOException> delegate)

Method Summary

Modifier and Type	Method	Description
protected abstract InternalAggregation	adapt(InternalAggregation delegateResult)	Adapt the result from the collecting Aggregator into the result expected 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.
Aggregator	delegate()
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.
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

bucketComparator, buildTopLevel, resolveSortPath, resolveSortPathOnValidAgg

Methods inherited from class java.lang.Object

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

Constructor Details

AdaptingAggregator

public AdaptingAggregator(Aggregator parent,
 AggregatorFactories subAggregators,
 org.elasticsearch.core.CheckedFunction<AggregatorFactories,? extends Aggregator,IOException> delegate)
                   throws IOException

Throws:

IOException

Method Details

adapt

protected abstract InternalAggregation adapt(InternalAggregation delegateResult)
                                      throws IOException

Adapt the result from the collecting Aggregator into the result expected by this Aggregator.

Throws:

IOException

close

public final void close()

scoreMode

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

name

public final String name()

Description copied from class: Aggregator

Return the name of this aggregator.

Specified by:

name in class Aggregator

parent

public final Aggregator parent()

Description copied from class: Aggregator

Return the parent aggregator.

Specified by:

parent in class Aggregator

subAggregator

public final Aggregator subAggregator(String name)

Description copied from class: Aggregator

Return the sub aggregator with the provided name.

Specified by:

subAggregator in class Aggregator

getLeafCollector

public final 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 final void preCollection()
                         throws IOException

Description copied from class: BucketCollector

Pre collection callback.

Specified by:

preCollection in class BucketCollector

Throws:

IOException

postCollection

public final void postCollection()
                          throws IOException

Description copied from class: BucketCollector

Post-collection callback.

Specified by:

postCollection in class BucketCollector

Throws:

IOException

buildAggregations

public final 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 final InternalAggregation buildEmptyAggregation()

Description copied from class: Aggregator

Build an empty aggregation.

Specified by:

buildEmptyAggregation in class Aggregator

subAggregators

public final Aggregator[] subAggregators()

Description copied from class: Aggregator

Get the aggregators running under this one.

Specified by:

subAggregators 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

delegate

public Aggregator delegate()