org.elasticsearch.search.aggregations

Class AggregationBuilder

java.lang.Object

org.elasticsearch.action.support.ToXContentToBytes

org.elasticsearch.search.aggregations.AggregationBuilder

All Implemented Interfaces:

NamedWriteable, Writeable, ToXContent, BaseAggregationBuilder

Direct Known Subclasses:

AbstractAggregationBuilder

public abstract class AggregationBuilder
extends ToXContentToBytes
implements NamedWriteable, ToXContent, BaseAggregationBuilder

A factory that knows how to create an Aggregator of a specific type.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	AggregationBuilder.CommonFields Common xcontent fields shared among aggregator builders

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
protected AggregatorFactories.Builder	factoriesBuilder
protected java.lang.String	name

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

EMPTY_PARAMS

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AggregationBuilder(java.lang.String name) Constructs a new aggregation builder.

Method Summary

Modifier and Type	Method and Description
protected abstract AggregatorFactory<?>	build(SearchContext context, AggregatorFactory<?> parent) Internal: build an AggregatorFactory based on the configuration of this builder.
java.lang.String	getName() Return this aggregation's name.
abstract AggregationBuilder	setMetaData(java.util.Map<java.lang.String,java.lang.Object> metaData) Associate metadata with this AggregationBuilder.
abstract AggregationBuilder	subAggregation(AggregationBuilder aggregation) Add a sub aggregation to this builder.
abstract AggregationBuilder	subAggregation(PipelineAggregationBuilder aggregation) Add a sub aggregation to this builder.
abstract AggregationBuilder	subAggregations(AggregatorFactories.Builder subFactories) Internal: Registers sub-factories with this factory.

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

buildAsBytes, buildAsBytes, toString, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.elasticsearch.common.io.stream.NamedWriteable

getWriteableName

Methods inherited from interface org.elasticsearch.common.io.stream.Writeable

writeTo

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

isFragment, toXContent

Methods inherited from interface org.elasticsearch.search.aggregations.BaseAggregationBuilder

getType

Field Detail

name

protected final java.lang.String name

factoriesBuilder

protected AggregatorFactories.Builder factoriesBuilder

Constructor Detail

AggregationBuilder

protected AggregationBuilder(java.lang.String name)

Constructs a new aggregation builder.

Parameters:

name - The aggregation name

Method Detail

getName

public java.lang.String getName()

Return this aggregation's name.

build

protected abstract AggregatorFactory<?> build(SearchContext context,
                                              AggregatorFactory<?> parent)
                                       throws java.io.IOException

Internal: build an AggregatorFactory based on the configuration of this builder.

Throws:

java.io.IOException

setMetaData

public abstract AggregationBuilder setMetaData(java.util.Map<java.lang.String,java.lang.Object> metaData)

Associate metadata with this AggregationBuilder.

Specified by:

setMetaData in interface BaseAggregationBuilder

subAggregation

public abstract AggregationBuilder subAggregation(AggregationBuilder aggregation)

Add a sub aggregation to this builder.

subAggregation

public abstract AggregationBuilder subAggregation(PipelineAggregationBuilder aggregation)

Add a sub aggregation to this builder.

subAggregations

public abstract AggregationBuilder subAggregations(AggregatorFactories.Builder subFactories)

Internal: Registers sub-factories with this factory. The sub-factory will be responsible for the creation of sub-aggregators under the aggregator created by this factory. This is only for use by AggregatorFactories.parseAggregators(QueryParseContext).

Specified by:

subAggregations in interface BaseAggregationBuilder

Parameters:

subFactories - The sub-factories

Returns:

this factory (fluent interface)