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

Class InternalBinaryRange.Bucket

java.lang.Object

org.elasticsearch.search.aggregations.InternalMultiBucketAggregation.InternalBucket

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

All Implemented Interfaces:

Writeable, org.elasticsearch.common.xcontent.ToXContent, MultiBucketsAggregation.Bucket, Range.Bucket, HasAggregations

Enclosing class:

InternalBinaryRange

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

Nested Class Summary

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

org.elasticsearch.common.xcontent.ToXContent.DelegatingMapParams, org.elasticsearch.common.xcontent.ToXContent.MapParams, org.elasticsearch.common.xcontent.ToXContent.Params

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

Writeable.Reader<V>, Writeable.Writer<V>

Field Summary

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

EMPTY_PARAMS

Constructor Summary

Constructors

Constructor	Description
Bucket(DocValueFormat format, boolean keyed, String key, org.apache.lucene.util.BytesRef from, org.apache.lucene.util.BytesRef to, long docCount, InternalAggregations aggregations)

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object o)
Aggregations	getAggregations()
long	getDocCount()
Object	getFrom()
String	getFromAsString()
Object	getKey()
String	getKeyAsString()
Object	getTo()
String	getToAsString()
int	hashCode()
org.elasticsearch.common.xcontent.XContentBuilder	toXContent(org.elasticsearch.common.xcontent.XContentBuilder builder, org.elasticsearch.common.xcontent.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, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

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

isFragment

Constructor Details

Bucket

public Bucket(DocValueFormat format,
 boolean keyed,
 String key,
 org.apache.lucene.util.BytesRef from,
 org.apache.lucene.util.BytesRef to,
 long docCount,
 InternalAggregations aggregations)

Method Details

writeTo

public void writeTo(StreamOutput out)
             throws IOException

Description copied from interface: Writeable

Write this into the StreamOutput.

Specified by:

writeTo in interface Writeable

Throws:

IOException

getKey

public Object getKey()

Specified by:

getKey in interface MultiBucketsAggregation.Bucket

Returns:

The key associated with the bucket

getKeyAsString

public String getKeyAsString()

Specified by:

getKeyAsString in interface MultiBucketsAggregation.Bucket

Returns:

The key associated with the bucket as a string

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 HasAggregations

Specified by:

getAggregations in interface MultiBucketsAggregation.Bucket

Returns:

The sub-aggregations of this bucket

toXContent

public org.elasticsearch.common.xcontent.XContentBuilder toXContent(org.elasticsearch.common.xcontent.XContentBuilder builder,
 org.elasticsearch.common.xcontent.ToXContent.Params params)
                                                             throws IOException

Specified by:

toXContent in interface org.elasticsearch.common.xcontent.ToXContent

Throws:

IOException

getFrom

public Object getFrom()

Specified by:

getFrom in interface Range.Bucket

Returns:

The lower bound of the range

getFromAsString

public String getFromAsString()

Specified by:

getFromAsString in interface Range.Bucket

Returns:

The string value for the lower bound of the range

getTo

public Object getTo()

Specified by:

getTo in interface Range.Bucket

Returns:

The upper bound of the range (excluding)

getToAsString

public String getToAsString()

Specified by:

getToAsString in interface Range.Bucket

Returns:

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

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object