Package org.elasticsearch.search.aggregations.bucket.terms

Class ParsedTerms

java.lang.Object
org.elasticsearch.search.aggregations.ParsedAggregation
org.elasticsearch.search.aggregations.ParsedMultiBucketAggregation<ParsedTerms.ParsedBucket>
org.elasticsearch.search.aggregations.bucket.terms.ParsedTerms
All Implemented Interfaces:
org.elasticsearch.common.xcontent.ToXContent, org.elasticsearch.common.xcontent.ToXContentFragment, Aggregation, MultiBucketsAggregation, Terms
Direct Known Subclasses:
ParsedDoubleTerms, ParsedLongTerms, ParsedStringTerms
public abstract class ParsedTerms
extends ParsedMultiBucketAggregation<ParsedTerms.ParsedBucket>
implements Terms

  • Nested Class Summary

    Nested Classes
    Modifier and Type Class Description
    static class  ParsedTerms.ParsedBucket  

    Nested classes/interfaces inherited from interface org.elasticsearch.search.aggregations.Aggregation

    Aggregation.CommonFields

    Nested classes/interfaces inherited from interface org.elasticsearch.search.aggregations.bucket.MultiBucketsAggregation

    MultiBucketsAggregation.Bucket

    Nested classes/interfaces inherited from interface org.elasticsearch.search.aggregations.bucket.terms.Terms

    Terms.Bucket

    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

  • Field Summary

    Fields
    Modifier and Type Field Description
    protected long docCountErrorUpperBound  
    protected long sumOtherDocCount  

    Fields inherited from class org.elasticsearch.search.aggregations.ParsedMultiBucketAggregation

    buckets, keyed

    Fields inherited from class org.elasticsearch.search.aggregations.ParsedAggregation

    metadata

    Fields inherited from interface org.elasticsearch.search.aggregations.Aggregation

    TYPED_KEYS_DELIMITER

    Fields inherited from interface org.elasticsearch.common.xcontent.ToXContent

    EMPTY_PARAMS

  • Constructor Summary

    Constructors
    Constructor Description
    ParsedTerms()  

  • Method Summary

    Modifier and Type Method Description
    protected org.elasticsearch.common.xcontent.XContentBuilder doXContentBody​(org.elasticsearch.common.xcontent.XContentBuilder builder, org.elasticsearch.common.xcontent.ToXContent.Params params)  
    Terms.Bucket getBucketByKey​(java.lang.String term)
    Get the bucket for the given term, or null if there is no such bucket.
    java.util.List<? extends Terms.Bucket> getBuckets()
    Return the sorted list of the buckets in this terms aggregation.
    long getDocCountError()
    Get an upper bound of the error on document counts in this aggregation.
    long getSumOfOtherDocCounts()
    Return the sum of the document counts of all buckets that did not make it to the top buckets.

    Methods inherited from class org.elasticsearch.search.aggregations.ParsedMultiBucketAggregation

    declareMultiBucketAggregationFields

    Methods inherited from class org.elasticsearch.search.aggregations.ParsedAggregation

    declareAggregationFields, getMetadata, getName, parseDouble, setName, toXContent

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    Methods inherited from interface org.elasticsearch.search.aggregations.Aggregation

    getMetadata, getName, getType

    Methods inherited from interface org.elasticsearch.common.xcontent.ToXContent

    toXContent

    Methods inherited from interface org.elasticsearch.common.xcontent.ToXContentFragment

    isFragment

  • Field Details

    • docCountErrorUpperBound

      protected long docCountErrorUpperBound

    • sumOtherDocCount

      protected long sumOtherDocCount

  • Constructor Details

    • ParsedTerms

      public ParsedTerms()

  • Method Details

    • getDocCountError

      public long getDocCountError()
      Description copied from interface: Terms
      Get an upper bound of the error on document counts in this aggregation.
      Specified by:
      getDocCountError in interface Terms

    • getSumOfOtherDocCounts

      public long getSumOfOtherDocCounts()
      Description copied from interface: Terms
      Return the sum of the document counts of all buckets that did not make it to the top buckets.
      Specified by:
      getSumOfOtherDocCounts in interface Terms

    • getBuckets

      public java.util.List<? extends Terms.Bucket> getBuckets()
      Description copied from interface: Terms
      Return the sorted list of the buckets in this terms aggregation.
      Specified by:
      getBuckets in interface MultiBucketsAggregation
      Specified by:
      getBuckets in interface Terms
      Returns:
      The buckets of this aggregation.

    • getBucketByKey

      public Terms.Bucket getBucketByKey​(java.lang.String term)
      Description copied from interface: Terms
      Get the bucket for the given term, or null if there is no such bucket.
      Specified by:
      getBucketByKey in interface Terms

    • doXContentBody

      protected org.elasticsearch.common.xcontent.XContentBuilder doXContentBody​(org.elasticsearch.common.xcontent.XContentBuilder builder, org.elasticsearch.common.xcontent.ToXContent.Params params) throws java.io.IOException
      Overrides:
      doXContentBody in class ParsedMultiBucketAggregation<ParsedTerms.ParsedBucket>
      Throws:
      java.io.IOException