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, Collector, 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.Aggregator

Aggregator.Parser, Aggregator.SubAggCollectionMode

Field Summary

Fields

Modifier and Type	Field	Description
protected LongHash	bucketOrds
protected int	requiredSize
protected int	shardSize
protected CellIdSource	valuesSource

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

collectableSubAggregators, context, DEFAULT_WEIGHT, name, parent, subAggregators

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

NO_OP_COLLECTOR

Method Summary

Modifier and Type	Method	Description
InternalGeoGrid	buildAggregation(long owningBucketOrdinal)	Build an aggregation for data that has been collected into bucket.
InternalGeoGrid	buildEmptyAggregation()	Build an empty aggregation.
void	doClose()	Release instance-specific data.
LeafBucketCollector	getLeafCollector(LeafReaderContext ctx, LeafBucketCollector sub)	Get a LeafBucketCollector for the given ctx, which should delegate to the given collector.
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

bucketAggregations, bucketDocCount, bucketEmptyAggregations, close, collectBucket, collectExistingBucket, consumeBucketsAndMaybeBreak, getDocCounts, grow, incrementBucketDocCount, maxBucketOrd, mergeBuckets

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

addRequestCircuitBreakerBytes, buildEmptySubAggregations, context, doPostCollection, doPreCollection, getLeafCollector, metaData, name, parent, pipelineAggregators, postCollection, preCollection, preGetSubLeafCollectors, subAggregator, subAggregators, toString

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

descendsFromBucketAggregator

Methods inherited from class java.lang.Object

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

Field Detail

requiredSize

protected final int requiredSize

shardSize

protected final int shardSize

valuesSource

protected final CellIdSource valuesSource

bucketOrds

protected final LongHash bucketOrds

Method Detail

scoreMode

public 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 Collector

Overrides:

scoreMode in class AggregatorBase

getLeafCollector

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

Description copied from class: AggregatorBase

Get a LeafBucketCollector for the given ctx, which should delegate to the given collector.

Specified by:

getLeafCollector in class AggregatorBase

Throws:

IOException

buildAggregation

public InternalGeoGrid buildAggregation(long owningBucketOrdinal)
                                 throws IOException

Description copied from class: Aggregator

Build an aggregation for data that has been collected into bucket.

Specified by:

buildAggregation in class Aggregator

Throws:

IOException

buildEmptyAggregation

public InternalGeoGrid 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