Package org.elasticsearch.search.aggregations

Class AggregatorFactories.Builder

java.lang.Object

org.elasticsearch.search.aggregations.AggregatorFactories.Builder

All Implemented Interfaces:

Writeable, org.elasticsearch.common.xcontent.ToXContent, org.elasticsearch.common.xcontent.ToXContentObject

Enclosing class:

AggregatorFactories

public static class AggregatorFactories.Builder
extends Object
implements Writeable, org.elasticsearch.common.xcontent.ToXContentObject

A mutable collection of AggregationBuilders and PipelineAggregationBuilders.

Nested Class Summary

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 inherited from interface org.elasticsearch.common.xcontent.ToXContent

EMPTY_PARAMS

Constructor Summary

Constructors

Constructor	Description
Builder()	Create an empty builder.
Builder(StreamInput in)	Read from a stream.

Method Summary

Modifier and Type	Method	Description
AggregatorFactories.Builder	addAggregator(AggregationBuilder factory)
AggregatorFactories.Builder	addPipelineAggregator(PipelineAggregationBuilder pipelineAggregatorFactory)
AggregatorFactories	build(AggregationContext context, AggregatorFactory parent)
PipelineAggregator.PipelineTree	buildPipelineTree()	Build a tree of PipelineAggregators to modify the tree of aggregation results after the final reduction.
long	bytesToPreallocate()	Bytes to preallocate on the "request" breaker for these aggregations.
int	count()
boolean	equals(Object obj)
Collection<AggregationBuilder>	getAggregatorFactories()
Collection<PipelineAggregationBuilder>	getPipelineAggregatorFactories()
int	hashCode()
boolean	mustVisitAllDocs()
AggregatorFactories.Builder	rewrite(QueryRewriteContext context)	Rewrites the underlying aggregation builders into their primitive form.
String	toString()
org.elasticsearch.common.xcontent.XContentBuilder	toXContent(org.elasticsearch.common.xcontent.XContentBuilder builder, org.elasticsearch.common.xcontent.ToXContent.Params params)
ActionRequestValidationException	validate(ActionRequestValidationException e)	Validate the root of the aggregation tree.
void	writeTo(StreamOutput out)	Write this into the StreamOutput.

Methods inherited from class java.lang.Object

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

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

isFragment

Constructor Details

Builder

public Builder()

Create an empty builder.

Builder

public Builder(StreamInput in)
        throws IOException

Read from a stream.

Throws:

IOException

Method Details

writeTo

public void writeTo(StreamOutput out)
             throws IOException

Description copied from interface: Writeable

Write this into the StreamOutput.

Specified by:

writeTo in interface Writeable

Throws:

IOException

mustVisitAllDocs

public boolean mustVisitAllDocs()

addAggregator

public AggregatorFactories.Builder addAggregator(AggregationBuilder factory)

addPipelineAggregator

public AggregatorFactories.Builder addPipelineAggregator(PipelineAggregationBuilder pipelineAggregatorFactory)

validate

public ActionRequestValidationException validate(ActionRequestValidationException e)

Validate the root of the aggregation tree.

build

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

Throws:

IOException

getAggregatorFactories

public Collection<AggregationBuilder> getAggregatorFactories()

getPipelineAggregatorFactories

public Collection<PipelineAggregationBuilder> getPipelineAggregatorFactories()

count

public int count()

toXContent

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

Specified by:

toXContent in interface org.elasticsearch.common.xcontent.ToXContent

Throws:

IOException

bytesToPreallocate

public long bytesToPreallocate()

Bytes to preallocate on the "request" breaker for these aggregations. The goal is to request a few more bytes than we expect to use at first to cut down on contention on the "request" breaker when we are constructing the aggs. Underestimating what we allocate up front will fail to accomplish the goal. Overestimating will cause requests to fail for no reason.

toString

public String toString()

Overrides:

toString in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

rewrite

public AggregatorFactories.Builder rewrite(QueryRewriteContext context)
                                    throws IOException

Rewrites the underlying aggregation builders into their primitive form. If the builder did not change the identity reference must be returned otherwise the builder will be rewritten infinitely.

Throws:

IOException

buildPipelineTree

public PipelineAggregator.PipelineTree buildPipelineTree()

Build a tree of PipelineAggregators to modify the tree of aggregation results after the final reduction.