org.elasticsearch.search.aggregations

Class InternalAggregation

java.lang.Object

org.elasticsearch.search.aggregations.InternalAggregation

All Implemented Interfaces:

Streamable, ToXContent, Aggregation

Direct Known Subclasses:

InternalMetricsAggregation, InternalMultiBucketAggregation, InternalSingleBucketAggregation

public abstract class InternalAggregation
extends Object
implements Aggregation, ToXContent, Streamable

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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	InternalAggregation.CommonFields Common xcontent fields that are shared among addAggregation
static class	InternalAggregation.ReduceContext
static class	InternalAggregation.Type The aggregation type that holds all the string types that are associated with an aggregation: name - used as the parser type stream - used as the stream type

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

ToXContent.DelegatingMapParams, ToXContent.MapParams, ToXContent.Params

Field Summary

Fields

Modifier and Type	Field and Description
protected Map<String,Object>	metaData
protected String	name

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

EMPTY_PARAMS

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	InternalAggregation() Constructs an un initialized addAggregation (used for serialization)
protected	InternalAggregation(String name, List<PipelineAggregator> pipelineAggregators, Map<String,Object> metaData) Constructs an get with a given name.

Method Summary

Methods

Modifier and Type	Method and Description
protected abstract void	doReadFrom(StreamInput in)
abstract InternalAggregation	doReduce(List<InternalAggregation> aggregations, InternalAggregation.ReduceContext reduceContext)
protected abstract void	doWriteTo(StreamOutput out)
abstract XContentBuilder	doXContentBody(XContentBuilder builder, ToXContent.Params params)
Map<String,Object>	getMetaData() Get the optional byte array metadata that was set on the aggregation
String	getName()
abstract Object	getProperty(List<String> path)
Object	getProperty(String path) Get the value of specified path in the aggregation.
List<PipelineAggregator>	pipelineAggregators()
void	readFrom(StreamInput in)
protected static int	readSize(StreamInput in) Read a size under the assumption that a value of 0 means unlimited.
InternalAggregation	reduce(List<InternalAggregation> aggregations, InternalAggregation.ReduceContext reduceContext) Reduces the given addAggregation to a single one and returns it.
XContentBuilder	toXContent(XContentBuilder builder, ToXContent.Params params)
abstract InternalAggregation.Type	type()
protected static void	writeSize(int size, StreamOutput out) Write a size under the assumption that a value of 0 means unlimited.
void	writeTo(StreamOutput out)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

name

protected String name

metaData

protected Map<String,Object> metaData

Constructor Detail

InternalAggregation

protected InternalAggregation()

Constructs an un initialized addAggregation (used for serialization)

InternalAggregation

protected InternalAggregation(String name,
                   List<PipelineAggregator> pipelineAggregators,
                   Map<String,Object> metaData)

Constructs an get with a given name.

Parameters:

name - The name of the get.

Method Detail

getName

public String getName()

Specified by:

getName in interface Aggregation

Returns:

The name of this aggregation.

type

public abstract InternalAggregation.Type type()

Returns:

The InternalAggregation.Type of this aggregation

reduce

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

Reduces the given addAggregation to a single one and returns it. In most cases, the assumption will be the all given addAggregation are of the same type (the same type as this aggregation). For best efficiency, when implementing, try reusing an existing get instance (typically the first in the given list) to save on redundant object construction.

doReduce

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

getProperty

public Object getProperty(String path)

Description copied from interface: Aggregation

Get the value of specified path in the aggregation.

Specified by:

getProperty in interface 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

pipelineAggregators

public List<PipelineAggregator> pipelineAggregators()

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

writeTo

public final void writeTo(StreamOutput out)
                   throws IOException

Specified by:

writeTo in interface Streamable

Throws:

IOException

doWriteTo

protected abstract void doWriteTo(StreamOutput out)
                           throws IOException

Throws:

IOException

readFrom

public final void readFrom(StreamInput in)
                    throws IOException

Specified by:

readFrom in interface Streamable

Throws:

IOException

doReadFrom

protected abstract void doReadFrom(StreamInput in)
                            throws IOException

Throws:

IOException