Package org.elasticsearch.search.aggregations.support

Class MultiValuesSourceAggregationBuilder<AB extends MultiValuesSourceAggregationBuilder<AB>>

java.lang.Object

org.elasticsearch.search.aggregations.AggregationBuilder

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

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

All Implemented Interfaces:

NamedWriteable, Writeable, Rewriteable<AggregationBuilder>, BaseAggregationBuilder, org.elasticsearch.xcontent.ToXContent, org.elasticsearch.xcontent.ToXContentFragment

Direct Known Subclasses:

MultiValuesSourceAggregationBuilder.LeafOnly

public abstract class MultiValuesSourceAggregationBuilder<AB extends MultiValuesSourceAggregationBuilder<AB>>
extends AbstractAggregationBuilder<AB>

Similar to ValuesSourceAggregationBuilder, except it references multiple ValuesSources (e.g. so that an aggregation can pull values from multiple fields). A limitation of this class is that all the ValuesSource's being refereenced must be of the same type.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	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

org.elasticsearch.xcontent.ToXContent.DelegatingMapParams, org.elasticsearch.xcontent.ToXContent.MapParams, org.elasticsearch.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 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_PARAMS

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
protected abstract ValuesSourceType	defaultValueSourceType()	Aggregations should use this method to define a ValuesSourceType of last resort.
protected final MultiValuesSourceAggregatorFactory	doBuild(AggregationContext context, AggregatorFactory parent, AggregatorFactories.Builder subFactoriesBuilder)
protected final void	doWriteTo(StreamOutput out)
protected abstract org.elasticsearch.xcontent.XContentBuilder	doXContentBody(org.elasticsearch.xcontent.XContentBuilder builder, org.elasticsearch.xcontent.ToXContent.Params params)
boolean	equals(Object obj)
protected AB	field(String propertyName, MultiValuesSourceFieldConfig config)
AB	format(String format)	Sets the format to use for the output of the aggregation.
int	hashCode()
protected abstract MultiValuesSourceAggregatorFactory	innerBuild(AggregationContext context, Map<String,ValuesSourceConfig> configs, Map<String,QueryBuilder> filters, DocValueFormat format, AggregatorFactory parent, AggregatorFactories.Builder subFactoriesBuilder)
protected abstract void	innerWriteTo(StreamOutput out)	Write subclass' state to the stream
final org.elasticsearch.xcontent.XContentBuilder	internalXContent(org.elasticsearch.xcontent.XContentBuilder builder, org.elasticsearch.xcontent.ToXContent.Params params)
static DocValueFormat	resolveFormat(String format, ValueType valueType, ValuesSourceType defaultValuesSourceType)
AB	userValueTypeHint(ValueType valueType)	Sets the ValueType for the value produced by this aggregation

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

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

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

bucketCardinality, buildPipelineTree, bytesToPreallocate, doRewrite, getName, getOutputFieldNames, getPipelineAggregations, getSubAggregations, rewrite, shallowCopy, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.elasticsearch.search.aggregations.BaseAggregationBuilder

getType

Methods inherited from interface org.elasticsearch.xcontent.ToXContentFragment

isFragment

Constructor Details

MultiValuesSourceAggregationBuilder

protected MultiValuesSourceAggregationBuilder(String name)

MultiValuesSourceAggregationBuilder

protected MultiValuesSourceAggregationBuilder(MultiValuesSourceAggregationBuilder<AB> clone,
 AggregatorFactories.Builder factoriesBuilder,
 Map<String,Object> metadata)

MultiValuesSourceAggregationBuilder

protected MultiValuesSourceAggregationBuilder(StreamInput in)
                                       throws IOException

Read from a stream.

Throws:

IOException

Method Details

doWriteTo

protected final void doWriteTo(StreamOutput out)
                        throws IOException

Specified by:

doWriteTo in class AbstractAggregationBuilder<AB extends MultiValuesSourceAggregationBuilder<AB>>

Throws:

IOException

innerWriteTo

protected abstract void innerWriteTo(StreamOutput out)
                              throws IOException

Write subclass' state to the stream

Throws:

IOException

field

protected AB field(String propertyName,
 MultiValuesSourceFieldConfig config)

userValueTypeHint

public AB userValueTypeHint(ValueType valueType)

Sets the ValueType for the value produced by this aggregation

format

public AB format(String format)

Sets the format to use for the output of the aggregation.

defaultValueSourceType

protected abstract ValuesSourceType defaultValueSourceType()

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.

Returns:

The CoreValuesSourceType we expect this script to yield.

doBuild

protected final MultiValuesSourceAggregatorFactory doBuild(AggregationContext context,
 AggregatorFactory parent,
 AggregatorFactories.Builder subFactoriesBuilder)
                                                    throws IOException

Specified by:

doBuild in class AbstractAggregationBuilder<AB extends MultiValuesSourceAggregationBuilder<AB>>

Throws:

IOException

resolveFormat

public static DocValueFormat resolveFormat(@Nullable
 String format,
 @Nullable
 ValueType valueType,
 ValuesSourceType defaultValuesSourceType)

innerBuild

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

Throws:

IOException

internalXContent

public final org.elasticsearch.xcontent.XContentBuilder internalXContent(org.elasticsearch.xcontent.XContentBuilder builder,
 org.elasticsearch.xcontent.ToXContent.Params params)
                                                                  throws IOException

Specified by:

internalXContent in class AbstractAggregationBuilder<AB extends MultiValuesSourceAggregationBuilder<AB>>

Throws:

IOException

doXContentBody

protected abstract org.elasticsearch.xcontent.XContentBuilder doXContentBody(org.elasticsearch.xcontent.XContentBuilder builder,
 org.elasticsearch.xcontent.ToXContent.Params params)
                                                                      throws IOException

Throws:

IOException

hashCode

public int hashCode()

Overrides:

hashCode in class AbstractAggregationBuilder<AB extends MultiValuesSourceAggregationBuilder<AB>>

equals

public boolean equals(Object obj)

Overrides:

equals in class AbstractAggregationBuilder<AB extends MultiValuesSourceAggregationBuilder<AB>>