Class InternalDateHistogram.Bucket
java.lang.Object
org.elasticsearch.search.aggregations.InternalMultiBucketAggregation.InternalBucket
org.elasticsearch.search.aggregations.bucket.histogram.InternalDateHistogram.Bucket
- All Implemented Interfaces:
Writeable
,Histogram.Bucket
,MultiBucketsAggregation.Bucket
,HasAggregations
,KeyComparable<InternalDateHistogram.Bucket>
,ToXContent
- Enclosing class:
- InternalDateHistogram
public static class InternalDateHistogram.Bucket
extends InternalMultiBucketAggregation.InternalBucket
implements Histogram.Bucket, KeyComparable<InternalDateHistogram.Bucket>
-
Nested Class Summary
Nested classes/interfaces inherited from interface org.elasticsearch.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 inherited from interface org.elasticsearch.xcontent.ToXContent
EMPTY_PARAMS
-
Constructor Summary
ConstructorDescriptionBucket
(long key, long docCount, boolean keyed, DocValueFormat format, InternalAggregations aggregations) Bucket
(StreamInput in, boolean keyed, DocValueFormat format) Read from a stream. -
Method Summary
Modifier and TypeMethodDescriptionint
Compare thisMultiBucketsAggregation.Bucket
skey
with another bucket.boolean
long
getKey()
boolean
getKeyed()
int
hashCode()
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, finalize, getClass, notify, notifyAll, toString, wait, wait, wait
Methods inherited from interface org.elasticsearch.xcontent.ToXContent
isFragment
-
Field Details
-
format
-
-
Constructor Details
-
Bucket
public Bucket(long key, long docCount, boolean keyed, DocValueFormat format, InternalAggregations aggregations) -
Bucket
Read from a stream.- Throws:
IOException
-
-
Method Details
-
equals
-
hashCode
public int hashCode() -
writeTo
Description copied from interface:Writeable
Write this into the StreamOutput.- Specified by:
writeTo
in interfaceWriteable
- Throws:
IOException
-
getKeyAsString
- Specified by:
getKeyAsString
in interfaceMultiBucketsAggregation.Bucket
- Returns:
- The key associated with the bucket as a string
-
getKey
- Specified by:
getKey
in interfaceMultiBucketsAggregation.Bucket
- Returns:
- The key associated with the bucket
-
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 XContentBuilder toXContent(XContentBuilder builder, ToXContent.Params params) throws IOException - Specified by:
toXContent
in interfaceToXContent
- Throws:
IOException
-
compareKey
Description copied from interface:KeyComparable
Compare thisMultiBucketsAggregation.Bucket
skey
with another bucket.- Specified by:
compareKey
in interfaceKeyComparable<InternalDateHistogram.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:
-
getFormatter
-
getKeyed
public boolean getKeyed()
-