Package org.elasticsearch.search.aggregations.bucket.range

Class AbstractRangeBuilder<AB extends AbstractRangeBuilder<AB,R>,R extends RangeAggregator.Range>

java.lang.Object

org.elasticsearch.search.aggregations.AggregationBuilder

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

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

org.elasticsearch.search.aggregations.bucket.range.AbstractRangeBuilder<AB,R>

All Implemented Interfaces:

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

Direct Known Subclasses:

DateRangeAggregationBuilder, RangeAggregationBuilder

public abstract class AbstractRangeBuilder<AB extends AbstractRangeBuilder<AB,R>,R extends RangeAggregator.Range>
extends ValuesSourceAggregationBuilder<AB>

Nested Class Summary

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

ValuesSourceAggregationBuilder.LeafOnly<VS extends ValuesSource,AB extends ValuesSourceAggregationBuilder<AB>>, ValuesSourceAggregationBuilder.MetricsAggregationBuilder<VS extends ValuesSource,AB extends ValuesSourceAggregationBuilder<AB>>, 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

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

Modifier and Type	Field	Description
protected boolean	keyed
protected final InternalRange.Factory<?,?>	rangeFactory
protected List<R>	ranges

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

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	AbstractRangeBuilder(String name, InternalRange.Factory<?,?> rangeFactory)
protected	AbstractRangeBuilder(StreamInput in, InternalRange.Factory<?,?> rangeFactory, Writeable.Reader<R> rangeReader)	Read from a stream.
protected	AbstractRangeBuilder(AbstractRangeBuilder<AB,R> clone, AggregatorFactories.Builder factoriesBuilder, Map<String,Object> metadata)

Method Summary

Modifier and Type	Method	Description
AB	addRange(R range)
AggregationBuilder.BucketCardinality	bucketCardinality()	A rough count of the number of buckets that Aggregators built by this builder will contain per owning parent bucket.
protected ValuesSourceType	defaultValueSourceType()	Aggregations should use this method to define a ValuesSourceType of last resort.
protected org.elasticsearch.xcontent.XContentBuilder	doXContentBody(org.elasticsearch.xcontent.XContentBuilder builder, org.elasticsearch.xcontent.ToXContent.Params params)
boolean	equals(Object obj)
int	hashCode()
protected void	innerWriteTo(StreamOutput out)	Write subclass's state to the stream.
boolean	keyed()
AB	keyed(boolean keyed)
protected RangeAggregator.Range[]	processRanges(Function<RangeAggregator.Range,RangeAggregator.Range> rangeProcessor)	Resolve any strings in the ranges so we have a number value for the from and to of each range.
List<R>	ranges()

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

declareFields, declareFields, doBuild, doWriteTo, field, field, format, format, getRegistryKey, innerBuild, internalXContent, missing, missing, resolveConfig, script, script, serializeTargetValueType, timeZone, timeZone, userValueTypeHint, 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

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

Field Details

rangeFactory

protected final InternalRange.Factory<?,?> rangeFactory

ranges

protected List<R extends RangeAggregator.Range> ranges

keyed

protected boolean keyed

Constructor Details

AbstractRangeBuilder

protected AbstractRangeBuilder(String name,
 InternalRange.Factory<?,?> rangeFactory)

AbstractRangeBuilder

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

AbstractRangeBuilder

protected AbstractRangeBuilder(StreamInput in,
 InternalRange.Factory<?,?> rangeFactory,
 Writeable.Reader<R> rangeReader)
                        throws IOException

Read from a stream.

Throws:

IOException

Method Details

defaultValueSourceType

protected ValuesSourceType defaultValueSourceType()

Description copied from class: ValuesSourceAggregationBuilder

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.

Specified by:

defaultValueSourceType in class ValuesSourceAggregationBuilder<AB extends AbstractRangeBuilder<AB,R>>

Returns:

The CoreValuesSourceType we expect this script to yield.

processRanges

protected RangeAggregator.Range[] processRanges(Function<RangeAggregator.Range,RangeAggregator.Range> rangeProcessor)

Resolve any strings in the ranges so we have a number value for the from and to of each range. The ranges are also sorted before being returned.

innerWriteTo

protected void innerWriteTo(StreamOutput out)
                     throws IOException

Description copied from class: ValuesSourceAggregationBuilder

Write subclass's state to the stream.

Specified by:

innerWriteTo in class ValuesSourceAggregationBuilder<AB extends AbstractRangeBuilder<AB,R>>

Throws:

IOException

addRange

public AB addRange(R range)

ranges

public List<R> ranges()

keyed

public AB keyed(boolean keyed)

keyed

public boolean keyed()

bucketCardinality

public AggregationBuilder.BucketCardinality bucketCardinality()

Description copied from class: AggregationBuilder

A rough count of the number of buckets that Aggregators built by this builder will contain per owning parent bucket.

Specified by:

bucketCardinality in class AggregationBuilder

doXContentBody

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

Specified by:

doXContentBody in class ValuesSourceAggregationBuilder<AB extends AbstractRangeBuilder<AB,R>>

Throws:

IOException

hashCode

public int hashCode()

Overrides:

hashCode in class ValuesSourceAggregationBuilder<AB extends AbstractRangeBuilder<AB,R>>

equals

public boolean equals(Object obj)

Overrides:

equals in class ValuesSourceAggregationBuilder<AB extends AbstractRangeBuilder<AB,R>>