org.elasticsearch.search.aggregations

クラス InternalAggregation

java.lang.Object

org.elasticsearch.search.aggregations.InternalAggregation

すべての実装されたインタフェース:

Streamable, ToXContent, Aggregation

直系の既知のサブクラス:

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.

ネストされたクラスのサマリー

ネストされたクラス

修飾子とタイプ	クラスと説明
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

インタフェースから継承されたネストされたクラス/インタフェース org.elasticsearch.common.xcontent.ToXContent

ToXContent.DelegatingMapParams, ToXContent.MapParams, ToXContent.Params

フィールドのサマリー

フィールド

修飾子とタイプ	フィールドと説明
protected Map<String,Object>	metaData
protected String	name

インタフェースから継承されたフィールド org.elasticsearch.common.xcontent.ToXContent

EMPTY_PARAMS

コンストラクタのサマリー

コンストラクタ

修飾子	コンストラクタと説明
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.

メソッドのサマリー

修飾子とタイプ	メソッドと説明
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)

クラスから継承されたメソッド java.lang.Object

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

フィールドの詳細

name

protected String name

metaData

protected Map<String,Object> metaData

コンストラクタの詳細

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.

パラメータ:

name - The name of the get.

メソッドの詳細

getName

public String getName()

定義:

getName インタフェース内 Aggregation

戻り値:

The name of this aggregation.

type

public abstract InternalAggregation.Type type()

戻り値:

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)

インタフェースからコピーされた説明: Aggregation

Get the value of specified path in the aggregation.

定義:

getProperty インタフェース内 Aggregation

パラメータ:

path - the path to the property in the aggregation tree

戻り値:

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.

例外:

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.

例外:

IOException

getMetaData

public Map<String,Object> getMetaData()

インタフェースからコピーされた説明: Aggregation

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

定義:

getMetaData インタフェース内 Aggregation

pipelineAggregators

public List<PipelineAggregator> pipelineAggregators()

toXContent

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

定義:

toXContent インタフェース内 ToXContent

例外:

IOException

doXContentBody

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

例外:

IOException

writeTo

public final void writeTo(StreamOutput out)
                   throws IOException

定義:

writeTo インタフェース内 Streamable

例外:

IOException

doWriteTo

protected abstract void doWriteTo(StreamOutput out)
                           throws IOException

例外:

IOException

readFrom

public final void readFrom(StreamInput in)
                    throws IOException

定義:

readFrom インタフェース内 Streamable

例外:

IOException

doReadFrom

protected abstract void doReadFrom(StreamInput in)
                            throws IOException

例外:

IOException