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

Class ParsedSignificantTerms.ParsedBucket

java.lang.Object
org.elasticsearch.search.aggregations.ParsedMultiBucketAggregation.ParsedBucket
org.elasticsearch.search.aggregations.bucket.terms.ParsedSignificantTerms.ParsedBucket
All Implemented Interfaces:
org.elasticsearch.common.xcontent.ToXContent, MultiBucketsAggregation.Bucket, SignificantTerms.Bucket, HasAggregations
Direct Known Subclasses:
ParsedSignificantLongTerms.ParsedBucket, ParsedSignificantStringTerms.ParsedBucket
Enclosing class:
ParsedSignificantTerms
public abstract static class ParsedSignificantTerms.ParsedBucket
extends ParsedMultiBucketAggregation.ParsedBucket
implements SignificantTerms.Bucket

  • Field Details

    • subsetDf

      protected long subsetDf

    • subsetSize

      protected long subsetSize

    • supersetDf

      protected long supersetDf

    • supersetSize

      protected long supersetSize

    • score

      protected double score

  • Constructor Details

    • ParsedBucket

      public ParsedBucket()

  • Method Details

    • getDocCount

      public long getDocCount()
      Specified by:
      getDocCount in interface MultiBucketsAggregation.Bucket
      Overrides:
      getDocCount in class ParsedMultiBucketAggregation.ParsedBucket
      Returns:
      The number of documents that fall within this bucket

    • getSubsetDf

      public long getSubsetDf()
      Specified by:
      getSubsetDf in interface SignificantTerms.Bucket
      Returns:
      The number of docs in the subset containing a particular term. This number is equal to the document count of the bucket.

    • getSupersetDf

      public long getSupersetDf()
      Specified by:
      getSupersetDf in interface SignificantTerms.Bucket
      Returns:
      The number of docs in the superset containing a particular term (also known as the "background count" of the bucket)

    • getSignificanceScore

      public double getSignificanceScore()
      Specified by:
      getSignificanceScore in interface SignificantTerms.Bucket
      Returns:
      The significant score for the subset

    • getSupersetSize

      public long getSupersetSize()
      Specified by:
      getSupersetSize in interface SignificantTerms.Bucket
      Returns:
      The numbers of docs in the superset (ordinarily the background count of the containing aggregation).

    • getSubsetSize

      public long getSubsetSize()
      Specified by:
      getSubsetSize in interface SignificantTerms.Bucket
      Returns:
      The numbers of docs in the subset (also known as "foreground set"). This number is equal to the document count of the containing aggregation.

    • toXContent

      public final 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
      Overrides:
      toXContent in class ParsedMultiBucketAggregation.ParsedBucket
      Throws:
      java.io.IOException

    • keyToXContent

      protected abstract org.elasticsearch.common.xcontent.XContentBuilder keyToXContent​(org.elasticsearch.common.xcontent.XContentBuilder builder) throws java.io.IOException
      Overrides:
      keyToXContent in class ParsedMultiBucketAggregation.ParsedBucket
      Throws:
      java.io.IOException