org.elasticsearch.search.aggregations.pipeline

Class PipelineAggregatorBuilder<PAB extends PipelineAggregatorBuilder<PAB>>

java.lang.Object

org.elasticsearch.action.support.ToXContentToBytes

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

All Implemented Interfaces:

NamedWriteable<PipelineAggregatorBuilder<PAB>>, StreamableReader<PipelineAggregatorBuilder<PAB>>, Writeable<PipelineAggregatorBuilder<PAB>>, ToXContent

Direct Known Subclasses:

BucketMetricsPipelineAggregatorBuilder, BucketScriptPipelineAggregatorBuilder, BucketSelectorPipelineAggregatorBuilder, CumulativeSumPipelineAggregatorBuilder, DerivativePipelineAggregatorBuilder, MovAvgPipelineAggregatorBuilder, SerialDiffPipelineAggregatorBuilder

public abstract class PipelineAggregatorBuilder<PAB extends PipelineAggregatorBuilder<PAB>>
extends ToXContentToBytes
implements NamedWriteable<PipelineAggregatorBuilder<PAB>>, ToXContent

A factory that knows how to create an PipelineAggregator of a specific type.

Nested Class Summary

Nested classes/interfaces inherited from interface org.elasticsearch.common.io.stream.Writeable

Writeable.Reader<R>

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 java.lang.String[]	bucketsPaths
protected java.util.Map<java.lang.String,java.lang.Object>	metaData
protected java.lang.String	name
protected java.lang.String	type

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

EMPTY_PARAMS

Constructor Summary

Constructors

Constructor and Description
PipelineAggregatorBuilder(java.lang.String name, java.lang.String type, java.lang.String[] bucketsPaths) Constructs a new pipeline aggregator factory.

Method Summary

Modifier and Type	Method and Description
PipelineAggregator	create() Creates the pipeline aggregator
protected abstract PipelineAggregator	createInternal(java.util.Map<java.lang.String,java.lang.Object> metaData)
protected abstract boolean	doEquals(java.lang.Object obj)
protected abstract int	doHashCode()
protected abstract PipelineAggregatorBuilder<PAB>	doReadFrom(java.lang.String name, java.lang.String[] bucketsPaths, StreamInput in)
void	doValidate(AggregatorFactory<?> parent, AggregatorFactory<?>[] factories, java.util.List<PipelineAggregatorBuilder<?>> pipelineAggregatorFactories)
protected abstract void	doWriteTo(StreamOutput out)
boolean	equals(java.lang.Object obj)
java.lang.String[]	getBucketsPaths()
java.lang.String	getName()
java.lang.String	getWriteableName() Returns the name of the writeable object
int	hashCode()
protected abstract XContentBuilder	internalXContent(XContentBuilder builder, ToXContent.Params params)
java.lang.String	name()
protected boolean	overrideBucketsPath()
PipelineAggregatorBuilder<PAB>	readFrom(StreamInput in) Reads an object of this type from the provided StreamInput.
PAB	setMetaData(java.util.Map<java.lang.String,java.lang.Object> metaData)
XContentBuilder	toXContent(XContentBuilder builder, ToXContent.Params params)
java.lang.String	type()
void	validate(AggregatorFactory<?> parent, AggregatorFactory<?>[] factories, java.util.List<PipelineAggregatorBuilder<?>> pipelineAggregatorFactories) Validates the state of this factory (makes sure the factory is properly configured)
void	writeTo(StreamOutput out) Write this into the StreamOutput.

Methods inherited from class org.elasticsearch.action.support.ToXContentToBytes

buildAsBytes, buildAsBytes, toString

Methods inherited from class java.lang.Object

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

Field Detail

name

protected java.lang.String name

type

protected java.lang.String type

bucketsPaths

protected java.lang.String[] bucketsPaths

metaData

protected java.util.Map<java.lang.String,java.lang.Object> metaData

Constructor Detail

PipelineAggregatorBuilder

public PipelineAggregatorBuilder(java.lang.String name,
                                 java.lang.String type,
                                 java.lang.String[] bucketsPaths)

Constructs a new pipeline aggregator factory.

Parameters:

name - The aggregation name

type - The aggregation type

Method Detail

name

public java.lang.String name()

type

public java.lang.String type()

validate

public final void validate(AggregatorFactory<?> parent,
                           AggregatorFactory<?>[] factories,
                           java.util.List<PipelineAggregatorBuilder<?>> pipelineAggregatorFactories)

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

createInternal

protected abstract PipelineAggregator createInternal(java.util.Map<java.lang.String,java.lang.Object> metaData)
                                              throws java.io.IOException

Throws:

java.io.IOException

create

public final PipelineAggregator create()
                                throws java.io.IOException

Creates the pipeline aggregator

Returns:

The created aggregator

Throws:

java.io.IOException

doValidate

public void doValidate(AggregatorFactory<?> parent,
                       AggregatorFactory<?>[] factories,
                       java.util.List<PipelineAggregatorBuilder<?>> pipelineAggregatorFactories)

setMetaData

public PAB setMetaData(java.util.Map<java.lang.String,java.lang.Object> metaData)

getName

public java.lang.String getName()

getBucketsPaths

public java.lang.String[] getBucketsPaths()

writeTo

public void writeTo(StreamOutput out)
             throws java.io.IOException

Description copied from interface: Writeable

Write this into the StreamOutput.

Specified by:

writeTo in interface Writeable<PipelineAggregatorBuilder<PAB extends PipelineAggregatorBuilder<PAB>>>

Throws:

java.io.IOException

doWriteTo

protected abstract void doWriteTo(StreamOutput out)
                           throws java.io.IOException

Throws:

java.io.IOException

getWriteableName

public java.lang.String getWriteableName()

Description copied from interface: NamedWriteable

Returns the name of the writeable object

Specified by:

getWriteableName in interface NamedWriteable<PipelineAggregatorBuilder<PAB extends PipelineAggregatorBuilder<PAB>>>

readFrom

public PipelineAggregatorBuilder<PAB> readFrom(StreamInput in)
                                        throws java.io.IOException

Description copied from interface: StreamableReader

Reads an object of this type from the provided StreamInput. The receiving instance remains unchanged.

Specified by:

readFrom in interface StreamableReader<PipelineAggregatorBuilder<PAB extends PipelineAggregatorBuilder<PAB>>>

Specified by:

readFrom in interface Writeable<PipelineAggregatorBuilder<PAB extends PipelineAggregatorBuilder<PAB>>>

Throws:

java.io.IOException

doReadFrom

protected abstract PipelineAggregatorBuilder<PAB> doReadFrom(java.lang.String name,
                                                             java.lang.String[] bucketsPaths,
                                                             StreamInput in)
                                                      throws java.io.IOException

Throws:

java.io.IOException

toXContent

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

Specified by:

toXContent in interface ToXContent

Throws:

java.io.IOException

overrideBucketsPath

protected boolean overrideBucketsPath()

Returns:

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

internalXContent

protected abstract XContentBuilder internalXContent(XContentBuilder builder,
                                                    ToXContent.Params params)
                                             throws java.io.IOException

Throws:

java.io.IOException

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

doHashCode

protected abstract int doHashCode()

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

doEquals

protected abstract boolean doEquals(java.lang.Object obj)