Module org.elasticsearch.server

Package org.elasticsearch.search.aggregations.metrics

Class WeightedAvgAggregationBuilder

java.lang.Object

org.elasticsearch.search.aggregations.AggregationBuilder

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

org.elasticsearch.search.aggregations.support.MultiValuesSourceAggregationBuilder<WeightedAvgAggregationBuilder>

org.elasticsearch.search.aggregations.support.MultiValuesSourceAggregationBuilder.LeafOnly<WeightedAvgAggregationBuilder>

org.elasticsearch.search.aggregations.metrics.WeightedAvgAggregationBuilder

All Implemented Interfaces:

NamedWriteable, VersionedNamedWriteable, Writeable, Rewriteable<AggregationBuilder>, BaseAggregationBuilder, ToXContent, ToXContentFragment

public class WeightedAvgAggregationBuilder
extends MultiValuesSourceAggregationBuilder.LeafOnly<WeightedAvgAggregationBuilder>

Nested Class Summary

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

MultiValuesSourceAggregationBuilder.LeafOnly<AB extends MultiValuesSourceAggregationBuilder<AB>>

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

AggregationBuilder.BucketCardinality, AggregationBuilder.CommonFields

Nested classes/interfaces inherited from interface org.elasticsearch.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 final String	NAME
static final ObjectParser<WeightedAvgAggregationBuilder,String>	PARSER
static final ParseField	VALUE_FIELD
static final ParseField	WEIGHT_FIELD

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

metadata

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

DEFAULT_PREALLOCATION, factoriesBuilder, name

Fields inherited from interface org.elasticsearch.index.query.Rewriteable

MAX_REWRITE_ROUNDS

Fields inherited from interface org.elasticsearch.xcontent.ToXContent

EMPTY, EMPTY_PARAMS

Constructor Summary

Constructors

Constructor	Description
WeightedAvgAggregationBuilder(String name)
WeightedAvgAggregationBuilder(StreamInput in)	Read from a stream.
WeightedAvgAggregationBuilder(WeightedAvgAggregationBuilder clone, AggregatorFactories.Builder factoriesBuilder, Map<String,Object> metadata)

Method Summary

Modifier and Type	Method	Description
AggregationBuilder.BucketCardinality	bucketCardinality()	A rough count of the number of buckets that Aggregators built by this builder will contain per owning parent bucket.
protected ValuesSourceType	defaultValueSourceType()	Aggregations should use this method to define a ValuesSourceType of last resort.
XContentBuilder	doXContentBody(XContentBuilder builder, ToXContent.Params params)
TransportVersion	getMinimalSupportedVersion()	The minimal version of the recipient this object can be sent to
String	getType()	The name of the type of aggregation built by this builder.
protected MultiValuesSourceAggregatorFactory	innerBuild(AggregationContext context, Map<String,ValuesSourceConfig> configs, Map<String,QueryBuilder> filters, DocValueFormat format, AggregatorFactory parent, AggregatorFactories.Builder subFactoriesBuilder)
protected void	innerWriteTo(StreamOutput out)	Write subclass' state to the stream
static void	registerUsage(ValuesSourceRegistry.Builder builder)
protected AggregationBuilder	shallowCopy(AggregatorFactories.Builder factoriesBuilder, Map<String,Object> metadata)	Create a shallow copy of this builder and replacing AggregationBuilder.factoriesBuilder and metadata.
boolean	supportsSampling()	Does this aggregation support running with in a sampling context.
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, doWriteTo, equals, field, format, hashCode, internalXContent, resolveFormat, userValueTypeHint

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

build, getMetadata, getWriteableName, setMetadata, subAggregation, subAggregation, toXContent, writeTo

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

buildPipelineTree, bytesToPreallocate, deepCopy, doRewrite, getName, getOutputFieldNames, getPipelineAggregations, getQuery, getSubAggregations, isInSortOrderExecutionRequired, rewrite, supportsParallelCollection, toString, validateSequentiallyOrdered, validateSequentiallyOrderedWithoutGaps

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.elasticsearch.xcontent.ToXContentFragment

isFragment

Field Details

NAME

public static final String NAME

See Also:

• Constant Field Values

VALUE_FIELD

public static final ParseField VALUE_FIELD

WEIGHT_FIELD

public static final ParseField WEIGHT_FIELD

PARSER

public static final ObjectParser<WeightedAvgAggregationBuilder,String> PARSER

Constructor Details

WeightedAvgAggregationBuilder

public WeightedAvgAggregationBuilder(String name)

WeightedAvgAggregationBuilder

public WeightedAvgAggregationBuilder(WeightedAvgAggregationBuilder clone,
 AggregatorFactories.Builder factoriesBuilder,
 Map<String,Object> metadata)

WeightedAvgAggregationBuilder

public WeightedAvgAggregationBuilder(StreamInput in)
                              throws IOException

Read from a stream.

Throws:

IOException

Method Details

registerUsage

public static void registerUsage(ValuesSourceRegistry.Builder builder)

value

public WeightedAvgAggregationBuilder value(MultiValuesSourceFieldConfig valueConfig)

weight

public WeightedAvgAggregationBuilder weight(MultiValuesSourceFieldConfig weightConfig)

shallowCopy

protected AggregationBuilder shallowCopy(AggregatorFactories.Builder factoriesBuilder,
 Map<String,Object> metadata)

Description copied from class: AggregationBuilder

Create a shallow copy of this builder and replacing AggregationBuilder.factoriesBuilder and metadata.

Specified by:

shallowCopy in class AggregationBuilder

supportsSampling

public boolean supportsSampling()

Description copied from class: AggregationBuilder

Does this aggregation support running with in a sampling context. By default, it's false for all aggregations. If the sub-classed builder supports sampling, be sure of the following that the resulting internal aggregation objects override the InternalAggregation.finalizeSampling(SamplingContext) and scales any values that require scaling.

Overrides:

supportsSampling in class AggregationBuilder

Returns:

does this aggregation builder support sampling

defaultValueSourceType

protected ValuesSourceType defaultValueSourceType()

Description copied from class: MultiValuesSourceAggregationBuilder

Aggregations should use this method to define a ValuesSourceType of last resort. This will only be used when the resolver can't find a field and the user hasn't provided a value type hint.

Specified by:

defaultValueSourceType in class MultiValuesSourceAggregationBuilder<WeightedAvgAggregationBuilder>

Returns:

The CoreValuesSourceType we expect this script to yield.

innerWriteTo

protected void innerWriteTo(StreamOutput out)

Description copied from class: MultiValuesSourceAggregationBuilder

Write subclass' state to the stream

Specified by:

innerWriteTo in class MultiValuesSourceAggregationBuilder<WeightedAvgAggregationBuilder>

bucketCardinality

public AggregationBuilder.BucketCardinality bucketCardinality()

Description copied from class: AggregationBuilder

A rough count of the number of buckets that Aggregators built by this builder will contain per owning parent bucket.

Specified by:

bucketCardinality in class AggregationBuilder

innerBuild

protected MultiValuesSourceAggregatorFactory innerBuild(AggregationContext context,
 Map<String,ValuesSourceConfig> configs,
 Map<String,QueryBuilder> filters,
 DocValueFormat format,
 AggregatorFactory parent,
 AggregatorFactories.Builder subFactoriesBuilder)
                                                 throws IOException

Specified by:

innerBuild in class MultiValuesSourceAggregationBuilder<WeightedAvgAggregationBuilder>

Throws:

IOException

doXContentBody

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

Specified by:

doXContentBody in class MultiValuesSourceAggregationBuilder<WeightedAvgAggregationBuilder>

Throws:

IOException

getType

public String getType()

Description copied from interface: BaseAggregationBuilder

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

getMinimalSupportedVersion

public TransportVersion getMinimalSupportedVersion()

Description copied from interface: VersionedNamedWriteable

The minimal version of the recipient this object can be sent to