org.elasticsearch.search.aggregations.bucket.significant

Interface SignificantTerms

All Superinterfaces:

Aggregation, Iterable<SignificantTerms.Bucket>, MultiBucketsAggregation

All Known Implementing Classes:

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 Classes

Modifier and Type	Interface and Description
static class	SignificantTerms.Bucket

Method Summary

Methods

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

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

getMetaData, getName, getProperty

Methods inherited from interface java.lang.Iterable

iterator

Method Detail

getBuckets

List<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.