Package org.elasticsearch.search.aggregations.pipeline

Class AbstractPipelineAggregationBuilder<PAB extends AbstractPipelineAggregationBuilder<PAB>>

java.lang.Object

org.elasticsearch.search.aggregations.PipelineAggregationBuilder

org.elasticsearch.search.aggregations.pipeline.AbstractPipelineAggregationBuilder<PAB>

All Implemented Interfaces:

NamedWriteable, Writeable, ToXContent, ToXContentFragment, BaseAggregationBuilder

Direct Known Subclasses:

BucketMetricsPipelineAggregationBuilder, BucketScriptPipelineAggregationBuilder, BucketSelectorPipelineAggregationBuilder, BucketSortPipelineAggregationBuilder, CumulativeSumPipelineAggregationBuilder, DerivativePipelineAggregationBuilder, MovAvgPipelineAggregationBuilder, MovFnPipelineAggregationBuilder, SerialDiffPipelineAggregationBuilder

public abstract class AbstractPipelineAggregationBuilder<PAB extends AbstractPipelineAggregationBuilder<PAB>>
extends PipelineAggregationBuilder

Base implementation of a PipelineAggregationBuilder.

Nested Class Summary

Nested classes/interfaces inherited from interface org.elasticsearch.common.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
static ParseField	BUCKETS_PATH_FIELD	Field shared by many parsers.
protected Map<String,Object>	metaData
protected String	type

Fields inherited from class org.elasticsearch.search.aggregations.PipelineAggregationBuilder

bucketsPaths, name

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

EMPTY_PARAMS

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AbstractPipelineAggregationBuilder(String name, String type, String[] bucketsPaths)
protected	AbstractPipelineAggregationBuilder(StreamInput in, String type)	Read from a stream.

Method Summary

Modifier and Type	Method	Description
PipelineAggregator	create()	Creates the pipeline aggregator
protected abstract PipelineAggregator	createInternal(Map<String,Object> metaData)
void	doValidate(AggregatorFactory parent, Collection<AggregationBuilder> factories, Collection<PipelineAggregationBuilder> pipelineAggregatorFactories)
protected abstract void	doWriteTo(StreamOutput out)
boolean	equals(Object obj)
String	getType()	The name of the type of aggregation built by this builder.
int	hashCode()
protected abstract XContentBuilder	internalXContent(XContentBuilder builder, ToXContent.Params params)
protected boolean	overrideBucketsPath()
PAB	setMetaData(Map<String,Object> metaData)	Associate metadata with this PipelineAggregationBuilder.
XContentBuilder	toXContent(XContentBuilder builder, ToXContent.Params params)
String	type()
void	validate(AggregatorFactory parent, Collection<AggregationBuilder> factories, Collection<PipelineAggregationBuilder> pipelineAggregatorFactories)	Validates the state of this factory (makes sure the factory is properly configured)
static void	validateSequentiallyOrderedParentAggs(AggregatorFactory parent, String type, String name)	Validates pipeline aggregations that need sequentially ordered data.
void	writeTo(StreamOutput out)	Write this into the StreamOutput.

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

getBucketsPaths, getName, subAggregations, toString

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.common.xcontent.ToXContentFragment

isFragment

Field Detail

BUCKETS_PATH_FIELD

public static final ParseField BUCKETS_PATH_FIELD

Field shared by many parsers.

type

protected final String type

metaData

protected Map<String,Object> metaData

Constructor Detail

AbstractPipelineAggregationBuilder

protected AbstractPipelineAggregationBuilder(String name,
                                             String type,
                                             String[] bucketsPaths)

AbstractPipelineAggregationBuilder

protected AbstractPipelineAggregationBuilder(StreamInput in,
                                             String type)
                                      throws IOException

Read from a stream.

Throws:

IOException

Method Detail

writeTo

public void writeTo(StreamOutput out)
             throws IOException

Description copied from interface: Writeable

Write this into the StreamOutput.

Throws:

IOException

doWriteTo

protected abstract void doWriteTo(StreamOutput out)
                           throws IOException

Throws:

IOException

type

public String type()

validate

public final void validate(AggregatorFactory parent,
                           Collection<AggregationBuilder> factories,
                           Collection<PipelineAggregationBuilder> pipelineAggregatorFactories)

Validates the state of this factory (makes sure the factory is properly configured)

Specified by:

validate in class PipelineAggregationBuilder

createInternal

protected abstract PipelineAggregator createInternal(Map<String,Object> metaData)

create

public final PipelineAggregator create()

Creates the pipeline aggregator

Specified by:

create in class PipelineAggregationBuilder

Returns:

The created aggregator

doValidate

public void doValidate(AggregatorFactory parent,
                       Collection<AggregationBuilder> factories,
                       Collection<PipelineAggregationBuilder> pipelineAggregatorFactories)

validateSequentiallyOrderedParentAggs

public static void validateSequentiallyOrderedParentAggs(AggregatorFactory parent,
                                                         String type,
                                                         String name)

Validates pipeline aggregations that need sequentially ordered data.

setMetaData

public PAB setMetaData(Map<String,Object> metaData)

Description copied from class: PipelineAggregationBuilder

Associate metadata with this PipelineAggregationBuilder.

Specified by:

setMetaData in interface BaseAggregationBuilder

Specified by:

setMetaData in class PipelineAggregationBuilder

toXContent

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

Throws:

IOException

overrideBucketsPath

protected boolean overrideBucketsPath()

Returns:

true if the AbstractPipelineAggregationBuilder overrides the XContent rendering of the bucketPath option.

internalXContent

protected abstract XContentBuilder internalXContent(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

getType

public String getType()

Description copied from interface: BaseAggregationBuilder

The name of the type of aggregation built by this builder.