org.elasticsearch.search.aggregations.bucket.significant

Class SignificantStringTerms.Bucket

java.lang.Object

org.elasticsearch.search.aggregations.InternalMultiBucketAggregation.InternalBucket

org.elasticsearch.search.aggregations.bucket.significant.InternalSignificantTerms.Bucket<SignificantStringTerms.Bucket>

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

All Implemented Interfaces:

Writeable, ToXContent, MultiBucketsAggregation.Bucket, SignificantTerms.Bucket, HasAggregations

Enclosing class:

SignificantStringTerms

public static class SignificantStringTerms.Bucket
extends InternalSignificantTerms.Bucket<SignificantStringTerms.Bucket>

Nested Class Summary

Nested classes/interfaces inherited from class org.elasticsearch.search.aggregations.bucket.significant.InternalSignificantTerms.Bucket

InternalSignificantTerms.Bucket.Reader<B extends InternalSignificantTerms.Bucket<B>>

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

Nested classes/interfaces inherited from interface org.elasticsearch.common.io.stream.Writeable

Writeable.Writer<V>

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
Bucket(org.apache.lucene.util.BytesRef term, long subsetDf, long subsetSize, long supersetDf, long supersetSize, InternalAggregations aggregations, DocValueFormat format)
Bucket(org.apache.lucene.util.BytesRef term, long subsetDf, long subsetSize, long supersetDf, long supersetSize, InternalAggregations aggregations, double score, DocValueFormat format)
Bucket(StreamInput in, long subsetSize, long supersetSize, DocValueFormat format) Read from a stream.

Method Summary

Modifier and Type	Method and Description
java.lang.String	getKey()
java.lang.Number	getKeyAsNumber()
java.lang.String	getKeyAsString()
protected XContentBuilder	keyToXContent(XContentBuilder builder)
void	writeTo(StreamOutput out) Write this into the StreamOutput.

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

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

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

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

isFragment

Constructor Detail

Bucket

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

Bucket

public Bucket(StreamInput in,
              long subsetSize,
              long supersetSize,
              DocValueFormat format)
       throws java.io.IOException

Read from a stream.

Throws:

java.io.IOException

Bucket

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

Method Detail

writeTo

public void writeTo(StreamOutput out)
             throws java.io.IOException

Description copied from interface: Writeable

Write this into the StreamOutput.

Throws:

java.io.IOException

getKeyAsNumber

public java.lang.Number getKeyAsNumber()

Returns:

The key, expressed as a number

getKeyAsString

public java.lang.String getKeyAsString()

Returns:

The key associated with the bucket as a string

getKey

public java.lang.String getKey()

Returns:

The key associated with the bucket

keyToXContent

protected XContentBuilder keyToXContent(XContentBuilder builder)
                                 throws java.io.IOException

Specified by:

keyToXContent in class InternalSignificantTerms.Bucket<SignificantStringTerms.Bucket>

Throws:

java.io.IOException