org.elasticsearch.search.aggregations.bucket.terms

Class StringTerms

java.lang.Object

org.elasticsearch.search.aggregations.InternalAggregation

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

org.elasticsearch.search.aggregations.bucket.terms.InternalTerms<A,B>

org.elasticsearch.search.aggregations.bucket.terms.InternalMappedTerms<StringTerms,StringTerms.Bucket>

org.elasticsearch.search.aggregations.bucket.terms.StringTerms

All Implemented Interfaces:

NamedWriteable, Writeable, ToXContent, ToXContentFragment, Aggregation, MultiBucketsAggregation, Terms

public class StringTerms
extends InternalMappedTerms<StringTerms,StringTerms.Bucket>

Result of the TermsAggregator when the field is a String.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	StringTerms.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.terms.InternalMappedTerms

bucketMap, buckets, docCountError, format, otherDocCount, shardSize, showTermDocCountError

Fields inherited from class org.elasticsearch.search.aggregations.bucket.terms.InternalTerms

DOC_COUNT_ERROR_UPPER_BOUND_FIELD_NAME, minDocCount, order, requiredSize, SUM_OF_OTHER_DOC_COUNTS

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
StringTerms(StreamInput in) Read from a stream.
StringTerms(java.lang.String name, BucketOrder order, int requiredSize, long minDocCount, java.util.List<PipelineAggregator> pipelineAggregators, java.util.Map<java.lang.String,java.lang.Object> metaData, DocValueFormat format, int shardSize, boolean showTermDocCountError, long otherDocCount, java.util.List<StringTerms.Bucket> buckets, long docCountError)

Method Summary

Modifier and Type	Method and Description
StringTerms	create(java.util.List<StringTerms.Bucket> buckets) Create a new copy of this Aggregation with the same settings as this Aggregation and contains the provided buckets.
protected StringTerms	create(java.lang.String name, java.util.List<StringTerms.Bucket> buckets, long docCountError, long otherDocCount)
StringTerms.Bucket	createBucket(InternalAggregations aggregations, StringTerms.Bucket prototype) Create a new InternalMultiBucketAggregation.InternalBucket using the provided prototype bucket and aggregations.
protected StringTerms.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.terms.InternalMappedTerms

doEquals, doHashCode, doXContentBody, getBucketByKey, getBuckets, getDocCountError, getShardSize, getSumOfOtherDocCounts, setDocCountError, writeTermTypeInfoTo

Methods inherited from class org.elasticsearch.search.aggregations.bucket.terms.InternalTerms

doReduce, doWriteTo, doXContentCommon

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

getProperty

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

equals, getMetaData, getName, getProperty, getType, hashCode, pipelineAggregators, readSize, reduce, toString, toXContent, writeSize, writeTo

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

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

getMetaData, getName, getType

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

isFragment

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

toXContent

Field Detail

NAME

public static final java.lang.String NAME

See Also:

Constant Field Values

Constructor Detail

StringTerms

public StringTerms(java.lang.String name,
                   BucketOrder order,
                   int requiredSize,
                   long minDocCount,
                   java.util.List<PipelineAggregator> pipelineAggregators,
                   java.util.Map<java.lang.String,java.lang.Object> metaData,
                   DocValueFormat format,
                   int shardSize,
                   boolean showTermDocCountError,
                   long otherDocCount,
                   java.util.List<StringTerms.Bucket> buckets,
                   long docCountError)

StringTerms

public StringTerms(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 StringTerms create(java.util.List<StringTerms.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<StringTerms,StringTerms.Bucket>

Parameters:

buckets - the buckets to use in the new Aggregation

Returns:

the new Aggregation

createBucket

public StringTerms.Bucket createBucket(InternalAggregations aggregations,
                                       StringTerms.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<StringTerms,StringTerms.Bucket>

Parameters:

aggregations - the aggregations for the new bucket

prototype - the bucket to use as a prototype

Returns:

the new bucket

create

protected StringTerms create(java.lang.String name,
                             java.util.List<StringTerms.Bucket> buckets,
                             long docCountError,
                             long otherDocCount)

Specified by:

create in class InternalTerms<StringTerms,StringTerms.Bucket>

createBucketsArray

protected StringTerms.Bucket[] createBucketsArray(int size)

Description copied from class: InternalTerms

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

Specified by:

createBucketsArray in class InternalTerms<StringTerms,StringTerms.Bucket>