Package org.opensearch.search.aggregations.bucket.terms

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

java.lang.Object

org.opensearch.search.aggregations.InternalAggregation

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

org.opensearch.search.aggregations.bucket.terms.InternalTerms<A,B>

All Implemented Interfaces:

NamedWriteable, Writeable, org.opensearch.common.xcontent.ToXContent, org.opensearch.common.xcontent.ToXContentFragment, Aggregation, MultiBucketsAggregation, Terms

Direct Known Subclasses:

InternalMappedTerms, UnmappedTerms

public abstract class InternalTerms<A extends InternalTerms<A,B>,B extends InternalTerms.Bucket<B>>
extends InternalMultiBucketAggregation<A,B>
implements Terms

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	InternalTerms.Bucket<B extends InternalTerms.Bucket<B>>

Nested classes/interfaces inherited from class org.opensearch.search.aggregations.InternalMultiBucketAggregation

InternalMultiBucketAggregation.InternalBucket

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

InternalAggregation.ReduceContext, InternalAggregation.ReduceContextBuilder

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

Aggregation.CommonFields

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

org.opensearch.common.xcontent.ToXContent.DelegatingMapParams, org.opensearch.common.xcontent.ToXContent.MapParams, org.opensearch.common.xcontent.ToXContent.Params

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

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

Field Summary

Fields

Modifier and Type	Field	Description
protected static org.opensearch.common.ParseField	DOC_COUNT_ERROR_UPPER_BOUND_FIELD_NAME
protected long	minDocCount
protected BucketOrder	order
protected BucketOrder	reduceOrder
protected int	requiredSize
protected static org.opensearch.common.ParseField	SUM_OF_OTHER_DOC_COUNTS

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

metadata, name

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

TYPED_KEYS_DELIMITER

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

EMPTY_PARAMS

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	InternalTerms(java.lang.String name, BucketOrder reduceOrder, BucketOrder order, int requiredSize, long minDocCount, java.util.Map<java.lang.String,java.lang.Object> metadata)	Creates a new InternalTerms
protected	InternalTerms(StreamInput in)	Read from a stream.

Method Summary

Modifier and Type	Method	Description
protected abstract A	create(java.lang.String name, java.util.List<B> buckets, BucketOrder reduceOrder, long docCountError, long otherDocCount)
protected abstract B[]	createBucketsArray(int size)	Create an array to hold some buckets.
protected void	doWriteTo(StreamOutput out)
protected static org.opensearch.common.xcontent.XContentBuilder	doXContentCommon(org.opensearch.common.xcontent.XContentBuilder builder, org.opensearch.common.xcontent.ToXContent.Params params, long docCountError, long otherDocCount, java.util.List<? extends InternalTerms.Bucket> buckets)
boolean	equals(java.lang.Object obj)
abstract B	getBucketByKey(java.lang.String term)	Get the bucket for the given term, or null if there is no such bucket.
abstract java.util.List<B>	getBuckets()	Return the sorted list of the buckets in this terms aggregation.
protected abstract int	getShardSize()
int	hashCode()
InternalAggregation	reduce(java.util.List<InternalAggregation> aggregations, InternalAggregation.ReduceContext reduceContext)	Reduces the given aggregations to a single one and returns it.
protected B	reduceBucket(java.util.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)
protected abstract void	writeTermTypeInfoTo(StreamOutput out)

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

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

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

doXContentBody, getMetadata, getName, getProperty, getType, 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.opensearch.search.aggregations.Aggregation

getMetadata, getName, getType

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

getWriteableName

Methods inherited from interface org.opensearch.search.aggregations.bucket.terms.Terms

getDocCountError, getSumOfOtherDocCounts

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

toXContent

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

isFragment

Field Details

DOC_COUNT_ERROR_UPPER_BOUND_FIELD_NAME

protected static final org.opensearch.common.ParseField DOC_COUNT_ERROR_UPPER_BOUND_FIELD_NAME

SUM_OF_OTHER_DOC_COUNTS

protected static final org.opensearch.common.ParseField SUM_OF_OTHER_DOC_COUNTS

reduceOrder

protected final BucketOrder reduceOrder

order

protected final BucketOrder order

requiredSize

protected final int requiredSize

minDocCount

protected final long minDocCount

Constructor Details

InternalTerms

protected InternalTerms(java.lang.String name, BucketOrder reduceOrder, BucketOrder order, int requiredSize, long minDocCount, java.util.Map<java.lang.String,java.lang.Object> metadata)

Creates a new InternalTerms

Parameters:

name - The name of the aggregation

reduceOrder - The BucketOrder that should be used to merge shard results.

order - The BucketOrder that should be used to sort the final reduce.

requiredSize - The number of top buckets.

minDocCount - The minimum number of documents allowed per bucket.

metadata - The metadata associated with the aggregation.

InternalTerms

protected InternalTerms(StreamInput in) throws java.io.IOException

Read from a stream.

Throws:

java.io.IOException

Method Details

doWriteTo

protected final void doWriteTo(StreamOutput out) throws java.io.IOException

Specified by:

doWriteTo in class InternalAggregation

Throws:

java.io.IOException

writeTermTypeInfoTo

protected abstract void writeTermTypeInfoTo(StreamOutput out) throws java.io.IOException

Throws:

java.io.IOException

getBuckets

public abstract java.util.List<B> getBuckets()

Description copied from interface: Terms

Return the sorted list of the buckets in this terms aggregation.

Specified by:

getBuckets in interface MultiBucketsAggregation

Specified by:

getBuckets in interface Terms

Specified by:

getBuckets in class InternalMultiBucketAggregation<A extends InternalTerms<A,B>,B extends InternalTerms.Bucket<B>>

Returns:

The buckets of this aggregation.

getBucketByKey

public abstract B getBucketByKey(java.lang.String term)

Description copied from interface: Terms

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

Specified by:

getBucketByKey in interface Terms

reduce

public InternalAggregation reduce(java.util.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()

reduceBucket

protected B reduceBucket(java.util.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 InternalTerms<A,B>,B extends InternalTerms.Bucket<B>>

setDocCountError

protected abstract void setDocCountError(long docCountError)

getShardSize

protected abstract int getShardSize()

create

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

createBucketsArray

protected abstract B[] createBucketsArray(int size)

Create an array to hold some buckets. Used in collecting the results.

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class InternalAggregation

hashCode

public int hashCode()

Overrides:

hashCode in class InternalAggregation

doXContentCommon

protected static org.opensearch.common.xcontent.XContentBuilder doXContentCommon(org.opensearch.common.xcontent.XContentBuilder builder, org.opensearch.common.xcontent.ToXContent.Params params, long docCountError, long otherDocCount, java.util.List<? extends InternalTerms.Bucket> buckets) throws java.io.IOException

Throws:

java.io.IOException