Class UnmappedRareTerms
java.lang.Object
org.elasticsearch.search.aggregations.InternalAggregation
org.elasticsearch.search.aggregations.InternalMultiBucketAggregation<A,B>
org.elasticsearch.search.aggregations.bucket.terms.InternalRareTerms<UnmappedRareTerms,UnmappedRareTerms.Bucket>
org.elasticsearch.search.aggregations.bucket.terms.UnmappedRareTerms
- All Implemented Interfaces:
NamedWriteable
,Writeable
,Aggregation
,MultiBucketsAggregation
,RareTerms
,ToXContent
,ToXContentFragment
public class UnmappedRareTerms
extends InternalRareTerms<UnmappedRareTerms,UnmappedRareTerms.Bucket>
Result of the RareTerms aggregation when the field is unmapped.
-
Nested Class Summary
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.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 inherited from class org.elasticsearch.search.aggregations.bucket.terms.InternalRareTerms
maxDocCount, order
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.xcontent.ToXContent
EMPTY_PARAMS
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptioncreate
(List<UnmappedRareTerms.Bucket> buckets) Create a new copy of thisAggregation
with the same settings as thisAggregation
and contains the provided buckets.createBucket
(InternalAggregations aggregations, UnmappedRareTerms.Bucket prototype) Create a newInternalMultiBucketAggregation.InternalBucket
using the provided prototype bucket and aggregations.protected UnmappedRareTerms.Bucket[]
createBucketsArray
(int size) Create an array to hold some buckets.protected UnmappedRareTerms
createWithFilter
(String name, List<UnmappedRareTerms.Bucket> buckets, SetBackedScalingCuckooFilter filter) final XContentBuilder
doXContentBody
(XContentBuilder builder, ToXContent.Params params) getBucketByKey
(String term) Get the bucket for the given term, or null if there is no such bucket.Return the sorted list of the buckets in this terms aggregation.getType()
Returns the name of the writeable objectboolean
isMapped()
Return true if this aggregation is mapped, and can lead a reduction.reduce
(List<InternalAggregation> aggregations, InternalAggregation.ReduceContext reduceContext) Reduces the given aggregations to a single one and returns it.protected void
Methods inherited from class org.elasticsearch.search.aggregations.bucket.terms.InternalRareTerms
doWriteTo, doXContentCommon, equals, hashCode, reduceBucket
Methods inherited from class org.elasticsearch.search.aggregations.InternalMultiBucketAggregation
copyWithRewritenBuckets, countInnerBucket, countInnerBucket, forEachBucket, getProperty, mustReduceOnSingleInternalAgg, reducePipelines
Methods inherited from class org.elasticsearch.search.aggregations.InternalAggregation
getMetadata, getName, getProperty, mergePipelineTreeForBWCSerialization, pipelineAggregatorsForBwcSerialization, 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
Methods inherited from interface org.elasticsearch.xcontent.ToXContent
toXContent
Methods inherited from interface org.elasticsearch.xcontent.ToXContentFragment
isFragment
-
Field Details
-
NAME
- See Also:
-
-
Constructor Details
-
UnmappedRareTerms
Read from a stream.- Throws:
IOException
-
-
Method Details
-
writeTermTypeInfoTo
- Specified by:
writeTermTypeInfoTo
in classInternalRareTerms<UnmappedRareTerms,
UnmappedRareTerms.Bucket> - Throws:
IOException
-
getWriteableName
Description copied from interface:NamedWriteable
Returns the name of the writeable object -
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<UnmappedRareTerms,
UnmappedRareTerms.Bucket> - Parameters:
buckets
- the buckets to use in the newAggregation
- Returns:
- the new
Aggregation
-
createBucket
public UnmappedRareTerms.Bucket createBucket(InternalAggregations aggregations, UnmappedRareTerms.Bucket prototype) Description copied from class:InternalMultiBucketAggregation
Create a newInternalMultiBucketAggregation.InternalBucket
using the provided prototype bucket and aggregations.- Specified by:
createBucket
in classInternalMultiBucketAggregation<UnmappedRareTerms,
UnmappedRareTerms.Bucket> - Parameters:
aggregations
- the aggregations for the new bucketprototype
- the bucket to use as a prototype- Returns:
- the new bucket
-
createWithFilter
protected UnmappedRareTerms createWithFilter(String name, List<UnmappedRareTerms.Bucket> buckets, SetBackedScalingCuckooFilter filter) - Specified by:
createWithFilter
in classInternalRareTerms<UnmappedRareTerms,
UnmappedRareTerms.Bucket>
-
reduce
public InternalAggregation reduce(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 classInternalRareTerms<UnmappedRareTerms,
UnmappedRareTerms.Bucket> - See Also:
-
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 IOException - Specified by:
doXContentBody
in classInternalAggregation
- Throws:
IOException
-
getBuckets
Description copied from interface:RareTerms
Return the sorted list of the buckets in this terms aggregation.- Specified by:
getBuckets
in interfaceMultiBucketsAggregation
- Specified by:
getBuckets
in interfaceRareTerms
- Specified by:
getBuckets
in classInternalRareTerms<UnmappedRareTerms,
UnmappedRareTerms.Bucket> - Returns:
- The buckets of this aggregation.
-
getBucketByKey
Description copied from interface:RareTerms
Get the bucket for the given term, or null if there is no such bucket.- Specified by:
getBucketByKey
in interfaceRareTerms
- Specified by:
getBucketByKey
in classInternalRareTerms<UnmappedRareTerms,
UnmappedRareTerms.Bucket>
-
createBucketsArray
Description copied from class:InternalRareTerms
Create an array to hold some buckets. Used in collecting the results.- Specified by:
createBucketsArray
in classInternalRareTerms<UnmappedRareTerms,
UnmappedRareTerms.Bucket>
-