Package org.elasticsearch.search.aggregations.support

Class ValuesSourceAggregationBuilder<AB extends ValuesSourceAggregationBuilder<AB>>

java.lang.Object

org.elasticsearch.search.aggregations.AggregationBuilder

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

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

All Implemented Interfaces:

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

Direct Known Subclasses:

AbstractRangeBuilder, AutoDateHistogramAggregationBuilder, DateHistogramAggregationBuilder, DiversifiedAggregationBuilder, GeoBoundsAggregationBuilder, GeoDistanceAggregationBuilder, GeoGridAggregationBuilder, HistogramAggregationBuilder, IpRangeAggregationBuilder, MissingAggregationBuilder, RareTermsAggregationBuilder, SignificantTermsAggregationBuilder, TermsAggregationBuilder, ValuesSourceAggregationBuilder.LeafOnly, VariableWidthHistogramAggregationBuilder

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ValuesSourceAggregationBuilder.LeafOnly<VS extends ValuesSource,AB extends ValuesSourceAggregationBuilder<AB>>
static class	ValuesSourceAggregationBuilder.MetricsAggregationBuilder<VS extends ValuesSource,AB extends ValuesSourceAggregationBuilder<AB>>
static class	ValuesSourceAggregationBuilder.SingleMetricAggregationBuilder<VS extends ValuesSource,AB extends ValuesSourceAggregationBuilder<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
protected ValuesSourceConfig	config

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	ValuesSourceAggregationBuilder(String name)
protected	ValuesSourceAggregationBuilder(StreamInput in)	Read from a stream.
protected	ValuesSourceAggregationBuilder(ValuesSourceAggregationBuilder<AB> clone, AggregatorFactories.Builder factoriesBuilder, Map<String,Object> metadata)

Method Summary

Modifier and Type	Method	Description
static <T> void	declareFields(AbstractObjectParser<? extends ValuesSourceAggregationBuilder<?>,T> objectParser, boolean scriptable, boolean formattable, boolean timezoneAware)
static <T> void	declareFields(AbstractObjectParser<? extends ValuesSourceAggregationBuilder<?>,T> objectParser, boolean scriptable, boolean formattable, boolean timezoneAware, boolean fieldRequired)
protected abstract ValuesSourceType	defaultValueSourceType()	Aggregations should use this method to define a ValuesSourceType of last resort.
protected final ValuesSourceAggregatorFactory	doBuild(AggregationContext context, AggregatorFactory parent, AggregatorFactories.Builder subFactoriesBuilder)
protected final void	doWriteTo(StreamOutput out)
protected abstract XContentBuilder	doXContentBody(XContentBuilder builder, ToXContent.Params params)
boolean	equals(Object obj)
String	field()	Gets the field to use for this aggregation.
AB	field(String field)	Sets the field to use for this aggregation.
String	format()	Gets the format to use for the output of the aggregation.
AB	format(String format)	Sets the format to use for the output of the aggregation.
protected abstract ValuesSourceRegistry.RegistryKey<?>	getRegistryKey()
int	hashCode()
protected abstract ValuesSourceAggregatorFactory	innerBuild(AggregationContext context, ValuesSourceConfig config, AggregatorFactory parent, AggregatorFactories.Builder subFactoriesBuilder)
protected abstract void	innerWriteTo(StreamOutput out)	Write subclass's state to the stream.
final XContentBuilder	internalXContent(XContentBuilder builder, ToXContent.Params params)
Object	missing()	Gets the value to use when the aggregation finds a missing value in a document
AB	missing(Object missing)	Sets the value to use when the aggregation finds a missing value in a document
protected ValuesSourceConfig	resolveConfig(AggregationContext context)	Aggregations should override this if they need non-standard logic for resolving where to get values from.
Script	script()	Gets the script to use for this aggregation.
AB	script(Script script)	Sets the script to use for this aggregation.
protected boolean	serializeTargetValueType(Version version)	DO NOT OVERRIDE THIS!
ZoneId	timeZone()	Gets the time zone to use for this aggregation
AB	timeZone(ZoneId timeZone)	Sets the time zone to use for this aggregation
ValueType	userValueTypeHint()
AB	userValueTypeHint(ValueType valueType)	This setter should only be used during parsing, to set the userValueTypeHint.

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, isInSortOrderExecutionRequired, rewrite, shallowCopy, toString, validateSequentiallyOrdered, validateSequentiallyOrderedWithoutGaps

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

Field Details

config

protected ValuesSourceConfig config

Constructor Details

ValuesSourceAggregationBuilder

protected ValuesSourceAggregationBuilder(String name)

ValuesSourceAggregationBuilder

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

ValuesSourceAggregationBuilder

protected ValuesSourceAggregationBuilder(StreamInput in)
                                  throws IOException

Read from a stream.

Throws:

IOException

Method Details

declareFields

public static <T> void declareFields(AbstractObjectParser<? extends ValuesSourceAggregationBuilder<?>,T> objectParser,
 boolean scriptable,
 boolean formattable,
 boolean timezoneAware)

declareFields

public static <T> void declareFields(AbstractObjectParser<? extends ValuesSourceAggregationBuilder<?>,T> objectParser,
 boolean scriptable,
 boolean formattable,
 boolean timezoneAware,
 boolean fieldRequired)

doWriteTo

protected final void doWriteTo(StreamOutput out)
                        throws IOException

Specified by:

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

Throws:

IOException

innerWriteTo

protected abstract void innerWriteTo(StreamOutput out)
                              throws IOException

Write subclass's state to the stream.

Throws:

IOException

serializeTargetValueType

protected boolean serializeTargetValueType(Version version)

DO NOT OVERRIDE THIS!

This method only exists for legacy support. No new aggregations need this, nor should they override it.

Parameters:

version - For backwards compatibility, subclasses can change behavior based on the version

field

public AB field(String field)

Sets the field to use for this aggregation.

field

public String field()

Gets the field to use for this aggregation.

script

public AB script(Script script)

Sets the script to use for this aggregation.

script

public Script script()

Gets the script to use for this aggregation.

userValueTypeHint

public AB userValueTypeHint(ValueType valueType)

This setter should only be used during parsing, to set the userValueTypeHint. This is information the user provides in the json query to indicate the output type of a script or the type of the 'missing' replacement value.

Parameters:

valueType - - The parsed ValueType based on the string the user specified

Returns:

- The modified builder instance, for chaining.

userValueTypeHint

public ValueType userValueTypeHint()

format

public AB format(String format)

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

format

public String format()

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

missing

public AB missing(Object missing)

Sets the value to use when the aggregation finds a missing value in a document

missing

public Object missing()

Gets the value to use when the aggregation finds a missing value in a document

timeZone

public AB timeZone(ZoneId timeZone)

Sets the time zone to use for this aggregation

timeZone

public ZoneId timeZone()

Gets the time zone to use for this aggregation

doBuild

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

Specified by:

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

Throws:

IOException

getRegistryKey

protected abstract ValuesSourceRegistry.RegistryKey<?> getRegistryKey()

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.

resolveConfig

protected ValuesSourceConfig resolveConfig(AggregationContext context)

Aggregations should override this if they need non-standard logic for resolving where to get values from. For example, join aggregations (like Parent and Child) ask the user to specify one side of the join and then look up the other field to read values from.

The default implementation just uses the field and/or script the user provided.

Returns:

A ValuesSourceConfig configured based on the parsed field and/or script.

innerBuild

protected abstract ValuesSourceAggregatorFactory innerBuild(AggregationContext context,
 ValuesSourceConfig config,
 AggregatorFactory parent,
 AggregatorFactories.Builder subFactoriesBuilder)
                                                     throws IOException

Throws:

IOException

internalXContent

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

Specified by:

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

Throws:

IOException

doXContentBody

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

Throws:

IOException

hashCode

public int hashCode()

Overrides:

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

equals

public boolean equals(Object obj)

Overrides:

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