Package org.elasticsearch.search.aggregations

Class AbstractAggregationBuilder<AB extends AbstractAggregationBuilder<AB>>

java.lang.Object

org.elasticsearch.search.aggregations.AggregationBuilder

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

All Implemented Interfaces:

NamedWriteable, Writeable, org.elasticsearch.common.xcontent.ToXContent, org.elasticsearch.common.xcontent.ToXContentFragment, Rewriteable<AggregationBuilder>, BaseAggregationBuilder

Direct Known Subclasses:

AdjacencyMatrixAggregationBuilder, CompositeAggregationBuilder, FilterAggregationBuilder, FiltersAggregationBuilder, GlobalAggregationBuilder, MultiValuesSourceAggregationBuilder, NestedAggregationBuilder, ReverseNestedAggregationBuilder, SamplerAggregationBuilder, ScriptedMetricAggregationBuilder, SignificantTextAggregationBuilder, TopHitsAggregationBuilder, ValuesSourceAggregationBuilder

public abstract class AbstractAggregationBuilder<AB extends AbstractAggregationBuilder<AB>>
extends AggregationBuilder

Base implementation of a AggregationBuilder.

Nested Class Summary

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

AggregationBuilder.BucketCardinality, AggregationBuilder.CommonFields

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

org.elasticsearch.common.xcontent.ToXContent.DelegatingMapParams, org.elasticsearch.common.xcontent.ToXContent.MapParams, org.elasticsearch.common.xcontent.ToXContent.Params

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

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

Field Summary

Fields

Modifier and Type	Field	Description
protected Map<String,Object>	metadata

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

DEFAULT_PREALLOCATION, factoriesBuilder, name

Fields inherited from interface org.elasticsearch.index.query.Rewriteable

MAX_REWRITE_ROUNDS

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

EMPTY_PARAMS

Constructor Summary

Constructors

Modifier	Constructor	Description
	AbstractAggregationBuilder(String name)	Constructs a new aggregation builder.
protected	AbstractAggregationBuilder(StreamInput in)	Read from a stream.
protected	AbstractAggregationBuilder(AbstractAggregationBuilder<AB> clone, AggregatorFactories.Builder factoriesBuilder, Map<String,Object> metadata)

Method Summary

Modifier and Type	Method	Description
AggregatorFactory	build(AggregationContext context, AggregatorFactory parent)	Internal: build an AggregatorFactory based on the configuration of this builder.
protected abstract AggregatorFactory	doBuild(AggregationContext context, AggregatorFactory parent, AggregatorFactories.Builder subfactoriesBuilder)
protected abstract void	doWriteTo(StreamOutput out)
boolean	equals(Object obj)
Map<String,Object>	getMetadata()	Return any associated metadata with this AggregationBuilder.
String	getWriteableName()	Returns the name of the writeable object
int	hashCode()
protected abstract org.elasticsearch.common.xcontent.XContentBuilder	internalXContent(org.elasticsearch.common.xcontent.XContentBuilder builder, org.elasticsearch.common.xcontent.ToXContent.Params params)
AB	setMetadata(Map<String,Object> metadata)	Associate metadata with this AggregationBuilder.
AB	subAggregation(AggregationBuilder aggregation)	Add a sub aggregation to this builder.
AB	subAggregation(PipelineAggregationBuilder aggregation)	Add a sub aggregation to this aggregation.
AB	subAggregations(AggregatorFactories.Builder subFactories)	Registers sub-factories with this factory.
org.elasticsearch.common.xcontent.XContentBuilder	toXContent(org.elasticsearch.common.xcontent.XContentBuilder builder, org.elasticsearch.common.xcontent.ToXContent.Params params)
void	writeTo(StreamOutput out)	Write this into the StreamOutput.

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

bucketCardinality, buildPipelineTree, bytesToPreallocate, doRewrite, getName, getOutputFieldNames, getPipelineAggregations, getSubAggregations, rewrite, shallowCopy, toString

Methods inherited from class java.lang.Object

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

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

getType

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

isFragment

Field Details

metadata

protected Map<String,Object> metadata

Constructor Details

AbstractAggregationBuilder

public AbstractAggregationBuilder(String name)

Constructs a new aggregation builder.

Parameters:

name - The aggregation name

AbstractAggregationBuilder

protected AbstractAggregationBuilder(AbstractAggregationBuilder<AB> clone,
 AggregatorFactories.Builder factoriesBuilder,
 Map<String,Object> metadata)

AbstractAggregationBuilder

protected AbstractAggregationBuilder(StreamInput in)
                              throws IOException

Read from a stream.

Throws:

IOException

Method Details

writeTo

public final void writeTo(StreamOutput out)
                   throws IOException

Description copied from interface: Writeable

Write this into the StreamOutput.

Throws:

IOException

doWriteTo

protected abstract void doWriteTo(StreamOutput out)
                           throws IOException

Throws:

IOException

subAggregation

public AB subAggregation(AggregationBuilder aggregation)

Description copied from class: AggregationBuilder

Add a sub aggregation to this builder.

Specified by:

subAggregation in class AggregationBuilder

subAggregation

public AB subAggregation(PipelineAggregationBuilder aggregation)

Add a sub aggregation to this aggregation.

Specified by:

subAggregation in class AggregationBuilder

subAggregations

public AB subAggregations(AggregatorFactories.Builder subFactories)

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.

Specified by:

subAggregations in interface BaseAggregationBuilder

Specified by:

subAggregations in class AggregationBuilder

Parameters:

subFactories - The sub-factories

Returns:

this factory (fluent interface)

setMetadata

public AB setMetadata(Map<String,Object> metadata)

Description copied from class: AggregationBuilder

Associate metadata with this AggregationBuilder.

Specified by:

setMetadata in interface BaseAggregationBuilder

Specified by:

setMetadata in class AggregationBuilder

getMetadata

public Map<String,Object> getMetadata()

Description copied from class: AggregationBuilder

Return any associated metadata with this AggregationBuilder.

Specified by:

getMetadata in class AggregationBuilder

getWriteableName

public final String getWriteableName()

Description copied from interface: NamedWriteable

Returns the name of the writeable object

build

public final AggregatorFactory build(AggregationContext context,
 AggregatorFactory parent)
                              throws IOException

Description copied from class: AggregationBuilder

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

Specified by:

build in class AggregationBuilder

Throws:

IOException

doBuild

protected abstract AggregatorFactory doBuild(AggregationContext context,
 AggregatorFactory parent,
 AggregatorFactories.Builder subfactoriesBuilder)
                                      throws IOException

Throws:

IOException

toXContent

public final org.elasticsearch.common.xcontent.XContentBuilder toXContent(org.elasticsearch.common.xcontent.XContentBuilder builder,
 org.elasticsearch.common.xcontent.ToXContent.Params params)
                                                                   throws IOException

Throws:

IOException

internalXContent

protected abstract org.elasticsearch.common.xcontent.XContentBuilder internalXContent(org.elasticsearch.common.xcontent.XContentBuilder builder,
 org.elasticsearch.common.xcontent.ToXContent.Params params)
                                                                               throws IOException

Throws:

IOException

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object