Package org.elasticsearch.search.aggregations.bucket.terms

Class AbstractInternalTerms<A extends AbstractInternalTerms<A,B>,B extends AbstractInternalTerms.AbstractTermsBucket>

java.lang.Object

org.elasticsearch.search.aggregations.InternalAggregation

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

org.elasticsearch.search.aggregations.bucket.terms.AbstractInternalTerms<A,B>

All Implemented Interfaces:

NamedWriteable, Writeable, Aggregation, MultiBucketsAggregation, ToXContent, ToXContentFragment

Direct Known Subclasses:

InternalTerms

public abstract class AbstractInternalTerms<A extends AbstractInternalTerms<A,B>,B extends AbstractInternalTerms.AbstractTermsBucket>
extends InternalMultiBucketAggregation<A,B>

Base class for terms and multi_terms aggregation that handles common reduce logic

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	AbstractInternalTerms.AbstractTermsBucket

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.ReduceContext, InternalAggregation.ReduceContextBuilder

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

Aggregation.CommonFields

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

MultiBucketsAggregation.Bucket

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

ToXContent.DelegatingMapParams, ToXContent.MapParams, ToXContent.Params

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

Writeable.Reader<V>, Writeable.Writer<V>

Field Summary

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

metadata, name

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

TYPED_KEYS_DELIMITER

Fields inherited from interface org.elasticsearch.xcontent.ToXContent

EMPTY_PARAMS

Constructor Summary

Constructors

Modifier	Constructor	Description
	AbstractInternalTerms(String name, Map<String,Object> metadata)
protected	AbstractInternalTerms(StreamInput in)

Method Summary

Modifier and Type	Method	Description
protected abstract A	create(String name, List<B> buckets, BucketOrder reduceOrder, long docCountError, long otherDocCount)	Creates InternalTerms at the end of the merge
protected abstract B	createBucket(long docCount, InternalAggregations aggs, long docCountError, B prototype)
protected static XContentBuilder	doXContentCommon(XContentBuilder builder, ToXContent.Params params, Long docCountError, long otherDocCount, List<? extends AbstractInternalTerms.AbstractTermsBucket> buckets)
protected abstract Long	getDocCountError()
protected abstract long	getMinDocCount()
protected abstract BucketOrder	getOrder()
protected abstract BucketOrder	getReduceOrder()
protected abstract int	getRequiredSize()
protected abstract int	getShardSize()
protected abstract long	getSumOfOtherDocCounts()
InternalAggregation	reduce(List<InternalAggregation> aggregations, InternalAggregation.ReduceContext reduceContext)	Reduces the given aggregations to a single one and returns it.
B	reduceBucket(List<B> buckets, InternalAggregation.ReduceContext context)	Reduce a list of same-keyed buckets (from multiple shards) to a single bucket.
protected abstract void	setDocCountError(long docCountError)

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

copyWithRewritenBuckets, countInnerBucket, countInnerBucket, create, createBucket, forEachBucket, getBuckets, getProperty, mustReduceOnSingleInternalAgg, reducePipelines

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

doWriteTo, doXContentBody, equals, getMetadata, getName, getProperty, getType, hashCode, isMapped, mergePipelineTreeForBWCSerialization, pipelineAggregatorsForBwcSerialization, readSize, sortValue, sortValue, toString, toXContent, writeSize, writeTo

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

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

getMetadata, getName, getType

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

getWriteableName

Methods inherited from interface org.elasticsearch.xcontent.ToXContent

toXContent

Methods inherited from interface org.elasticsearch.xcontent.ToXContentFragment

isFragment

Constructor Details

AbstractInternalTerms

public AbstractInternalTerms(String name,
 Map<String,Object> metadata)

AbstractInternalTerms

protected AbstractInternalTerms(StreamInput in)
                         throws IOException

Throws:

IOException

Method Details

create

protected abstract A create(String name,
 List<B> buckets,
 BucketOrder reduceOrder,
 long docCountError,
 long otherDocCount)

Creates InternalTerms at the end of the merge

getShardSize

protected abstract int getShardSize()

getReduceOrder

protected abstract BucketOrder getReduceOrder()

getOrder

protected abstract BucketOrder getOrder()

getSumOfOtherDocCounts

protected abstract long getSumOfOtherDocCounts()

getDocCountError

protected abstract Long getDocCountError()

setDocCountError

protected abstract void setDocCountError(long docCountError)

getMinDocCount

protected abstract long getMinDocCount()

getRequiredSize

protected abstract int getRequiredSize()

createBucket

protected abstract B createBucket(long docCount,
 InternalAggregations aggs,
 long docCountError,
 B prototype)

reduceBucket

public B reduceBucket(List<B> buckets,
 InternalAggregation.ReduceContext context)

Description copied from class: InternalMultiBucketAggregation

Reduce a list of same-keyed buckets (from multiple shards) to a single bucket. This requires all buckets to have the same key.

Specified by:

reduceBucket in class InternalMultiBucketAggregation<A extends AbstractInternalTerms<A,B>,B extends AbstractInternalTerms.AbstractTermsBucket>

reduce

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

Description copied from class: InternalAggregation

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

Specified by:

reduce in class InternalAggregation

See Also:

• InternalAggregation.mustReduceOnSingleInternalAgg()

doXContentCommon

protected static XContentBuilder doXContentCommon(XContentBuilder builder,
 ToXContent.Params params,
 Long docCountError,
 long otherDocCount,
 List<? extends AbstractInternalTerms.AbstractTermsBucket> buckets)
                                           throws IOException

Throws:

IOException