Module org.elasticsearch.server

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

Class LongTerms

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<LongTerms,LongTerms.Bucket>

org.elasticsearch.search.aggregations.bucket.terms.LongTerms

All Implemented Interfaces:

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

public class LongTerms
extends InternalMappedTerms<LongTerms,LongTerms.Bucket>

Result of the TermsAggregator when the field is some kind of whole number like a integer, long, or a date.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	LongTerms.Bucket

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 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
static final String	NAME

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

bucketMap, buckets, docCountError, format, otherDocCount, shardSize, 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

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

Method Summary

Modifier and Type	Method	Description
protected LongTerms	create(String name, List<LongTerms.Bucket> buckets, BucketOrder reduceOrder, long docCountError, long otherDocCount)	Creates InternalTerms at the end of the merge
LongTerms	create(List<LongTerms.Bucket> buckets)	Create a new copy of this Aggregation with the same settings as this Aggregation and contains the provided buckets.
protected LongTerms.Bucket	createBucket(long docCount, InternalAggregations aggs, long docCountError, LongTerms.Bucket prototype)
LongTerms.Bucket	createBucket(InternalAggregations aggregations, LongTerms.Bucket prototype)	Create a new InternalMultiBucketAggregation.InternalBucket using the provided prototype bucket and aggregations.
String	getWriteableName()	Returns the name of the writeable object
InternalAggregation	reduce(List<InternalAggregation> aggregations, AggregationReduceContext reduceContext)	Reduces the given aggregations to a single one and returns it.

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

doXContentBody, equals, getBucketByKey, getBuckets, getDocCountError, getShardSize, getSumOfOtherDocCounts, hashCode, setDocCountError, writeTermTypeInfoTo

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

doWriteTo, getMinDocCount, getOrder, getReduceOrder, getRequiredSize

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

doXContentCommon, finalizeSampling, 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

LongTerms

public LongTerms(String name,
 BucketOrder reduceOrder,
 BucketOrder order,
 int requiredSize,
 long minDocCount,
 Map<String,Object> metadata,
 DocValueFormat format,
 int shardSize,
 boolean showTermDocCountError,
 long otherDocCount,
 List<LongTerms.Bucket> buckets,
 Long docCountError)

LongTerms

public LongTerms(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 LongTerms create(List<LongTerms.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<LongTerms,LongTerms.Bucket>

Parameters:

buckets - the buckets to use in the new Aggregation

Returns:

the new Aggregation

createBucket

public LongTerms.Bucket createBucket(InternalAggregations aggregations,
 LongTerms.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<LongTerms,LongTerms.Bucket>

Parameters:

aggregations - the aggregations for the new bucket

prototype - the bucket to use as a prototype

Returns:

the new bucket

create

protected LongTerms create(String name,
 List<LongTerms.Bucket> buckets,
 BucketOrder reduceOrder,
 long docCountError,
 long otherDocCount)

Description copied from class: AbstractInternalTerms

Creates InternalTerms at the end of the merge

Specified by:

create in class InternalTerms<LongTerms,LongTerms.Bucket>

reduce

public InternalAggregation reduce(List<InternalAggregation> aggregations,
 AggregationReduceContext 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.

Overrides:

reduce in class AbstractInternalTerms<LongTerms,LongTerms.Bucket>

See Also:

• InternalAggregation.mustReduceOnSingleInternalAgg()

createBucket

protected LongTerms.Bucket createBucket(long docCount,
 InternalAggregations aggs,
 long docCountError,
 LongTerms.Bucket prototype)

Specified by:

createBucket in class AbstractInternalTerms<LongTerms,LongTerms.Bucket>