org.elasticsearch.search.aggregations.bucket.significant

Interface SignificantTerms

All Superinterfaces:

Aggregation, java.lang.Iterable<SignificantTerms.Bucket>, MultiBucketsAggregation, ToXContent

All Known Implementing Classes:

InternalMappedSignificantTerms, InternalSignificantTerms, ParsedSignificantLongTerms, ParsedSignificantStringTerms, ParsedSignificantTerms, SignificantLongTerms, SignificantStringTerms, UnmappedSignificantTerms

public interface SignificantTerms
extends MultiBucketsAggregation, java.lang.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 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

ToXContent.DelegatingMapParams, ToXContent.MapParams, 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 and Description
SignificantTerms.Bucket	getBucketByKey(java.lang.String term) Get the bucket for the given term, or null if there is no such bucket.
java.util.List<? extends SignificantTerms.Bucket>	getBuckets()

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

getMetaData, getName, getType

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

isFragment, toXContent

Methods inherited from interface java.lang.Iterable

forEach, iterator, spliterator

Method Detail

getBuckets

java.util.List<? extends SignificantTerms.Bucket> getBuckets()

Specified by:

getBuckets in interface MultiBucketsAggregation

Returns:

The buckets of this aggregation.

getBucketByKey

SignificantTerms.Bucket getBucketByKey(java.lang.String term)

Get the bucket for the given term, or null if there is no such bucket.