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

Class InternalRareTerms<A extends InternalRareTerms<A,B>,B extends InternalRareTerms.Bucket<B>>

java.lang.Object

org.elasticsearch.search.aggregations.InternalAggregation

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

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

All Implemented Interfaces:

NamedWriteable, Writeable, Aggregation, MultiBucketsAggregation, RareTerms, ToXContent, ToXContentFragment

Direct Known Subclasses:

InternalMappedRareTerms, UnmappedRareTerms

public abstract class InternalRareTerms<A extends InternalRareTerms<A,B>,B extends InternalRareTerms.Bucket<B>>
extends InternalMultiBucketAggregation<A,B>
implements RareTerms

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	InternalRareTerms.Bucket<B extends InternalRareTerms.Bucket<B>>

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 final long	maxDocCount
protected final BucketOrder	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

Constructors

Modifier	Constructor	Description
protected	InternalRareTerms(String name, BucketOrder order, long maxDocCount, Map<String,Object> metadata)
protected	InternalRareTerms(StreamInput in)	Read from a stream.

Method Summary

Modifier and Type	Method	Description
protected abstract B[]	createBucketsArray(int size)	Create an array to hold some buckets.
protected abstract A	createWithFilter(String name, List<B> buckets, SetBackedScalingCuckooFilter filter)
protected final void	doWriteTo(StreamOutput out)
protected static XContentBuilder	doXContentCommon(XContentBuilder builder, ToXContent.Params params, List<? extends InternalRareTerms.Bucket<?>> buckets)
boolean	equals(Object obj)
abstract B	getBucketByKey(String term)	Get the bucket for the given term, or null if there is no such bucket.
abstract List<B>	getBuckets()	Return the sorted list of the buckets in this terms aggregation.
int	hashCode()
InternalAggregation	reduce(List<InternalAggregation> aggregations, InternalAggregation.ReduceContext reduceContext)	Reduces the given aggregations to a single one and returns it.
protected B	reduceBucket(List<B> buckets, InternalAggregation.ReduceContext context)	Reduce a list of same-keyed buckets (from multiple shards) to a single bucket.
protected abstract void	writeTermTypeInfoTo(StreamOutput out)

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

doXContentBody, 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

order

protected final BucketOrder order

maxDocCount

protected final long maxDocCount

Constructor Details

InternalRareTerms

protected InternalRareTerms(String name,
 BucketOrder order,
 long maxDocCount,
 Map<String,Object> metadata)

InternalRareTerms

protected InternalRareTerms(StreamInput in)
                     throws IOException

Read from a stream.

Throws:

IOException

Method Details

doWriteTo

protected final void doWriteTo(StreamOutput out)
                        throws IOException

Specified by:

doWriteTo in class InternalAggregation

Throws:

IOException

writeTermTypeInfoTo

protected abstract void writeTermTypeInfoTo(StreamOutput out)
                                     throws IOException

Throws:

IOException

getBuckets

public abstract List<B> getBuckets()

Description copied from interface: RareTerms

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

Specified by:

getBuckets in interface MultiBucketsAggregation

Specified by:

getBuckets in interface RareTerms

Specified by:

getBuckets in class InternalMultiBucketAggregation<A extends InternalRareTerms<A,B>,B extends InternalRareTerms.Bucket<B>>

Returns:

The buckets of this aggregation.

getBucketByKey

public abstract B getBucketByKey(String term)

Description copied from interface: RareTerms

Get the bucket for the given term, or null if there is no such bucket.

Specified by:

getBucketByKey in interface RareTerms

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.

Specified by:

reduce in class InternalAggregation

See Also:

• InternalAggregation.mustReduceOnSingleInternalAgg()

reduceBucket

protected B reduceBucket(List<B> buckets,
 InternalAggregation.ReduceContext context)

Description copied from class: InternalMultiBucketAggregation

Reduce a list of same-keyed buckets (from multiple shards) to a single bucket. This requires all buckets to have the same key.

Specified by:

reduceBucket in class InternalMultiBucketAggregation<A extends InternalRareTerms<A,B>,B extends InternalRareTerms.Bucket<B>>

createWithFilter

protected abstract A createWithFilter(String name,
 List<B> buckets,
 SetBackedScalingCuckooFilter filter)

createBucketsArray

protected abstract B[] createBucketsArray(int size)

Create an array to hold some buckets. Used in collecting the results.

equals

public boolean equals(Object obj)

Overrides:

equals in class InternalAggregation

hashCode

public int hashCode()

Overrides:

hashCode in class InternalAggregation

doXContentCommon

protected static XContentBuilder doXContentCommon(XContentBuilder builder,
 ToXContent.Params params,
 List<? extends InternalRareTerms.Bucket<?>> buckets)
                                           throws IOException

Throws:

IOException