org.elasticsearch.search.aggregations.bucket.range

Class RangeAggregatorBuilder

java.lang.Object

org.elasticsearch.action.support.ToXContentToBytes

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

org.elasticsearch.search.aggregations.support.ValuesSourceAggregatorBuilder<ValuesSource.Numeric,AB>

org.elasticsearch.search.aggregations.bucket.range.AbstractRangeBuilder<RangeAggregatorBuilder,RangeAggregator.Range>

org.elasticsearch.search.aggregations.bucket.range.RangeAggregatorBuilder

All Implemented Interfaces:

NamedWriteable, Writeable, ToXContent

public class RangeAggregatorBuilder
extends AbstractRangeBuilder<RangeAggregatorBuilder,RangeAggregator.Range>

Nested Class Summary

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

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
static ParseField	AGGREGATION_NAME_FIELD
static java.lang.String	NAME

Fields inherited from class org.elasticsearch.search.aggregations.bucket.range.AbstractRangeBuilder

keyed, rangeFactory, ranges

Fields inherited from class org.elasticsearch.search.aggregations.support.ValuesSourceAggregatorBuilder

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

Constructor and Description
RangeAggregatorBuilder(StreamInput in) Read from a stream.
RangeAggregatorBuilder(java.lang.String name)

Method Summary

Modifier and Type	Method and Description
RangeAggregatorBuilder	addRange(double from, double to) Same as addRange(String, double, double) but the key will be automatically generated based on from and to.
RangeAggregatorBuilder	addRange(java.lang.String key, double from, double to) Add a new range to this aggregation.
RangeAggregatorBuilder	addUnboundedFrom(double from) Same as addUnboundedFrom(String, double) but the key will be computed automatically.
RangeAggregatorBuilder	addUnboundedFrom(java.lang.String key, double from) Add a new range with no upper bound.
RangeAggregatorBuilder	addUnboundedTo(double to) Same as addUnboundedTo(String, double) but the key will be computed automatically.
RangeAggregatorBuilder	addUnboundedTo(java.lang.String key, double to) Add a new range with no lower bound.
java.lang.String	getWriteableName() Returns the name of the writeable object
protected RangeAggregatorFactory	innerBuild(AggregationContext context, ValuesSourceConfig<ValuesSource.Numeric> config, AggregatorFactory<?> parent, AggregatorFactories.Builder subFactoriesBuilder)

Methods inherited from class org.elasticsearch.search.aggregations.bucket.range.AbstractRangeBuilder

addRange, doXContentBody, innerEquals, innerHashCode, innerWriteTo, keyed, keyed, ranges

Methods inherited from class org.elasticsearch.search.aggregations.support.ValuesSourceAggregatorBuilder

config, doBuild, doEquals, doHashCode, doWriteTo, field, field, format, format, internalXContent, missing, missing, resolveConfig, script, script, serializeTargetValueType, timeZone, timeZone, valueType, valueType

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

build, equals, getType, hashCode, 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

NAME

public static final java.lang.String NAME

AGGREGATION_NAME_FIELD

public static final ParseField AGGREGATION_NAME_FIELD

Constructor Detail

RangeAggregatorBuilder

public RangeAggregatorBuilder(java.lang.String name)

RangeAggregatorBuilder

public RangeAggregatorBuilder(StreamInput in)
                       throws java.io.IOException

Read from a stream.

Throws:

java.io.IOException

Method Detail

addRange

public RangeAggregatorBuilder addRange(java.lang.String key,
                                       double from,
                                       double to)

Add a new range to this aggregation.

Parameters:

key - the key to use for this range in the response

from - the lower bound on the distances, inclusive

to - the upper bound on the distances, exclusive

addRange

public RangeAggregatorBuilder addRange(double from,
                                       double to)

Same as addRange(String, double, double) but the key will be automatically generated based on from and to.

addUnboundedTo

public RangeAggregatorBuilder addUnboundedTo(java.lang.String key,
                                             double to)

Add a new range with no lower bound.

Parameters:

key - the key to use for this range in the response

to - the upper bound on the distances, exclusive

addUnboundedTo

public RangeAggregatorBuilder addUnboundedTo(double to)

Same as addUnboundedTo(String, double) but the key will be computed automatically.

addUnboundedFrom

public RangeAggregatorBuilder addUnboundedFrom(java.lang.String key,
                                               double from)

Add a new range with no upper bound.

Parameters:

key - the key to use for this range in the response

from - the lower bound on the distances, inclusive

addUnboundedFrom

public RangeAggregatorBuilder addUnboundedFrom(double from)

Same as addUnboundedFrom(String, double) but the key will be computed automatically.

innerBuild

protected RangeAggregatorFactory innerBuild(AggregationContext context,
                                            ValuesSourceConfig<ValuesSource.Numeric> config,
                                            AggregatorFactory<?> parent,
                                            AggregatorFactories.Builder subFactoriesBuilder)
                                     throws java.io.IOException

Specified by:

innerBuild in class ValuesSourceAggregatorBuilder<ValuesSource.Numeric,RangeAggregatorBuilder>

Throws:

java.io.IOException

getWriteableName

public java.lang.String getWriteableName()

Description copied from interface: NamedWriteable

Returns the name of the writeable object