Package org.opensearch.geo.search.aggregations.bucket.geogrid

Class GeoHashGridAggregator

java.lang.Object

org.opensearch.search.aggregations.BucketCollector

org.opensearch.search.aggregations.Aggregator

org.opensearch.search.aggregations.AggregatorBase

org.opensearch.search.aggregations.bucket.BucketsAggregator

org.opensearch.geo.search.aggregations.bucket.geogrid.GeoGridAggregator<InternalGeoHashGrid>

org.opensearch.geo.search.aggregations.bucket.geogrid.GeoHashGridAggregator

All Implemented Interfaces:

Closeable, AutoCloseable, org.apache.lucene.search.Collector, org.opensearch.common.lease.Releasable

public class GeoHashGridAggregator
extends GeoGridAggregator<InternalGeoHashGrid>

Aggregates data expressed as GeoHash longs (for efficiency's sake) but formats results as Geohash strings.

Opensearch.internal:

Nested Class Summary

Nested classes/interfaces inherited from class org.opensearch.search.aggregations.bucket.BucketsAggregator

BucketsAggregator.BucketBuilderForFixedCount<B>, BucketsAggregator.BucketBuilderForVariable<B>, BucketsAggregator.ResultBuilderForVariable<B>, BucketsAggregator.SingleBucketResultBuilder

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

Aggregator.BucketComparator, Aggregator.Parser, Aggregator.SubAggCollectionMode

Field Summary

Fields inherited from class org.opensearch.geo.search.aggregations.bucket.geogrid.GeoGridAggregator

bucketOrds, requiredSize, shardSize, valuesSource

Fields inherited from class org.opensearch.search.aggregations.bucket.BucketsAggregator

docCountProvider

Fields inherited from class org.opensearch.search.aggregations.AggregatorBase

collectableSubAggregators, context, DEFAULT_WEIGHT, name, parent, subAggregators

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

NO_OP_COLLECTOR

Constructor Summary

Constructors

Constructor	Description
GeoHashGridAggregator(String name, AggregatorFactories factories, ValuesSource.Numeric valuesSource, int requiredSize, int shardSize, SearchContext aggregationContext, Aggregator parent, CardinalityUpperBound cardinality, Map<String,Object> metadata)

Method Summary

Modifier and Type	Method	Description
protected InternalGeoHashGrid	buildAggregation(String name, int requiredSize, List<InternalGeoGridBucket> buckets, Map<String,Object> metadata)
InternalGeoHashGrid	buildEmptyAggregation()
protected InternalGeoGridBucket	newEmptyBucket()	This method is used to return a re-usable instance of the bucket when building the aggregation.

Methods inherited from class org.opensearch.geo.search.aggregations.bucket.geogrid.GeoGridAggregator

buildAggregations, doClose, getLeafCollector, scoreMode

Methods inherited from class org.opensearch.search.aggregations.bucket.BucketsAggregator

beforeBuildingBuckets, bucketComparator, bucketDocCount, buildAggregationsForFixedBucketCount, buildAggregationsForSingleBucket, buildAggregationsForVariableBuckets, buildSubAggsForAllBuckets, buildSubAggsForBuckets, buildSubAggsForBuckets, close, collectBucket, collectExistingBucket, descendsFromGlobalAggregator, getDocCounts, grow, incrementBucketDocCount, maxBucketOrd, mergeBuckets, mergeBuckets, preGetSubLeafCollectors, resolveSortPath

Methods inherited from class org.opensearch.search.aggregations.AggregatorBase

addRequestCircuitBreakerBytes, buildEmptySubAggregations, context, doPostCollection, doPreCollection, getLeafCollector, metadata, name, parent, pointReaderIfAvailable, postCollection, preCollection, subAggregator, subAggregators, toString

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

buildTopLevel, collectDebugInfo, resolveSortPathOnValidAgg

Methods inherited from class java.lang.Object

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

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

setWeight

Constructor Details

GeoHashGridAggregator

public GeoHashGridAggregator(String name,
 AggregatorFactories factories,
 ValuesSource.Numeric valuesSource,
 int requiredSize,
 int shardSize,
 SearchContext aggregationContext,
 Aggregator parent,
 CardinalityUpperBound cardinality,
 Map<String,Object> metadata)
                      throws IOException

Throws:

IOException

Method Details

buildAggregation

protected InternalGeoHashGrid buildAggregation(String name,
 int requiredSize,
 List<InternalGeoGridBucket> buckets,
 Map<String,Object> metadata)

Specified by:

buildAggregation in class GeoGridAggregator<InternalGeoHashGrid>

buildEmptyAggregation

public InternalGeoHashGrid buildEmptyAggregation()

Overrides:

buildEmptyAggregation in class GeoGridAggregator<InternalGeoHashGrid>

newEmptyBucket

protected InternalGeoGridBucket newEmptyBucket()

Description copied from class: GeoGridAggregator

This method is used to return a re-usable instance of the bucket when building the aggregation.

Specified by:

newEmptyBucket in class GeoGridAggregator<InternalGeoHashGrid>

Returns:

a new InternalGeoGridBucket implementation with empty parameters