Class GeoGridAggregator<T extends InternalGeoGrid<?>>
- All Implemented Interfaces:
Closeable,AutoCloseable,Releasable
- Direct Known Subclasses:
GeoHashGridAggregator,GeoTileGridAggregator
-
Nested Class Summary
Nested classes/interfaces inherited from class org.elasticsearch.search.aggregations.bucket.BucketsAggregator
BucketsAggregator.BucketBuilderForFixedCount<B>, BucketsAggregator.BucketBuilderForVariable<B>, BucketsAggregator.ResultBuilderForVariable<B>, BucketsAggregator.SingleBucketResultBuilderNested classes/interfaces inherited from class org.elasticsearch.search.aggregations.Aggregator
Aggregator.BucketComparator, Aggregator.Parser, Aggregator.SubAggCollectionModeNested classes/interfaces inherited from class org.elasticsearch.search.aggregations.BucketCollector
BucketCollector.BucketCollectorWrapper -
Field Summary
FieldsModifier and TypeFieldDescriptionprotected final LongKeyedBucketOrdsprotected final intprotected final intprotected final ValuesSource.NumericFields inherited from class org.elasticsearch.search.aggregations.bucket.BucketsAggregator
docCountProviderFields inherited from class org.elasticsearch.search.aggregations.AggregatorBase
collectableSubAggregators, context, DEFAULT_WEIGHT, name, parent, subAggregatorsFields inherited from class org.elasticsearch.search.aggregations.BucketCollector
NO_OP_BUCKET_COLLECTOR, NO_OP_COLLECTOR -
Constructor Summary
ConstructorsModifierConstructorDescriptionprotectedGeoGridAggregator(String name, AggregatorFactories factories, Function<LongConsumer, ValuesSource.Numeric> valuesSource, int requiredSize, int shardSize, AggregationContext aggregationContext, Aggregator parent, CardinalityUpperBound cardinality, Map<String, Object> metadata) -
Method Summary
Modifier and TypeMethodDescriptionprotected abstract TbuildAggregation(String name, int requiredSize, List<InternalGeoGridBucket> buckets, Map<String, Object> metadata) buildAggregations(LongArray owningBucketOrds) Build the results of this aggregation.Build an empty aggregation.voiddoClose()Release instance-specific data.Collect results for this leaf.protected abstract InternalGeoGridBucketThis method is used to return a re-usable instance of the bucket when building the aggregation.org.apache.lucene.search.ScoreModeMost aggregators don't need scores, make sure to extend this method if your aggregator needs them.Methods inherited from class org.elasticsearch.search.aggregations.bucket.BucketsAggregator
bucketComparator, bucketDocCount, buildAggregationsForFixedBucketCount, buildAggregationsForSingleBucket, buildAggregationsForVariableBuckets, buildSubAggsForAllBuckets, buildSubAggsForAllBuckets, buildSubAggsForBuckets, checkRealMemoryCBForInternalBucket, close, collectBucket, collectExistingBucket, descendsFromGlobalAggregator, getDocCounts, grow, incrementBucketDocCount, preGetSubLeafCollectors, prepareSubAggs, resolveSortPath, rewriteBucketsMethods inherited from class org.elasticsearch.search.aggregations.AggregatorBase
addRequestCircuitBreakerBytes, bigArrays, buildAggregations, buildEmptySubAggregations, checkRealMemoryCB, doPostCollection, doPreCollection, getLeafCollector, metadata, name, parent, pointReaderIfAvailable, postCollection, preCollection, releaseAggregations, searcher, subAggregator, subAggregators, topLevelQuery, toStringMethods inherited from class org.elasticsearch.search.aggregations.Aggregator
buildTopLevel, collectDebugInfo, resolveSortPathOnValidAggMethods inherited from class org.elasticsearch.search.aggregations.BucketCollector
asCollector
-
Field Details
-
requiredSize
protected final int requiredSize -
shardSize
protected final int shardSize -
valuesSource
-
bucketOrds
-
-
Constructor Details
-
GeoGridAggregator
protected GeoGridAggregator(String name, AggregatorFactories factories, Function<LongConsumer, ValuesSource.Numeric> valuesSource, int requiredSize, int shardSize, AggregationContext aggregationContext, Aggregator parent, CardinalityUpperBound cardinality, Map<String, throws IOExceptionObject> metadata) - Throws:
IOException
-
-
Method Details
-
scoreMode
public org.apache.lucene.search.ScoreMode scoreMode()Description copied from class:AggregatorBaseMost aggregators don't need scores, make sure to extend this method if your aggregator needs them.- Overrides:
scoreModein classAggregatorBase
-
getLeafCollector
public LeafBucketCollector getLeafCollector(AggregationExecutionContext aggCtx, LeafBucketCollector sub) throws IOException Description copied from class:AggregatorBaseCollect results for this leaf.Most Aggregators will return a custom
LeafBucketCollectorthat collects document information for every hit. Callers of this method will make sure to callcollectfor every hit. So anyAggregatorthat returns a customer LeafBucketCollector from this method runs at bestO(hits)time. See thesumAggregator for a fairly strait forward example of this.Some Aggregators are able to correctly collect results on their own, without being iterated by the top level query or the rest of the aggregations framework. These aggregations collect what they need by calling methods on
LeafReaderContextand then they returnLeafBucketCollector.NO_OP_COLLECTORto signal that they've done their own collection. These aggregations can do better thanO(hits). See theminAggregator for an example of an aggregation that does this. It happens to run in constant time in some cases.In other cases
MinAggregatorcan't get correct results by taking the constant time path so instead it returns a customLeafBucketCollector. This is fairly common for aggregations that have these fast paths because most of these fast paths are only possible when the aggregation is at the root of the tree.Its also useful to look at the
filtersAggregator chooses whether or not it can use the fast path before building the Aggregator rather than on each leaf. Either is fine.- Specified by:
getLeafCollectorin classAggregatorBase- Throws:
IOException
-
buildAggregation
-
newEmptyBucket
This method is used to return a re-usable instance of the bucket when building the aggregation.- Returns:
- a new
InternalGeoGridBucketimplementation with empty parameters
-
buildAggregations
Description copied from class:AggregatorBuild the results of this aggregation.- Specified by:
buildAggregationsin 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:
IOException
-
buildEmptyAggregation
Description copied from class:AggregatorBuild an empty aggregation.- Specified by:
buildEmptyAggregationin classAggregator
-
doClose
public void doClose()Description copied from class:AggregatorBaseRelease instance-specific data.- Overrides:
doClosein classAggregatorBase
-