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:

NamedWriteable, Writeable, ToXContent, ToXContentFragment, 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.ReduceContext

Nested classes/interfaces inherited from interface org.elasticsearch.search.aggregations.Aggregation

Aggregation.CommonFields

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

ToXContent.DelegatingMapParams, ToXContent.MapParams, ToXContent.Params

Nested classes/interfaces inherited from interface org.elasticsearch.common.io.stream.Writeable

Writeable.Reader<V>, Writeable.Writer<V>

Field Summary

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

metaData, name

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

TYPED_KEYS_DELIMITER

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

EMPTY_PARAMS

Constructor Summary

Constructors

Constructor and Description
InternalGeoHashGrid(StreamInput in) Read from a stream.

Method Summary

Modifier and Type	Method and Description
InternalGeoHashGrid	create(java.util.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 boolean	doEquals(java.lang.Object obj) Opportunity for subclasses to add criteria to the InternalAggregation.equals(Object) method for this class.
protected int	doHashCode() Opportunity for subclasses to the InternalAggregation.hashCode() for this class.
InternalGeoHashGrid	doReduce(java.util.List<InternalAggregation> aggregations, InternalAggregation.ReduceContext reduceContext)
protected void	doWriteTo(StreamOutput out)
XContentBuilder	doXContentBody(XContentBuilder builder, ToXContent.Params params)
java.util.List<org.elasticsearch.search.aggregations.bucket.geogrid.InternalGeoHashGrid.Bucket>	getBuckets()
java.lang.String	getWriteableName() Returns the name of the writeable object

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

getProperty

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

equals, getMetaData, getName, getProperty, getType, hashCode, pipelineAggregators, readSize, reduce, toString, toXContent, writeSize, writeTo

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

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

getMetaData, getName, getType

Methods inherited from interface org.elasticsearch.common.xcontent.ToXContentFragment

isFragment

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

toXContent

Constructor Detail

InternalGeoHashGrid

public InternalGeoHashGrid(StreamInput in)
                    throws java.io.IOException

Read from a stream.

Throws:

java.io.IOException

Method Detail

doWriteTo

protected void doWriteTo(StreamOutput out)
                  throws java.io.IOException

Specified by:

doWriteTo in class InternalAggregation

Throws:

java.io.IOException

getWriteableName

public java.lang.String getWriteableName()

Description copied from interface: NamedWriteable

Returns the name of the writeable object

Specified by:

getWriteableName in interface NamedWriteable

create

public InternalGeoHashGrid create(java.util.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 java.util.List<org.elasticsearch.search.aggregations.bucket.geogrid.InternalGeoHashGrid.Bucket> getBuckets()

Specified by:

getBuckets in interface GeoHashGrid

Specified by:

getBuckets in interface MultiBucketsAggregation

Specified by:

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

Returns:

The buckets of this aggregation.

doReduce

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

Specified by:

doReduce in class InternalAggregation

doXContentBody

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

Specified by:

doXContentBody in class InternalAggregation

Throws:

java.io.IOException

doHashCode

protected int doHashCode()

Description copied from class: InternalAggregation

Opportunity for subclasses to the InternalAggregation.hashCode() for this class.

Specified by:

doHashCode in class InternalAggregation

doEquals

protected boolean doEquals(java.lang.Object obj)

Description copied from class: InternalAggregation

Opportunity for subclasses to add criteria to the InternalAggregation.equals(Object) method for this class. This method can safely cast obj to the subclass since the InternalAggregation.equals(Object) method checks that obj is the same class as this

Specified by:

doEquals in class InternalAggregation