org.elasticsearch.search.aggregations.bucket.children

Class ChildrenParser

java.lang.Object

org.elasticsearch.search.aggregations.bucket.children.ChildrenParser

All Implemented Interfaces:

Aggregator.Parser

public class ChildrenParser
extends java.lang.Object
implements Aggregator.Parser

Constructor Summary

Constructors

Constructor and Description
ChildrenParser()

Method Summary

Modifier and Type	Method and Description
ChildrenAggregatorBuilder	getFactoryPrototypes()
ChildrenAggregatorBuilder	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()

Methods inherited from class java.lang.Object

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

Constructor Detail

ChildrenParser

public ChildrenParser()

Method Detail

type

public java.lang.String type()

Specified by:

type in interface Aggregator.Parser

Returns:

The aggregation type this parser is associated with.

parse

public ChildrenAggregatorBuilder parse(java.lang.String aggregationName,
                                       XContentParser parser,
                                       QueryParseContext context)
                                throws java.io.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:

java.io.IOException - When parsing fails

getFactoryPrototypes

public ChildrenAggregatorBuilder getFactoryPrototypes()

Specified by:

getFactoryPrototypes in interface Aggregator.Parser

Returns:

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