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 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, InternalAggregation.ReduceContextBuilder
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 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
-
Constructor Summary
Constructors Constructor Description 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(StreamInput in)
Read from a stream. -
Method Summary
Modifier and Type Method Description protected StringTerms
create(java.lang.String name, java.util.List<StringTerms.Bucket> buckets, long docCountError, long otherDocCount)
StringTerms
create(java.util.List<StringTerms.Bucket> buckets)
Create a new copy of thisAggregation
with the same settings as thisAggregation
and contains the provided buckets.StringTerms.Bucket
createBucket(InternalAggregations aggregations, StringTerms.Bucket prototype)
Create a newInternalMultiBucketAggregation.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 objectMethods inherited from class org.elasticsearch.search.aggregations.bucket.terms.InternalMappedTerms
doXContentBody, equals, getBucketByKey, getBuckets, getDocCountError, getShardSize, getSumOfOtherDocCounts, hashCode, setDocCountError, writeTermTypeInfoTo
Methods inherited from class org.elasticsearch.search.aggregations.bucket.terms.InternalTerms
doWriteTo, doXContentCommon, reduce, reduceBucket
Methods inherited from class org.elasticsearch.search.aggregations.InternalMultiBucketAggregation
copyWithRewritenBuckets, countInnerBucket, countInnerBucket, getProperty, reducePipelines
Methods inherited from class org.elasticsearch.search.aggregations.InternalAggregation
getMetaData, getName, getProperty, getType, isMapped, pipelineAggregators, 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.elasticsearch.search.aggregations.Aggregation
getMetaData, getName, getType
-
Field Details
-
NAME
public static final java.lang.String NAME- See Also:
- Constant Field Values
-
-
Constructor Details
-
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
Read from a stream.- Throws:
java.io.IOException
-
-
Method Details
-
getWriteableName
public java.lang.String getWriteableName()Description copied from interface:NamedWriteable
Returns the name of the writeable object -
create
Description copied from class:InternalMultiBucketAggregation
Create a new copy of thisAggregation
with the same settings as thisAggregation
and contains the provided buckets.- Specified by:
create
in classInternalMultiBucketAggregation<StringTerms,StringTerms.Bucket>
- Parameters:
buckets
- the buckets to use in the newAggregation
- Returns:
- the new
Aggregation
-
createBucket
public StringTerms.Bucket createBucket(InternalAggregations aggregations, StringTerms.Bucket prototype)Description copied from class:InternalMultiBucketAggregation
Create a newInternalMultiBucketAggregation.InternalBucket
using the provided prototype bucket and aggregations.- Specified by:
createBucket
in classInternalMultiBucketAggregation<StringTerms,StringTerms.Bucket>
- Parameters:
aggregations
- the aggregations for the new bucketprototype
- 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 classInternalTerms<StringTerms,StringTerms.Bucket>
-
createBucketsArray
Description copied from class:InternalTerms
Create an array to hold some buckets. Used in collecting the results.- Specified by:
createBucketsArray
in classInternalTerms<StringTerms,StringTerms.Bucket>
-