Package org.elasticsearch.search.aggregations.bucket.terms

Class InternalMappedTerms<A extends InternalTerms<A,B>,B extends InternalTerms.Bucket<B>>

java.lang.Object

org.elasticsearch.search.aggregations.InternalAggregation

org.elasticsearch.search.aggregations.InternalMultiBucketAggregation<A,B>

org.elasticsearch.search.aggregations.bucket.terms.AbstractInternalTerms<A,B>

org.elasticsearch.search.aggregations.bucket.terms.InternalTerms<A,B>

org.elasticsearch.search.aggregations.bucket.terms.InternalMappedTerms<A,B>

All Implemented Interfaces:

NamedWriteable, Writeable, Aggregation, MultiBucketsAggregation, Terms, ToXContent, ToXContentFragment

Direct Known Subclasses:

DoubleTerms, LongTerms, StringTerms

public abstract class InternalMappedTerms<A extends InternalTerms<A,B>,B extends InternalTerms.Bucket<B>>
extends InternalTerms<A,B>

Common superclass for results of the terms aggregation on mapped fields.

Nested Class Summary

Nested classes/interfaces inherited from class org.elasticsearch.search.aggregations.bucket.terms.InternalTerms

InternalTerms.Bucket<B extends InternalTerms.Bucket<B>>

Nested classes/interfaces inherited from class org.elasticsearch.search.aggregations.bucket.terms.AbstractInternalTerms

AbstractInternalTerms.AbstractTermsBucket

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

Modifier and Type	Field	Description
protected Map<String,B>	bucketMap
protected final List<B>	buckets
protected Long	docCountError
protected final DocValueFormat	format
protected final long	otherDocCount
protected final int	shardSize
protected final boolean	showTermDocCountError

Fields 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_COUNTS

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

Constructors

Modifier	Constructor	Description
protected	InternalMappedTerms(String name, BucketOrder reduceOrder, BucketOrder order, int requiredSize, long minDocCount, Map<String,Object> metadata, DocValueFormat format, int shardSize, boolean showTermDocCountError, long otherDocCount, List<B> buckets, Long docCountError)
protected	InternalMappedTerms(StreamInput in, InternalTerms.Bucket.Reader<B> bucketReader)	Read from a stream.

Method Summary

Modifier and Type	Method	Description
final XContentBuilder	doXContentBody(XContentBuilder builder, ToXContent.Params params)
boolean	equals(Object obj)
B	getBucketByKey(String term)	Get the bucket for the given term, or null if there is no such bucket.
List<B>	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.
int	hashCode()
protected void	setDocCountError(long docCountError)
protected final void	writeTermTypeInfoTo(StreamOutput out)

Methods inherited from class org.elasticsearch.search.aggregations.bucket.terms.InternalTerms

create, doWriteTo, getMinDocCount, getOrder, getReduceOrder, getRequiredSize

Methods inherited from class org.elasticsearch.search.aggregations.bucket.terms.AbstractInternalTerms

createBucket, doXContentCommon, reduce, reduceBucket

Methods inherited from class org.elasticsearch.search.aggregations.InternalMultiBucketAggregation

copyWithRewritenBuckets, countInnerBucket, countInnerBucket, create, createBucket, forEachBucket, getProperty, mustReduceOnSingleInternalAgg, reducePipelines

Methods inherited from class org.elasticsearch.search.aggregations.InternalAggregation

getMetadata, getName, getProperty, getType, isMapped, 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, getType

Methods inherited from interface org.elasticsearch.common.io.stream.NamedWriteable

getWriteableName

Methods inherited from interface org.elasticsearch.xcontent.ToXContent

toXContent

Methods inherited from interface org.elasticsearch.xcontent.ToXContentFragment

isFragment

Field Details

format

protected final DocValueFormat format

shardSize

protected final int shardSize

showTermDocCountError

protected final boolean showTermDocCountError

otherDocCount

protected final long otherDocCount

buckets

protected final List<B extends InternalTerms.Bucket<B>> buckets

bucketMap

protected Map<String,B extends InternalTerms.Bucket<B>> bucketMap

docCountError

protected Long docCountError

Constructor Details

InternalMappedTerms

protected InternalMappedTerms(String name,
 BucketOrder reduceOrder,
 BucketOrder order,
 int requiredSize,
 long minDocCount,
 Map<String,Object> metadata,
 DocValueFormat format,
 int shardSize,
 boolean showTermDocCountError,
 long otherDocCount,
 List<B> buckets,
 Long docCountError)

InternalMappedTerms

protected InternalMappedTerms(StreamInput in,
 InternalTerms.Bucket.Reader<B> bucketReader)
                       throws IOException

Read from a stream.

Throws:

IOException

Method Details

writeTermTypeInfoTo

protected final void writeTermTypeInfoTo(StreamOutput out)
                                  throws IOException

Specified by:

writeTermTypeInfoTo in class InternalTerms<A extends InternalTerms<A,B>,B extends InternalTerms.Bucket<B>>

Throws:

IOException

setDocCountError

protected void setDocCountError(long docCountError)

Specified by:

setDocCountError in class InternalTerms<A extends InternalTerms<A,B>,B extends InternalTerms.Bucket<B>>

getShardSize

protected int getShardSize()

Specified by:

getShardSize in class InternalTerms<A extends InternalTerms<A,B>,B extends InternalTerms.Bucket<B>>

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 interface Terms

Specified by:

getDocCountError in class AbstractInternalTerms<A extends InternalTerms<A,B>,B extends InternalTerms.Bucket<B>>

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 interface Terms

Specified by:

getSumOfOtherDocCounts in class AbstractInternalTerms<A extends InternalTerms<A,B>,B extends InternalTerms.Bucket<B>>

getBuckets

public List<B> getBuckets()

Description copied from interface: Terms

Return the sorted list of the buckets in this terms aggregation.

Specified by:

getBuckets in interface MultiBucketsAggregation

Specified by:

getBuckets in interface Terms

Specified by:

getBuckets in class InternalTerms<A extends InternalTerms<A,B>,B extends InternalTerms.Bucket<B>>

Returns:

The buckets of this aggregation.

getBucketByKey

public B getBucketByKey(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 interface Terms

Specified by:

getBucketByKey in class InternalTerms<A extends InternalTerms<A,B>,B extends InternalTerms.Bucket<B>>

equals

public boolean equals(Object obj)

Overrides:

equals in class InternalTerms<A extends InternalTerms<A,B>,B extends InternalTerms.Bucket<B>>

hashCode

public int hashCode()

Overrides:

hashCode in class InternalTerms<A extends InternalTerms<A,B>,B extends InternalTerms.Bucket<B>>

doXContentBody

public final XContentBuilder doXContentBody(XContentBuilder builder,
 ToXContent.Params params)
                                     throws IOException

Specified by:

doXContentBody in class InternalAggregation

Throws:

IOException