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

Class InternalMappedRareTerms<A extends InternalRareTerms<A,B>,B extends InternalRareTerms.Bucket<B>>

java.lang.Object

org.opensearch.search.aggregations.InternalAggregation

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

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

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

All Implemented Interfaces:

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

Direct Known Subclasses:

LongRareTerms, StringRareTerms

public abstract class InternalMappedRareTerms<A extends InternalRareTerms<A,B>,B extends InternalRareTerms.Bucket<B>>
extends InternalRareTerms<A,B>

Implementation of mapped rare terms

Opensearch.internal:

Nested Class Summary

Nested classes/interfaces inherited from class org.opensearch.search.aggregations.bucket.terms.InternalRareTerms

InternalRareTerms.Bucket<B extends InternalRareTerms.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 Map<String,B>	bucketMap
protected List<B>	buckets
protected DocValueFormat	format
protected final org.apache.logging.log4j.Logger	logger

Fields inherited from class org.opensearch.search.aggregations.bucket.terms.InternalRareTerms

maxDocCount, order

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

Method Summary

Modifier and Type	Method	Description
abstract void	addToFilter(SetBackedScalingCuckooFilter filter, B bucket)
abstract boolean	containsTerm(SetBackedScalingCuckooFilter filter, B bucket)
final org.opensearch.common.xcontent.XContentBuilder	doXContentBody(org.opensearch.common.xcontent.XContentBuilder builder, org.opensearch.common.xcontent.ToXContent.Params params)
boolean	equals(Object obj)
B	getBucketByKey(String term)	Get the bucket for the given term, or null if there is no such bucket.
List<B>	getBuckets()	Return the sorted list of the buckets in this terms aggregation.
long	getMaxDocCount()
int	hashCode()
InternalAggregation	reduce(List<InternalAggregation> aggregations, InternalAggregation.ReduceContext reduceContext)	Reduces the given aggregations to a single one and returns it.
protected void	writeTermTypeInfoTo(StreamOutput out)

Methods inherited from class org.opensearch.search.aggregations.bucket.terms.InternalRareTerms

createBucketsArray, createWithFilter, doWriteTo, doXContentCommon, reduceBucket

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

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.common.xcontent.ToXContent

toXContent

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

isFragment

Field Details

format

protected DocValueFormat format

buckets

protected List<B extends InternalRareTerms.Bucket<B>> buckets

bucketMap

protected Map<String,B extends InternalRareTerms.Bucket<B>> bucketMap

logger

protected final org.apache.logging.log4j.Logger logger

Method Details

getMaxDocCount

public long getMaxDocCount()

writeTermTypeInfoTo

protected void writeTermTypeInfoTo(StreamOutput out)
                            throws IOException

Specified by:

writeTermTypeInfoTo in class InternalRareTerms<A extends InternalRareTerms<A,B>,B extends InternalRareTerms.Bucket<B>>

Throws:

IOException

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.

Overrides:

reduce in class InternalRareTerms<A extends InternalRareTerms<A,B>,B extends InternalRareTerms.Bucket<B>>

See Also:

• InternalAggregation.mustReduceOnSingleInternalAgg()

containsTerm

public abstract boolean containsTerm(SetBackedScalingCuckooFilter filter,
 B bucket)

addToFilter

public abstract void addToFilter(SetBackedScalingCuckooFilter filter,
 B bucket)

getBuckets

public List<B> getBuckets()

Description copied from interface: RareTerms

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

Specified by:

getBuckets in interface MultiBucketsAggregation

Specified by:

getBuckets in interface RareTerms

Specified by:

getBuckets in class InternalRareTerms<A extends InternalRareTerms<A,B>,B extends InternalRareTerms.Bucket<B>>

Returns:

The buckets of this aggregation.

getBucketByKey

public B getBucketByKey(String term)

Description copied from interface: RareTerms

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

Specified by:

getBucketByKey in interface RareTerms

Specified by:

getBucketByKey in class InternalRareTerms<A extends InternalRareTerms<A,B>,B extends InternalRareTerms.Bucket<B>>

equals

public boolean equals(Object obj)

Overrides:

equals in class InternalRareTerms<A extends InternalRareTerms<A,B>,B extends InternalRareTerms.Bucket<B>>

hashCode

public int hashCode()

Overrides:

hashCode in class InternalRareTerms<A extends InternalRareTerms<A,B>,B extends InternalRareTerms.Bucket<B>>

doXContentBody

public final org.opensearch.common.xcontent.XContentBuilder doXContentBody(org.opensearch.common.xcontent.XContentBuilder builder,
 org.opensearch.common.xcontent.ToXContent.Params params)
                                                                    throws IOException

Specified by:

doXContentBody in class InternalAggregation

Throws:

IOException