org.elasticsearch.search.aggregations.metrics.percentiles

Class AbstractPercentilesParser

java.lang.Object

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

org.elasticsearch.search.aggregations.support.AbstractValuesSourceParser.NumericValuesSourceParser

org.elasticsearch.search.aggregations.metrics.percentiles.AbstractPercentilesParser

All Implemented Interfaces:

Aggregator.Parser

Direct Known Subclasses:

PercentileRanksParser, PercentilesParser

public abstract class AbstractPercentilesParser
extends AbstractValuesSourceParser.NumericValuesSourceParser

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 ParseField	COMPRESSION_FIELD
static ParseField	KEYED_FIELD
static ParseField	METHOD_FIELD
static ParseField	NUMBER_SIGNIFICANT_DIGITS_FIELD

Constructor Summary

Constructors

Constructor and Description
AbstractPercentilesParser(boolean formattable)

Method Summary

Modifier and Type	Method and Description
protected abstract ValuesSourceAggregationBuilder<ValuesSource.Numeric,?>	buildFactory(java.lang.String aggregationName, double[] cdfValues, PercentilesMethod method, java.lang.Double compression, java.lang.Integer numberOfSignificantValueDigits, java.lang.Boolean keyed)
protected ValuesSourceAggregationBuilder<ValuesSource.Numeric,?>	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 abstract ParseField	keysField()
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

Field Detail

KEYED_FIELD

public static final ParseField KEYED_FIELD

METHOD_FIELD

public static final ParseField METHOD_FIELD

COMPRESSION_FIELD

public static final ParseField COMPRESSION_FIELD

NUMBER_SIGNIFICANT_DIGITS_FIELD

public static final ParseField NUMBER_SIGNIFICANT_DIGITS_FIELD

Constructor Detail

AbstractPercentilesParser

public AbstractPercentilesParser(boolean formattable)

Method Detail

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.Numeric>

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

createFactory

protected ValuesSourceAggregationBuilder<ValuesSource.Numeric,?> 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.Numeric>

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

buildFactory

protected abstract ValuesSourceAggregationBuilder<ValuesSource.Numeric,?> buildFactory(java.lang.String aggregationName,
                                                                                       double[] cdfValues,
                                                                                       PercentilesMethod method,
                                                                                       java.lang.Double compression,
                                                                                       java.lang.Integer numberOfSignificantValueDigits,
                                                                                       java.lang.Boolean keyed)

keysField

protected abstract ParseField keysField()