Package org.opensearch.search.aggregations.bucket.terms

Class ParsedSignificantTerms.ParsedBucket

java.lang.Object

org.opensearch.search.aggregations.ParsedMultiBucketAggregation.ParsedBucket

org.opensearch.search.aggregations.bucket.terms.ParsedSignificantTerms.ParsedBucket

All Implemented Interfaces:

org.opensearch.core.xcontent.ToXContent, MultiBucketsAggregation.Bucket, SignificantTerms.Bucket, HasAggregations

Direct Known Subclasses:

ParsedSignificantLongTerms.ParsedBucket, ParsedSignificantStringTerms.ParsedBucket

Enclosing class:

ParsedSignificantTerms

public abstract static class ParsedSignificantTerms.ParsedBucket
extends ParsedMultiBucketAggregation.ParsedBucket
implements SignificantTerms.Bucket

Parsed bucket for significant values

Opensearch.internal:

Nested Class Summary

Nested classes/interfaces inherited from interface org.opensearch.core.xcontent.ToXContent

org.opensearch.core.xcontent.ToXContent.DelegatingMapParams, org.opensearch.core.xcontent.ToXContent.MapParams, org.opensearch.core.xcontent.ToXContent.Params

Field Summary

Fields

Modifier and Type	Field	Description
protected double	score
protected long	subsetDf
protected long	subsetSize
protected long	supersetDf
protected long	supersetSize

Fields inherited from interface org.opensearch.core.xcontent.ToXContent

EMPTY_PARAMS

Constructor Summary

Constructors

Constructor	Description
ParsedBucket()

Method Summary

Modifier and Type	Method	Description
long	getDocCount()
double	getSignificanceScore()
long	getSubsetDf()
long	getSubsetSize()
long	getSupersetDf()
long	getSupersetSize()
protected abstract org.opensearch.core.xcontent.XContentBuilder	keyToXContent(org.opensearch.core.xcontent.XContentBuilder builder)
final org.opensearch.core.xcontent.XContentBuilder	toXContent(org.opensearch.core.xcontent.XContentBuilder builder, org.opensearch.core.xcontent.ToXContent.Params params)

Methods inherited from class org.opensearch.search.aggregations.ParsedMultiBucketAggregation.ParsedBucket

getAggregations, getKeyAsString, isKeyed, parseXContent, setAggregations, setDocCount, setKeyAsString, setKeyed

Methods inherited from class java.lang.Object

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

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

getAggregations, getKey, getKeyAsString

Methods inherited from interface org.opensearch.search.aggregations.bucket.terms.SignificantTerms.Bucket

getKeyAsNumber

Methods inherited from interface org.opensearch.core.xcontent.ToXContent

isFragment

Field Details

subsetDf

protected long subsetDf

subsetSize

protected long subsetSize

supersetDf

protected long supersetDf

supersetSize

protected long supersetSize

score

protected double score

Constructor Details

ParsedBucket

public ParsedBucket()

Method Details

getDocCount

public long getDocCount()

Specified by:

getDocCount in interface MultiBucketsAggregation.Bucket

Overrides:

getDocCount in class ParsedMultiBucketAggregation.ParsedBucket

Returns:

The number of documents that fall within this bucket

getSubsetDf

public long getSubsetDf()

Specified by:

getSubsetDf in interface SignificantTerms.Bucket

Returns:

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

getSupersetDf

public long getSupersetDf()

Specified by:

getSupersetDf in interface SignificantTerms.Bucket

Returns:

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

getSignificanceScore

public double getSignificanceScore()

Specified by:

getSignificanceScore in interface SignificantTerms.Bucket

Returns:

The significant score for the subset

getSupersetSize

public long getSupersetSize()

Specified by:

getSupersetSize in interface SignificantTerms.Bucket

Returns:

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

getSubsetSize

public long getSubsetSize()

Specified by:

getSubsetSize in interface SignificantTerms.Bucket

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.

toXContent

public final org.opensearch.core.xcontent.XContentBuilder toXContent(org.opensearch.core.xcontent.XContentBuilder builder,
 org.opensearch.core.xcontent.ToXContent.Params params)
                                                              throws IOException

Specified by:

toXContent in interface org.opensearch.core.xcontent.ToXContent

Overrides:

toXContent in class ParsedMultiBucketAggregation.ParsedBucket

Throws:

IOException

keyToXContent

protected abstract org.opensearch.core.xcontent.XContentBuilder keyToXContent(org.opensearch.core.xcontent.XContentBuilder builder)
                                                                       throws IOException

Overrides:

keyToXContent in class ParsedMultiBucketAggregation.ParsedBucket

Throws:

IOException