org.elasticsearch.search.aggregations.bucket.significant

Class InternalSignificantTerms.Bucket

java.lang.Object

org.elasticsearch.search.aggregations.InternalMultiBucketAggregation.InternalBucket

org.elasticsearch.search.aggregations.bucket.significant.SignificantTerms.Bucket

org.elasticsearch.search.aggregations.bucket.significant.InternalSignificantTerms.Bucket

All Implemented Interfaces:

Streamable, ToXContent, MultiBucketsAggregation.Bucket, HasAggregations

Direct Known Subclasses:

SignificantStringTerms.Bucket

Enclosing class:

InternalSignificantTerms<A extends InternalSignificantTerms,B extends InternalSignificantTerms.Bucket>

public abstract static class InternalSignificantTerms.Bucket
extends SignificantTerms.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

Modifier and Type	Field and Description
protected InternalAggregations	aggregations

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

EMPTY_PARAMS

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	InternalSignificantTerms.Bucket(long subsetSize, long supersetSize)
protected	InternalSignificantTerms.Bucket(long subsetDf, long subsetSize, long supersetDf, long supersetSize, InternalAggregations aggregations)

Method Summary

Methods

Modifier and Type	Method and Description
Aggregations	getAggregations()
long	getDocCount()
double	getSignificanceScore()
long	getSubsetDf()
long	getSubsetSize()
long	getSupersetDf()
long	getSupersetSize()
InternalSignificantTerms.Bucket	reduce(List<? extends InternalSignificantTerms.Bucket> buckets, InternalAggregation.ReduceContext context)
void	updateScore(SignificanceHeuristic significanceHeuristic)

Methods inherited from class org.elasticsearch.search.aggregations.InternalMultiBucketAggregation.InternalBucket

getProperty

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

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

getKey, getKeyAsString

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

toXContent

Methods inherited from interface org.elasticsearch.common.io.stream.Streamable

readFrom, writeTo

Field Detail

aggregations

protected InternalAggregations aggregations

Constructor Detail

InternalSignificantTerms.Bucket

protected InternalSignificantTerms.Bucket(long subsetSize,
                               long supersetSize)

InternalSignificantTerms.Bucket

protected InternalSignificantTerms.Bucket(long subsetDf,
                               long subsetSize,
                               long supersetDf,
                               long supersetSize,
                               InternalAggregations aggregations)

Method Detail

getSubsetDf

public long getSubsetDf()

Overrides:

getSubsetDf in class SignificantTerms.Bucket

getSupersetDf

public long getSupersetDf()

Overrides:

getSupersetDf in class SignificantTerms.Bucket

getSupersetSize

public long getSupersetSize()

Overrides:

getSupersetSize in class SignificantTerms.Bucket

getSubsetSize

public long getSubsetSize()

Overrides:

getSubsetSize in class SignificantTerms.Bucket

updateScore

public void updateScore(SignificanceHeuristic significanceHeuristic)

getDocCount

public long getDocCount()

Returns:

The number of documents that fall within this bucket

getAggregations

public Aggregations getAggregations()

Returns:

The sub-aggregations of this bucket

reduce

public InternalSignificantTerms.Bucket reduce(List<? extends InternalSignificantTerms.Bucket> buckets,
                                     InternalAggregation.ReduceContext context)

getSignificanceScore

public double getSignificanceScore()

Specified by:

getSignificanceScore in class SignificantTerms.Bucket