Module org.elasticsearch.server
Class UnmappedSignificantTerms
java.lang.Object
org.elasticsearch.search.aggregations.InternalAggregation
org.elasticsearch.search.aggregations.InternalMultiBucketAggregation<UnmappedSignificantTerms,UnmappedSignificantTerms.Bucket>
org.elasticsearch.search.aggregations.bucket.terms.InternalSignificantTerms<UnmappedSignificantTerms,UnmappedSignificantTerms.Bucket>
org.elasticsearch.search.aggregations.bucket.terms.UnmappedSignificantTerms
- All Implemented Interfaces:
Iterable<SignificantTerms.Bucket>,NamedWriteable,Writeable,Aggregation,MultiBucketsAggregation,SignificantTerms,ToXContent,ToXContentFragment
public class UnmappedSignificantTerms
extends InternalSignificantTerms<UnmappedSignificantTerms,UnmappedSignificantTerms.Bucket>
Result of the running the significant terms aggregation on an unmapped field.
-
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.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.InternalSignificantTerms
BG_COUNT, minDocCount, requiredSize, SCOREFields 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
ConstructorsConstructorDescriptionUnmappedSignificantTerms(String name, 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 UnmappedSignificantTermscreate(long subsetSize, long supersetSize, List<UnmappedSignificantTerms.Bucket> buckets) create(List<UnmappedSignificantTerms.Bucket> buckets) Create a new copy of thisAggregationwith the same settings as thisAggregationand contains the provided buckets.createBucket(InternalAggregations aggregations, UnmappedSignificantTerms.Bucket prototype) Create a newInternalMultiBucketAggregation.InternalBucketusing the provided prototype bucket and aggregations.protected UnmappedSignificantTerms.Bucket[]createBucketsArray(int size) Create an array to hold some buckets.doXContentBody(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.protected AggregatorReducergetLeaderReducer(AggregationReduceContext reduceContext, int size) Return an object that Reduces several aggregations to a single one.protected SignificanceHeuristiclonglonggetType()Returns the name of the writeable objectiterator()protected voidMethods inherited from class org.elasticsearch.search.aggregations.bucket.terms.InternalSignificantTerms
doWriteTo, equals, hashCodeMethods 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 java.lang.Iterable
forEach, spliteratorMethods inherited from interface org.elasticsearch.xcontent.ToXContent
toXContentMethods inherited from interface org.elasticsearch.xcontent.ToXContentFragment
isFragment
-
Field Details
-
NAME
- See Also:
-
-
Constructor Details
-
UnmappedSignificantTerms
-
UnmappedSignificantTerms
Read from a stream.- Throws:
IOException
-
-
Method Details
-
writeTermTypeInfoTo
- Specified by:
writeTermTypeInfoToin classInternalSignificantTerms<UnmappedSignificantTerms,UnmappedSignificantTerms.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<UnmappedSignificantTerms,UnmappedSignificantTerms.Bucket> - Parameters:
buckets- the buckets to use in the newAggregation- Returns:
- the new
Aggregation
-
createBucket
public UnmappedSignificantTerms.Bucket createBucket(InternalAggregations aggregations, UnmappedSignificantTerms.Bucket prototype) Description copied from class:InternalMultiBucketAggregationCreate a newInternalMultiBucketAggregation.InternalBucketusing the provided prototype bucket and aggregations.- Specified by:
createBucketin classInternalMultiBucketAggregation<UnmappedSignificantTerms,UnmappedSignificantTerms.Bucket> - Parameters:
aggregations- the aggregations for the new bucketprototype- the bucket to use as a prototype- Returns:
- the new bucket
-
create
protected UnmappedSignificantTerms create(long subsetSize, long supersetSize, List<UnmappedSignificantTerms.Bucket> buckets) - Specified by:
createin classInternalSignificantTerms<UnmappedSignificantTerms,UnmappedSignificantTerms.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 classInternalSignificantTerms<UnmappedSignificantTerms,UnmappedSignificantTerms.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.- Overrides:
getLeaderReducerin classInternalSignificantTerms<UnmappedSignificantTerms,UnmappedSignificantTerms.Bucket>
-
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 XContentBuilder doXContentBody(XContentBuilder builder, ToXContent.Params params) throws IOException - Specified by:
doXContentBodyin classInternalAggregation- Throws:
IOException
-
createBucketsArray
Description copied from class:InternalSignificantTermsCreate an array to hold some buckets. Used in collecting the results.- Specified by:
createBucketsArrayin classInternalSignificantTerms<UnmappedSignificantTerms,UnmappedSignificantTerms.Bucket>
-
iterator
-
getBuckets
- Specified by:
getBucketsin interfaceMultiBucketsAggregation- Specified by:
getBucketsin interfaceSignificantTerms- Specified by:
getBucketsin classInternalSignificantTerms<UnmappedSignificantTerms,UnmappedSignificantTerms.Bucket> - Returns:
- The buckets of this aggregation.
-
getBucketByKey
Description copied from interface:SignificantTermsGet the bucket for the given term, or null if there is no such bucket. -
getSignificanceHeuristic
- Specified by:
getSignificanceHeuristicin classInternalSignificantTerms<UnmappedSignificantTerms,UnmappedSignificantTerms.Bucket>
-
getSubsetSize
public long getSubsetSize()- Returns:
- The numbers of docs in the subset (also known as "foreground set"). This number is equal to the document count of the containing aggregation.
-
getSupersetSize
public long getSupersetSize()- Returns:
- The numbers of docs in the superset (ordinarily the background count of the containing aggregation).
-