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 java.lang.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(QueryShardContext queryShardContext, AggregatorFactory parent)
PipelineAggregator.PipelineTree	buildPipelineTree()	Build a tree of PipelineAggregators to modify the tree of aggregation results after the final reduction.
int	count()
boolean	equals(java.lang.Object obj)
java.util.Collection<AggregationBuilder>	getAggregatorFactories()
java.util.Collection<PipelineAggregationBuilder>	getPipelineAggregatorFactories()
int	hashCode()
boolean	mustVisitAllDocs()
AggregatorFactories.Builder	rewrite(QueryRewriteContext context)	Rewrites the underlying aggregation builders into their primitive form.
java.lang.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 java.io.IOException

Read from a stream.

Throws:

java.io.IOException

Method Details

writeTo

public void writeTo(StreamOutput out) throws java.io.IOException

Description copied from interface: Writeable

Write this into the StreamOutput.

Specified by:

writeTo in interface Writeable

Throws:

java.io.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(QueryShardContext queryShardContext, AggregatorFactory parent) throws java.io.IOException

Throws:

java.io.IOException

getAggregatorFactories

public java.util.Collection<AggregationBuilder> getAggregatorFactories()

getPipelineAggregatorFactories

public java.util.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 java.io.IOException

Specified by:

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

Throws:

java.io.IOException

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

rewrite

public AggregatorFactories.Builder rewrite(QueryRewriteContext context) throws java.io.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:

java.io.IOException

buildPipelineTree

public PipelineAggregator.PipelineTree buildPipelineTree()

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