Package org.elasticsearch.search.aggregations.pipeline

Class AbstractPipelineAggregationBuilder<PAB extends AbstractPipelineAggregationBuilder<PAB>>

org.elasticsearch.search.aggregations.PipelineAggregationBuilder

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

All Implemented Interfaces:

NamedWriteable, Writeable, org.elasticsearch.common.xcontent.ToXContent, org.elasticsearch.common.xcontent.ToXContentFragment, Rewriteable<PipelineAggregationBuilder>, 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 class org.elasticsearch.search.aggregations.PipelineAggregationBuilder

PipelineAggregationBuilder.ValidationContext

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

org.elasticsearch.common.xcontent.ToXContent.DelegatingMapParams, org.elasticsearch.common.xcontent.ToXContent.MapParams, org.elasticsearch.common.xcontent.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 org.elasticsearch.common.xcontent.ParseField	BUCKETS_PATH_FIELD	Field shared by many parsers.
protected <,>	metadata
protected	type

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

bucketsPaths, name

Fields inherited from interface org.elasticsearch.index.query.Rewriteable

MAX_REWRITE_ROUNDS

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

EMPTY_PARAMS

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
PipelineAggregator	create()	Creates the pipeline aggregator
protected abstract PipelineAggregator	<,> metadata)
protected abstract void	doWriteTo(StreamOutput out)
boolean	obj)
	getType()	The name of the type of aggregation built by this builder.
int	hashCode()
protected abstract org.elasticsearch.common.xcontent.XContentBuilder	internalXContent(org.elasticsearch.common.xcontent.XContentBuilder builder, org.elasticsearch.common.xcontent.ToXContent.Params params)
protected boolean	overrideBucketsPath()
PAB	<,> metadata)	Associate metadata with this PipelineAggregationBuilder.
org.elasticsearch.common.xcontent.XContentBuilder	toXContent(org.elasticsearch.common.xcontent.XContentBuilder builder, org.elasticsearch.common.xcontent.ToXContent.Params params)
	type()
void	writeTo(StreamOutput out)	Write this into the StreamOutput.

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

getBucketsPaths, getName, rewrite, subAggregations, toString, validate

Methods inherited from class java.lang.

, , , , , , ,

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

getWriteableName

Methods inherited from interface org.elasticsearch.common.xcontent.ToXContentFragment

isFragment

Field Details

BUCKETS_PATH_FIELD

public static final org.elasticsearch.common.xcontent.ParseField BUCKETS_PATH_FIELD

Field shared by many parsers.

type

protected final  type

metadata

protected <,> metadata

Constructor Details

AbstractPipelineAggregationBuilder

protected AbstractPipelineAggregationBuilder( name,
  type,
 [] bucketsPaths)

AbstractPipelineAggregationBuilder

protected AbstractPipelineAggregationBuilder(StreamInput in,
  type)
                                      throws 

Read from a stream.

Throws:

Method Details

writeTo

public void writeTo(StreamOutput out)
             throws 

Description copied from interface: Writeable

Write this into the StreamOutput.

Throws:

doWriteTo

protected abstract void doWriteTo(StreamOutput out)
                           throws 

Throws:

type

public  type()

createInternal

protected abstract <,> metadata)

create

public final PipelineAggregator create()

Creates the pipeline aggregator

Specified by:

create in class PipelineAggregationBuilder

Returns:

The created aggregator

setMetadata

public <,> 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 org.elasticsearch.common.xcontent.XContentBuilder toXContent(org.elasticsearch.common.xcontent.XContentBuilder builder,
 org.elasticsearch.common.xcontent.ToXContent.Params params)
                                                                   throws 

Throws:

overrideBucketsPath

protected boolean overrideBucketsPath()

Returns:

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

internalXContent

protected abstract org.elasticsearch.common.xcontent.XContentBuilder internalXContent(org.elasticsearch.common.xcontent.XContentBuilder builder,
 org.elasticsearch.common.xcontent.ToXContent.Params params)
                                                                               throws 

Throws:

hashCode

public int hashCode()

Overrides:

in class

equals

public boolean equals( obj)

Overrides:

in class

getType

public  getType()

Description copied from interface: BaseAggregationBuilder

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