Package org.elasticsearch.search.aggregations

Class PipelineAggregationBuilder

java.lang.Object

org.elasticsearch.search.aggregations.PipelineAggregationBuilder

All Implemented Interfaces:

NamedWriteable, Writeable, ToXContent, ToXContentFragment, BaseAggregationBuilder

Direct Known Subclasses:

AbstractPipelineAggregationBuilder

public abstract class PipelineAggregationBuilder
extends java.lang.Object
implements NamedWriteable, BaseAggregationBuilder, ToXContentFragment

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	PipelineAggregationBuilder.ValidationContext

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
protected java.lang.String[]	bucketsPaths
protected java.lang.String	name

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

EMPTY_PARAMS

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	PipelineAggregationBuilder(java.lang.String name, java.lang.String[] bucketsPaths)	Constructs a new pipeline aggregator factory.

Method Summary

Modifier and Type	Method	Description
protected abstract PipelineAggregator	create()	Creates the pipeline aggregator
java.lang.String[]	getBucketsPaths()	Return the consumed buckets paths.
java.lang.String	getName()	Return this aggregation's name.
abstract PipelineAggregationBuilder	setMetaData(java.util.Map<java.lang.String,java.lang.Object> metaData)	Associate metadata with this PipelineAggregationBuilder.
PipelineAggregationBuilder	subAggregations(AggregatorFactories.Builder subFactories)	Set the sub aggregations if this aggregation supports sub aggregations.
java.lang.String	toString()
protected abstract void	validate(PipelineAggregationBuilder.ValidationContext context)	Makes sure this builder is properly configured.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.elasticsearch.search.aggregations.BaseAggregationBuilder

getType

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

getWriteableName

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

toXContent

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

isFragment

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

writeTo

Field Details

name

protected final java.lang.String name

bucketsPaths

protected final java.lang.String[] bucketsPaths

Constructor Details

PipelineAggregationBuilder

protected PipelineAggregationBuilder(java.lang.String name, java.lang.String[] bucketsPaths)

Constructs a new pipeline aggregator factory.

Parameters:

name - The aggregation name

Method Details

getName

public java.lang.String getName()

Return this aggregation's name.

getBucketsPaths

public final java.lang.String[] getBucketsPaths()

Return the consumed buckets paths.

validate

protected abstract void validate(PipelineAggregationBuilder.ValidationContext context)

Makes sure this builder is properly configured.

create

protected abstract PipelineAggregator create()

Creates the pipeline aggregator

Returns:

The created aggregator

setMetaData

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

Associate metadata with this PipelineAggregationBuilder.

Specified by:

setMetaData in interface BaseAggregationBuilder

subAggregations

public PipelineAggregationBuilder subAggregations(AggregatorFactories.Builder subFactories)

Description copied from interface: BaseAggregationBuilder

Set the sub aggregations if this aggregation supports sub aggregations. Returns this for chaining.

Specified by:

subAggregations in interface BaseAggregationBuilder

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object