org.elasticsearch.search.aggregations.bucket.significant

Class InternalSignificantTerms

java.lang.Object

org.elasticsearch.search.aggregations.InternalAggregation

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

All Implemented Interfaces:

Iterable<SignificantTerms.Bucket>, Streamable, ToXContent, Aggregation, MultiBucketsAggregation, SignificantTerms

Direct Known Subclasses:

SignificantLongTerms, SignificantStringTerms, UnmappedSignificantTerms

public abstract class InternalSignificantTerms
extends InternalAggregation
implements SignificantTerms, ToXContent, Streamable

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	InternalSignificantTerms.Bucket

Nested classes/interfaces inherited from class org.elasticsearch.search.aggregations.InternalAggregation

InternalAggregation.CommonFields, InternalAggregation.ReduceContext, InternalAggregation.Type

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

ToXContent.DelegatingMapParams, ToXContent.MapParams, ToXContent.Params

Field Summary

Fields

Modifier and Type	Field and Description
protected Map<String,InternalSignificantTerms.Bucket>	bucketMap
protected Collection<InternalSignificantTerms.Bucket>	buckets
protected long	minDocCount
protected int	requiredSize
protected SignificanceHeuristic	significanceHeuristic
protected long	subsetSize
protected long	supersetSize

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

name

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

EMPTY_PARAMS

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	InternalSignificantTerms()
protected	InternalSignificantTerms(long subsetSize, long supersetSize, String name, int requiredSize, long minDocCount, SignificanceHeuristic significanceHeuristic, Collection<InternalSignificantTerms.Bucket> buckets)

Method Summary

Modifier and Type	Method and Description
SignificantTerms.Bucket	getBucketByKey(String term) The bucket that is associated with the given key.
Collection<SignificantTerms.Bucket>	getBuckets()
Iterator<SignificantTerms.Bucket>	iterator()
InternalAggregation	reduce(InternalAggregation.ReduceContext reduceContext) Reduces the given addAggregation to a single one and returns it.

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

doXContentBody, getName, readSize, toXContent, type, writeSize

Methods inherited from class java.lang.Object

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

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

getName

Methods inherited from interface java.lang.Iterable

forEach, spliterator

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

toXContent

Methods inherited from interface org.elasticsearch.common.io.stream.Streamable

readFrom, writeTo

Field Detail

significanceHeuristic

protected SignificanceHeuristic significanceHeuristic

requiredSize

protected int requiredSize

minDocCount

protected long minDocCount

buckets

protected Collection<InternalSignificantTerms.Bucket> buckets

bucketMap

protected Map<String,InternalSignificantTerms.Bucket> bucketMap

subsetSize

protected long subsetSize

supersetSize

protected long supersetSize

Constructor Detail

InternalSignificantTerms

protected InternalSignificantTerms()

InternalSignificantTerms

protected InternalSignificantTerms(long subsetSize,
                                   long supersetSize,
                                   String name,
                                   int requiredSize,
                                   long minDocCount,
                                   SignificanceHeuristic significanceHeuristic,
                                   Collection<InternalSignificantTerms.Bucket> buckets)

Method Detail

iterator

public Iterator<SignificantTerms.Bucket> iterator()

Specified by:

iterator in interface Iterable<SignificantTerms.Bucket>

getBuckets

public Collection<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(String term)

Description copied from interface: MultiBucketsAggregation

The bucket that is associated with the given key.

Specified by:

getBucketByKey in interface MultiBucketsAggregation

Specified by:

getBucketByKey in interface SignificantTerms

Parameters:

term - The key of the requested bucket.

Returns:

The bucket

reduce

public InternalAggregation reduce(InternalAggregation.ReduceContext reduceContext)

Description copied from class: InternalAggregation

Reduces the given addAggregation to a single one and returns it. In most cases, the assumption will be the all given addAggregation are of the same type (the same type as this aggregation). For best efficiency, when implementing, try reusing an existing get instance (typically the first in the given list) to save on redundant object construction.

Specified by:

reduce in class InternalAggregation