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<SignificantStringTerms,SignificantStringTerms.Bucket>

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

All Implemented Interfaces:

Iterable<SignificantTerms.Bucket>, Streamable, ToXContent, Aggregation, MultiBucketsAggregation, SignificantTerms

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

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.CommonFields, InternalAggregation.ReduceContext, InternalAggregation.Type

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

ToXContent.DelegatingMapParams, ToXContent.MapParams, ToXContent.Params

Field Summary

Fields

Modifier and Type	Field and Description
static AggregationStreams.Stream	STREAM
static InternalAggregation.Type	TYPE

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

bucketMap, buckets, minDocCount, requiredSize, significanceHeuristic, subsetSize, supersetSize

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

metaData, name

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

EMPTY_PARAMS

Constructor Summary

Constructors

Constructor and Description
SignificantStringTerms(long subsetSize, long supersetSize, String name, int requiredSize, long minDocCount, SignificanceHeuristic significanceHeuristic, List<? extends InternalSignificantTerms.Bucket> buckets, List<PipelineAggregator> pipelineAggregators, Map<String,Object> metaData)

Method Summary

Methods

Modifier and Type	Method and Description
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.
protected SignificantStringTerms	create(long subsetSize, long supersetSize, List<InternalSignificantTerms.Bucket> buckets, InternalSignificantTerms prototype)
SignificantStringTerms.Bucket	createBucket(InternalAggregations aggregations, SignificantStringTerms.Bucket prototype) Create a new InternalMultiBucketAggregation.InternalBucket using the provided prototype bucket and aggregations.
protected void	doReadFrom(StreamInput in)
protected void	doWriteTo(StreamOutput out)
XContentBuilder	doXContentBody(XContentBuilder builder, ToXContent.Params params)
static void	registerStream()
static void	registerStreams()
InternalAggregation.Type	type()

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

doReduce, getBucketByKey, getBuckets, iterator

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

getProperty

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

getMetaData, getName, getProperty, pipelineAggregators, readFrom, 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, getProperty

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

toXContent

Methods inherited from interface org.elasticsearch.common.io.stream.Streamable

readFrom, writeTo

Field Detail

TYPE

public static final InternalAggregation.Type TYPE

STREAM

public static final AggregationStreams.Stream STREAM

Constructor Detail

SignificantStringTerms

public SignificantStringTerms(long subsetSize,
                      long supersetSize,
                      String name,
                      int requiredSize,
                      long minDocCount,
                      SignificanceHeuristic significanceHeuristic,
                      List<? extends InternalSignificantTerms.Bucket> buckets,
                      List<PipelineAggregator> pipelineAggregators,
                      Map<String,Object> metaData)

Method Detail

registerStream

public static void registerStream()

registerStreams

public static void registerStreams()

type

public InternalAggregation.Type type()

Specified by:

type in class InternalAggregation

Returns:

The InternalAggregation.Type of this aggregation

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<InternalSignificantTerms.Bucket> buckets,
                            InternalSignificantTerms prototype)

Specified by:

create in class InternalSignificantTerms<SignificantStringTerms,SignificantStringTerms.Bucket>

doReadFrom

protected void doReadFrom(StreamInput in)
                   throws IOException

Specified by:

doReadFrom in class InternalAggregation

Throws:

IOException

doWriteTo

protected void doWriteTo(StreamOutput out)
                  throws IOException

Specified by:

doWriteTo in class InternalAggregation

Throws:

IOException

doXContentBody

public XContentBuilder doXContentBody(XContentBuilder builder,
                             ToXContent.Params params)
                               throws IOException

Specified by:

doXContentBody in class InternalAggregation

Throws:

IOException