Module org.elasticsearch.server
Class UnmappedTerms
java.lang.Object
org.elasticsearch.search.aggregations.InternalAggregation
org.elasticsearch.search.aggregations.InternalMultiBucketAggregation<UnmappedTerms,UnmappedTerms.Bucket>
org.elasticsearch.search.aggregations.bucket.terms.AbstractInternalTerms<UnmappedTerms,UnmappedTerms.Bucket>
org.elasticsearch.search.aggregations.bucket.terms.InternalTerms<UnmappedTerms,UnmappedTerms.Bucket>
org.elasticsearch.search.aggregations.bucket.terms.UnmappedTerms
- All Implemented Interfaces:
NamedWriteable,Writeable,Aggregation,MultiBucketsAggregation,Terms,ToXContent,ToXContentFragment
Result of the
TermsAggregator when the field is unmapped.-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionprotected static classConcrete type that can't be built because Java needs a concrete type soInternalTerms.Bucketcan 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.bucket.terms.AbstractInternalTerms
AbstractInternalTerms.AbstractTermsBucket<B extends AbstractInternalTerms.AbstractTermsBucket<B>>Nested classes/interfaces inherited from class org.elasticsearch.search.aggregations.InternalMultiBucketAggregation
InternalMultiBucketAggregation.BucketAggregationList<B extends MultiBucketsAggregation.Bucket>, InternalMultiBucketAggregation.InternalBucket, InternalMultiBucketAggregation.InternalBucketWritableNested classes/interfaces inherited from interface org.elasticsearch.search.aggregations.Aggregation
Aggregation.CommonFieldsNested classes/interfaces inherited from interface org.elasticsearch.xcontent.ToXContent
ToXContent.DelegatingMapParams, ToXContent.MapParams, ToXContent.ParamsNested classes/interfaces inherited from interface org.elasticsearch.common.io.stream.Writeable
Writeable.Reader<V>, Writeable.Writer<V> -
Field Summary
FieldsFields inherited from class org.elasticsearch.search.aggregations.bucket.terms.InternalTerms
DOC_COUNT_ERROR_UPPER_BOUND_FIELD_NAME, minDocCount, order, reduceOrder, requiredSize, SUM_OF_OTHER_DOC_COUNTSFields inherited from class org.elasticsearch.search.aggregations.InternalMultiBucketAggregation
REPORT_EMPTY_EVERYFields inherited from class org.elasticsearch.search.aggregations.InternalAggregation
metadata, nameFields inherited from interface org.elasticsearch.search.aggregations.Aggregation
TYPED_KEYS_DELIMITERFields inherited from interface org.elasticsearch.xcontent.ToXContent
EMPTY, EMPTY_PARAMS -
Constructor Summary
ConstructorsConstructorDescriptionUnmappedTerms(String name, BucketOrder order, int requiredSize, long minDocCount, Map<String, Object> metadata) Read from a stream. -
Method Summary
Modifier and TypeMethodDescriptionbooleanReturn true if this aggregation can lead a reduction (ie, is not unmapped or empty).protected UnmappedTermscreate(String name, List<UnmappedTerms.Bucket> buckets, BucketOrder reduceOrder, long docCountError, long otherDocCount) Creates InternalTerms at the end of the mergecreate(List<UnmappedTerms.Bucket> buckets) Create a new copy of thisAggregationwith the same settings as thisAggregationand contains the provided buckets.protected UnmappedTerms.BucketcreateBucket(long docCount, InternalAggregations aggs, long docCountError, UnmappedTerms.Bucket prototype) createBucket(InternalAggregations aggregations, UnmappedTerms.Bucket prototype) Create a newInternalMultiBucketAggregation.InternalBucketusing the provided prototype bucket and aggregations.final XContentBuilderdoXContentBody(XContentBuilder builder, ToXContent.Params params) finalizeSampling(SamplingContext samplingContext) Called by the parent sampling context.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.Get an upper bound of the error on document counts in this aggregation.protected AggregatorReducergetLeaderReducer(AggregationReduceContext reduceContext, int size) Return an object that Reduces several aggregations to a single one.protected intprotected booleanlongReturn the sum of the document counts of all buckets that did not make it to the top buckets.getType()Returns the name of the writeable objectprotected voidsetDocCountError(long docCountError) protected voidMethods inherited from class org.elasticsearch.search.aggregations.bucket.terms.InternalTerms
doWriteTo, equals, getMinDocCount, getOrder, getReduceOrder, getRequiredSize, hashCodeMethods inherited from class org.elasticsearch.search.aggregations.bucket.terms.AbstractInternalTerms
doXContentCommon, termsAggregationReducerMethods inherited from class org.elasticsearch.search.aggregations.InternalMultiBucketAggregation
copyWithRewritenBuckets, countInnerBucket, countInnerBucket, forEachBucket, getProperty, mustReduceOnSingleInternalAgg, reducePipelinesMethods inherited from class org.elasticsearch.search.aggregations.InternalAggregation
getMetadata, getName, getProperty, getReducer, readSize, sortValue, sortValue, toString, toXContent, writeSize, writeToMethods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, waitMethods inherited from interface org.elasticsearch.search.aggregations.Aggregation
getMetadata, getNameMethods inherited from interface org.elasticsearch.xcontent.ToXContent
toXContentMethods inherited from interface org.elasticsearch.xcontent.ToXContentFragment
isFragment
-
Field Details
-
NAME
- See Also:
-
-
Constructor Details
-
UnmappedTerms
public UnmappedTerms(String name, BucketOrder order, int requiredSize, long minDocCount, Map<String, Object> metadata) -
UnmappedTerms
Read from a stream.- Throws:
IOException
-
-
Method Details
-
writeTermTypeInfoTo
- Specified by:
writeTermTypeInfoToin classInternalTerms<UnmappedTerms,UnmappedTerms.Bucket> - Throws:
IOException
-
getWriteableName
Description copied from interface:NamedWriteableReturns the name of the writeable object -
getType
- Specified by:
getTypein interfaceAggregation- Overrides:
getTypein 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:InternalMultiBucketAggregationCreate a new copy of thisAggregationwith the same settings as thisAggregationand contains the provided buckets.- Specified by:
createin 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:InternalMultiBucketAggregationCreate a newInternalMultiBucketAggregation.InternalBucketusing the provided prototype bucket and aggregations.- Specified by:
createBucketin classInternalMultiBucketAggregation<UnmappedTerms,UnmappedTerms.Bucket> - Parameters:
aggregations- the aggregations for the new bucketprototype- the bucket to use as a prototype- Returns:
- the new bucket
-
createBucket
protected UnmappedTerms.Bucket createBucket(long docCount, InternalAggregations aggs, long docCountError, UnmappedTerms.Bucket prototype) - Specified by:
createBucketin classAbstractInternalTerms<UnmappedTerms,UnmappedTerms.Bucket>
-
create
protected UnmappedTerms create(String name, List<UnmappedTerms.Bucket> buckets, BucketOrder reduceOrder, long docCountError, long otherDocCount) Description copied from class:AbstractInternalTermsCreates InternalTerms at the end of the merge- Specified by:
createin classInternalTerms<UnmappedTerms,UnmappedTerms.Bucket>
-
finalizeSampling
Description copied from class:InternalAggregationCalled by the parent sampling context. Should only ever be called once as some aggregations scale their internal values- Overrides:
finalizeSamplingin classAbstractInternalTerms<UnmappedTerms,UnmappedTerms.Bucket> - Parameters:
samplingContext- the current sampling context- Returns:
- new aggregation with the sampling context applied, could be the same aggregation instance if nothing needs to be done
-
getLeaderReducer
Description copied from class:InternalAggregationReturn an object that Reduces several aggregations to a single one. This method is called whenInternalAggregation.canLeadReduction()returns true and expects an reducer that produces the right result.- Specified by:
getLeaderReducerin classInternalAggregation
-
canLeadReduction
public boolean canLeadReduction()Description copied from class:InternalAggregationReturn true if this aggregation can lead a reduction (ie, is not unmapped or empty). If this agg returns false, it should return itself if asked to lead a reduction.- Overrides:
canLeadReductionin classInternalAggregation
-
doXContentBody
public final XContentBuilder doXContentBody(XContentBuilder builder, ToXContent.Params params) throws IOException - Specified by:
doXContentBodyin classInternalAggregation- Throws:
IOException
-
getShowDocCountError
protected boolean getShowDocCountError()- Specified by:
getShowDocCountErrorin classAbstractInternalTerms<UnmappedTerms,UnmappedTerms.Bucket>
-
setDocCountError
protected void setDocCountError(long docCountError) - Specified by:
setDocCountErrorin classInternalTerms<UnmappedTerms,UnmappedTerms.Bucket>
-
getShardSize
protected int getShardSize()- Specified by:
getShardSizein classInternalTerms<UnmappedTerms,UnmappedTerms.Bucket>
-
getDocCountError
Description copied from interface:TermsGet an upper bound of the error on document counts in this aggregation.- Specified by:
getDocCountErrorin interfaceTerms- Specified by:
getDocCountErrorin classAbstractInternalTerms<UnmappedTerms,UnmappedTerms.Bucket>
-
getSumOfOtherDocCounts
public long getSumOfOtherDocCounts()Description copied from interface:TermsReturn the sum of the document counts of all buckets that did not make it to the top buckets.- Specified by:
getSumOfOtherDocCountsin interfaceTerms- Specified by:
getSumOfOtherDocCountsin classAbstractInternalTerms<UnmappedTerms,UnmappedTerms.Bucket>
-
getBuckets
Description copied from interface:TermsReturn the sorted list of the buckets in this terms aggregation.- Specified by:
getBucketsin interfaceMultiBucketsAggregation- Specified by:
getBucketsin interfaceTerms- Specified by:
getBucketsin classInternalTerms<UnmappedTerms,UnmappedTerms.Bucket> - Returns:
- The buckets of this aggregation.
-
getBucketByKey
Description copied from interface:TermsGet the bucket for the given term, or null if there is no such bucket.- Specified by:
getBucketByKeyin interfaceTerms- Specified by:
getBucketByKeyin classInternalTerms<UnmappedTerms,UnmappedTerms.Bucket>
-