Package org.elasticsearch.search.aggregations.bucket.range

Class InternalBinaryRange

java.lang.Object

org.elasticsearch.search.aggregations.InternalAggregation

org.elasticsearch.search.aggregations.InternalMultiBucketAggregation<InternalBinaryRange,InternalBinaryRange.Bucket>

org.elasticsearch.search.aggregations.bucket.range.InternalBinaryRange

All Implemented Interfaces:

NamedWriteable, Writeable, Aggregation, MultiBucketsAggregation, Range, ToXContent, ToXContentFragment

public final class InternalBinaryRange
extends InternalMultiBucketAggregation<InternalBinaryRange,InternalBinaryRange.Bucket>
implements Range

A range aggregation for data that is encoded in doc values using a binary representation.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	InternalBinaryRange.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

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 DocValueFormat	format
protected final boolean	keyed

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
InternalBinaryRange(String name, DocValueFormat format, boolean keyed, List<InternalBinaryRange.Bucket> buckets, Map<String,Object> metadata)
InternalBinaryRange(StreamInput in)	Read from a stream.

Method Summary

Modifier and Type	Method	Description
InternalBinaryRange	create(List<InternalBinaryRange.Bucket> buckets)	Create a new copy of this Aggregation with the same settings as this Aggregation and contains the provided buckets.
InternalBinaryRange.Bucket	createBucket(InternalAggregations aggregations, InternalBinaryRange.Bucket prototype)	Create a new InternalMultiBucketAggregation.InternalBucket using the provided prototype bucket and aggregations.
protected void	doWriteTo(StreamOutput out)
XContentBuilder	doXContentBody(XContentBuilder builder, ToXContent.Params params)
boolean	equals(Object obj)
List<InternalBinaryRange.Bucket>	getBuckets()	Return the buckets of this range aggregation.
String	getWriteableName()	Returns the name of the writeable object
int	hashCode()
InternalAggregation	reduce(List<InternalAggregation> aggregations, InternalAggregation.ReduceContext reduceContext)	Reduces the given aggregations to a single one and returns it.
protected InternalBinaryRange.Bucket	reduceBucket(List<InternalBinaryRange.Bucket> buckets, InternalAggregation.ReduceContext context)	Reduce a list of same-keyed buckets (from multiple shards) to a single bucket.

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, 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.xcontent.ToXContent

toXContent

Methods inherited from interface org.elasticsearch.xcontent.ToXContentFragment

isFragment

Field Details

format

protected final DocValueFormat format

keyed

protected final boolean keyed

Constructor Details

InternalBinaryRange

public InternalBinaryRange(String name,
 DocValueFormat format,
 boolean keyed,
 List<InternalBinaryRange.Bucket> buckets,
 Map<String,Object> metadata)

InternalBinaryRange

public InternalBinaryRange(StreamInput in)
                    throws IOException

Read from a stream.

Throws:

IOException

Method Details

doWriteTo

protected void doWriteTo(StreamOutput out)
                  throws IOException

Specified by:

doWriteTo in class InternalAggregation

Throws:

IOException

getWriteableName

public String getWriteableName()

Description copied from interface: NamedWriteable

Returns the name of the writeable object

Specified by:

getWriteableName in interface NamedWriteable

getBuckets

public List<InternalBinaryRange.Bucket> getBuckets()

Description copied from interface: Range

Return the buckets of this range aggregation.

Specified by:

getBuckets in interface MultiBucketsAggregation

Specified by:

getBuckets in interface Range

Specified by:

getBuckets in class InternalMultiBucketAggregation<InternalBinaryRange,InternalBinaryRange.Bucket>

Returns:

The buckets of this aggregation.

create

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

Parameters:

buckets - the buckets to use in the new Aggregation

Returns:

the new Aggregation

createBucket

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

Parameters:

aggregations - the aggregations for the new bucket

prototype - the bucket to use as a prototype

Returns:

the new bucket

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 InternalBinaryRange.Bucket reduceBucket(List<InternalBinaryRange.Bucket> 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<InternalBinaryRange,InternalBinaryRange.Bucket>

doXContentBody

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

Specified by:

doXContentBody in class InternalAggregation

Throws:

IOException

equals

public boolean equals(Object obj)

Overrides:

equals in class InternalAggregation

hashCode

public int hashCode()

Overrides:

hashCode in class InternalAggregation