Module org.elasticsearch.server
Interface SignificantTerms
- 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.
-
Nested Class Summary
Nested ClassesNested classes/interfaces inherited from interface org.elasticsearch.search.aggregations.Aggregation
Aggregation.CommonFieldsNested classes/interfaces inherited from interface org.elasticsearch.xcontent.ToXContent
ToXContent.DelegatingMapParams, ToXContent.MapParams, ToXContent.Params -
Field Summary
Fields inherited from interface org.elasticsearch.search.aggregations.Aggregation
TYPED_KEYS_DELIMITERFields inherited from interface org.elasticsearch.xcontent.ToXContent
EMPTY, EMPTY_PARAMS -
Method Summary
Modifier and TypeMethodDescriptiongetBucketByKey(String term) Get the bucket for the given term, or null if there is no such bucket.List<? extends SignificantTerms.Bucket> longlongMethods inherited from interface org.elasticsearch.search.aggregations.Aggregation
getMetadata, getName, getTypeMethods inherited from interface java.lang.Iterable
forEach, iterator, spliteratorMethods inherited from interface org.elasticsearch.xcontent.ToXContent
toXContentMethods inherited from interface org.elasticsearch.xcontent.ToXContentFragment
isFragment
-
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:
getBucketsin interfaceMultiBucketsAggregation- Returns:
- The buckets of this aggregation.
-
getBucketByKey
Get the bucket for the given term, or null if there is no such bucket.
-