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

Class InternalTerms<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.InternalTerms<A,B>

All Implemented Interfaces:

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

Direct Known Subclasses:

InternalMappedTerms, UnmappedTerms

public abstract class InternalTerms<A extends InternalTerms<A,B>,B extends InternalTerms.Bucket<B>>
extends InternalMultiBucketAggregation<A,B>
implements Terms

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	InternalTerms.Bucket<B extends InternalTerms.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

Nested classes/interfaces inherited from interface org.elasticsearch.search.aggregations.Aggregation

Aggregation.CommonFields

Nested classes/interfaces inherited from interface org.elasticsearch.common.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 static ParseField	DOC_COUNT_ERROR_UPPER_BOUND_FIELD_NAME
protected long	minDocCount
protected BucketOrder	order
protected int	requiredSize
protected static ParseField	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.common.xcontent.ToXContent

EMPTY_PARAMS

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	InternalTerms(java.lang.String name, BucketOrder order, int requiredSize, long minDocCount, java.util.List<PipelineAggregator> pipelineAggregators, java.util.Map<java.lang.String,java.lang.Object> metaData)
protected	InternalTerms(StreamInput in)	Read from a stream.

Method Summary

Modifier and Type	Method	Description
protected abstract A	create(java.lang.String name, java.util.List<B> buckets, long docCountError, long otherDocCount)
protected abstract B[]	createBucketsArray(int size)	Create an array to hold some buckets.
protected boolean	doEquals(java.lang.Object obj)	Opportunity for subclasses to add criteria to the InternalAggregation.equals(Object) method for this class.
protected int	doHashCode()	Opportunity for subclasses to the InternalAggregation.hashCode() for this class.
InternalAggregation	doReduce(java.util.List<InternalAggregation> aggregations, InternalAggregation.ReduceContext reduceContext)
protected void	doWriteTo(StreamOutput out)
protected static XContentBuilder	doXContentCommon(XContentBuilder builder, ToXContent.Params params, long docCountError, long otherDocCount, java.util.List<? extends InternalTerms.Bucket> buckets)
abstract B	getBucketByKey(java.lang.String term)	Get the bucket for the given term, or null if there is no such bucket.
abstract java.util.List<B>	getBuckets()	Return the sorted list of the buckets in this terms aggregation.
protected abstract int	getShardSize()
protected abstract void	setDocCountError(long docCountError)
protected abstract void	writeTermTypeInfoTo(StreamOutput out)

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

countInnerBucket, countInnerBucket, create, createBucket, getProperty

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

doXContentBody, equals, getMetaData, getName, getProperty, getType, hashCode, isMapped, pipelineAggregators, readSize, reduce, 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.search.aggregations.bucket.terms.Terms

getDocCountError, getSumOfOtherDocCounts

Methods inherited from interface org.elasticsearch.common.xcontent.ToXContent

toXContent

Methods inherited from interface org.elasticsearch.common.xcontent.ToXContentFragment

isFragment

Field Detail

DOC_COUNT_ERROR_UPPER_BOUND_FIELD_NAME

protected static final ParseField DOC_COUNT_ERROR_UPPER_BOUND_FIELD_NAME

SUM_OF_OTHER_DOC_COUNTS

protected static final ParseField SUM_OF_OTHER_DOC_COUNTS

order

protected final BucketOrder order

requiredSize

protected final int requiredSize

minDocCount

protected final long minDocCount

Constructor Detail

InternalTerms

protected InternalTerms(java.lang.String name,
                        BucketOrder order,
                        int requiredSize,
                        long minDocCount,
                        java.util.List<PipelineAggregator> pipelineAggregators,
                        java.util.Map<java.lang.String,java.lang.Object> metaData)

InternalTerms

protected InternalTerms(StreamInput in)
                 throws java.io.IOException

Read from a stream.

Throws:

java.io.IOException

Method Detail

doWriteTo

protected final void doWriteTo(StreamOutput out)
                        throws java.io.IOException

Specified by:

doWriteTo in class InternalAggregation

Throws:

java.io.IOException

writeTermTypeInfoTo

protected abstract void writeTermTypeInfoTo(StreamOutput out)
                                     throws java.io.IOException

Throws:

java.io.IOException

getBuckets

public abstract java.util.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 InternalMultiBucketAggregation<A extends InternalTerms<A,B>,B extends InternalTerms.Bucket<B>>

Returns:

The buckets of this aggregation.

getBucketByKey

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

doReduce

public InternalAggregation doReduce(java.util.List<InternalAggregation> aggregations,
                                    InternalAggregation.ReduceContext reduceContext)

Specified by:

doReduce in class InternalAggregation

setDocCountError

protected abstract void setDocCountError(long docCountError)

getShardSize

protected abstract int getShardSize()

create

protected abstract A create(java.lang.String name,
                            java.util.List<B> buckets,
                            long docCountError,
                            long otherDocCount)

createBucketsArray

protected abstract B[] createBucketsArray(int size)

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

doEquals

protected boolean doEquals(java.lang.Object obj)

Description copied from class: InternalAggregation

Opportunity for subclasses to add criteria to the InternalAggregation.equals(Object) method for this class. This method can safely cast obj to the subclass since the InternalAggregation.equals(Object) method checks that obj is the same class as this

Specified by:

doEquals in class InternalAggregation

doHashCode

protected int doHashCode()

Description copied from class: InternalAggregation

Opportunity for subclasses to the InternalAggregation.hashCode() for this class.

Specified by:

doHashCode in class InternalAggregation

doXContentCommon

protected static XContentBuilder doXContentCommon(XContentBuilder builder,
                                                  ToXContent.Params params,
                                                  long docCountError,
                                                  long otherDocCount,
                                                  java.util.List<? extends InternalTerms.Bucket> buckets)
                                           throws java.io.IOException

Throws:

java.io.IOException