Module org.elasticsearch.server

Package org.elasticsearch.search.aggregations.metrics

Class Max

java.lang.Object

org.elasticsearch.search.aggregations.InternalAggregation

org.elasticsearch.search.aggregations.metrics.InternalNumericMetricsAggregation

org.elasticsearch.search.aggregations.metrics.InternalNumericMetricsAggregation.SingleValue

org.elasticsearch.search.aggregations.metrics.Max

All Implemented Interfaces:

NamedWriteable, Writeable, Aggregation, NumericMetricsAggregation, NumericMetricsAggregation.SingleValue, ToXContent, ToXContentFragment

public class Max
extends InternalNumericMetricsAggregation.SingleValue

Nested Class Summary

Nested classes/interfaces inherited from class org.elasticsearch.search.aggregations.metrics.InternalNumericMetricsAggregation

InternalNumericMetricsAggregation.MultiValue, InternalNumericMetricsAggregation.SingleValue

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

Aggregation.CommonFields

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

NumericMetricsAggregation.MultiValue, NumericMetricsAggregation.SingleValue

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 inherited from class org.elasticsearch.search.aggregations.metrics.InternalNumericMetricsAggregation

format

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, EMPTY_PARAMS

Constructor Summary

Constructors

Constructor	Description
Max(String name, double max, DocValueFormat formatter, Map<String,Object> metadata)
Max(StreamInput in)	Read from a stream.

Method Summary

Modifier and Type	Method	Description
boolean	canLeadReduction()	Return true if this aggregation can lead a reduction (ie, is not unmapped or empty).
static Max	createEmptyMax(String name, DocValueFormat formatter, Map<String,Object> metadata)
protected void	doWriteTo(StreamOutput out)
XContentBuilder	doXContentBody(XContentBuilder builder, ToXContent.Params params)
boolean	equals(Object obj)
InternalAggregation	finalizeSampling(SamplingContext samplingContext)	Called by the parent sampling context.
protected AggregatorReducer	getLeaderReducer(AggregationReduceContext reduceContext, int size)	Return an object that Reduces several aggregations to a single one.
String	getWriteableName()	Returns the name of the writeable object
int	hashCode()
double	value()

Methods inherited from class org.elasticsearch.search.aggregations.metrics.InternalNumericMetricsAggregation.SingleValue

getProperty, getValueAsString, sortValue

Methods inherited from class org.elasticsearch.search.aggregations.metrics.InternalNumericMetricsAggregation

mustReduceOnSingleInternalAgg, sortValue

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

copyWithRewritenBuckets, forEachBucket, getMetadata, getName, getProperty, getReducer, getType, readSize, reducePipelines, 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

Constructor Details

Max

public Max(String name,
 double max,
 DocValueFormat formatter,
 Map<String,Object> metadata)

Max

public Max(StreamInput in)
    throws IOException

Read from a stream.

Throws:

IOException

Method Details

createEmptyMax

public static Max createEmptyMax(String name,
 DocValueFormat formatter,
 Map<String,Object> metadata)

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

finalizeSampling

public InternalAggregation finalizeSampling(SamplingContext samplingContext)

Description copied from class: InternalAggregation

Called by the parent sampling context. Should only ever be called once as some aggregations scale their internal values

Overrides:

finalizeSampling in class InternalAggregation

Parameters:

samplingContext - the current sampling context

Returns:

new aggregation with the sampling context applied, could be the same aggregation instance if nothing needs to be done

value

public double value()

getLeaderReducer

protected AggregatorReducer getLeaderReducer(AggregationReduceContext reduceContext,
 int size)

Description copied from class: InternalAggregation

Return an object that Reduces several aggregations to a single one. This method is called when InternalAggregation.canLeadReduction() returns true and expects an reducer that produces the right result.

Specified by:

getLeaderReducer in class InternalAggregation

canLeadReduction

public boolean canLeadReduction()

Description copied from class: InternalAggregation

Return true if this aggregation can lead a reduction (ie, is not unmapped or empty). If this agg returns false, it should return itself if asked to lead a reduction.

Overrides:

canLeadReduction in class InternalAggregation

doXContentBody

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

Specified by:

doXContentBody in class InternalAggregation

Throws:

IOException

hashCode

public int hashCode()

Overrides:

hashCode in class InternalNumericMetricsAggregation

equals

public boolean equals(Object obj)

Overrides:

equals in class InternalNumericMetricsAggregation