Class StringRareTerms.Bucket
java.lang.Object
org.elasticsearch.search.aggregations.InternalMultiBucketAggregation.InternalBucket
org.elasticsearch.search.aggregations.bucket.terms.InternalRareTerms.Bucket<StringRareTerms.Bucket>
org.elasticsearch.search.aggregations.bucket.terms.StringRareTerms.Bucket
- All Implemented Interfaces:
Writeable
,ToXContent
,MultiBucketsAggregation.Bucket
,RareTerms.Bucket
,HasAggregations
,KeyComparable<StringRareTerms.Bucket>
- Enclosing class:
- StringRareTerms
public static class StringRareTerms.Bucket extends InternalRareTerms.Bucket<StringRareTerms.Bucket>
-
Nested Class Summary
Nested classes/interfaces inherited from class org.elasticsearch.search.aggregations.bucket.terms.InternalRareTerms.Bucket
InternalRareTerms.Bucket.Reader<B extends InternalRareTerms.Bucket<B>>
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.Writer<V>
-
Field Summary
Fields inherited from class org.elasticsearch.search.aggregations.bucket.terms.InternalRareTerms.Bucket
aggregations, docCount, format
-
Constructor Summary
Constructors Constructor Description Bucket(org.apache.lucene.util.BytesRef term, long docCount, InternalAggregations aggregations, DocValueFormat format)
Bucket(StreamInput in, DocValueFormat format)
Read from a stream. -
Method Summary
Modifier and Type Method Description int
compareKey(StringRareTerms.Bucket other)
Compare thisMultiBucketsAggregation.Bucket
skey
with another bucket.boolean
equals(java.lang.Object obj)
java.lang.Object
getKey()
java.lang.Number
getKeyAsNumber()
java.lang.String
getKeyAsString()
int
hashCode()
protected XContentBuilder
keyToXContent(XContentBuilder builder)
protected void
writeTermTo(StreamOutput out)
Methods inherited from class org.elasticsearch.search.aggregations.bucket.terms.InternalRareTerms.Bucket
getAggregations, getDocCount, toXContent, writeTo
Methods inherited from class org.elasticsearch.search.aggregations.InternalMultiBucketAggregation.InternalBucket
getProperty
-
Constructor Details
-
Bucket
public Bucket(org.apache.lucene.util.BytesRef term, long docCount, InternalAggregations aggregations, DocValueFormat format) -
Bucket
Read from a stream.- Throws:
java.io.IOException
-
-
Method Details
-
writeTermTo
- Specified by:
writeTermTo
in classInternalRareTerms.Bucket<StringRareTerms.Bucket>
- Throws:
java.io.IOException
-
getKey
public java.lang.Object getKey()- Returns:
- The key associated with the bucket
-
getKeyAsNumber
public java.lang.Number getKeyAsNumber() -
getKeyAsString
public java.lang.String getKeyAsString()- Returns:
- The key associated with the bucket as a string
-
compareKey
Description copied from interface:KeyComparable
Compare thisMultiBucketsAggregation.Bucket
skey
with another 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)
-
keyToXContent
- Specified by:
keyToXContent
in classInternalRareTerms.Bucket<StringRareTerms.Bucket>
- Throws:
java.io.IOException
-
equals
public boolean equals(java.lang.Object obj)- Overrides:
equals
in classInternalRareTerms.Bucket<StringRareTerms.Bucket>
-
hashCode
public int hashCode()- Overrides:
hashCode
in classInternalRareTerms.Bucket<StringRareTerms.Bucket>
-