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

Class StringRareTerms

java.lang.Object

org.elasticsearch.search.aggregations.InternalAggregation

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

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

org.elasticsearch.search.aggregations.bucket.terms.InternalMappedRareTerms<StringRareTerms,StringRareTerms.Bucket>

org.elasticsearch.search.aggregations.bucket.terms.StringRareTerms

All Implemented Interfaces:

NamedWriteable, Writeable, Aggregation, MultiBucketsAggregation, RareTerms, org.elasticsearch.xcontent.ToXContent, org.elasticsearch.xcontent.ToXContentFragment

public class StringRareTerms
extends InternalMappedRareTerms<StringRareTerms,StringRareTerms.Bucket>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	StringRareTerms.Bucket

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

org.elasticsearch.xcontent.ToXContent.DelegatingMapParams, org.elasticsearch.xcontent.ToXContent.MapParams, org.elasticsearch.xcontent.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
static final String	NAME

Fields inherited from class org.elasticsearch.search.aggregations.bucket.terms.InternalMappedRareTerms

bucketMap, buckets, format, logger

Fields inherited from class org.elasticsearch.search.aggregations.bucket.terms.InternalRareTerms

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

Constructor	Description
StringRareTerms(StreamInput in)	Read from a stream.

Method Summary

Modifier and Type	Method	Description
void	addToFilter(SetBackedScalingCuckooFilter filter, StringRareTerms.Bucket bucket)
boolean	containsTerm(SetBackedScalingCuckooFilter filter, StringRareTerms.Bucket bucket)
StringRareTerms	create(List<StringRareTerms.Bucket> buckets)	Create a new copy of this Aggregation with the same settings as this Aggregation and contains the provided buckets.
StringRareTerms.Bucket	createBucket(InternalAggregations aggregations, StringRareTerms.Bucket prototype)	Create a new InternalMultiBucketAggregation.InternalBucket using the provided prototype bucket and aggregations.
protected StringRareTerms.Bucket[]	createBucketsArray(int size)	Create an array to hold some buckets.
protected StringRareTerms	createWithFilter(String name, List<StringRareTerms.Bucket> buckets, SetBackedScalingCuckooFilter filterFilter)
String	getWriteableName()	Returns the name of the writeable object

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

doXContentBody, equals, getBucketByKey, getBuckets, getMaxDocCount, hashCode, reduce, writeTermTypeInfoTo

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

doWriteTo, doXContentCommon, reduceBucket

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

copyWithRewritenBuckets, countInnerBucket, countInnerBucket, forEachBucket, getProperty, mustReduceOnSingleInternalAgg, reducePipelines

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

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

toXContent

Methods inherited from interface org.elasticsearch.xcontent.ToXContentFragment

isFragment

Field Details

NAME

public static final String NAME

See Also:

• Constant Field Values

Constructor Details

StringRareTerms

public StringRareTerms(StreamInput in)
                throws IOException

Read from a stream.

Throws:

IOException

Method Details

getWriteableName

public String getWriteableName()

Description copied from interface: NamedWriteable

Returns the name of the writeable object

create

public StringRareTerms create(List<StringRareTerms.Bucket> buckets)

Description copied from class: InternalMultiBucketAggregation

Create a new copy of this Aggregation with the same settings as this Aggregation and contains the provided buckets.

Specified by:

create in class InternalMultiBucketAggregation<StringRareTerms,StringRareTerms.Bucket>

Parameters:

buckets - the buckets to use in the new Aggregation

Returns:

the new Aggregation

createBucket

public StringRareTerms.Bucket createBucket(InternalAggregations aggregations,
 StringRareTerms.Bucket prototype)

Description copied from class: InternalMultiBucketAggregation

Create a new InternalMultiBucketAggregation.InternalBucket using the provided prototype bucket and aggregations.

Specified by:

createBucket in class InternalMultiBucketAggregation<StringRareTerms,StringRareTerms.Bucket>

Parameters:

aggregations - the aggregations for the new bucket

prototype - the bucket to use as a prototype

Returns:

the new bucket

createWithFilter

protected StringRareTerms createWithFilter(String name,
 List<StringRareTerms.Bucket> buckets,
 SetBackedScalingCuckooFilter filterFilter)

Specified by:

createWithFilter in class InternalRareTerms<StringRareTerms,StringRareTerms.Bucket>

createBucketsArray

protected StringRareTerms.Bucket[] createBucketsArray(int size)

Description copied from class: InternalRareTerms

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

Specified by:

createBucketsArray in class InternalRareTerms<StringRareTerms,StringRareTerms.Bucket>

containsTerm

public boolean containsTerm(SetBackedScalingCuckooFilter filter,
 StringRareTerms.Bucket bucket)

Specified by:

containsTerm in class InternalMappedRareTerms<StringRareTerms,StringRareTerms.Bucket>

addToFilter

public void addToFilter(SetBackedScalingCuckooFilter filter,
 StringRareTerms.Bucket bucket)

Specified by:

addToFilter in class InternalMappedRareTerms<StringRareTerms,StringRareTerms.Bucket>