Package org.elasticsearch.search.aggregations

Class AggregatorFactories.Builder

java.lang.Object

org.elasticsearch.search.aggregations.AggregatorFactories.Builder

All Implemented Interfaces:

Writeable, ToXContent, ToXContentObject

Enclosing class:

AggregatorFactories

public static class AggregatorFactories.Builder
extends Object
implements Writeable, ToXContentObject

Nested Class Summary

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

ToXContent.DelegatingMapParams, ToXContent.MapParams, 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)
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()
XContentBuilder	toXContent(XContentBuilder builder, ToXContent.Params params)
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 Detail

Builder

public Builder()

Create an empty builder.

Builder

public Builder(StreamInput in)
        throws IOException

Read from a stream.

Throws:

IOException

Method Detail

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)

build

public AggregatorFactories build(QueryShardContext queryShardContext,
                                 AggregatorFactory parent)
                          throws IOException

Throws:

IOException

getAggregatorFactories

public Collection<AggregationBuilder> getAggregatorFactories()

getPipelineAggregatorFactories

public Collection<PipelineAggregationBuilder> getPipelineAggregatorFactories()

count

public int count()

toXContent

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

Specified by:

toXContent in interface ToXContent

Throws:

IOException

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