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

Class SignificantStringTerms

java.lang.Object

org.opensearch.search.aggregations.InternalAggregation

org.opensearch.search.aggregations.InternalMultiBucketAggregation<SignificantStringTerms,SignificantStringTerms.Bucket>

org.opensearch.search.aggregations.bucket.terms.InternalSignificantTerms<SignificantStringTerms,SignificantStringTerms.Bucket>

org.opensearch.search.aggregations.bucket.terms.InternalMappedSignificantTerms<SignificantStringTerms,SignificantStringTerms.Bucket>

org.opensearch.search.aggregations.bucket.terms.SignificantStringTerms

All Implemented Interfaces:

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

public class SignificantStringTerms
extends InternalMappedSignificantTerms<SignificantStringTerms,SignificantStringTerms.Bucket>

Result of the running the significant terms aggregation on a String field.

Opensearch.internal:

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	SignificantStringTerms.Bucket	Bucket for significant string values

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

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

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

org.opensearch.core.common.io.stream.Writeable.Reader<V>, org.opensearch.core.common.io.stream.Writeable.WriteableRegistry, org.opensearch.core.common.io.stream.Writeable.Writer<V>

Field Summary

Fields

Modifier and Type	Field	Description
static final String	NAME

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

bucketMap, buckets, format, significanceHeuristic, subsetSize, supersetSize

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

BG_COUNT, bucketCountThresholds, 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.core.xcontent.ToXContent

EMPTY_PARAMS

Constructor Summary

Constructors

Constructor	Description
SignificantStringTerms(String name, Map<String,Object> metadata, DocValueFormat format, long subsetSize, long supersetSize, SignificanceHeuristic significanceHeuristic, List<SignificantStringTerms.Bucket> buckets, TermsAggregator.BucketCountThresholds bucketCountThresholds)
SignificantStringTerms(org.opensearch.core.common.io.stream.StreamInput in)	Read from a stream.

Method Summary

Modifier and Type	Method	Description
protected SignificantStringTerms	create(long subsetSize, long supersetSize, List<SignificantStringTerms.Bucket> buckets)
SignificantStringTerms	create(List<SignificantStringTerms.Bucket> buckets)	Create a new copy of this Aggregation with the same settings as this Aggregation and contains the provided buckets.
SignificantStringTerms.Bucket	createBucket(InternalAggregations aggregations, SignificantStringTerms.Bucket prototype)	Create a new InternalMultiBucketAggregation.InternalBucket using the provided prototype bucket and aggregations.
protected SignificantStringTerms.Bucket[]	createBucketsArray(int size)	Create an array to hold some buckets.
String	getWriteableName()

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

doXContentBody, equals, getBucketByKey, getBuckets, getSignificanceHeuristic, getSubsetSize, getSupersetSize, hashCode, iterator, writeTermTypeInfoTo

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

doWriteTo, reduce, reduceBucket

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

copyWithRewritenBuckets, countInnerBucket, countInnerBucket, 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.core.xcontent.ToXContent

toXContent

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

isFragment

Field Details

NAME

public static final String NAME

See Also:

• Constant Field Values

Constructor Details

SignificantStringTerms

public SignificantStringTerms(String name,
 Map<String,Object> metadata,
 DocValueFormat format,
 long subsetSize,
 long supersetSize,
 SignificanceHeuristic significanceHeuristic,
 List<SignificantStringTerms.Bucket> buckets,
 TermsAggregator.BucketCountThresholds bucketCountThresholds)

SignificantStringTerms

public SignificantStringTerms(org.opensearch.core.common.io.stream.StreamInput in)
                       throws IOException

Read from a stream.

Throws:

IOException

Method Details

getWriteableName

public String getWriteableName()

create

public SignificantStringTerms create(List<SignificantStringTerms.Bucket> buckets)

Description copied from class: InternalMultiBucketAggregation

Create a new copy of this Aggregation with the same settings as this Aggregation and contains the provided buckets.

Specified by:

create in class InternalMultiBucketAggregation<SignificantStringTerms,SignificantStringTerms.Bucket>

Parameters:

buckets - the buckets to use in the new Aggregation

Returns:

the new Aggregation

createBucket

public SignificantStringTerms.Bucket createBucket(InternalAggregations aggregations,
 SignificantStringTerms.Bucket prototype)

Description copied from class: InternalMultiBucketAggregation

Create a new InternalMultiBucketAggregation.InternalBucket using the provided prototype bucket and aggregations.

Specified by:

createBucket in class InternalMultiBucketAggregation<SignificantStringTerms,SignificantStringTerms.Bucket>

Parameters:

aggregations - the aggregations for the new bucket

prototype - the bucket to use as a prototype

Returns:

the new bucket

create

protected SignificantStringTerms create(long subsetSize,
 long supersetSize,
 List<SignificantStringTerms.Bucket> buckets)

Specified by:

create in class InternalSignificantTerms<SignificantStringTerms,SignificantStringTerms.Bucket>

createBucketsArray

protected SignificantStringTerms.Bucket[] createBucketsArray(int size)

Description copied from class: InternalSignificantTerms

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

Specified by:

createBucketsArray in class InternalSignificantTerms<SignificantStringTerms,SignificantStringTerms.Bucket>