org.elasticsearch.search.aggregations.bucket.significant

Class SignificantStringTerms

java.lang.Object

org.elasticsearch.search.aggregations.InternalAggregation

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

org.elasticsearch.search.aggregations.bucket.significant.InternalSignificantTerms<A,B>

org.elasticsearch.search.aggregations.bucket.significant.InternalMappedSignificantTerms<SignificantStringTerms,SignificantStringTerms.Bucket>

org.elasticsearch.search.aggregations.bucket.significant.SignificantStringTerms

All Implemented Interfaces:

java.lang.Iterable<SignificantTerms.Bucket>, NamedWriteable, Writeable, ToXContent, Aggregation, MultiBucketsAggregation, SignificantTerms

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

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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SignificantStringTerms.Bucket

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

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

Aggregation.CommonFields

Nested classes/interfaces inherited from interface org.elasticsearch.common.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

Modifier and Type	Field and Description
static java.lang.String	NAME

Fields inherited from class org.elasticsearch.search.aggregations.bucket.significant.InternalMappedSignificantTerms

bucketMap, buckets, format, significanceHeuristic, subsetSize, supersetSize

Fields inherited from class org.elasticsearch.search.aggregations.bucket.significant.InternalSignificantTerms

BG_COUNT, minDocCount, requiredSize, SCORE

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

EMPTY_PARAMS

Constructor Summary

Constructors

Constructor and Description
SignificantStringTerms(StreamInput in) Read from a stream.
SignificantStringTerms(java.lang.String name, int requiredSize, long minDocCount, java.util.List<PipelineAggregator> pipelineAggregators, java.util.Map<java.lang.String,java.lang.Object> metaData, DocValueFormat format, long subsetSize, long supersetSize, SignificanceHeuristic significanceHeuristic, java.util.List<SignificantStringTerms.Bucket> buckets)

Method Summary

Modifier and Type	Method and Description
SignificantStringTerms	create(java.util.List<SignificantStringTerms.Bucket> buckets) Create a new copy of this Aggregation with the same settings as this Aggregation and contains the provided buckets.
protected SignificantStringTerms	create(long subsetSize, long supersetSize, java.util.List<SignificantStringTerms.Bucket> 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.
java.lang.String	getWriteableName() Returns the name of the writeable object

Methods inherited from class org.elasticsearch.search.aggregations.bucket.significant.InternalMappedSignificantTerms

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

Methods inherited from class org.elasticsearch.search.aggregations.bucket.significant.InternalSignificantTerms

doReduce, doWriteTo

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

getProperty

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

getMetaData, getName, getProperty, getType, pipelineAggregators, readSize, reduce, toXContent, writeSize, writeTo

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

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

getMetaData, getName, getType

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

isFragment, toXContent

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Field Detail

NAME

public static final java.lang.String NAME

See Also:

Constant Field Values

Constructor Detail

SignificantStringTerms

public SignificantStringTerms(java.lang.String name,
                              int requiredSize,
                              long minDocCount,
                              java.util.List<PipelineAggregator> pipelineAggregators,
                              java.util.Map<java.lang.String,java.lang.Object> metaData,
                              DocValueFormat format,
                              long subsetSize,
                              long supersetSize,
                              SignificanceHeuristic significanceHeuristic,
                              java.util.List<SignificantStringTerms.Bucket> buckets)

SignificantStringTerms

public SignificantStringTerms(StreamInput in)
                       throws java.io.IOException

Read from a stream.

Throws:

java.io.IOException

Method Detail

getWriteableName

public java.lang.String getWriteableName()

Description copied from interface: NamedWriteable

Returns the name of the writeable object

create

public SignificantStringTerms create(java.util.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,
                                        java.util.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>