org.elasticsearch.search.aggregations

Interface Aggregator.Parser

All Known Implementing Classes:

AbstractPercentilesParser, AbstractTermsParser, AbstractValuesSourceParser, AbstractValuesSourceParser.AnyValuesSourceParser, AbstractValuesSourceParser.BytesValuesSourceParser, AbstractValuesSourceParser.GeoPointValuesSourceParser, AbstractValuesSourceParser.NumericValuesSourceParser, AvgParser, CardinalityParser, ChildrenParser, DateHistogramParser, DateRangeParser, DiversifiedSamplerParser, ExtendedStatsParser, FilterParser, FiltersParser, GeoBoundsParser, GeoCentroidParser, GeoDistanceParser, GeoHashGridParser, GlobalParser, HistogramParser, IpRangeParser, MaxParser, MinParser, MissingParser, NestedParser, PercentileRanksParser, PercentilesParser, RangeParser, ReverseNestedParser, SamplerParser, ScriptedMetricParser, SignificantTermsParser, StatsParser, SumParser, TermsParser, TopHitsParser, ValueCountParser

Enclosing class:

Aggregator

public static interface Aggregator.Parser

Parses the aggregation request and creates the appropriate aggregator factory for it.

See Also:

AggregatorBuilder

Method Summary

Modifier and Type	Method and Description
AggregatorBuilder<?>	getFactoryPrototypes()
AggregatorBuilder<?>	parse(java.lang.String aggregationName, XContentParser parser, QueryParseContext context) Returns the aggregator factory with which this parser is associated, may return null indicating the aggregation should be skipped (e.g.
java.lang.String	type()

Method Detail

type

java.lang.String type()

Returns:

The aggregation type this parser is associated with.

parse

AggregatorBuilder<?> parse(java.lang.String aggregationName,
                           XContentParser parser,
                           QueryParseContext context)
                    throws java.io.IOException

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

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:

java.io.IOException - When parsing fails

getFactoryPrototypes

AggregatorBuilder<?> getFactoryPrototypes()

Returns:

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