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:
java.io.Closeable
,java.lang.AutoCloseable
,org.apache.lucene.search.Collector
,org.elasticsearch.common.lease.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(java.lang.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(java.util.function.BiConsumer<java.lang.String,java.lang.Object> add)
Collect debug information to add to the profiling results.LeafBucketCollector
getLeafCollector(org.apache.lucene.index.LeafReaderContext ctx)
java.lang.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, java.util.Iterator<AggregationPath.PathElement> path)
Resolve a sort path to the target.org.apache.lucene.search.ScoreMode
scoreMode()
Aggregator
subAggregator(java.lang.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 java.lang.String name()Description copied from class:Aggregator
Return the name of this aggregator.- Specified by:
name
in classAggregator
-
parent
Description copied from class:Aggregator
Return the parent aggregator.- Specified by:
parent
in classAggregator
-
subAggregator
Description copied from class:Aggregator
Return the sub aggregator with the provided name.- Specified by:
subAggregator
in classAggregator
-
buildAggregations
Description copied from class:Aggregator
Build the results of this aggregation.- Specified by:
buildAggregations
in classAggregator
- 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:
java.io.IOException
-
buildEmptyAggregation
Description copied from class:Aggregator
Build an empty aggregation.- Specified by:
buildEmptyAggregation
in classAggregator
-
collectDebugInfo
public void collectDebugInfo(java.util.function.BiConsumer<java.lang.String,java.lang.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)
andXContentBuilder.value(Object)
. And they'll have an integration test.- Overrides:
collectDebugInfo
in classAggregator
-
getLeafCollector
public LeafBucketCollector getLeafCollector(org.apache.lucene.index.LeafReaderContext ctx) throws java.io.IOException- Specified by:
getLeafCollector
in interfaceorg.apache.lucene.search.Collector
- Specified by:
getLeafCollector
in classBucketCollector
- Throws:
java.io.IOException
-
preCollection
public void preCollection() throws java.io.IOExceptionDescription copied from class:BucketCollector
Pre collection callback.- Specified by:
preCollection
in classBucketCollector
- Throws:
java.io.IOException
-
postCollection
public void postCollection() throws java.io.IOExceptionDescription copied from class:BucketCollector
Post-collection callback.- Specified by:
postCollection
in classBucketCollector
- Throws:
java.io.IOException
-
resolveSortPath
public Aggregator resolveSortPath(AggregationPath.PathElement next, java.util.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 classAggregator
-
bucketComparator
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 classAggregator
-
subAggregators
Description copied from class:Aggregator
Get the aggregators running under this one.- Specified by:
subAggregators
in classAggregator
-