Module org.elasticsearch.server
Class InternalSignificantTerms.Bucket<B extends InternalSignificantTerms.Bucket<B>>
java.lang.Object
org.elasticsearch.search.aggregations.InternalMultiBucketAggregation.InternalBucket
org.elasticsearch.search.aggregations.bucket.terms.InternalSignificantTerms.Bucket<B>
- All Implemented Interfaces:
Writeable
,MultiBucketsAggregation.Bucket
,SignificantTerms.Bucket
,HasAggregations
,ToXContent
- Direct Known Subclasses:
SignificantLongTerms.Bucket
,SignificantStringTerms.Bucket
,UnmappedSignificantTerms.Bucket
- Enclosing class:
- InternalSignificantTerms<A extends InternalSignificantTerms<A,
B>, B extends InternalSignificantTerms.Bucket<B>>
public abstract static class InternalSignificantTerms.Bucket<B extends InternalSignificantTerms.Bucket<B>>
extends InternalMultiBucketAggregation.InternalBucket
implements SignificantTerms.Bucket
-
Nested Class Summary
Modifier and TypeClassDescriptionstatic interface
Reads a bucket.Nested classes/interfaces inherited from interface org.elasticsearch.xcontent.ToXContent
ToXContent.DelegatingMapParams, ToXContent.MapParams, ToXContent.Params
Nested classes/interfaces inherited from interface org.elasticsearch.common.io.stream.Writeable
Writeable.Writer<V>
-
Field Summary
Fields inherited from interface org.elasticsearch.xcontent.ToXContent
EMPTY_PARAMS
-
Constructor Summary
ModifierConstructorDescriptionprotected
Bucket
(long subsetDf, long subsetSize, long supersetDf, long supersetSize, InternalAggregations aggregations, DocValueFormat format) protected
Bucket
(StreamInput in, long subsetSize, long supersetSize, DocValueFormat format) Read from a stream. -
Method Summary
Modifier and TypeMethodDescriptionboolean
long
double
long
long
long
long
int
hashCode()
protected abstract XContentBuilder
keyToXContent
(XContentBuilder builder) final XContentBuilder
toXContent
(XContentBuilder builder, ToXContent.Params params) Methods inherited from class org.elasticsearch.search.aggregations.InternalMultiBucketAggregation.InternalBucket
getProperty
Methods inherited from class java.lang.Object
clone, finalize, getClass, 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.search.aggregations.bucket.terms.SignificantTerms.Bucket
getKeyAsNumber
Methods inherited from interface org.elasticsearch.xcontent.ToXContent
isFragment
-
Field Details
-
aggregations
-
-
Constructor Details
-
Bucket
protected Bucket(long subsetDf, long subsetSize, long supersetDf, long supersetSize, InternalAggregations aggregations, DocValueFormat format) -
Bucket
Read from a stream.
-
-
Method Details
-
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)
-
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.
-
getDocCount
public long getDocCount()- Specified by:
getDocCount
in interfaceMultiBucketsAggregation.Bucket
- Returns:
- The number of documents that fall within this bucket
-
getAggregations
- Specified by:
getAggregations
in interfaceHasAggregations
- Specified by:
getAggregations
in interfaceMultiBucketsAggregation.Bucket
- Returns:
- The sub-aggregations of this bucket
-
getSignificanceScore
public double getSignificanceScore()- Specified by:
getSignificanceScore
in interfaceSignificantTerms.Bucket
- Returns:
- The significant score for the subset
-
equals
-
hashCode
public int hashCode() -
toXContent
public final XContentBuilder toXContent(XContentBuilder builder, ToXContent.Params params) throws IOException - Specified by:
toXContent
in interfaceToXContent
- Throws:
IOException
-
keyToXContent
- Throws:
IOException
-