Package org.elasticsearch.search.aggregations.bucket.geogrid

Class GeoGridAggregator<T extends InternalGeoGrid<?>>

java.lang.Object

org.elasticsearch.search.aggregations.BucketCollector

org.elasticsearch.search.aggregations.Aggregator

org.elasticsearch.search.aggregations.AggregatorBase

org.elasticsearch.search.aggregations.bucket.BucketsAggregator

org.elasticsearch.search.aggregations.bucket.geogrid.GeoGridAggregator<T>

All Implemented Interfaces:

Closeable, AutoCloseable, org.apache.lucene.search.Collector, org.elasticsearch.core.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.

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.SingleBucketResultBuilder

Nested classes/interfaces inherited from class org.elasticsearch.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.elasticsearch.search.aggregations.bucket.BucketsAggregator

docCountProvider

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

collectableSubAggregators, DEFAULT_WEIGHT, name, parent, subAggregators

Fields inherited from class org.elasticsearch.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, AggregationContext 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)	Build the results of this aggregation.
InternalAggregation	buildEmptyAggregation()	Build an empty aggregation.
void	doClose()	Release instance-specific data.
LeafBucketCollector	getLeafCollector(org.apache.lucene.index.LeafReaderContext ctx, LeafBucketCollector sub)	Collect results for this leaf.
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()	Most 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, buildSubAggsForBuckets, buildSubAggsForBuckets, close, collectBucket, collectExistingBucket, descendsFromGlobalAggregator, getDocCounts, grow, incrementBucketDocCount, maxBucketOrd, preGetSubLeafCollectors, prepareSubAggs, resolveSortPath, rewriteBuckets

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

addRequestCircuitBreakerBytes, bigArrays, buildEmptySubAggregations, doPostCollection, doPreCollection, getLeafCollector, metadata, name, parent, pointReaderIfAvailable, postCollection, preCollection, searcher, subAggregator, subAggregators, topLevelQuery, toString

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

buildTopLevel, collectDebugInfo, resolveSortPathOnValidAgg

Methods inherited from class java.lang.Object

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

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,
 AggregationContext aggregationContext,
 Aggregator parent,
 CardinalityUpperBound cardinality,
 Map<String,Object> metadata)
                     throws IOException

Throws:

IOException

Method Details

scoreMode

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

Description copied from class: AggregatorBase

Most aggregators don't need scores, make sure to extend this method if your aggregator needs them.

Specified by:

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

Overrides:

scoreMode in class AggregatorBase

getLeafCollector

public LeafBucketCollector getLeafCollector(org.apache.lucene.index.LeafReaderContext ctx,
 LeafBucketCollector sub)
                                     throws IOException

Description copied from class: AggregatorBase

Collect results for this leaf.

Most Aggregators will return a custom LeafBucketCollector that collects document information for every hit. Callers of this method will make sure to call collect for every hit. So any Aggregator that returns a customer LeafBucketCollector from this method runs at best O(hits) time. See the sum Aggregator 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 LeafReaderContext and then they return LeafBucketCollector.NO_OP_COLLECTOR to signal that they've done their own collection. These aggregations can do better than O(hits). See the min Aggregator for an example of an aggregation that does this. It happens to run in constant time in some cases.

In other cases MinAggregator can't get correct results by taking the constant time path so instead it returns a custom LeafBucketCollector. 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 filters Aggregator chooses whether or not it can use the fast path before building the Aggregator rather than on each leaf. Either is fine.

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

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

Description copied from class: Aggregator

Build an empty aggregation.

Specified by:

buildEmptyAggregation in class Aggregator

doClose

public void doClose()

Description copied from class: AggregatorBase

Release instance-specific data.

Overrides:

doClose in class AggregatorBase