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, ToXContent, ToXContentFragment, Aggregation, MultiBucketsAggregation, Range

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 and 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

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 and Description
protected DocValueFormat	format
protected 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.common.xcontent.ToXContent

EMPTY_PARAMS

Constructor Summary

Constructors

Constructor and Description
InternalBinaryRange(StreamInput in) Read from a stream.
InternalBinaryRange(java.lang.String name, DocValueFormat format, boolean keyed, java.util.List<InternalBinaryRange.Bucket> buckets, java.util.List<PipelineAggregator> pipelineAggregators, java.util.Map<java.lang.String,java.lang.Object> metaData)

Method Summary

Modifier and Type	Method and Description
InternalBinaryRange	create(java.util.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.
boolean	doEquals(java.lang.Object obj) Opportunity for subclasses to add criteria to the InternalAggregation.equals(Object) method for this class.
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)
XContentBuilder	doXContentBody(XContentBuilder builder, ToXContent.Params params)
java.util.List<InternalBinaryRange.Bucket>	getBuckets() Return the buckets of this range aggregation.
java.lang.String	getWriteableName() Returns the name of the writeable object

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

getProperty

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

equals, getMetaData, getName, getProperty, getType, hashCode, 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.xcontent.ToXContentFragment

isFragment

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

toXContent

Field Detail

format

protected final DocValueFormat format

keyed

protected final boolean keyed

Constructor Detail

InternalBinaryRange

public InternalBinaryRange(java.lang.String name,
                           DocValueFormat format,
                           boolean keyed,
                           java.util.List<InternalBinaryRange.Bucket> buckets,
                           java.util.List<PipelineAggregator> pipelineAggregators,
                           java.util.Map<java.lang.String,java.lang.Object> metaData)

InternalBinaryRange

public InternalBinaryRange(StreamInput in)
                    throws java.io.IOException

Read from a stream.

Throws:

java.io.IOException

Method Detail

doWriteTo

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

Specified by:

doWriteTo in class InternalAggregation

Throws:

java.io.IOException

getWriteableName

public java.lang.String getWriteableName()

Description copied from interface: NamedWriteable

Returns the name of the writeable object

Specified by:

getWriteableName in interface NamedWriteable

getBuckets

public java.util.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(java.util.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

doReduce

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

Specified by:

doReduce in class InternalAggregation

doXContentBody

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

Specified by:

doXContentBody in class InternalAggregation

Throws:

java.io.IOException

doEquals

public 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

public int doHashCode()

Description copied from class: InternalAggregation

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

Specified by:

doHashCode in class InternalAggregation