org.elasticsearch.search.aggregations.bucket.significant

Class SignificantStringTerms.Bucket

java.lang.Object

org.elasticsearch.search.aggregations.InternalMultiBucketAggregation.InternalBucket

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:

Streamable, ToXContent, 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>

Nested classes/interfaces inherited from interface org.elasticsearch.common.xcontent.ToXContent

ToXContent.DelegatingMapParams, ToXContent.MapParams, ToXContent.Params

Field Summary

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

aggregations

Fields inherited from interface org.elasticsearch.common.xcontent.ToXContent

EMPTY_PARAMS

Constructor Summary

Constructors

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

Method Summary

Methods

Modifier and Type	Method and Description
String	getKey()
Number	getKeyAsNumber()
String	getKeyAsString()
void	readFrom(StreamInput in)
XContentBuilder	toXContent(XContentBuilder builder, ToXContent.Params params)
void	writeTo(StreamOutput out)

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 org.elasticsearch.search.aggregations.InternalMultiBucketAggregation.InternalBucket

getProperty

Methods inherited from class java.lang.Object

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

Constructor Detail

SignificantStringTerms.Bucket

public SignificantStringTerms.Bucket(long subsetSize,
                             long supersetSize)

SignificantStringTerms.Bucket

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

SignificantStringTerms.Bucket

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

Method Detail

getKeyAsNumber

public Number getKeyAsNumber()

getKeyAsString

public String getKeyAsString()

Returns:

The key associated with the bucket as a string

getKey

public String getKey()

Returns:

The key associated with the bucket

readFrom

public void readFrom(StreamInput in)
              throws IOException

Throws:

IOException

writeTo

public void writeTo(StreamOutput out)
             throws IOException

Throws:

IOException

toXContent

public XContentBuilder toXContent(XContentBuilder builder,
                         ToXContent.Params params)
                           throws IOException

Throws:

IOException