Package org.elasticsearch.search.aggregations.bucket.composite

Class InternalComposite.InternalBucket

java.lang.Object
org.elasticsearch.search.aggregations.InternalMultiBucketAggregation.InternalBucket
org.elasticsearch.search.aggregations.bucket.composite.InternalComposite.InternalBucket
All Implemented Interfaces:
Writeable, org.elasticsearch.common.xcontent.ToXContent, CompositeAggregation.Bucket, MultiBucketsAggregation.Bucket, HasAggregations, KeyComparable<InternalComposite.InternalBucket>
Enclosing class:
InternalComposite
public static class InternalComposite.InternalBucket
extends InternalMultiBucketAggregation.InternalBucket
implements CompositeAggregation.Bucket, KeyComparable<InternalComposite.InternalBucket>

  • 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

  • Method Summary

    Modifier and Type Method Description
    int compareKey​(InternalComposite.InternalBucket other)
    Compare this MultiBucketsAggregation.Buckets key with another bucket.
    boolean equals​(java.lang.Object obj)  
    Aggregations getAggregations()  
    long getDocCount()  
    java.util.Map<java.lang.String,​java.lang.Object> getKey()  
    java.lang.String getKeyAsString()  
    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

  • Method Details

    • writeTo

      public void writeTo​(StreamOutput out) throws java.io.IOException
      Description copied from interface: Writeable
      Write this into the StreamOutput.
      Specified by:
      writeTo in interface Writeable
      Throws:
      java.io.IOException

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class java.lang.Object

    • equals

      public boolean equals​(java.lang.Object obj)
      Overrides:
      equals in class java.lang.Object

    • getKey

      public java.util.Map<java.lang.String,​java.lang.Object> getKey()
      Specified by:
      getKey in interface CompositeAggregation.Bucket
      Specified by:
      getKey in interface MultiBucketsAggregation.Bucket
      Returns:
      The key associated with the bucket

    • getKeyAsString

      public java.lang.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

    • compareKey

      public int compareKey​(InternalComposite.InternalBucket other)
      Description copied from interface: KeyComparable
      Compare this MultiBucketsAggregation.Buckets key with another bucket.
      Specified by:
      compareKey in interface KeyComparable<InternalComposite.InternalBucket>
      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)

    • 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 interface org.elasticsearch.common.xcontent.ToXContent
      Throws:
      java.io.IOException