org.elasticsearch.search.aggregations.metrics.tophits

Class TopHitsParser

java.lang.Object

org.elasticsearch.search.aggregations.metrics.tophits.TopHitsParser

All Implemented Interfaces:

Aggregator.Parser

public class TopHitsParser
extends Object
implements Aggregator.Parser

Constructor Summary

Constructors

Constructor and Description
TopHitsParser(FetchPhase fetchPhase, SortParseElement sortParseElement, FetchSourceParseElement sourceParseElement, HighlighterParseElement highlighterParseElement, FieldDataFieldsParseElement fieldDataFieldsParseElement, ScriptFieldsParseElement scriptFieldsParseElement, FieldsParseElement fieldsParseElement)

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

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

TopHitsParser

@Inject
public TopHitsParser(FetchPhase fetchPhase,
                    SortParseElement sortParseElement,
                    FetchSourceParseElement sourceParseElement,
                    HighlighterParseElement highlighterParseElement,
                    FieldDataFieldsParseElement fieldDataFieldsParseElement,
                    ScriptFieldsParseElement scriptFieldsParseElement,
                    FieldsParseElement fieldsParseElement)

Method Detail

type

public String type()

Specified by:

type in interface Aggregator.Parser

Returns:

The aggregation type this parser is associated with.

parse

public AggregatorFactory parse(String aggregationName,
                      XContentParser parser,
                      SearchContext context)
                        throws IOException

Description copied from interface: Aggregator.Parser

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

Specified by:

parse in interface Aggregator.Parser

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