Package org.elasticsearch.search.aggregations.bucket.significant

Class ParsedSignificantTerms

java.lang.Object

org.elasticsearch.search.aggregations.ParsedAggregation

org.elasticsearch.search.aggregations.ParsedMultiBucketAggregation<ParsedSignificantTerms.ParsedBucket>

org.elasticsearch.search.aggregations.bucket.significant.ParsedSignificantTerms

All Implemented Interfaces:

java.lang.Iterable<SignificantTerms.Bucket>, ToXContent, ToXContentFragment, Aggregation, MultiBucketsAggregation, SignificantTerms

Direct Known Subclasses:

ParsedSignificantLongTerms, ParsedSignificantStringTerms

public abstract class ParsedSignificantTerms
extends ParsedMultiBucketAggregation<ParsedSignificantTerms.ParsedBucket>
implements SignificantTerms

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ParsedSignificantTerms.ParsedBucket

Nested classes/interfaces inherited from interface org.elasticsearch.search.aggregations.Aggregation

Aggregation.CommonFields

Nested classes/interfaces inherited from interface org.elasticsearch.search.aggregations.bucket.significant.SignificantTerms

SignificantTerms.Bucket

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

ToXContent.DelegatingMapParams, ToXContent.MapParams, ToXContent.Params

Field Summary

Fields

Modifier and Type	Field	Description
protected long	subsetSize
protected long	supersetSize

Fields inherited from interface org.elasticsearch.search.aggregations.Aggregation

TYPED_KEYS_DELIMITER

Fields inherited from class org.elasticsearch.search.aggregations.ParsedAggregation

metadata

Fields inherited from class org.elasticsearch.search.aggregations.ParsedMultiBucketAggregation

buckets, keyed

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

EMPTY_PARAMS

Constructor Summary

Constructors

Constructor	Description
ParsedSignificantTerms()

Method Summary

Modifier and Type	Method	Description
protected XContentBuilder	doXContentBody(XContentBuilder builder, ToXContent.Params params)
SignificantTerms.Bucket	getBucketByKey(java.lang.String term)	Get the bucket for the given term, or null if there is no such bucket.
java.util.List<? extends SignificantTerms.Bucket>	getBuckets()
protected long	getSubsetSize()
protected long	getSupersetSize()
java.util.Iterator<SignificantTerms.Bucket>	iterator()

Methods inherited from interface org.elasticsearch.search.aggregations.Aggregation

getMetaData, getName, getType

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Methods inherited from class java.lang.Object

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

Methods inherited from class org.elasticsearch.search.aggregations.ParsedAggregation

declareAggregationFields, getMetaData, getName, parseDouble, setName, toXContent

Methods inherited from class org.elasticsearch.search.aggregations.ParsedMultiBucketAggregation

declareMultiBucketAggregationFields

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

toXContent

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

isFragment

Field Detail

subsetSize

protected long subsetSize

supersetSize

protected long supersetSize

Constructor Detail

ParsedSignificantTerms

public ParsedSignificantTerms()

Method Detail

getSubsetSize

protected long getSubsetSize()

getSupersetSize

protected long getSupersetSize()

getBuckets

public java.util.List<? extends SignificantTerms.Bucket> getBuckets()

Specified by:

getBuckets in interface MultiBucketsAggregation

Specified by:

getBuckets in interface SignificantTerms

Returns:

The buckets of this aggregation.

getBucketByKey

public SignificantTerms.Bucket getBucketByKey(java.lang.String term)

Description copied from interface: SignificantTerms

Get the bucket for the given term, or null if there is no such bucket.

Specified by:

getBucketByKey in interface SignificantTerms

iterator

public java.util.Iterator<SignificantTerms.Bucket> iterator()

Specified by:

iterator in interface java.lang.Iterable<SignificantTerms.Bucket>

doXContentBody

protected XContentBuilder doXContentBody(XContentBuilder builder,
                                         ToXContent.Params params)
                                  throws java.io.IOException

Overrides:

doXContentBody in class ParsedMultiBucketAggregation<ParsedSignificantTerms.ParsedBucket>

Throws:

java.io.IOException