Class InternalVariableWidthHistogram.Bucket
java.lang.Object
org.elasticsearch.search.aggregations.InternalMultiBucketAggregation.InternalBucket
org.elasticsearch.search.aggregations.bucket.histogram.InternalVariableWidthHistogram.Bucket
- All Implemented Interfaces:
Writeable
,org.elasticsearch.common.xcontent.ToXContent
,Histogram.Bucket
,MultiBucketsAggregation.Bucket
,HasAggregations
,KeyComparable<InternalVariableWidthHistogram.Bucket>
- Enclosing class:
- InternalVariableWidthHistogram
public static class InternalVariableWidthHistogram.Bucket extends InternalMultiBucketAggregation.InternalBucket implements Histogram.Bucket, KeyComparable<InternalVariableWidthHistogram.Bucket>
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
InternalVariableWidthHistogram.Bucket.BucketBounds
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 Modifier and Type Field Description protected DocValueFormat
format
Fields inherited from interface org.elasticsearch.common.xcontent.ToXContent
EMPTY_PARAMS
-
Constructor Summary
Constructors Constructor Description Bucket(double centroid, InternalVariableWidthHistogram.Bucket.BucketBounds bounds, long docCount, DocValueFormat format, InternalAggregations aggregations)
Bucket(StreamInput in, DocValueFormat format)
Read from a stream. -
Method Summary
Modifier and Type Method Description double
centroid()
int
compareKey(InternalVariableWidthHistogram.Bucket other)
Compare thisMultiBucketsAggregation.Bucket
skey
with another bucket.boolean
equals(java.lang.Object obj)
Aggregations
getAggregations()
long
getDocCount()
DocValueFormat
getFormatter()
java.lang.Object
getKey()
Buckets are compared using their centroids.java.lang.String
getKeyAsString()
int
hashCode()
double
max()
double
min()
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
-
Field Details
-
format
-
-
Constructor Details
-
Bucket
public Bucket(double centroid, InternalVariableWidthHistogram.Bucket.BucketBounds bounds, long docCount, DocValueFormat format, InternalAggregations aggregations) -
Bucket
Read from a stream.- Throws:
java.io.IOException
-
-
Method Details
-
writeTo
Description copied from interface:Writeable
Write this into the StreamOutput. -
equals
public boolean equals(java.lang.Object obj)- Overrides:
equals
in classjava.lang.Object
-
hashCode
public int hashCode()- Overrides:
hashCode
in classjava.lang.Object
-
getKeyAsString
public java.lang.String getKeyAsString()- Specified by:
getKeyAsString
in interfaceMultiBucketsAggregation.Bucket
- Returns:
- The key associated with the bucket as a string
-
getKey
public java.lang.Object getKey()Buckets are compared using their centroids. But, in the final XContent returned by the aggregation, we want the bucket's key to be its min. Otherwise, it would look like the distances between centroids are buckets, which is incorrect.- Specified by:
getKey
in interfaceMultiBucketsAggregation.Bucket
- Returns:
- The key associated with the bucket
-
min
public double min() -
max
public double max() -
centroid
public double centroid() -
getDocCount
public long getDocCount()- Specified by:
getDocCount
in interfaceMultiBucketsAggregation.Bucket
- Returns:
- The number of documents that fall within this bucket
-
getAggregations
- Specified by:
getAggregations
in interfaceHasAggregations
- Specified by:
getAggregations
in interfaceMultiBucketsAggregation.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 java.io.IOException- Specified by:
toXContent
in interfaceorg.elasticsearch.common.xcontent.ToXContent
- Throws:
java.io.IOException
-
compareKey
Description copied from interface:KeyComparable
Compare thisMultiBucketsAggregation.Bucket
skey
with another bucket.- Specified by:
compareKey
in interfaceKeyComparable<InternalVariableWidthHistogram.Bucket>
- Parameters:
other
- the bucket that contains the key to compare to.- Returns:
- a negative integer, zero, or a positive integer as this buckets key is less than, equal to, or greater than the other buckets key.
- See Also:
Comparable.compareTo(Object)
-
getFormatter
-