org.elasticsearch.search.aggregations.bucket.geogrid

Interface GeoHashGrid

All Superinterfaces:

Aggregation, MultiBucketsAggregation

All Known Implementing Classes:

InternalGeoHashGrid

public interface GeoHashGrid
extends MultiBucketsAggregation

A geohash_grid aggregation. Defines multiple buckets, each representing a cell in a geo-grid of a specific precision.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	GeoHashGrid.Bucket A bucket that is associated with a geohash_grid cell.

Method Summary

Modifier and Type	Method and Description
GeoHashGrid.Bucket	getBucketByKey(GeoPoint key)
GeoHashGrid.Bucket	getBucketByKey(Number key)
GeoHashGrid.Bucket	getBucketByKey(String key) The bucket that is associated with the given key.
Collection<GeoHashGrid.Bucket>	getBuckets()

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

getName

Method Detail

getBuckets

Collection<GeoHashGrid.Bucket> getBuckets()

Specified by:

getBuckets in interface MultiBucketsAggregation

Returns:

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

getBucketByKey

GeoHashGrid.Bucket getBucketByKey(String key)

Description copied from interface: MultiBucketsAggregation

The bucket that is associated with the given key.

Specified by:

getBucketByKey in interface MultiBucketsAggregation

Parameters:

key - The key of the requested bucket.

Returns:

The bucket

getBucketByKey

GeoHashGrid.Bucket getBucketByKey(Number key)

getBucketByKey

GeoHashGrid.Bucket getBucketByKey(GeoPoint key)