org.elasticsearch.search.aggregations.bucket.significant

Class InternalSignificantTerms<A extends InternalSignificantTerms,B extends InternalSignificantTerms.Bucket>

java.lang.Object

org.elasticsearch.search.aggregations.InternalAggregation

org.elasticsearch.search.aggregations.InternalMultiBucketAggregation<A,B>

org.elasticsearch.search.aggregations.bucket.significant.InternalSignificantTerms<A,B>

All Implemented Interfaces:

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

Direct Known Subclasses:

SignificantLongTerms, SignificantStringTerms, UnmappedSignificantTerms

public abstract class InternalSignificantTerms<A extends InternalSignificantTerms,B extends InternalSignificantTerms.Bucket>
extends InternalMultiBucketAggregation<A,B>
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.InternalMultiBucketAggregation

InternalMultiBucketAggregation.InternalBucket

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 List<? extends 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

metaData, 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, List<? extends InternalSignificantTerms.Bucket> buckets, List<PipelineAggregator> pipelineAggregators, Map<String,Object> metaData)

Method Summary

Methods

Modifier and Type	Method and Description
protected abstract A	create(long subsetSize, long supersetSize, List<InternalSignificantTerms.Bucket> buckets, InternalSignificantTerms prototype)
InternalAggregation	doReduce(List<InternalAggregation> aggregations, InternalAggregation.ReduceContext reduceContext)
SignificantTerms.Bucket	getBucketByKey(String term) Get the bucket for the given term, or null if there is no such bucket.
List<SignificantTerms.Bucket>	getBuckets()
Iterator<SignificantTerms.Bucket>	iterator()

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

create, createBucket, getProperty

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

doReadFrom, doWriteTo, doXContentBody, getMetaData, getName, getProperty, pipelineAggregators, readFrom, readSize, reduce, toXContent, type, writeSize, writeTo

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

getMetaData, getName, getProperty

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 List<? extends 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,
                        List<? extends InternalSignificantTerms.Bucket> buckets,
                        List<PipelineAggregator> pipelineAggregators,
                        Map<String,Object> metaData)

Method Detail

iterator

public Iterator<SignificantTerms.Bucket> iterator()

Specified by:

iterator in interface Iterable<SignificantTerms.Bucket>

getBuckets

public List<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: SignificantTerms

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

Specified by:

getBucketByKey in interface SignificantTerms

doReduce

public InternalAggregation doReduce(List<InternalAggregation> aggregations,
                           InternalAggregation.ReduceContext reduceContext)

Specified by:

doReduce in class InternalAggregation

create

protected abstract A create(long subsetSize,
       long supersetSize,
       List<InternalSignificantTerms.Bucket> buckets,
       InternalSignificantTerms prototype)