Class UnmappedTerms
java.lang.Object
org.elasticsearch.search.aggregations.InternalAggregation
org.elasticsearch.search.aggregations.InternalMultiBucketAggregation<A,B>
org.elasticsearch.search.aggregations.bucket.terms.InternalTerms<UnmappedTerms,UnmappedTerms.Bucket>
org.elasticsearch.search.aggregations.bucket.terms.UnmappedTerms
- All Implemented Interfaces:
NamedWriteable
,Writeable
,ToXContent
,ToXContentFragment
,Aggregation
,MultiBucketsAggregation
,Terms
public class UnmappedTerms extends InternalTerms<UnmappedTerms,UnmappedTerms.Bucket>
Result of the
TermsAggregator
when the field is unmapped.-
Nested Class Summary
Nested Classes Modifier and Type Class Description protected static class
UnmappedTerms.Bucket
Concrete type that can't be built because Java needs a concrete type soInternalTerms.Bucket
can have a self type but UnmappedTerms doesn't ever need to build it because it never returns any buckets.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 Description static java.lang.String
NAME
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 UnmappedTerms(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)
UnmappedTerms(StreamInput in)
Read from a stream. -
Method Summary
Modifier and Type Method Description protected UnmappedTerms
create(java.lang.String name, java.util.List<UnmappedTerms.Bucket> buckets, long docCountError, long otherDocCount)
UnmappedTerms
create(java.util.List<UnmappedTerms.Bucket> buckets)
Create a new copy of thisAggregation
with the same settings as thisAggregation
and contains the provided buckets.UnmappedTerms.Bucket
createBucket(InternalAggregations aggregations, UnmappedTerms.Bucket prototype)
Create a newInternalMultiBucketAggregation.InternalBucket
using the provided prototype bucket and aggregations.protected UnmappedTerms.Bucket[]
createBucketsArray(int size)
Create an array to hold some buckets.XContentBuilder
doXContentBody(XContentBuilder builder, ToXContent.Params params)
UnmappedTerms.Bucket
getBucketByKey(java.lang.String term)
Get the bucket for the given term, or null if there is no such bucket.java.util.List<UnmappedTerms.Bucket>
getBuckets()
Return the sorted list of the buckets in this terms aggregation.long
getDocCountError()
Get an upper bound of the error on document counts in this aggregation.protected int
getShardSize()
long
getSumOfOtherDocCounts()
Return the sum of the document counts of all buckets that did not make it to the top buckets.java.lang.String
getType()
java.lang.String
getWriteableName()
Returns the name of the writeable objectboolean
isMapped()
Return true if this aggregation is mapped, and can lead a reduction.InternalAggregation
reduce(java.util.List<InternalAggregation> aggregations, InternalAggregation.ReduceContext reduceContext)
Reduces the given aggregations to a single one and returns it.protected void
setDocCountError(long docCountError)
protected void
writeTermTypeInfoTo(StreamOutput out)
Methods inherited from class org.elasticsearch.search.aggregations.bucket.terms.InternalTerms
doWriteTo, doXContentCommon, equals, hashCode, reduceBucket
Methods inherited from class org.elasticsearch.search.aggregations.InternalMultiBucketAggregation
countInnerBucket, countInnerBucket, getProperty, reducePipelines
Methods inherited from class org.elasticsearch.search.aggregations.InternalAggregation
getMetaData, getName, getProperty, pipelineAggregators, readSize, 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
-
Field Details
-
NAME
public static final java.lang.String NAME- See Also:
- Constant Field Values
-
-
Constructor Details
-
UnmappedTerms
public UnmappedTerms(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) -
UnmappedTerms
Read from a stream.- Throws:
java.io.IOException
-
-
Method Details
-
writeTermTypeInfoTo
- Specified by:
writeTermTypeInfoTo
in classInternalTerms<UnmappedTerms,UnmappedTerms.Bucket>
- Throws:
java.io.IOException
-
getWriteableName
public java.lang.String getWriteableName()Description copied from interface:NamedWriteable
Returns the name of the writeable object -
getType
public java.lang.String getType()- Specified by:
getType
in interfaceAggregation
- Overrides:
getType
in classInternalAggregation
- Returns:
- a string representing the type of the aggregation. This type is added to the aggregation name in the response, so that it can later be used by clients to determine type of the aggregation and parse it into the proper 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<UnmappedTerms,UnmappedTerms.Bucket>
- Parameters:
buckets
- the buckets to use in the newAggregation
- Returns:
- the new
Aggregation
-
createBucket
public UnmappedTerms.Bucket createBucket(InternalAggregations aggregations, UnmappedTerms.Bucket prototype)Description copied from class:InternalMultiBucketAggregation
Create a newInternalMultiBucketAggregation.InternalBucket
using the provided prototype bucket and aggregations.- Specified by:
createBucket
in classInternalMultiBucketAggregation<UnmappedTerms,UnmappedTerms.Bucket>
- Parameters:
aggregations
- the aggregations for the new bucketprototype
- the bucket to use as a prototype- Returns:
- the new bucket
-
create
protected UnmappedTerms create(java.lang.String name, java.util.List<UnmappedTerms.Bucket> buckets, long docCountError, long otherDocCount)- Specified by:
create
in classInternalTerms<UnmappedTerms,UnmappedTerms.Bucket>
-
reduce
public InternalAggregation reduce(java.util.List<InternalAggregation> aggregations, InternalAggregation.ReduceContext reduceContext)Description copied from class:InternalAggregation
Reduces the given aggregations to a single one and returns it. In most cases, the assumption will be the all given aggregations are of the same type (the same type as this aggregation). For best efficiency, when implementing, try reusing an existing instance (typically the first in the given list) to save on redundant object construction.- Overrides:
reduce
in classInternalTerms<UnmappedTerms,UnmappedTerms.Bucket>
-
isMapped
public boolean isMapped()Description copied from class:InternalAggregation
Return true if this aggregation is mapped, and can lead a reduction. If this agg returns false, it should return itself if asked to lead a reduction- Overrides:
isMapped
in classInternalAggregation
-
doXContentBody
public final XContentBuilder doXContentBody(XContentBuilder builder, ToXContent.Params params) throws java.io.IOException- Specified by:
doXContentBody
in classInternalAggregation
- Throws:
java.io.IOException
-
setDocCountError
protected void setDocCountError(long docCountError)- Specified by:
setDocCountError
in classInternalTerms<UnmappedTerms,UnmappedTerms.Bucket>
-
getShardSize
protected int getShardSize()- Specified by:
getShardSize
in classInternalTerms<UnmappedTerms,UnmappedTerms.Bucket>
-
getDocCountError
public long getDocCountError()Description copied from interface:Terms
Get an upper bound of the error on document counts in this aggregation. -
getSumOfOtherDocCounts
public long getSumOfOtherDocCounts()Description copied from interface:Terms
Return the sum of the document counts of all buckets that did not make it to the top buckets. -
getBuckets
Description copied from interface:Terms
Return the sorted list of the buckets in this terms aggregation.- Specified by:
getBuckets
in interfaceMultiBucketsAggregation
- Specified by:
getBuckets
in interfaceTerms
- Specified by:
getBuckets
in classInternalTerms<UnmappedTerms,UnmappedTerms.Bucket>
- Returns:
- The buckets of this aggregation.
-
getBucketByKey
Description copied from interface:Terms
Get the bucket for the given term, or null if there is no such bucket.- Specified by:
getBucketByKey
in interfaceTerms
- Specified by:
getBucketByKey
in classInternalTerms<UnmappedTerms,UnmappedTerms.Bucket>
-
createBucketsArray
Description copied from class:InternalTerms
Create an array to hold some buckets. Used in collecting the results.- Specified by:
createBucketsArray
in classInternalTerms<UnmappedTerms,UnmappedTerms.Bucket>
-