Interface SignificantTerms.Bucket

All Superinterfaces:
HasAggregations, MultiBucketsAggregation.Bucket, org.elasticsearch.common.xcontent.ToXContent
All Known Implementing Classes:
InternalSignificantTerms.Bucket, ParsedSignificantLongTerms.ParsedBucket, ParsedSignificantStringTerms.ParsedBucket, ParsedSignificantTerms.ParsedBucket, SignificantStringTerms.Bucket, UnmappedSignificantTerms.Bucket
Enclosing interface:

public static interface SignificantTerms.Bucket
extends MultiBucketsAggregation.Bucket
  • 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
  • Field Summary

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

  • Method Summary

    Modifier and Type Method Description
    java.lang.Number getKeyAsNumber()  
    double getSignificanceScore()  
    long getSubsetDf()  
    long getSubsetSize()  
    long getSupersetDf()  
    long getSupersetSize()  

    Methods inherited from interface

    getAggregations, getDocCount, getKey, getKeyAsString

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

    isFragment, toXContent
  • Method Details

    • getSignificanceScore

      double getSignificanceScore()
      The significant score for the subset
    • getSubsetDf

      long getSubsetDf()
      The number of docs in the subset containing a particular term. This number is equal to the document count of the bucket.
    • getSubsetSize

      long getSubsetSize()
      The numbers of docs in the subset (also known as "foreground set"). This number is equal to the document count of the containing aggregation.
    • getSupersetDf

      long getSupersetDf()
      The number of docs in the superset containing a particular term (also known as the "background count" of the bucket)
    • getSupersetSize

      long getSupersetSize()
      The numbers of docs in the superset (ordinarily the background count of the containing aggregation).
    • getKeyAsNumber

      java.lang.Number getKeyAsNumber()
      The key, expressed as a number