org.elasticsearch.search.aggregations.bucket.range

Class InternalRange<B extends InternalRange.Bucket>

java.lang.Object

org.elasticsearch.search.aggregations.InternalAggregation

org.elasticsearch.search.aggregations.bucket.range.InternalRange<B>

All Implemented Interfaces:

Streamable, ToXContent, Aggregation, MultiBucketsAggregation, Range

Direct Known Subclasses:

InternalDateRange, InternalGeoDistance, InternalIPv4Range

public class InternalRange<B extends InternalRange.Bucket>
extends InternalAggregation
implements Range

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	InternalRange.Bucket
static class	InternalRange.Factory<B extends InternalRange.Bucket,R extends InternalRange<B>>

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

InternalAggregation.CommonFields, InternalAggregation.ReduceContext, InternalAggregation.Type

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 InternalAggregation.Type	TYPE

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

name

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

EMPTY_PARAMS

Constructor Summary

Constructors

Constructor and Description
InternalRange()
InternalRange(String name, List<B> ranges, ValueFormatter formatter, boolean keyed)

Method Summary

Modifier and Type	Method and Description
XContentBuilder	doXContentBody(XContentBuilder builder, ToXContent.Params params)
B	getBucketByKey(String key) The bucket that is associated with the given key.
Collection<B>	getBuckets() Return the buckets of this range aggregation.
protected InternalRange.Factory<B,?>	getFactory()
void	readFrom(StreamInput in)
InternalAggregation	reduce(InternalAggregation.ReduceContext reduceContext) Reduces the given addAggregation to a single one and returns it.
static void	registerStream()
InternalAggregation.Type	type()
void	writeTo(StreamOutput out)

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

getName, readSize, toXContent, writeSize

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.elasticsearch.search.aggregations.Aggregation

getName

Field Detail

TYPE

public static final InternalAggregation.Type TYPE

Constructor Detail

InternalRange

public InternalRange()

InternalRange

public InternalRange(String name,
                     List<B> ranges,
                     @Nullable
                     ValueFormatter formatter,
                     boolean keyed)

Method Detail

registerStream

public static void registerStream()

type

public InternalAggregation.Type type()

Specified by:

type in class InternalAggregation

Returns:

The InternalAggregation.Type of this aggregation

getBuckets

public Collection<B> getBuckets()

Description copied from interface: Range

Return the buckets of this range aggregation.

Specified by:

getBuckets in interface MultiBucketsAggregation

Specified by:

getBuckets in interface Range

Returns:

The buckets of this aggregation.

getBucketByKey

public B getBucketByKey(String key)

Description copied from interface: MultiBucketsAggregation

The bucket that is associated with the given key.

Specified by:

getBucketByKey in interface MultiBucketsAggregation

Specified by:

getBucketByKey in interface Range

Parameters:

key - The key of the requested bucket.

Returns:

The bucket

getFactory

protected InternalRange.Factory<B,?> getFactory()

reduce

public InternalAggregation reduce(InternalAggregation.ReduceContext reduceContext)

Description copied from class: InternalAggregation

Reduces the given addAggregation to a single one and returns it. In most cases, the assumption will be the all given addAggregation are of the same type (the same type as this aggregation). For best efficiency, when implementing, try reusing an existing get instance (typically the first in the given list) to save on redundant object construction.

Specified by:

reduce in class InternalAggregation

readFrom

public void readFrom(StreamInput in)
              throws IOException

Specified by:

readFrom in interface Streamable

Throws:

IOException

writeTo

public void writeTo(StreamOutput out)
             throws IOException

Specified by:

writeTo in interface Streamable

Throws:

IOException

doXContentBody

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

Specified by:

doXContentBody in class InternalAggregation

Throws:

IOException