Module org.elasticsearch.server
Class StringRareTerms.Bucket
java.lang.Object
org.elasticsearch.search.aggregations.InternalMultiBucketAggregation.InternalBucket
org.elasticsearch.search.aggregations.InternalMultiBucketAggregation.InternalBucketWritable
org.elasticsearch.search.aggregations.bucket.terms.InternalRareTerms.Bucket<StringRareTerms.Bucket>
org.elasticsearch.search.aggregations.bucket.terms.StringRareTerms.Bucket
- All Implemented Interfaces:
Writeable,MultiBucketsAggregation.Bucket,RareTerms.Bucket,HasAggregations,KeyComparable<StringRareTerms.Bucket>
- Enclosing class:
StringRareTerms
-
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.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
ConstructorsConstructorDescriptionBucket(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 TypeMethodDescriptionintcompareKey(StringRareTerms.Bucket other) Compare thisMultiBucketsAggregation.Bucketskeywith another bucket.booleangetKey()inthashCode()protected final XContentBuilderkeyToXContent(XContentBuilder builder) protected voidwriteTermTo(StreamOutput out) Methods inherited from class org.elasticsearch.search.aggregations.bucket.terms.InternalRareTerms.Bucket
getAggregations, getDocCount, writeToMethods 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:
IOException
-
-
Method Details
-
writeTermTo
- Specified by:
writeTermToin classInternalRareTerms.Bucket<StringRareTerms.Bucket>- Throws:
IOException
-
getKey
- Returns:
- The key associated with the bucket
-
getKeyAsString
- Returns:
- The key associated with the bucket as a string
-
compareKey
Description copied from interface:KeyComparableCompare thisMultiBucketsAggregation.Bucketskeywith 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:
-
keyToXContent
- Specified by:
keyToXContentin classInternalRareTerms.Bucket<StringRareTerms.Bucket>- Throws:
IOException
-
equals
- Overrides:
equalsin classInternalRareTerms.Bucket<StringRareTerms.Bucket>
-
hashCode
public int hashCode()- Overrides:
hashCodein classInternalRareTerms.Bucket<StringRareTerms.Bucket>
-