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

Class GeoGridAggregator<T extends InternalGeoGrid>

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<T>

All Implemented Interfaces:

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

Direct Known Subclasses:

GeoHashGridAggregator, GeoTileGridAggregator

public abstract class GeoGridAggregator<T extends InternalGeoGrid>
extends BucketsAggregator

Aggregates data expressed as longs (for efficiency's sake) but formats results as aggregation-specific 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

Modifier and Type	Field	Description
protected final LongKeyedBucketOrds	bucketOrds
protected final int	requiredSize
protected final int	shardSize
protected final ValuesSource.Numeric	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

Modifier	Constructor	Description
protected	GeoGridAggregator(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 abstract T	buildAggregation(String name, int requiredSize, List<InternalGeoGridBucket> buckets, Map<String,Object> metadata)
InternalAggregation[]	buildAggregations(long[] owningBucketOrds)
InternalGeoGrid	buildEmptyAggregation()
void	doClose()
LeafBucketCollector	getLeafCollector(LeafReaderContext ctx, LeafBucketCollector sub)
protected abstract InternalGeoGridBucket	newEmptyBucket()	This method is used to return a re-usable instance of the bucket when building the aggregation.
org.apache.lucene.search.ScoreMode	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

Field Details

requiredSize

protected final int requiredSize

shardSize

protected final int shardSize

valuesSource

protected final ValuesSource.Numeric valuesSource

bucketOrds

protected final LongKeyedBucketOrds bucketOrds

Constructor Details

GeoGridAggregator

protected GeoGridAggregator(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

scoreMode

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

Specified by:

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

Overrides:

scoreMode in class AggregatorBase

getLeafCollector

public LeafBucketCollector getLeafCollector(LeafReaderContext ctx,
 LeafBucketCollector sub)
                                     throws IOException

Specified by:

getLeafCollector in class AggregatorBase

Throws:

IOException

buildAggregation

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

newEmptyBucket

protected abstract InternalGeoGridBucket newEmptyBucket()

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

Returns:

a new InternalGeoGridBucket implementation with empty parameters

buildAggregations

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

Specified by:

buildAggregations in class Aggregator

Throws:

IOException

buildEmptyAggregation

public InternalGeoGrid buildEmptyAggregation()

Specified by:

buildEmptyAggregation in class Aggregator

doClose

public void doClose()

Overrides:

doClose in class AggregatorBase