org.elasticsearch.search.aggregations.bucket.range

Class InternalRange.Bucket

java.lang.Object

org.elasticsearch.search.aggregations.InternalMultiBucketAggregation.InternalBucket

org.elasticsearch.search.aggregations.bucket.range.InternalRange.Bucket

All Implemented Interfaces:

Writeable, ToXContent, MultiBucketsAggregation.Bucket, Range.Bucket, HasAggregations

Direct Known Subclasses:

InternalDateRange.Bucket

Enclosing class:

InternalRange<B extends InternalRange.Bucket,R extends InternalRange<B,R>>

public static class InternalRange.Bucket
extends InternalMultiBucketAggregation.InternalBucket
implements Range.Bucket

Nested Class Summary

Nested classes/interfaces inherited from interface org.elasticsearch.search.aggregations.bucket.MultiBucketsAggregation.Bucket

MultiBucketsAggregation.Bucket.SubAggregationComparator<B extends MultiBucketsAggregation.Bucket>

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

ToXContent.DelegatingMapParams, ToXContent.MapParams, 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 and Description
protected DocValueFormat	format
protected double	from
protected boolean	keyed
protected double	to

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

EMPTY_PARAMS

Constructor Summary

Constructors

Constructor and Description
Bucket(boolean keyed, DocValueFormat formatter)
Bucket(java.lang.String key, double from, double to, long docCount, InternalAggregations aggregations, boolean keyed, DocValueFormat formatter)

Method Summary

Modifier and Type	Method and Description
protected java.lang.String	generateKey(double from, double to, DocValueFormat formatter)
Aggregations	getAggregations()
long	getDocCount()
protected InternalRange.Factory<? extends InternalRange.Bucket,?>	getFactory()
DocValueFormat	getFormat()
java.lang.Object	getFrom()
java.lang.String	getFromAsString()
java.lang.String	getKey()
java.lang.String	getKeyAsString()
boolean	getKeyed()
java.lang.Object	getTo()
java.lang.String	getToAsString()
XContentBuilder	toXContent(XContentBuilder builder, ToXContent.Params params)
void	writeTo(StreamOutput out) Write this into the StreamOutput.

Methods inherited from class org.elasticsearch.search.aggregations.InternalMultiBucketAggregation.InternalBucket

getProperty

Methods inherited from class java.lang.Object

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

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

isFragment

Field Detail

keyed

protected final transient boolean keyed

format

protected final transient DocValueFormat format

from

protected double from

to

protected double to

Constructor Detail

Bucket

public Bucket(boolean keyed,
              DocValueFormat formatter)

Bucket

public Bucket(java.lang.String key,
              double from,
              double to,
              long docCount,
              InternalAggregations aggregations,
              boolean keyed,
              DocValueFormat formatter)

Method Detail

getKey

public java.lang.String getKey()

Specified by:

getKey in interface MultiBucketsAggregation.Bucket

Returns:

The key associated with the bucket

getKeyAsString

public java.lang.String getKeyAsString()

Specified by:

getKeyAsString in interface MultiBucketsAggregation.Bucket

Returns:

The key associated with the bucket as a string

getFrom

public java.lang.Object getFrom()

Specified by:

getFrom in interface Range.Bucket

Returns:

The lower bound of the range

getTo

public java.lang.Object getTo()

Specified by:

getTo in interface Range.Bucket

Returns:

The upper bound of the range (excluding)

getKeyed

public boolean getKeyed()

getFormat

public DocValueFormat getFormat()

getFromAsString

public java.lang.String getFromAsString()

Specified by:

getFromAsString in interface Range.Bucket

Returns:

The string value for the lower bound of the range

getToAsString

public java.lang.String getToAsString()

Specified by:

getToAsString in interface Range.Bucket

Returns:

The string value for the upper bound of the range (excluding)

getDocCount

public long getDocCount()

Specified by:

getDocCount in interface MultiBucketsAggregation.Bucket

Returns:

The number of documents that fall within this bucket

getAggregations

public Aggregations getAggregations()

Specified by:

getAggregations in interface MultiBucketsAggregation.Bucket

Specified by:

getAggregations in interface HasAggregations

Returns:

The sub-aggregations of this bucket

getFactory

protected InternalRange.Factory<? extends InternalRange.Bucket,?> getFactory()

toXContent

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

Specified by:

toXContent in interface ToXContent

Throws:

java.io.IOException

generateKey

protected java.lang.String generateKey(double from,
                                       double to,
                                       DocValueFormat formatter)

writeTo

public void writeTo(StreamOutput out)
             throws java.io.IOException

Description copied from interface: Writeable

Write this into the StreamOutput.

Specified by:

writeTo in interface Writeable

Throws:

java.io.IOException