Package org.elasticsearch.search.aggregations.bucket.nested

Class NestedAggregationBuilder

java.lang.Object

org.elasticsearch.search.aggregations.AggregationBuilder

org.elasticsearch.search.aggregations.AbstractAggregationBuilder<NestedAggregationBuilder>

org.elasticsearch.search.aggregations.bucket.nested.NestedAggregationBuilder

All Implemented Interfaces:

NamedWriteable, Writeable, Rewriteable<AggregationBuilder>, BaseAggregationBuilder, ToXContent, ToXContentFragment

public class NestedAggregationBuilder
extends AbstractAggregationBuilder<NestedAggregationBuilder>

Nested Class Summary

Nested classes/interfaces inherited from class org.elasticsearch.search.aggregations.AggregationBuilder

AggregationBuilder.BucketCardinality, AggregationBuilder.CommonFields

Nested classes/interfaces inherited from interface org.elasticsearch.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 final String	NAME

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

metadata

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

DEFAULT_PREALLOCATION, factoriesBuilder, name

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

MAX_REWRITE_ROUNDS

Fields inherited from interface org.elasticsearch.xcontent.ToXContent

EMPTY_PARAMS

Constructor Summary

Constructors

Modifier	Constructor	Description
	NestedAggregationBuilder(String name, String path)
	NestedAggregationBuilder(StreamInput in)	Read from a stream.
protected	NestedAggregationBuilder(NestedAggregationBuilder clone, AggregatorFactories.Builder factoriesBuilder, Map<String,Object> metadata)

Method Summary

Modifier and Type	Method	Description
AggregationBuilder.BucketCardinality	bucketCardinality()	A rough count of the number of buckets that Aggregators built by this builder will contain per owning parent bucket.
protected AggregatorFactory	doBuild(AggregationContext context, AggregatorFactory parent, AggregatorFactories.Builder subFactoriesBuilder)
protected void	doWriteTo(StreamOutput out)
boolean	equals(Object obj)
String	getType()	The name of the type of aggregation built by this builder.
int	hashCode()
protected XContentBuilder	internalXContent(XContentBuilder builder, ToXContent.Params params)
static NestedAggregationBuilder	parse(String aggregationName, XContentParser parser)
String	path()	Get the path to use for this nested aggregation.
protected AggregationBuilder	shallowCopy(AggregatorFactories.Builder factoriesBuilder, Map<String,Object> metadata)	Create a shallow copy of this builder and replacing AggregationBuilder.factoriesBuilder and metadata.

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

build, getMetadata, getWriteableName, setMetadata, subAggregation, subAggregation, subAggregations, toXContent, writeTo

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

buildPipelineTree, bytesToPreallocate, doRewrite, getName, getOutputFieldNames, getPipelineAggregations, getSubAggregations, isInSortOrderExecutionRequired, rewrite, toString, validateSequentiallyOrdered, validateSequentiallyOrderedWithoutGaps

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.elasticsearch.xcontent.ToXContentFragment

isFragment

Field Details

NAME

public static final String NAME

See Also:

• Constant Field Values

Constructor Details

NestedAggregationBuilder

public NestedAggregationBuilder(String name,
 String path)

Parameters:

name - the name of this aggregation

path - the path to use for this nested aggregation. The path must match the path to a nested object in the mappings.

NestedAggregationBuilder

protected NestedAggregationBuilder(NestedAggregationBuilder clone,
 AggregatorFactories.Builder factoriesBuilder,
 Map<String,Object> metadata)

NestedAggregationBuilder

public NestedAggregationBuilder(StreamInput in)
                         throws IOException

Read from a stream.

Throws:

IOException

Method Details

shallowCopy

protected AggregationBuilder shallowCopy(AggregatorFactories.Builder factoriesBuilder,
 Map<String,Object> metadata)

Description copied from class: AggregationBuilder

Create a shallow copy of this builder and replacing AggregationBuilder.factoriesBuilder and metadata. Used by AggregationBuilder.rewrite(QueryRewriteContext).

Specified by:

shallowCopy in class AggregationBuilder

doWriteTo

protected void doWriteTo(StreamOutput out)
                  throws IOException

Specified by:

doWriteTo in class AbstractAggregationBuilder<NestedAggregationBuilder>

Throws:

IOException

path

public String path()

Get the path to use for this nested aggregation.

bucketCardinality

public AggregationBuilder.BucketCardinality bucketCardinality()

Description copied from class: AggregationBuilder

A rough count of the number of buckets that Aggregators built by this builder will contain per owning parent bucket.

Specified by:

bucketCardinality in class AggregationBuilder

doBuild

protected AggregatorFactory doBuild(AggregationContext context,
 AggregatorFactory parent,
 AggregatorFactories.Builder subFactoriesBuilder)
                             throws IOException

Specified by:

doBuild in class AbstractAggregationBuilder<NestedAggregationBuilder>

Throws:

IOException

internalXContent

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

Specified by:

internalXContent in class AbstractAggregationBuilder<NestedAggregationBuilder>

Throws:

IOException

parse

public static NestedAggregationBuilder parse(String aggregationName,
 XContentParser parser)
                                      throws IOException

Throws:

IOException

hashCode

public int hashCode()

Overrides:

hashCode in class AbstractAggregationBuilder<NestedAggregationBuilder>

equals

public boolean equals(Object obj)

Overrides:

equals in class AbstractAggregationBuilder<NestedAggregationBuilder>

getType

public String getType()

Description copied from interface: BaseAggregationBuilder

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