Package org.opensearch.search.aggregations.bucket.histogram

Class InternalHistogram

java.lang.Object

org.opensearch.search.aggregations.InternalAggregation

org.opensearch.search.aggregations.InternalMultiBucketAggregation<InternalHistogram,InternalHistogram.Bucket>

org.opensearch.search.aggregations.bucket.histogram.InternalHistogram

All Implemented Interfaces:

NamedWriteable, Writeable, org.opensearch.common.xcontent.ToXContent, org.opensearch.common.xcontent.ToXContentFragment, Aggregation, Histogram, HistogramFactory, MultiBucketsAggregation

public final class InternalHistogram
extends InternalMultiBucketAggregation<InternalHistogram,InternalHistogram.Bucket>
implements Histogram, HistogramFactory

Implementation of Histogram.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	InternalHistogram.Bucket
static class	InternalHistogram.EmptyBucketInfo

Nested classes/interfaces inherited from class org.opensearch.search.aggregations.InternalMultiBucketAggregation

InternalMultiBucketAggregation.InternalBucket

Nested classes/interfaces inherited from class org.opensearch.search.aggregations.InternalAggregation

InternalAggregation.ReduceContext, InternalAggregation.ReduceContextBuilder

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

Aggregation.CommonFields

Nested classes/interfaces inherited from interface org.opensearch.common.xcontent.ToXContent

org.opensearch.common.xcontent.ToXContent.DelegatingMapParams, org.opensearch.common.xcontent.ToXContent.MapParams, org.opensearch.common.xcontent.ToXContent.Params

Nested classes/interfaces inherited from interface org.opensearch.common.io.stream.Writeable

Writeable.Reader<V>, Writeable.Writer<V>

Field Summary

Fields inherited from class org.opensearch.search.aggregations.InternalAggregation

metadata, name

Fields inherited from interface org.opensearch.search.aggregations.Aggregation

TYPED_KEYS_DELIMITER

Fields inherited from interface org.opensearch.search.aggregations.bucket.histogram.Histogram

EXTENDED_BOUNDS_FIELD, HARD_BOUNDS_FIELD, INTERVAL_FIELD, KEYED_FIELD, MIN_DOC_COUNT_FIELD, OFFSET_FIELD, ORDER_FIELD

Fields inherited from interface org.opensearch.common.xcontent.ToXContent

EMPTY_PARAMS

Constructor Summary

Constructors

Constructor	Description
InternalHistogram(java.lang.String name, java.util.List<InternalHistogram.Bucket> buckets, BucketOrder order, long minDocCount, InternalHistogram.EmptyBucketInfo emptyBucketInfo, DocValueFormat formatter, boolean keyed, java.util.Map<java.lang.String,java.lang.Object> metadata)
InternalHistogram(StreamInput in)	Stream from a stream.

Method Summary

Modifier and Type	Method	Description
InternalHistogram	create(java.util.List<InternalHistogram.Bucket> buckets)	Create a new copy of this Aggregation with the same settings as this Aggregation and contains the provided buckets.
InternalAggregation	createAggregation(java.util.List<MultiBucketsAggregation.Bucket> buckets)	Create an InternalAggregation object that wraps the given buckets.
InternalHistogram.Bucket	createBucket(java.lang.Number key, long docCount, InternalAggregations aggregations)	Create a MultiBucketsAggregation.Bucket object that wraps the given key, document count and aggregations.
InternalHistogram.Bucket	createBucket(InternalAggregations aggregations, InternalHistogram.Bucket prototype)	Create a new InternalMultiBucketAggregation.InternalBucket using the provided prototype bucket and aggregations.
protected void	doWriteTo(StreamOutput out)
org.opensearch.common.xcontent.XContentBuilder	doXContentBody(org.opensearch.common.xcontent.XContentBuilder builder, org.opensearch.common.xcontent.ToXContent.Params params)
boolean	equals(java.lang.Object obj)
java.util.List<InternalHistogram.Bucket>	getBuckets()
java.lang.Number	getKey(MultiBucketsAggregation.Bucket bucket)	Get the key for the given bucket.
java.lang.String	getWriteableName()	Returns the name of the writeable object
int	hashCode()
java.lang.Number	nextKey(java.lang.Number key)	Given a key returned by HistogramFactory.getKey(org.opensearch.search.aggregations.bucket.MultiBucketsAggregation.Bucket), compute the lowest key that is greater than it.
InternalAggregation	reduce(java.util.List<InternalAggregation> aggregations, InternalAggregation.ReduceContext reduceContext)	Reduces the given aggregations to a single one and returns it.
protected InternalHistogram.Bucket	reduceBucket(java.util.List<InternalHistogram.Bucket> buckets, InternalAggregation.ReduceContext context)	Reduce a list of same-keyed buckets (from multiple shards) to a single bucket.

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

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

Methods inherited from class org.opensearch.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.opensearch.search.aggregations.Aggregation

getMetadata, getName, getType

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

toXContent

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

isFragment

Constructor Details

InternalHistogram

public InternalHistogram(java.lang.String name, java.util.List<InternalHistogram.Bucket> buckets, BucketOrder order, long minDocCount, InternalHistogram.EmptyBucketInfo emptyBucketInfo, DocValueFormat formatter, boolean keyed, java.util.Map<java.lang.String,java.lang.Object> metadata)

InternalHistogram

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

Stream from a stream.

Throws:

java.io.IOException

Method Details

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<InternalHistogram.Bucket> getBuckets()

Specified by:

getBuckets in interface Histogram

Specified by:

getBuckets in interface MultiBucketsAggregation

Specified by:

getBuckets in class InternalMultiBucketAggregation<InternalHistogram,InternalHistogram.Bucket>

Returns:

The buckets of this aggregation.

create

public InternalHistogram create(java.util.List<InternalHistogram.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<InternalHistogram,InternalHistogram.Bucket>

Parameters:

buckets - the buckets to use in the new Aggregation

Returns:

the new Aggregation

createBucket

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

Parameters:

aggregations - the aggregations for the new bucket

prototype - the bucket to use as a prototype

Returns:

the new bucket

reduceBucket

protected InternalHistogram.Bucket reduceBucket(java.util.List<InternalHistogram.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<InternalHistogram,InternalHistogram.Bucket>

reduce

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

doXContentBody

public org.opensearch.common.xcontent.XContentBuilder doXContentBody(org.opensearch.common.xcontent.XContentBuilder builder, org.opensearch.common.xcontent.ToXContent.Params params) throws java.io.IOException

Specified by:

doXContentBody in class InternalAggregation

Throws:

java.io.IOException

getKey

public java.lang.Number getKey(MultiBucketsAggregation.Bucket bucket)

Description copied from interface: HistogramFactory

Get the key for the given bucket. Date histograms must return the number of millis since Epoch of the bucket key while numeric histograms must return the double value of the key.

Specified by:

getKey in interface HistogramFactory

nextKey

public java.lang.Number nextKey(java.lang.Number key)

Description copied from interface: HistogramFactory

Given a key returned by HistogramFactory.getKey(org.opensearch.search.aggregations.bucket.MultiBucketsAggregation.Bucket), compute the lowest key that is greater than it.

Specified by:

nextKey in interface HistogramFactory

createAggregation

public InternalAggregation createAggregation(java.util.List<MultiBucketsAggregation.Bucket> buckets)

Description copied from interface: HistogramFactory

Create an InternalAggregation object that wraps the given buckets.

Specified by:

createAggregation in interface HistogramFactory

createBucket

public InternalHistogram.Bucket createBucket(java.lang.Number key, long docCount, InternalAggregations aggregations)

Description copied from interface: HistogramFactory

Create a MultiBucketsAggregation.Bucket object that wraps the given key, document count and aggregations.

Specified by:

createBucket in interface HistogramFactory

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class InternalAggregation

hashCode

public int hashCode()

Overrides:

hashCode in class InternalAggregation