org.elasticsearch.search.aggregations.bucket.significant

Interface SignificantTerms.Bucket

All Superinterfaces:

HasAggregations, MultiBucketsAggregation.Bucket, ToXContent

All Known Implementing Classes:

InternalSignificantTerms.Bucket, ParsedSignificantLongTerms.ParsedBucket, ParsedSignificantStringTerms.ParsedBucket, ParsedSignificantTerms.ParsedBucket, SignificantStringTerms.Bucket, UnmappedSignificantTerms.Bucket

Enclosing interface:

SignificantTerms

public static interface SignificantTerms.Bucket
extends MultiBucketsAggregation.Bucket

Nested Class Summary

Nested classes/interfaces inherited from interface org.elasticsearch.search.aggregations.bucket.MultiBucketsAggregation.Bucket

MultiBucketsAggregation.Bucket.SubAggregationComparator<B extends MultiBucketsAggregation.Bucket>

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.common.xcontent.ToXContent

EMPTY_PARAMS

Method Summary

Modifier and Type	Method and Description
java.lang.Number	getKeyAsNumber()
double	getSignificanceScore()
long	getSubsetDf()
long	getSubsetSize()
long	getSupersetDf()
long	getSupersetSize()

Methods inherited from interface org.elasticsearch.search.aggregations.bucket.MultiBucketsAggregation.Bucket

getAggregations, getDocCount, getKey, getKeyAsString

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

isFragment, toXContent

Method Detail

getSignificanceScore

double getSignificanceScore()

Returns:

The significant score for the subset

getSubsetDf

long getSubsetDf()

Returns:

The number of docs in the subset containing a particular term. This number is equal to the document count of the bucket.

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.

getSupersetDf

long getSupersetDf()

Returns:

The number of docs in the superset containing a particular term (also known as the "background count" of the bucket)

getSupersetSize

long getSupersetSize()

Returns:

The numbers of docs in the superset (ordinarily the background count of the containing aggregation).

getKeyAsNumber

java.lang.Number getKeyAsNumber()

Returns:

The key, expressed as a number