org.elasticsearch.search.aggregations.bucket.geogrid

Class GeoHashGridParser

java.lang.Object

org.elasticsearch.search.aggregations.bucket.geogrid.GeoHashGridParser

All Implemented Interfaces:

Aggregator.Parser

public class GeoHashGridParser
extends Object
implements Aggregator.Parser

Aggregates Geo information into cells determined by geohashes of a given precision. WARNING - for high-precision geohashes it may prove necessary to use a GeoBoundingBoxFilterBuilder aggregation to focus in on a smaller area to avoid generating too many buckets and using too much RAM

Field Summary

Fields

Modifier and Type	Field and Description
static int	DEFAULT_MAX_NUM_CELLS
static int	DEFAULT_PRECISION

Constructor Summary

Constructors

Constructor and Description
GeoHashGridParser()

Method Summary

Modifier and Type	Method and Description
AggregatorFactory	parse(String aggregationName, XContentParser parser, SearchContext context) Returns the aggregator factory with which this parser is associated, may return null indicating the aggregation should be skipped (e.g.
String	type()

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_PRECISION

public static final int DEFAULT_PRECISION

See Also:

Constant Field Values

DEFAULT_MAX_NUM_CELLS

public static final int DEFAULT_MAX_NUM_CELLS

See Also:

Constant Field Values

Constructor Detail

GeoHashGridParser

public GeoHashGridParser()

Method Detail

type

public String type()

Specified by:

type in interface Aggregator.Parser

Returns:

The aggregation type this parser is associated with.

parse

public AggregatorFactory parse(String aggregationName,
                               XContentParser parser,
                               SearchContext context)
                        throws IOException

Description copied from interface: Aggregator.Parser

Returns the aggregator factory with which this parser is associated, may return null indicating the aggregation should be skipped (e.g. when trying to aggregate on unmapped fields).

Specified by:

parse in interface Aggregator.Parser

Parameters:

aggregationName - The name of the aggregation

parser - The xcontent parser

context - The search context

Returns:

The resolved aggregator factory or null in case the aggregation should be skipped

Throws:

IOException - When parsing fails