org.elasticsearch.search.aggregations.bucket.geogrid

Class InternalGeoHashGrid

java.lang.Object

org.elasticsearch.search.aggregations.InternalAggregation

org.elasticsearch.search.aggregations.bucket.geogrid.InternalGeoHashGrid

All Implemented Interfaces:

Streamable, ToXContent, Aggregation, GeoHashGrid, MultiBucketsAggregation

public class InternalGeoHashGrid
extends InternalAggregation
implements GeoHashGrid

Represents a grid of cells where each cell's location is determined by a geohash. All geohashes in a grid are of the same precision and held internally as a single long for efficiency's sake.

Nested Class Summary

Nested classes/interfaces inherited from class org.elasticsearch.search.aggregations.InternalAggregation

InternalAggregation.CommonFields, InternalAggregation.ReduceContext, InternalAggregation.Type

Nested classes/interfaces inherited from interface org.elasticsearch.common.xcontent.ToXContent

ToXContent.DelegatingMapParams, ToXContent.MapParams, ToXContent.Params

Field Summary

Fields

Modifier and Type	Field and Description
protected Map<String,org.elasticsearch.search.aggregations.bucket.geogrid.InternalGeoHashGrid.Bucket>	bucketMap
static AggregationStreams.Stream	STREAM
static InternalAggregation.Type	TYPE

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

name

Fields inherited from interface org.elasticsearch.common.xcontent.ToXContent

EMPTY_PARAMS

Constructor Summary

Constructors

Constructor and Description
InternalGeoHashGrid(String name, int requiredSize, Collection<org.elasticsearch.search.aggregations.bucket.geogrid.InternalGeoHashGrid.Bucket> buckets)

Method Summary

Modifier and Type	Method and Description
XContentBuilder	doXContentBody(XContentBuilder builder, ToXContent.Params params)
GeoHashGrid.Bucket	getBucketByKey(GeoPoint key)
GeoHashGrid.Bucket	getBucketByKey(Number key)
GeoHashGrid.Bucket	getBucketByKey(String geohash) The bucket that is associated with the given key.
Collection<GeoHashGrid.Bucket>	getBuckets()
void	readFrom(StreamInput in)
InternalGeoHashGrid	reduce(InternalAggregation.ReduceContext reduceContext) Reduces the given addAggregation to a single one and returns it.
static void	registerStreams()
InternalAggregation.Type	type()
void	writeTo(StreamOutput out)

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

getName, readSize, toXContent, writeSize

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.elasticsearch.search.aggregations.Aggregation

getName

Field Detail

TYPE

public static final InternalAggregation.Type TYPE

STREAM

public static final AggregationStreams.Stream STREAM

bucketMap

protected Map<String,org.elasticsearch.search.aggregations.bucket.geogrid.InternalGeoHashGrid.Bucket> bucketMap

Constructor Detail

InternalGeoHashGrid

public InternalGeoHashGrid(String name,
                           int requiredSize,
                           Collection<org.elasticsearch.search.aggregations.bucket.geogrid.InternalGeoHashGrid.Bucket> buckets)

Method Detail

registerStreams

public static void registerStreams()

type

public InternalAggregation.Type type()

Specified by:

type in class InternalAggregation

Returns:

The InternalAggregation.Type of this aggregation

getBuckets

public Collection<GeoHashGrid.Bucket> getBuckets()

Specified by:

getBuckets in interface GeoHashGrid

Specified by:

getBuckets in interface MultiBucketsAggregation

Returns:

The buckets of this aggregation (each bucket representing a geohash grid cell)

getBucketByKey

public GeoHashGrid.Bucket getBucketByKey(String geohash)

Description copied from interface: MultiBucketsAggregation

The bucket that is associated with the given key.

Specified by:

getBucketByKey in interface GeoHashGrid

Specified by:

getBucketByKey in interface MultiBucketsAggregation

Parameters:

geohash - The key of the requested bucket.

Returns:

The bucket

getBucketByKey

public GeoHashGrid.Bucket getBucketByKey(Number key)

Specified by:

getBucketByKey in interface GeoHashGrid

getBucketByKey

public GeoHashGrid.Bucket getBucketByKey(GeoPoint key)

Specified by:

getBucketByKey in interface GeoHashGrid

reduce

public InternalGeoHashGrid reduce(InternalAggregation.ReduceContext reduceContext)

Description copied from class: InternalAggregation

Reduces the given addAggregation to a single one and returns it. In most cases, the assumption will be the all given addAggregation are of the same type (the same type as this aggregation). For best efficiency, when implementing, try reusing an existing get instance (typically the first in the given list) to save on redundant object construction.

Specified by:

reduce in class InternalAggregation

readFrom

public void readFrom(StreamInput in)
              throws IOException

Specified by:

readFrom in interface Streamable

Throws:

IOException

writeTo

public void writeTo(StreamOutput out)
             throws IOException

Specified by:

writeTo in interface Streamable

Throws:

IOException

doXContentBody

public XContentBuilder doXContentBody(XContentBuilder builder,
                                      ToXContent.Params params)
                               throws IOException

Specified by:

doXContentBody in class InternalAggregation

Throws:

IOException