Package org.elasticsearch.search.aggregations.metrics.sum

Class SumAggregationBuilder

java.lang.Object

org.elasticsearch.search.aggregations.AggregationBuilder

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

org.elasticsearch.search.aggregations.support.ValuesSourceAggregationBuilder<VS,AB>

org.elasticsearch.search.aggregations.support.ValuesSourceAggregationBuilder.LeafOnly<ValuesSource.Numeric,SumAggregationBuilder>

org.elasticsearch.search.aggregations.metrics.sum.SumAggregationBuilder

All Implemented Interfaces:

NamedWriteable, Writeable, ToXContent, ToXContentFragment, BaseAggregationBuilder

public class SumAggregationBuilder
extends ValuesSourceAggregationBuilder.LeafOnly<ValuesSource.Numeric,SumAggregationBuilder>

Nested Class Summary

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

ValuesSourceAggregationBuilder.LeafOnly<VS extends ValuesSource,AB extends ValuesSourceAggregationBuilder<VS,AB>>

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

AggregationBuilder.CommonFields

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

Modifier and Type	Field	Description
static java.lang.String	NAME

Fields inherited from class org.elasticsearch.search.aggregations.support.ValuesSourceAggregationBuilder

config

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

metaData

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

factoriesBuilder, name

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

EMPTY_PARAMS

Constructor Summary

Constructors

Modifier	Constructor	Description
	SumAggregationBuilder(java.lang.String name)
	SumAggregationBuilder(StreamInput in)	Read from a stream.
protected	SumAggregationBuilder(SumAggregationBuilder clone, AggregatorFactories.Builder factoriesBuilder, java.util.Map<java.lang.String,java.lang.Object> metaData)

Method Summary

Modifier and Type	Method	Description
XContentBuilder	doXContentBody(XContentBuilder builder, ToXContent.Params params)
java.lang.String	getType()	The name of the type of aggregation built by this builder.
protected SumAggregatorFactory	innerBuild(SearchContext context, ValuesSourceConfig<ValuesSource.Numeric> config, AggregatorFactory<?> parent, AggregatorFactories.Builder subFactoriesBuilder)
protected boolean	innerEquals(java.lang.Object obj)
protected int	innerHashCode()
protected void	innerWriteTo(StreamOutput out)	Write subclass's state to the stream.
static AggregationBuilder	parse(java.lang.String aggregationName, XContentParser parser)
protected AggregationBuilder	shallowCopy(AggregatorFactories.Builder factoriesBuilder, java.util.Map<java.lang.String,java.lang.Object> metaData)	Create a shallow copy of this builder and replacing AggregationBuilder.factoriesBuilder and metaData.

Methods inherited from class org.elasticsearch.search.aggregations.support.ValuesSourceAggregationBuilder.LeafOnly

subAggregations

Methods inherited from class org.elasticsearch.search.aggregations.support.ValuesSourceAggregationBuilder

doBuild, doEquals, doHashCode, doWriteTo, field, field, format, format, internalXContent, missing, missing, resolveConfig, script, script, serializeTargetValueType, timeZone, timeZone, valueType, valueType

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

build, equals, getMetaData, getWriteableName, hashCode, setMetaData, subAggregation, subAggregation, toXContent, writeTo

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

doRewrite, getName, getPipelineAggregations, getSubAggregations, rewrite, toString

Methods inherited from class java.lang.Object

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

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

isFragment

Field Detail

NAME

public static final java.lang.String NAME

See Also:

Constant Field Values

Constructor Detail

SumAggregationBuilder

public SumAggregationBuilder(java.lang.String name)

SumAggregationBuilder

protected SumAggregationBuilder(SumAggregationBuilder clone,
                                AggregatorFactories.Builder factoriesBuilder,
                                java.util.Map<java.lang.String,java.lang.Object> metaData)

SumAggregationBuilder

public SumAggregationBuilder(StreamInput in)
                      throws java.io.IOException

Read from a stream.

Throws:

java.io.IOException

Method Detail

parse

public static AggregationBuilder parse(java.lang.String aggregationName,
                                       XContentParser parser)
                                throws java.io.IOException

Throws:

java.io.IOException

shallowCopy

protected AggregationBuilder shallowCopy(AggregatorFactories.Builder factoriesBuilder,
                                         java.util.Map<java.lang.String,java.lang.Object> metaData)

Description copied from class: AggregationBuilder

Create a shallow copy of this builder and replacing AggregationBuilder.factoriesBuilder and metaData. Used by AggregationBuilder.rewrite(QueryRewriteContext).

Specified by:

shallowCopy in class AggregationBuilder

innerWriteTo

protected void innerWriteTo(StreamOutput out)

Description copied from class: ValuesSourceAggregationBuilder

Write subclass's state to the stream.

Specified by:

innerWriteTo in class ValuesSourceAggregationBuilder<ValuesSource.Numeric,SumAggregationBuilder>

innerBuild

protected SumAggregatorFactory innerBuild(SearchContext context,
                                          ValuesSourceConfig<ValuesSource.Numeric> config,
                                          AggregatorFactory<?> parent,
                                          AggregatorFactories.Builder subFactoriesBuilder)
                                   throws java.io.IOException

Specified by:

innerBuild in class ValuesSourceAggregationBuilder<ValuesSource.Numeric,SumAggregationBuilder>

Throws:

java.io.IOException

doXContentBody

public XContentBuilder doXContentBody(XContentBuilder builder,
                                      ToXContent.Params params)
                               throws java.io.IOException

Specified by:

doXContentBody in class ValuesSourceAggregationBuilder<ValuesSource.Numeric,SumAggregationBuilder>

Throws:

java.io.IOException

innerHashCode

protected int innerHashCode()

Specified by:

innerHashCode in class ValuesSourceAggregationBuilder<ValuesSource.Numeric,SumAggregationBuilder>

innerEquals

protected boolean innerEquals(java.lang.Object obj)

Specified by:

innerEquals in class ValuesSourceAggregationBuilder<ValuesSource.Numeric,SumAggregationBuilder>

getType

public java.lang.String getType()

Description copied from interface: BaseAggregationBuilder

The name of the type of aggregation built by this builder.