Package org.elasticsearch.search.aggregations.metrics.weighted_avg

Class WeightedAvgAggregationBuilder

java.lang.Object

org.elasticsearch.search.aggregations.AggregationBuilder

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

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

org.elasticsearch.search.aggregations.support.MultiValuesSourceAggregationBuilder.LeafOnly<ValuesSource.Numeric,WeightedAvgAggregationBuilder>

org.elasticsearch.search.aggregations.metrics.weighted_avg.WeightedAvgAggregationBuilder

All Implemented Interfaces:

NamedWriteable, Writeable, ToXContent, ToXContentFragment, BaseAggregationBuilder

public class WeightedAvgAggregationBuilder
extends MultiValuesSourceAggregationBuilder.LeafOnly<ValuesSource.Numeric,WeightedAvgAggregationBuilder>

Nested Class Summary

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

MultiValuesSourceAggregationBuilder.LeafOnly<VS extends ValuesSource,AB extends MultiValuesSourceAggregationBuilder<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
static ParseField	VALUE_FIELD
static ParseField	WEIGHT_FIELD

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

Constructor	Description
WeightedAvgAggregationBuilder(java.lang.String name)
WeightedAvgAggregationBuilder(StreamInput in)	Read from a stream.
WeightedAvgAggregationBuilder(WeightedAvgAggregationBuilder 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 MultiValuesSourceAggregatorFactory<ValuesSource.Numeric,?>	innerBuild(SearchContext context, java.util.Map<java.lang.String,ValuesSourceConfig<ValuesSource.Numeric>> configs, DocValueFormat format, AggregatorFactory<?> parent, AggregatorFactories.Builder subFactoriesBuilder)
protected boolean	innerEquals(java.lang.Object obj)
protected int	innerHashCode()
protected void	innerWriteTo(StreamOutput out)	Write subclass' 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.
WeightedAvgAggregationBuilder	value(MultiValuesSourceFieldConfig valueConfig)
WeightedAvgAggregationBuilder	weight(MultiValuesSourceFieldConfig weightConfig)

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

subAggregations

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

doBuild, doEquals, doHashCode, doWriteTo, field, fields, format, format, internalXContent, serializeTargetValueType, 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

VALUE_FIELD

public static final ParseField VALUE_FIELD

WEIGHT_FIELD

public static final ParseField WEIGHT_FIELD

Constructor Detail

WeightedAvgAggregationBuilder

public WeightedAvgAggregationBuilder(java.lang.String name)

WeightedAvgAggregationBuilder

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

WeightedAvgAggregationBuilder

public WeightedAvgAggregationBuilder(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

value

public WeightedAvgAggregationBuilder value(MultiValuesSourceFieldConfig valueConfig)

weight

public WeightedAvgAggregationBuilder weight(MultiValuesSourceFieldConfig weightConfig)

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: MultiValuesSourceAggregationBuilder

Write subclass' state to the stream

Specified by:

innerWriteTo in class MultiValuesSourceAggregationBuilder<ValuesSource.Numeric,WeightedAvgAggregationBuilder>

innerBuild

protected MultiValuesSourceAggregatorFactory<ValuesSource.Numeric,?> innerBuild(SearchContext context,
                                                                                      java.util.Map<java.lang.String,ValuesSourceConfig<ValuesSource.Numeric>> configs,
                                                                                      DocValueFormat format,
                                                                                      AggregatorFactory<?> parent,
                                                                                      AggregatorFactories.Builder subFactoriesBuilder)
                                                                               throws java.io.IOException

Specified by:

innerBuild in class MultiValuesSourceAggregationBuilder<ValuesSource.Numeric,WeightedAvgAggregationBuilder>

Throws:

java.io.IOException

doXContentBody

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

Specified by:

doXContentBody in class MultiValuesSourceAggregationBuilder<ValuesSource.Numeric,WeightedAvgAggregationBuilder>

Throws:

java.io.IOException

innerHashCode

protected int innerHashCode()

Specified by:

innerHashCode in class MultiValuesSourceAggregationBuilder<ValuesSource.Numeric,WeightedAvgAggregationBuilder>

innerEquals

protected boolean innerEquals(java.lang.Object obj)

Specified by:

innerEquals in class MultiValuesSourceAggregationBuilder<ValuesSource.Numeric,WeightedAvgAggregationBuilder>

getType

public java.lang.String getType()

Description copied from interface: BaseAggregationBuilder

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