org.elasticsearch.search.aggregations.bucket.children

Class ChildrenAggregationBuilder

java.lang.Object

org.elasticsearch.action.support.ToXContentToBytes

org.elasticsearch.search.aggregations.AggregationBuilder

org.elasticsearch.search.aggregations.AbstractAggregationBuilder<AB>

org.elasticsearch.search.aggregations.support.ValuesSourceAggregationBuilder<ValuesSource.Bytes.ParentChild,ChildrenAggregationBuilder>

org.elasticsearch.search.aggregations.bucket.children.ChildrenAggregationBuilder

All Implemented Interfaces:

NamedWriteable, Writeable, ToXContent

public class ChildrenAggregationBuilder
extends ValuesSourceAggregationBuilder<ValuesSource.Bytes.ParentChild,ChildrenAggregationBuilder>

Nested Class Summary

Nested classes/interfaces inherited from class org.elasticsearch.search.aggregations.support.ValuesSourceAggregationBuilder

ValuesSourceAggregationBuilder.LeafOnly<VS extends ValuesSource,AB extends ValuesSourceAggregationBuilder<VS,AB>>

Nested classes/interfaces inherited from class org.elasticsearch.search.aggregations.AggregationBuilder

AggregationBuilder.CommonFields

Nested classes/interfaces inherited from interface org.elasticsearch.common.io.stream.Writeable

Writeable.Reader<V>, Writeable.Writer<V>

Nested classes/interfaces inherited from interface org.elasticsearch.common.xcontent.ToXContent

ToXContent.DelegatingMapParams, ToXContent.MapParams, ToXContent.Params

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	NAME

Fields inherited from class org.elasticsearch.search.aggregations.support.ValuesSourceAggregationBuilder

config

Fields inherited from class org.elasticsearch.search.aggregations.AbstractAggregationBuilder

metaData

Fields inherited from class org.elasticsearch.search.aggregations.AggregationBuilder

factoriesBuilder, name, type

Fields inherited from interface org.elasticsearch.common.xcontent.ToXContent

EMPTY_PARAMS

Constructor Summary

Constructors

Constructor and Description
ChildrenAggregationBuilder(StreamInput in) Read from a stream.
ChildrenAggregationBuilder(java.lang.String name, java.lang.String childType)

Method Summary

Modifier and Type	Method and Description
protected XContentBuilder	doXContentBody(XContentBuilder builder, ToXContent.Params params)
java.lang.String	getWriteableName() Returns the name of the writeable object
protected ValuesSourceAggregatorFactory<ValuesSource.Bytes.ParentChild,?>	innerBuild(AggregationContext context, ValuesSourceConfig<ValuesSource.Bytes.ParentChild> config, AggregatorFactory<?> parent, AggregatorFactories.Builder subFactoriesBuilder)
protected boolean	innerEquals(java.lang.Object obj)
protected int	innerHashCode()
protected void	innerWriteTo(StreamOutput out) Write subclass's state to the stream.
static ChildrenAggregationBuilder	parse(java.lang.String aggregationName, QueryParseContext context)
protected ValuesSourceConfig<ValuesSource.Bytes.ParentChild>	resolveConfig(AggregationContext aggregationContext)

Methods inherited from class org.elasticsearch.search.aggregations.support.ValuesSourceAggregationBuilder

config, doBuild, doEquals, doHashCode, doWriteTo, field, field, format, format, internalXContent, missing, missing, script, script, serializeTargetValueType, timeZone, timeZone, valueType, valueType

Methods inherited from class org.elasticsearch.search.aggregations.AbstractAggregationBuilder

build, equals, getType, hashCode, setMetaData, subAggregation, subAggregation, subAggregations, toXContent, writeTo

Methods inherited from class org.elasticsearch.search.aggregations.AggregationBuilder

getName

Methods inherited from class org.elasticsearch.action.support.ToXContentToBytes

buildAsBytes, buildAsBytes, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

NAME

public static final java.lang.String NAME

See Also:

Constant Field Values

Constructor Detail

ChildrenAggregationBuilder

public ChildrenAggregationBuilder(java.lang.String name,
                                  java.lang.String childType)

Parameters:

name - the name of this aggregation

childType - the type of children documents

ChildrenAggregationBuilder

public ChildrenAggregationBuilder(StreamInput in)
                           throws java.io.IOException

Read from a stream.

Throws:

java.io.IOException

Method Detail

innerWriteTo

protected void innerWriteTo(StreamOutput out)
                     throws java.io.IOException

Description copied from class: ValuesSourceAggregationBuilder

Write subclass's state to the stream.

Specified by:

innerWriteTo in class ValuesSourceAggregationBuilder<ValuesSource.Bytes.ParentChild,ChildrenAggregationBuilder>

Throws:

java.io.IOException

innerBuild

protected ValuesSourceAggregatorFactory<ValuesSource.Bytes.ParentChild,?> innerBuild(AggregationContext context,
                                                                                     ValuesSourceConfig<ValuesSource.Bytes.ParentChild> config,
                                                                                     AggregatorFactory<?> parent,
                                                                                     AggregatorFactories.Builder subFactoriesBuilder)
                                                                              throws java.io.IOException

Specified by:

innerBuild in class ValuesSourceAggregationBuilder<ValuesSource.Bytes.ParentChild,ChildrenAggregationBuilder>

Throws:

java.io.IOException

resolveConfig

protected ValuesSourceConfig<ValuesSource.Bytes.ParentChild> resolveConfig(AggregationContext aggregationContext)

Overrides:

resolveConfig in class ValuesSourceAggregationBuilder<ValuesSource.Bytes.ParentChild,ChildrenAggregationBuilder>

doXContentBody

protected XContentBuilder doXContentBody(XContentBuilder builder,
                                         ToXContent.Params params)
                                  throws java.io.IOException

Specified by:

doXContentBody in class ValuesSourceAggregationBuilder<ValuesSource.Bytes.ParentChild,ChildrenAggregationBuilder>

Throws:

java.io.IOException

parse

public static ChildrenAggregationBuilder parse(java.lang.String aggregationName,
                                               QueryParseContext context)
                                        throws java.io.IOException

Throws:

java.io.IOException

innerHashCode

protected int innerHashCode()

Specified by:

innerHashCode in class ValuesSourceAggregationBuilder<ValuesSource.Bytes.ParentChild,ChildrenAggregationBuilder>

innerEquals

protected boolean innerEquals(java.lang.Object obj)

Specified by:

innerEquals in class ValuesSourceAggregationBuilder<ValuesSource.Bytes.ParentChild,ChildrenAggregationBuilder>

getWriteableName

public java.lang.String getWriteableName()

Description copied from interface: NamedWriteable

Returns the name of the writeable object