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

Modifier and Type	Method and Description
SignificantTerms.Bucket	getBucketByKey(String key) The bucket that is associated with the given key.
Collection<SignificantTerms.Bucket>	getBuckets()

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

getName

Methods inherited from interface java.lang.Iterable

forEach, iterator, spliterator

Method Detail

getBuckets

Collection<SignificantTerms.Bucket> getBuckets()

Specified by:

getBuckets in interface MultiBucketsAggregation

Returns:

The buckets of this aggregation.

getBucketByKey

SignificantTerms.Bucket getBucketByKey(String key)

Description copied from interface: MultiBucketsAggregation

The bucket that is associated with the given key.

Specified by:

getBucketByKey in interface MultiBucketsAggregation

Parameters:

key - The key of the requested bucket.

Returns:

The bucket