org.elasticsearch.search.aggregations.bucket.geogrid

Class InternalGeoHashGrid

java.lang.Object

org.elasticsearch.search.aggregations.InternalAggregation

org.elasticsearch.search.aggregations.InternalMultiBucketAggregation<InternalGeoHashGrid,org.elasticsearch.search.aggregations.bucket.geogrid.InternalGeoHashGrid.Bucket>

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

All Implemented Interfaces:

Streamable, ToXContent, Aggregation, GeoHashGrid, MultiBucketsAggregation

public class InternalGeoHashGrid
extends InternalMultiBucketAggregation<InternalGeoHashGrid,org.elasticsearch.search.aggregations.bucket.geogrid.InternalGeoHashGrid.Bucket>
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.InternalMultiBucketAggregation

InternalMultiBucketAggregation.InternalBucket

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
static BucketStreams.Stream<org.elasticsearch.search.aggregations.bucket.geogrid.InternalGeoHashGrid.Bucket>	BUCKET_STREAM
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

metaData, 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, List<PipelineAggregator> pipelineAggregators, Map<String,Object> metaData)

Method Summary

Methods

Modifier and Type	Method and Description
InternalGeoHashGrid	create(List<org.elasticsearch.search.aggregations.bucket.geogrid.InternalGeoHashGrid.Bucket> buckets) Create a new copy of this Aggregation with the same settings as this Aggregation and contains the provided buckets.
org.elasticsearch.search.aggregations.bucket.geogrid.InternalGeoHashGrid.Bucket	createBucket(InternalAggregations aggregations, org.elasticsearch.search.aggregations.bucket.geogrid.InternalGeoHashGrid.Bucket prototype) Create a new InternalMultiBucketAggregation.InternalBucket using the provided prototype bucket and aggregations.
protected void	doReadFrom(StreamInput in)
InternalGeoHashGrid	doReduce(List<InternalAggregation> aggregations, InternalAggregation.ReduceContext reduceContext)
protected void	doWriteTo(StreamOutput out)
XContentBuilder	doXContentBody(XContentBuilder builder, ToXContent.Params params)
List<GeoHashGrid.Bucket>	getBuckets()
static void	registerStreams()
InternalAggregation.Type	type()

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

getProperty

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

getMetaData, getName, getProperty, pipelineAggregators, readFrom, readSize, reduce, toXContent, writeSize, writeTo

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

getMetaData, getName, getProperty

Field Detail

TYPE

public static final InternalAggregation.Type TYPE

STREAM

public static final AggregationStreams.Stream STREAM

BUCKET_STREAM

public static final BucketStreams.Stream<org.elasticsearch.search.aggregations.bucket.geogrid.InternalGeoHashGrid.Bucket> BUCKET_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,
                   List<PipelineAggregator> pipelineAggregators,
                   Map<String,Object> metaData)

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

create

public InternalGeoHashGrid create(List<org.elasticsearch.search.aggregations.bucket.geogrid.InternalGeoHashGrid.Bucket> buckets)

Description copied from class: InternalMultiBucketAggregation

Create a new copy of this Aggregation with the same settings as this Aggregation and contains the provided buckets.

Specified by:

create in class InternalMultiBucketAggregation<InternalGeoHashGrid,org.elasticsearch.search.aggregations.bucket.geogrid.InternalGeoHashGrid.Bucket>

Parameters:

buckets - the buckets to use in the new Aggregation

Returns:

the new Aggregation

createBucket

public org.elasticsearch.search.aggregations.bucket.geogrid.InternalGeoHashGrid.Bucket createBucket(InternalAggregations aggregations,
                                                                                           org.elasticsearch.search.aggregations.bucket.geogrid.InternalGeoHashGrid.Bucket prototype)

Description copied from class: InternalMultiBucketAggregation

Create a new InternalMultiBucketAggregation.InternalBucket using the provided prototype bucket and aggregations.

Specified by:

createBucket in class InternalMultiBucketAggregation<InternalGeoHashGrid,org.elasticsearch.search.aggregations.bucket.geogrid.InternalGeoHashGrid.Bucket>

Parameters:

aggregations - the aggregations for the new bucket

prototype - the bucket to use as a prototype

Returns:

the new bucket

getBuckets

public List<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)

doReduce

public InternalGeoHashGrid doReduce(List<InternalAggregation> aggregations,
                           InternalAggregation.ReduceContext reduceContext)

Specified by:

doReduce in class InternalAggregation

doReadFrom

protected void doReadFrom(StreamInput in)
                   throws IOException

Specified by:

doReadFrom in class InternalAggregation

Throws:

IOException

doWriteTo

protected void doWriteTo(StreamOutput out)
                  throws IOException

Specified by:

doWriteTo in class InternalAggregation

Throws:

IOException

doXContentBody

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

Specified by:

doXContentBody in class InternalAggregation

Throws:

IOException