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

Interface SignificantTerms

All Superinterfaces:
Aggregation, Iterable<SignificantTerms.Bucket>, MultiBucketsAggregation, org.elasticsearch.common.xcontent.ToXContent, org.elasticsearch.common.xcontent.ToXContentFragment
All Known Implementing Classes:
InternalMappedSignificantTerms, InternalSignificantTerms, ParsedSignificantLongTerms, ParsedSignificantStringTerms, ParsedSignificantTerms, SignificantLongTerms, SignificantStringTerms, UnmappedSignificantTerms
public interface SignificantTerms extends MultiBucketsAggregation, Iterable<SignificantTerms.Bucket>
An aggregation that collects significant terms in comparison to a background set.

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Interface
    Description
    static interface 
    SignificantTerms.Bucket
     

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

    Aggregation.CommonFields

    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.search.aggregations.Aggregation

    TYPED_KEYS_DELIMITER

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

    EMPTY_PARAMS

  • Method Summary

    Modifier and Type
    Method
    Description
    SignificantTerms.Bucket
    getBucketByKey(String term)
    Get the bucket for the given term, or null if there is no such bucket.
    List<? extends SignificantTerms.Bucket>
    getBuckets()
     

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

    getMetadata, getName, getType

    Methods inherited from interface java.lang.Iterable

    forEach, iterator, spliterator

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

    toXContent

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

    isFragment