Package org.elasticsearch.search.aggregations

Class InternalAggregation

java.lang.Object

org.elasticsearch.search.aggregations.InternalAggregation

All Implemented Interfaces:

NamedWriteable, Writeable, Aggregation, ToXContent, ToXContentFragment

Direct Known Subclasses:

InternalGeoBounds, InternalGeoCentroid, InternalMultiBucketAggregation, InternalMultiValueAggregation, InternalNumericMetricsAggregation, InternalScriptedMetric, InternalSingleBucketAggregation, InternalTopHits

public abstract class InternalAggregation
extends Object
implements Aggregation, NamedWriteable

An internal implementation of Aggregation. Serves as a base class for all aggregation implementations.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	InternalAggregation.ReduceContext
static interface	InternalAggregation.ReduceContextBuilder	Builds InternalAggregation.ReduceContext.

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 Map<String,Object>	metadata
protected final String	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

Modifier	Constructor	Description
protected	InternalAggregation(String name, Map<String,Object> metadata)	Constructs an aggregation result with a given name.
protected	InternalAggregation(StreamInput in)	Read from a stream.

Method Summary

Modifier and Type	Method	Description
InternalAggregation	copyWithRewritenBuckets(Function<InternalAggregations,InternalAggregations> rewriter)	Rewrite the sub-aggregations in the buckets in this aggregation.
protected abstract void	doWriteTo(StreamOutput out)
abstract XContentBuilder	doXContentBody(XContentBuilder builder, ToXContent.Params params)
boolean	equals(Object obj)
void	forEachBucket(Consumer<InternalAggregations> consumer)	Run a Consumer over all buckets in this aggregation.
Map<String,Object>	getMetadata()	Get the optional byte array metadata that was set on the aggregation
String	getName()
Object	getProperty(String path)	Get the value of specified path in the aggregation.
abstract Object	getProperty(List<String> path)
String	getType()
int	hashCode()
boolean	isMapped()	Return true if this aggregation is mapped, and can lead a reduction.
final void	mergePipelineTreeForBWCSerialization(PipelineAggregator.PipelineTree pipelineTree)	Merge a PipelineAggregator.PipelineTree into this aggregation result tree before serializing to a node older than 7.8.0.
protected abstract boolean	mustReduceOnSingleInternalAgg()	Signal the framework if the reduce(List, ReduceContext) phase needs to be called when there is only one InternalAggregation.
List<PipelineAggregator>	pipelineAggregatorsForBwcSerialization()	Deprecated. only use these for serializing to older Elasticsearch versions
protected static int	readSize(StreamInput in)	Read a size under the assumption that a value of 0 means unlimited.
abstract InternalAggregation	reduce(List<InternalAggregation> aggregations, InternalAggregation.ReduceContext reduceContext)	Reduces the given aggregations to a single one and returns it.
InternalAggregation	reducePipelines(InternalAggregation reducedAggs, InternalAggregation.ReduceContext reduceContext, PipelineAggregator.PipelineTree pipelinesForThisAgg)	Creates the output from all pipeline aggs that this aggregation is associated with.
double	sortValue(String key)	Get value to use when sorting by this aggregation.
double	sortValue(AggregationPath.PathElement head, Iterator<AggregationPath.PathElement> tail)	Get value to use when sorting by a descendant of this aggregation.
String	toString()
final XContentBuilder	toXContent(XContentBuilder builder, ToXContent.Params params)
protected static void	writeSize(int size, StreamOutput out)	Write a size under the assumption that a value of 0 means unlimited.
final void	writeTo(StreamOutput out)	Write this into the StreamOutput.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.elasticsearch.common.io.stream.NamedWriteable

getWriteableName

Methods inherited from interface org.elasticsearch.xcontent.ToXContentFragment

isFragment

Field Details

name

protected final String name

metadata

protected final Map<String,Object> metadata

Constructor Details

InternalAggregation

protected InternalAggregation(String name,
 Map<String,Object> metadata)

Constructs an aggregation result with a given name.

Parameters:

name - The name of the aggregation.

InternalAggregation

protected InternalAggregation(StreamInput in)
                       throws IOException

Read from a stream.

Throws:

IOException

Method Details

mergePipelineTreeForBWCSerialization

public final void mergePipelineTreeForBWCSerialization(PipelineAggregator.PipelineTree pipelineTree)

Merge a PipelineAggregator.PipelineTree into this aggregation result tree before serializing to a node older than 7.8.0.

writeTo

public final void writeTo(StreamOutput out)
                   throws IOException

Description copied from interface: Writeable

Write this into the StreamOutput.

Specified by:

writeTo in interface Writeable

Throws:

IOException

doWriteTo

protected abstract void doWriteTo(StreamOutput out)
                           throws IOException

Throws:

IOException

getName

public String getName()

Specified by:

getName in interface Aggregation

Returns:

The name of this aggregation.

copyWithRewritenBuckets

public InternalAggregation copyWithRewritenBuckets(Function<InternalAggregations,InternalAggregations> rewriter)

Rewrite the sub-aggregations in the buckets in this aggregation. Returns a copy of this InternalAggregation with the rewritten buckets, or, if there aren't any modifications to the buckets then this method will return this aggregation. Either way, it doesn't modify this aggregation.

Implementers of this should call the rewriter once per bucket with its InternalAggregations. The rewriter should return null if it doen't have any rewriting to do or it should return a new InternalAggregations to make changs.

The default implementation throws an exception because most aggregations don't have buckets in them. It should be overridden by aggregations that contain buckets. Implementers should respect the description above.

forEachBucket

public void forEachBucket(Consumer<InternalAggregations> consumer)

Run a Consumer over all buckets in this aggregation.

reducePipelines

public InternalAggregation reducePipelines(InternalAggregation reducedAggs,
 InternalAggregation.ReduceContext reduceContext,
 PipelineAggregator.PipelineTree pipelinesForThisAgg)

Creates the output from all pipeline aggs that this aggregation is associated with. Should only be called after all aggregations have been fully reduced

reduce

public abstract InternalAggregation reduce(List<InternalAggregation> aggregations,
 InternalAggregation.ReduceContext reduceContext)

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.

See Also:

• mustReduceOnSingleInternalAgg()

mustReduceOnSingleInternalAgg

protected abstract boolean mustReduceOnSingleInternalAgg()

Signal the framework if the reduce(List, ReduceContext) phase needs to be called when there is only one InternalAggregation.

isMapped

public boolean isMapped()

Return true if this aggregation is mapped, and can lead a reduction. If this agg returns false, it should return itself if asked to lead a reduction

getProperty

public Object getProperty(String path)

Get the value of specified path in the aggregation.

Parameters:

path - the path to the property in the aggregation tree

Returns:

the value of the property

getProperty

public abstract Object getProperty(List<String> path)

readSize

protected static int readSize(StreamInput in)
                       throws IOException

Read a size under the assumption that a value of 0 means unlimited.

Throws:

IOException

writeSize

protected static void writeSize(int size,
 StreamOutput out)
                         throws IOException

Write a size under the assumption that a value of 0 means unlimited.

Throws:

IOException

getMetadata

public Map<String,Object> getMetadata()

Description copied from interface: Aggregation

Get the optional byte array metadata that was set on the aggregation

Specified by:

getMetadata in interface Aggregation

pipelineAggregatorsForBwcSerialization

@Deprecated
public List<PipelineAggregator> pipelineAggregatorsForBwcSerialization()

Deprecated.

only use these for serializing to older Elasticsearch versions

The PipelineAggregators sent to older versions of Elasticsearch.

getType

public String getType()

Specified by:

getType in interface Aggregation

Returns:

a string representing the type of the aggregation. This type is added to the aggregation name in the response, so that it can later be used by clients to determine type of the aggregation and parse it into the proper object.

toXContent

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

Specified by:

toXContent in interface ToXContent

Throws:

IOException

doXContentBody

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

Throws:

IOException

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object

sortValue

public double sortValue(String key)

Get value to use when sorting by this aggregation.

sortValue

public double sortValue(AggregationPath.PathElement head,
 Iterator<AggregationPath.PathElement> tail)

Get value to use when sorting by a descendant of this aggregation.