org.elasticsearch.search.aggregations.bucket.significant

Class SignificantStringTerms.Bucket

java.lang.Object

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

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

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

All Implemented Interfaces:

MultiBucketsAggregation.Bucket, HasAggregations

Enclosing class:

SignificantStringTerms

public static class SignificantStringTerms.Bucket
extends InternalSignificantTerms.Bucket

Nested Class Summary

Nested classes/interfaces inherited from interface org.elasticsearch.search.aggregations.bucket.MultiBucketsAggregation.Bucket

MultiBucketsAggregation.Bucket.SubAggregationComparator<B extends MultiBucketsAggregation.Bucket>

Field Summary

Fields inherited from class org.elasticsearch.search.aggregations.bucket.significant.InternalSignificantTerms.Bucket

aggregations

Constructor Summary

Constructors

Constructor and Description
Bucket(org.apache.lucene.util.BytesRef term, long subsetDf, long subsetSize, long supersetDf, long supersetSize, InternalAggregations aggregations)
Bucket(org.apache.lucene.util.BytesRef term, long subsetDf, long subsetSize, long supersetDf, long supersetSize, InternalAggregations aggregations, double score)

Method Summary

Modifier and Type	Method and Description
String	getKey()
Number	getKeyAsNumber()
Text	getKeyAsText()

Methods inherited from class org.elasticsearch.search.aggregations.bucket.significant.InternalSignificantTerms.Bucket

getAggregations, getDocCount, getSignificanceScore, getSubsetDf, getSubsetSize, getSupersetDf, getSupersetSize, reduce, updateScore

Methods inherited from class java.lang.Object

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

Constructor Detail

Bucket

public Bucket(org.apache.lucene.util.BytesRef term,
              long subsetDf,
              long subsetSize,
              long supersetDf,
              long supersetSize,
              InternalAggregations aggregations)

Bucket

public Bucket(org.apache.lucene.util.BytesRef term,
              long subsetDf,
              long subsetSize,
              long supersetDf,
              long supersetSize,
              InternalAggregations aggregations,
              double score)

Method Detail

getKeyAsText

public Text getKeyAsText()

Returns:

The key associated with the bucket as text (ideal for further streaming this instance)

getKeyAsNumber

public Number getKeyAsNumber()

Specified by:

getKeyAsNumber in class SignificantTerms.Bucket

getKey

public String getKey()

Returns:

The key associated with the bucket as a string