org.elasticsearch.search.aggregations.bucket.range.ip

Class IpRangeParser

java.lang.Object

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

org.elasticsearch.search.aggregations.support.AbstractValuesSourceParser.BytesValuesSourceParser

org.elasticsearch.search.aggregations.bucket.range.ip.IpRangeParser

All Implemented Interfaces:

Aggregator.Parser

public class IpRangeParser
extends AbstractValuesSourceParser.BytesValuesSourceParser

A parser for ip range aggregations.

Nested Class Summary

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

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

Constructor Summary

Constructors

Constructor and Description
IpRangeParser()

Method Summary

Modifier and Type	Method and Description
protected ValuesSourceAggregationBuilder<ValuesSource.Bytes,?>	createFactory(java.lang.String aggregationName, ValuesSourceType valuesSourceType, ValueType targetValueType, java.util.Map<ParseField,java.lang.Object> otherOptions) Creates a ValuesSourceAggregationBuilder from the information gathered by the subclass.
protected boolean	token(java.lang.String aggregationName, java.lang.String currentFieldName, XContentParser.Token token, XContentParseContext context, 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).

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

Constructor Detail

IpRangeParser

public IpRangeParser()

Method Detail

createFactory

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

Description copied from class: AbstractValuesSourceParser

Creates a ValuesSourceAggregationBuilder 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.Bytes>

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, XContentParser.Token, XContentParseContext, Map) method

Returns:

the created factory

token

protected boolean token(java.lang.String aggregationName,
                        java.lang.String currentFieldName,
                        XContentParser.Token token,
                        XContentParseContext context,
                        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.Bytes>

Parameters:

aggregationName - the name of the aggregation

currentFieldName - the name of the current field being parsed

token - the current token for the parser

context - the query context

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