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

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

java.lang.Object

org.opensearch.search.aggregations.InternalAggregation

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

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

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

All Implemented Interfaces:

Iterable<SignificantTerms.Bucket>, NamedWriteable, Writeable, org.opensearch.common.xcontent.ToXContent, org.opensearch.common.xcontent.ToXContentFragment, Aggregation, MultiBucketsAggregation, SignificantTerms

Direct Known Subclasses:

SignificantLongTerms, SignificantStringTerms

public abstract class InternalMappedSignificantTerms<A extends InternalMappedSignificantTerms<A,B>,B extends InternalSignificantTerms.Bucket<B>>
extends InternalSignificantTerms<A,B>

Implementation of mapped significant terms

Opensearch.internal:

Nested Class Summary

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

InternalSignificantTerms.Bucket<B extends InternalSignificantTerms.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 final List<B>	buckets
protected final DocValueFormat	format
protected final SignificanceHeuristic	significanceHeuristic
protected final long	subsetSize
protected final long	supersetSize

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

BG_COUNT, minDocCount, requiredSize, SCORE

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	InternalMappedSignificantTerms(String name, int requiredSize, long minDocCount, Map<String,Object> metadata, DocValueFormat format, long subsetSize, long supersetSize, SignificanceHeuristic significanceHeuristic, List<B> buckets)
protected	InternalMappedSignificantTerms(StreamInput in, InternalSignificantTerms.Bucket.Reader<B> bucketReader)

Method Summary

Modifier and Type	Method	Description
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()
protected SignificanceHeuristic	getSignificanceHeuristic()
protected long	getSubsetSize()
protected long	getSupersetSize()
int	hashCode()
Iterator<SignificantTerms.Bucket>	iterator()
protected final void	writeTermTypeInfoTo(StreamOutput out)

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

create, createBucketsArray, doWriteTo, reduce, 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 java.lang.Iterable

forEach, spliterator

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 final DocValueFormat format

subsetSize

protected final long subsetSize

supersetSize

protected final long supersetSize

significanceHeuristic

protected final SignificanceHeuristic significanceHeuristic

buckets

protected final List<B extends InternalSignificantTerms.Bucket<B>> buckets

bucketMap

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

Constructor Details

InternalMappedSignificantTerms

protected InternalMappedSignificantTerms(String name,
 int requiredSize,
 long minDocCount,
 Map<String,Object> metadata,
 DocValueFormat format,
 long subsetSize,
 long supersetSize,
 SignificanceHeuristic significanceHeuristic,
 List<B> buckets)

InternalMappedSignificantTerms

protected InternalMappedSignificantTerms(StreamInput in,
 InternalSignificantTerms.Bucket.Reader<B> bucketReader)
                                  throws IOException

Throws:

IOException

Method Details

writeTermTypeInfoTo

protected final void writeTermTypeInfoTo(StreamOutput out)
                                  throws IOException

Specified by:

writeTermTypeInfoTo in class InternalSignificantTerms<A extends InternalMappedSignificantTerms<A,B>,B extends InternalSignificantTerms.Bucket<B>>

Throws:

IOException

iterator

public Iterator<SignificantTerms.Bucket> iterator()

getBuckets

public List<B> getBuckets()

Specified by:

getBuckets in interface MultiBucketsAggregation

Specified by:

getBuckets in interface SignificantTerms

Specified by:

getBuckets in class InternalSignificantTerms<A extends InternalMappedSignificantTerms<A,B>,B extends InternalSignificantTerms.Bucket<B>>

Returns:

The buckets of this aggregation.

getBucketByKey

public B getBucketByKey(String term)

Description copied from interface: SignificantTerms

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

getSubsetSize

protected long getSubsetSize()

Specified by:

getSubsetSize in class InternalSignificantTerms<A extends InternalMappedSignificantTerms<A,B>,B extends InternalSignificantTerms.Bucket<B>>

getSupersetSize

protected long getSupersetSize()

Specified by:

getSupersetSize in class InternalSignificantTerms<A extends InternalMappedSignificantTerms<A,B>,B extends InternalSignificantTerms.Bucket<B>>

getSignificanceHeuristic

protected SignificanceHeuristic getSignificanceHeuristic()

Specified by:

getSignificanceHeuristic in class InternalSignificantTerms<A extends InternalMappedSignificantTerms<A,B>,B extends InternalSignificantTerms.Bucket<B>>

equals

public boolean equals(Object obj)

Overrides:

equals in class InternalSignificantTerms<A extends InternalMappedSignificantTerms<A,B>,B extends InternalSignificantTerms.Bucket<B>>

hashCode

public int hashCode()

Overrides:

hashCode in class InternalSignificantTerms<A extends InternalMappedSignificantTerms<A,B>,B extends InternalSignificantTerms.Bucket<B>>

doXContentBody

public 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