org.elasticsearch.search.aggregations

Interface Aggregator.Parser

All Known Implementing Classes:

AbstractPercentilesParser, AvgParser, CardinalityParser, ChildrenParser, DateHistogramParser, DateRangeParser, ExtendedStatsParser, FilterParser, FiltersParser, GeoBoundsParser, GeoCentroidParser, GeoDistanceParser, GeoHashGridParser, GlobalParser, HistogramParser, IpRangeParser, MaxParser, MinParser, MissingParser, NestedParser, NumericValuesSourceMetricsAggregatorParser, 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:

AggregatorFactory

Method Summary

Methods

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

Method Detail

type

String type()

Returns:

The aggregation type this parser is associated with.

parse

AggregatorFactory parse(String aggregationName,
                      XContentParser parser,
                      SearchContext context)
                        throws 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:

IOException - When parsing fails