org.elasticsearch.search.aggregations.bucket.geogrid

Class GeoHashGridParser

java.lang.Object

org.elasticsearch.search.aggregations.support.AbstractValuesSourceParser<ValuesSource.GeoPoint>

org.elasticsearch.search.aggregations.support.AbstractValuesSourceParser.GeoPointValuesSourceParser

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

All Implemented Interfaces:

Aggregator.Parser

public class GeoHashGridParser
extends AbstractValuesSourceParser.GeoPointValuesSourceParser

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

Nested Class Summary

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

AbstractValuesSourceParser.AnyValuesSourceParser, AbstractValuesSourceParser.BytesValuesSourceParser, AbstractValuesSourceParser.GeoPointValuesSourceParser, AbstractValuesSourceParser.NumericValuesSourceParser

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
protected GeoGridAggregatorBuilder	createFactory(java.lang.String aggregationName, ValuesSourceType valuesSourceType, ValueType targetValueType, java.util.Map<ParseField,java.lang.Object> otherOptions) Creates a ValuesSourceAggregatorBuilder from the information gathered by the subclass.
GeoGridAggregatorBuilder	getFactoryPrototypes()
protected boolean	token(java.lang.String aggregationName, java.lang.String currentFieldName, XContentParser.Token token, XContentParser parser, ParseFieldMatcher parseFieldMatcher, java.util.Map<ParseField,java.lang.Object> otherOptions) Allows subclasses of AbstractValuesSourceParser to parse extra parameters and store them in a Map which will later be passed to AbstractValuesSourceParser.createFactory(String, ValuesSourceType, ValueType, Map).
java.lang.String	type()

Methods inherited from class org.elasticsearch.search.aggregations.support.AbstractValuesSourceParser

parse

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 java.lang.String type()

Returns:

The aggregation type this parser is associated with.

getFactoryPrototypes

public GeoGridAggregatorBuilder getFactoryPrototypes()

Returns:

an empty AggregatorBuilder instance for this parser that can be used for deserialization

createFactory

protected GeoGridAggregatorBuilder createFactory(java.lang.String aggregationName,
                                                 ValuesSourceType valuesSourceType,
                                                 ValueType targetValueType,
                                                 java.util.Map<ParseField,java.lang.Object> otherOptions)

Description copied from class: AbstractValuesSourceParser

Creates a ValuesSourceAggregatorBuilder from the information gathered by the subclass. Options parsed in AbstractValuesSourceParser itself will be added to the factory after it has been returned by this method.

Specified by:

createFactory in class AbstractValuesSourceParser<ValuesSource.GeoPoint>

Parameters:

aggregationName - the name of the aggregation

valuesSourceType - the type of the ValuesSource

targetValueType - the target type of the final value output by the aggregation

otherOptions - a Map containing the extra options parsed by the AbstractValuesSourceParser.token(String, String, org.elasticsearch.common.xcontent.XContentParser.Token, XContentParser, ParseFieldMatcher, Map) method

Returns:

the created factory

token

protected boolean token(java.lang.String aggregationName,
                        java.lang.String currentFieldName,
                        XContentParser.Token token,
                        XContentParser parser,
                        ParseFieldMatcher parseFieldMatcher,
                        java.util.Map<ParseField,java.lang.Object> otherOptions)
                 throws java.io.IOException

Description copied from class: AbstractValuesSourceParser

Allows subclasses of AbstractValuesSourceParser to parse extra parameters and store them in a Map which will later be passed to AbstractValuesSourceParser.createFactory(String, ValuesSourceType, ValueType, Map).

Specified by:

token in class AbstractValuesSourceParser<ValuesSource.GeoPoint>

Parameters:

aggregationName - the name of the aggregation

currentFieldName - the name of the current field being parsed

token - the current token for the parser

parser - the parser

parseFieldMatcher - the ParseFieldMatcher to use to match field names

otherOptions - a Map of options to be populated by successive calls to this method which will then be passed to the AbstractValuesSourceParser.createFactory(String, ValuesSourceType, ValueType, Map) method

Returns:

true if the current token was correctly parsed, false otherwise

Throws:

java.io.IOException - if an error occurs whilst parsing