Class ParsedTerms
- java.lang.Object
-
- org.elasticsearch.search.aggregations.ParsedAggregation
-
- org.elasticsearch.search.aggregations.ParsedMultiBucketAggregation<ParsedTerms.ParsedBucket>
-
- org.elasticsearch.search.aggregations.bucket.terms.ParsedTerms
-
- All Implemented Interfaces:
ToXContent
,ToXContentFragment
,Aggregation
,MultiBucketsAggregation
,Terms
- Direct Known Subclasses:
ParsedDoubleTerms
,ParsedLongTerms
,ParsedStringTerms
public abstract class ParsedTerms extends ParsedMultiBucketAggregation<ParsedTerms.ParsedBucket> implements Terms
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
ParsedTerms.ParsedBucket
-
Nested classes/interfaces inherited from interface org.elasticsearch.search.aggregations.Aggregation
Aggregation.CommonFields
-
Nested classes/interfaces inherited from interface org.elasticsearch.search.aggregations.bucket.MultiBucketsAggregation
MultiBucketsAggregation.Bucket
-
Nested classes/interfaces inherited from interface org.elasticsearch.search.aggregations.bucket.terms.Terms
Terms.Bucket
-
Nested classes/interfaces inherited from interface org.elasticsearch.common.xcontent.ToXContent
ToXContent.DelegatingMapParams, ToXContent.MapParams, ToXContent.Params
-
-
Field Summary
Fields Modifier and Type Field Description protected long
docCountErrorUpperBound
protected long
sumOtherDocCount
-
Fields inherited from class org.elasticsearch.search.aggregations.ParsedMultiBucketAggregation
buckets, keyed
-
Fields inherited from class org.elasticsearch.search.aggregations.ParsedAggregation
metadata
-
Fields inherited from interface org.elasticsearch.search.aggregations.Aggregation
TYPED_KEYS_DELIMITER
-
Fields inherited from interface org.elasticsearch.common.xcontent.ToXContent
EMPTY_PARAMS
-
-
Constructor Summary
Constructors Constructor Description ParsedTerms()
-
Method Summary
Modifier and Type Method Description protected XContentBuilder
doXContentBody(XContentBuilder builder, ToXContent.Params params)
Terms.Bucket
getBucketByKey(java.lang.String term)
Get the bucket for the given term, or null if there is no such bucket.java.util.List<? extends Terms.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.long
getSumOfOtherDocCounts()
Return the sum of the document counts of all buckets that did not make it to the top buckets.-
Methods inherited from class org.elasticsearch.search.aggregations.ParsedMultiBucketAggregation
declareMultiBucketAggregationFields
-
Methods inherited from class org.elasticsearch.search.aggregations.ParsedAggregation
declareAggregationFields, getMetaData, getName, parseDouble, setName, toXContent
-
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
Methods inherited from interface org.elasticsearch.search.aggregations.Aggregation
getMetaData, getName, getType
-
Methods inherited from interface org.elasticsearch.common.xcontent.ToXContent
toXContent
-
Methods inherited from interface org.elasticsearch.common.xcontent.ToXContentFragment
isFragment
-
-
-
-
Method Detail
-
getDocCountError
public long getDocCountError()
Description copied from interface:Terms
Get an upper bound of the error on document counts in this aggregation.- Specified by:
getDocCountError
in interfaceTerms
-
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.- Specified by:
getSumOfOtherDocCounts
in interfaceTerms
-
getBuckets
public java.util.List<? extends Terms.Bucket> 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
- Returns:
- The buckets of this aggregation.
-
getBucketByKey
public Terms.Bucket getBucketByKey(java.lang.String term)
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
-
doXContentBody
protected XContentBuilder doXContentBody(XContentBuilder builder, ToXContent.Params params) throws java.io.IOException
- Overrides:
doXContentBody
in classParsedMultiBucketAggregation<ParsedTerms.ParsedBucket>
- Throws:
java.io.IOException
-
-