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.InternalMultiBucketAggregation.InternalBucketWritable
org.elasticsearch.search.aggregations.bucket.terms.InternalSignificantTerms.Bucket<B>
- All Implemented Interfaces:
Writeable,MultiBucketsAggregation.Bucket,SignificantTerms.Bucket,HasAggregations
- 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.InternalBucketWritable
implements SignificantTerms.Bucket
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic interfaceReads a bucket.Nested classes/interfaces inherited from interface org.elasticsearch.common.io.stream.Writeable
Writeable.Writer<V> -
Field Summary
Fields -
Constructor Summary
ConstructorsModifierConstructorDescriptionprotectedBucket(long subsetDf, long supersetDf, InternalAggregations aggregations, DocValueFormat format) protectedBucket(DocValueFormat format) Read from a stream. -
Method Summary
Modifier and TypeMethodDescriptionbooleanlongdoublelonglonginthashCode()protected abstract XContentBuilderkeyToXContent(XContentBuilder builder) Methods inherited from class org.elasticsearch.search.aggregations.InternalMultiBucketAggregation.InternalBucket
getPropertyMethods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, waitMethods inherited from interface org.elasticsearch.search.aggregations.bucket.MultiBucketsAggregation.Bucket
getKey, getKeyAsString
-
Field Details
-
aggregations
-
-
Constructor Details
-
Bucket
protected Bucket(long subsetDf, long supersetDf, InternalAggregations aggregations, DocValueFormat format) -
Bucket
Read from a stream.
-
-
Method Details
-
getSubsetDf
public long getSubsetDf()- Specified by:
getSubsetDfin 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:
getSupersetDfin interfaceSignificantTerms.Bucket- Returns:
- The number of docs in the superset containing a particular term (also known as the "background count" of the bucket)
-
getDocCount
public long getDocCount()- Specified by:
getDocCountin interfaceMultiBucketsAggregation.Bucket- Returns:
- The number of documents that fall within this bucket
-
getAggregations
- Specified by:
getAggregationsin interfaceHasAggregations- Specified by:
getAggregationsin interfaceMultiBucketsAggregation.Bucket- Returns:
- The sub-aggregations of this bucket
-
getSignificanceScore
public double getSignificanceScore()- Specified by:
getSignificanceScorein interfaceSignificantTerms.Bucket- Returns:
- The significant score for the subset
-
equals
-
hashCode
public int hashCode() -
keyToXContent
- Throws:
IOException
-