org.elasticsearch.search.aggregations.support

Class ValuesSourceAggregatorBuilder<VS extends ValuesSource,AB extends ValuesSourceAggregatorBuilder<VS,AB>>

java.lang.Object

org.elasticsearch.action.support.ToXContentToBytes

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

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

All Implemented Interfaces:

NamedWriteable<AB>, StreamableReader<AB>, Writeable<AB>, ToXContent

Direct Known Subclasses:

AbstractHistogramBuilder, AbstractRangeBuilder, ChildrenAggregatorBuilder, DiversifiedAggregatorBuilder, GeoBoundsAggregatorBuilder, GeoDistanceAggregatorBuilder, GeoGridAggregatorBuilder, MissingAggregatorBuilder, SignificantTermsAggregatorBuilder, TermsAggregatorBuilder, ValuesSourceAggregatorBuilder.LeafOnly

public abstract class ValuesSourceAggregatorBuilder<VS extends ValuesSource,AB extends ValuesSourceAggregatorBuilder<VS,AB>>
extends AggregatorBuilder<AB>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ValuesSourceAggregatorBuilder.LeafOnly<VS extends ValuesSource,AB extends ValuesSourceAggregatorBuilder<VS,AB>>

Nested classes/interfaces inherited from interface org.elasticsearch.common.io.stream.Writeable

Writeable.Reader<R>

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

ToXContent.DelegatingMapParams, ToXContent.MapParams, ToXContent.Params

Field Summary

Fields

Modifier and Type	Field and Description
protected ValuesSourceConfig<VS>	config

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

factoriesBuilder, metaData, name, type

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

EMPTY_PARAMS

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	ValuesSourceAggregatorBuilder(java.lang.String name, InternalAggregation.Type type, ValuesSourceType valuesSourceType, ValueType targetValueType)

Method Summary

Modifier and Type	Method and Description
ValuesSourceConfig<VS>	config(AggregationContext context)
protected ValuesSourceAggregatorFactory<VS,?>	doBuild(AggregationContext context, AggregatorFactory<?> parent, AggregatorFactories.Builder subFactoriesBuilder)
protected boolean	doEquals(java.lang.Object obj)
protected int	doHashCode()
protected AB	doReadFrom(java.lang.String name, StreamInput in)
protected void	doWriteTo(StreamOutput out)
protected abstract XContentBuilder	doXContentBody(XContentBuilder builder, ToXContent.Params params)
java.lang.String	field() Gets the field to use for this aggregation.
AB	field(java.lang.String field) Sets the field to use for this aggregation.
java.lang.String	format() Gets the format to use for the output of the aggregation.
AB	format(java.lang.String format) Sets the format to use for the output of the aggregation.
protected abstract ValuesSourceAggregatorFactory<VS,?>	innerBuild(AggregationContext context, ValuesSourceConfig<VS> config, AggregatorFactory<?> parent, AggregatorFactories.Builder subFactoriesBuilder)
protected abstract boolean	innerEquals(java.lang.Object obj)
protected abstract int	innerHashCode()
protected abstract ValuesSourceAggregatorBuilder<VS,AB>	innerReadFrom(java.lang.String name, ValuesSourceType valuesSourceType, ValueType targetValueType, StreamInput in)
protected abstract void	innerWriteTo(StreamOutput out)
XContentBuilder	internalXContent(XContentBuilder builder, ToXContent.Params params)
java.lang.Object	missing() Gets the value to use when the aggregation finds a missing value in a document
AB	missing(java.lang.Object missing) Sets the value to use when the aggregation finds a missing value in a document
protected ValuesSourceConfig<VS>	resolveConfig(AggregationContext context)
Script	script() Gets the script to use for this aggregation.
AB	script(Script script) Sets the script to use for this aggregation.
org.joda.time.DateTimeZone	timeZone() Gets the time zone to use for this aggregation
AB	timeZone(org.joda.time.DateTimeZone timeZone) Sets the time zone to use for this aggregation
ValueType	valueType() Gets the ValueType for the value produced by this aggregation
AB	valueType(ValueType valueType) Sets the ValueType for the value produced by this aggregation

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

build, equals, getType, getWriteableName, hashCode, readFrom, setMetaData, subAggregation, subAggregation, subAggregations, toXContent, writeTo

Methods inherited from class org.elasticsearch.action.support.ToXContentToBytes

buildAsBytes, buildAsBytes, toString

Methods inherited from class java.lang.Object

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

Field Detail

config

protected ValuesSourceConfig<VS extends ValuesSource> config

Constructor Detail

ValuesSourceAggregatorBuilder

protected ValuesSourceAggregatorBuilder(java.lang.String name,
                                        InternalAggregation.Type type,
                                        ValuesSourceType valuesSourceType,
                                        ValueType targetValueType)

Method Detail

field

public AB field(java.lang.String field)

Sets the field to use for this aggregation.

field

public java.lang.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.

valueType

public AB valueType(ValueType valueType)

Sets the ValueType for the value produced by this aggregation

valueType

public ValueType valueType()

Gets the ValueType for the value produced by this aggregation

format

public AB format(java.lang.String format)

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

format

public java.lang.String format()

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

missing

public AB missing(java.lang.Object missing)

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

missing

public java.lang.Object missing()

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

timeZone

public AB timeZone(org.joda.time.DateTimeZone timeZone)

Sets the time zone to use for this aggregation

timeZone

public org.joda.time.DateTimeZone timeZone()

Gets the time zone to use for this aggregation

doBuild

protected final ValuesSourceAggregatorFactory<VS,?> doBuild(AggregationContext context,
                                                            AggregatorFactory<?> parent,
                                                            AggregatorFactories.Builder subFactoriesBuilder)
                                                     throws java.io.IOException

Specified by:

doBuild in class AggregatorBuilder<AB extends ValuesSourceAggregatorBuilder<VS,AB>>

Throws:

java.io.IOException

resolveConfig

protected ValuesSourceConfig<VS> resolveConfig(AggregationContext context)

innerBuild

protected abstract ValuesSourceAggregatorFactory<VS,?> innerBuild(AggregationContext context,
                                                                  ValuesSourceConfig<VS> config,
                                                                  AggregatorFactory<?> parent,
                                                                  AggregatorFactories.Builder subFactoriesBuilder)
                                                           throws java.io.IOException

Throws:

java.io.IOException

config

public ValuesSourceConfig<VS> config(AggregationContext context)

doWriteTo

protected final void doWriteTo(StreamOutput out)
                        throws java.io.IOException

Specified by:

doWriteTo in class AggregatorBuilder<AB extends ValuesSourceAggregatorBuilder<VS,AB>>

Throws:

java.io.IOException

innerWriteTo

protected abstract void innerWriteTo(StreamOutput out)
                              throws java.io.IOException

Throws:

java.io.IOException

doReadFrom

protected final AB doReadFrom(java.lang.String name,
                              StreamInput in)
                       throws java.io.IOException

Specified by:

doReadFrom in class AggregatorBuilder<AB extends ValuesSourceAggregatorBuilder<VS,AB>>

Throws:

java.io.IOException

innerReadFrom

protected abstract ValuesSourceAggregatorBuilder<VS,AB> innerReadFrom(java.lang.String name,
                                                                      ValuesSourceType valuesSourceType,
                                                                      ValueType targetValueType,
                                                                      StreamInput in)
                                                               throws java.io.IOException

Throws:

java.io.IOException

internalXContent

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

Specified by:

internalXContent in class AggregatorBuilder<AB extends ValuesSourceAggregatorBuilder<VS,AB>>

Throws:

java.io.IOException

doXContentBody

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

Throws:

java.io.IOException

doHashCode

protected final int doHashCode()

Specified by:

doHashCode in class AggregatorBuilder<AB extends ValuesSourceAggregatorBuilder<VS,AB>>

innerHashCode

protected abstract int innerHashCode()

doEquals

protected final boolean doEquals(java.lang.Object obj)

Specified by:

doEquals in class AggregatorBuilder<AB extends ValuesSourceAggregatorBuilder<VS,AB>>

innerEquals

protected abstract boolean innerEquals(java.lang.Object obj)