org.elasticsearch.search.aggregations

Class ValuesSourceAggregationBuilder<B extends ValuesSourceAggregationBuilder<B>>

java.lang.Object

org.elasticsearch.search.aggregations.AbstractAggregationBuilder

org.elasticsearch.search.aggregations.AggregationBuilder<B>

org.elasticsearch.search.aggregations.ValuesSourceAggregationBuilder<B>

All Implemented Interfaces:

ToXContent

Direct Known Subclasses:

AbstractRangeBuilder, DateHistogramBuilder, GeoBoundsBuilder, HistogramBuilder, SamplerAggregationBuilder, TermsBuilder

public abstract class ValuesSourceAggregationBuilder<B extends ValuesSourceAggregationBuilder<B>>
extends AggregationBuilder<B>

A base class for all bucket aggregation builders that are based on values (either script generated or field data values)

Nested Class Summary

Nested classes/interfaces inherited from interface org.elasticsearch.common.xcontent.ToXContent

ToXContent.DelegatingMapParams, ToXContent.MapParams, ToXContent.Params

Field Summary

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

type

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

EMPTY_PARAMS

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	ValuesSourceAggregationBuilder(String name, String type) Constructs a new builder.

Method Summary

Methods

Modifier and Type	Method and Description
protected abstract XContentBuilder	doInternalXContent(XContentBuilder builder, ToXContent.Params params)
B	field(String field) Sets the field from which the values will be extracted.
protected XContentBuilder	internalXContent(XContentBuilder builder, ToXContent.Params builderParams)
B	missing(Object missingValue) Configure the value to use when documents miss a value.
B	script(Script script) Sets the script which generates the values.

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

setMetaData, subAggregation, subAggregation, subAggregation, subAggregation, subAggregation, subAggregation, toXContent

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

getName

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ValuesSourceAggregationBuilder

protected ValuesSourceAggregationBuilder(String name,
                              String type)

Constructs a new builder.

Parameters:

name - The name of the aggregation.

type - The type of the aggregation.

Method Detail

field

public B field(String field)

Sets the field from which the values will be extracted.

Parameters:

field - The name of the field

Returns:

This builder (fluent interface support)

script

public B script(Script script)

Sets the script which generates the values. If the script is configured along with the field (as in field(String)), then this script will be treated as a value script. A value script will be applied on the values that are extracted from the field data (you can refer to that value in the script using the _value reserved variable). If only the script is configured (and the no field is configured next to it), then the script will be responsible to generate the values that will be aggregated.

Parameters:

script - The configured script.

Returns:

This builder (fluent interface support)

missing

public B missing(Object missingValue)

Configure the value to use when documents miss a value.

internalXContent

protected final XContentBuilder internalXContent(XContentBuilder builder,
                               ToXContent.Params builderParams)
                                          throws IOException

Specified by:

internalXContent in class AggregationBuilder<B extends ValuesSourceAggregationBuilder<B>>

Throws:

IOException

doInternalXContent

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

Throws:

IOException