org.elasticsearch.search.aggregations

Class AggregationBuilder<B extends AggregationBuilder<B>>

java.lang.Object

org.elasticsearch.search.aggregations.AbstractAggregationBuilder

org.elasticsearch.search.aggregations.AggregationBuilder<B>

All Implemented Interfaces:

ToXContent

Direct Known Subclasses:

ChildrenBuilder, FilterAggregationBuilder, FiltersAggregationBuilder, GeoDistanceBuilder, GeoHashGridBuilder, GlobalBuilder, MissingBuilder, NestedBuilder, ReverseNestedBuilder, SignificantTermsBuilder, ValuesSourceAggregationBuilder

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

A base class for all bucket aggregation builders.

Nested Class Summary

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

ToXContent.DelegatingMapParams, ToXContent.MapParams, ToXContent.Params

Field Summary

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

type

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

EMPTY_PARAMS

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AggregationBuilder(String name, String type) Sole constructor, typically used by sub-classes.

Method Summary

Modifier and Type	Method and Description
protected abstract XContentBuilder	internalXContent(XContentBuilder builder, ToXContent.Params params)
B	setMetaData(Map<String,Object> metaData) Sets the meta data to be included in the aggregation response
B	subAggregation(AbstractAggregationBuilder aggregation) Add a sub get to this bucket get.
B	subAggregation(byte[] aggregationsBinary) Sets a raw (xcontent / json) sub addAggregation.
B	subAggregation(byte[] aggregationsBinary, int aggregationsBinaryOffset, int aggregationsBinaryLength) Sets a raw (xcontent / json) sub addAggregation.
B	subAggregation(BytesReference aggregationsBinary) Sets a raw (xcontent / json) sub addAggregation.
B	subAggregation(Map<String,Object> aggs) Sets a raw (xcontent / json) sub addAggregation.
B	subAggregation(XContentBuilder aggs) Sets a raw (xcontent / json) sub addAggregation.
XContentBuilder	toXContent(XContentBuilder builder, ToXContent.Params params)

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

getName

Methods inherited from class java.lang.Object

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

Constructor Detail

AggregationBuilder

protected AggregationBuilder(String name,
                             String type)

Sole constructor, typically used by sub-classes.

Method Detail

subAggregation

public B subAggregation(AbstractAggregationBuilder aggregation)

Add a sub get to this bucket get.

subAggregation

public B subAggregation(byte[] aggregationsBinary)

Sets a raw (xcontent / json) sub addAggregation.

subAggregation

public B subAggregation(byte[] aggregationsBinary,
                        int aggregationsBinaryOffset,
                        int aggregationsBinaryLength)

Sets a raw (xcontent / json) sub addAggregation.

subAggregation

public B subAggregation(BytesReference aggregationsBinary)

Sets a raw (xcontent / json) sub addAggregation.

subAggregation

public B subAggregation(XContentBuilder aggs)

Sets a raw (xcontent / json) sub addAggregation.

subAggregation

public B subAggregation(Map<String,Object> aggs)

Sets a raw (xcontent / json) sub addAggregation.

setMetaData

public B setMetaData(Map<String,Object> metaData)

Sets the meta data to be included in the aggregation response

toXContent

public final XContentBuilder toXContent(XContentBuilder builder,
                                        ToXContent.Params params)
                                 throws IOException

Throws:

IOException

internalXContent

protected abstract XContentBuilder internalXContent(XContentBuilder builder,
                                                    ToXContent.Params params)
                                             throws IOException

Throws:

IOException