All Superinterfaces:
Aggregation, Iterable<SignificantTerms.Bucket>, MultiBucketsAggregation, ToXContent, ToXContentFragment
All Known Implementing Classes:
InternalMappedSignificantTerms, InternalSignificantTerms, SignificantLongTerms, SignificantStringTerms, UnmappedSignificantTerms

public interface SignificantTerms extends MultiBucketsAggregation, Iterable<SignificantTerms.Bucket>
An aggregation that collects significant terms in comparison to a background set.
  • Method Details

    • getSubsetSize

      long getSubsetSize()
      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.
    • getSupersetSize

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

      List<? extends SignificantTerms.Bucket> getBuckets()
      Specified by:
      getBuckets in interface MultiBucketsAggregation
      Returns:
      The buckets of this aggregation.
    • getBucketByKey

      SignificantTerms.Bucket getBucketByKey(String term)
      Get the bucket for the given term, or null if there is no such bucket.