Class ParsedSignificantTerms.ParsedBucket
- java.lang.Object
-
- org.elasticsearch.search.aggregations.ParsedMultiBucketAggregation.ParsedBucket
-
- org.elasticsearch.search.aggregations.bucket.significant.ParsedSignificantTerms.ParsedBucket
-
- All Implemented Interfaces:
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
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from interface org.elasticsearch.common.xcontent.ToXContent
ToXContent.DelegatingMapParams, ToXContent.MapParams, 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.elasticsearch.common.xcontent.ToXContent
EMPTY_PARAMS
-
-
Constructor Summary
Constructors Constructor Description ParsedBucket()
-
Method Summary
All Methods Instance Methods Abstract Methods Concrete Methods Modifier and Type Method Description long
getDocCount()
double
getSignificanceScore()
long
getSubsetDf()
long
getSubsetSize()
long
getSupersetDf()
long
getSupersetSize()
protected abstract XContentBuilder
keyToXContent(XContentBuilder builder)
XContentBuilder
toXContent(XContentBuilder builder, ToXContent.Params params)
-
Methods inherited from class org.elasticsearch.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.elasticsearch.search.aggregations.bucket.MultiBucketsAggregation.Bucket
getAggregations, getKey, getKeyAsString
-
Methods inherited from interface org.elasticsearch.search.aggregations.bucket.significant.SignificantTerms.Bucket
getKeyAsNumber
-
Methods inherited from interface org.elasticsearch.common.xcontent.ToXContent
isFragment
-
-
-
-
Method Detail
-
getDocCount
public long getDocCount()
- Specified by:
getDocCount
in interfaceMultiBucketsAggregation.Bucket
- Overrides:
getDocCount
in classParsedMultiBucketAggregation.ParsedBucket
- Returns:
- The number of documents that fall within this bucket
-
getSubsetDf
public long getSubsetDf()
- Specified by:
getSubsetDf
in interfaceSignificantTerms.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 interfaceSignificantTerms.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 interfaceSignificantTerms.Bucket
- Returns:
- The significant score for the subset
-
getSupersetSize
public long getSupersetSize()
- Specified by:
getSupersetSize
in interfaceSignificantTerms.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 interfaceSignificantTerms.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 XContentBuilder toXContent(XContentBuilder builder, ToXContent.Params params) throws java.io.IOException
- Specified by:
toXContent
in interfaceToXContent
- Overrides:
toXContent
in classParsedMultiBucketAggregation.ParsedBucket
- Throws:
java.io.IOException
-
keyToXContent
protected abstract XContentBuilder keyToXContent(XContentBuilder builder) throws java.io.IOException
- Overrides:
keyToXContent
in classParsedMultiBucketAggregation.ParsedBucket
- Throws:
java.io.IOException
-
-