Package org.elasticsearch.search.aggregations.bucket

Class InternalSingleBucketAggregation

java.lang.Object

org.elasticsearch.search.aggregations.InternalAggregation

org.elasticsearch.search.aggregations.bucket.InternalSingleBucketAggregation

All Implemented Interfaces:

NamedWriteable, Writeable, Aggregation, SingleBucketAggregation, HasAggregations, ToXContent, ToXContentFragment

Direct Known Subclasses:

InternalFilter, InternalGlobal, InternalMissing, InternalNested, InternalReverseNested, InternalSampler

public abstract class InternalSingleBucketAggregation
extends InternalAggregation
implements SingleBucketAggregation

A base class for all the single bucket aggregations.

Nested Class Summary

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

InternalAggregation.ReduceContext, InternalAggregation.ReduceContextBuilder

Nested classes/interfaces inherited from interface org.elasticsearch.search.aggregations.Aggregation

Aggregation.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 inherited from class org.elasticsearch.search.aggregations.InternalAggregation

metadata, name

Fields inherited from interface org.elasticsearch.search.aggregations.Aggregation

TYPED_KEYS_DELIMITER

Fields inherited from interface org.elasticsearch.xcontent.ToXContent

EMPTY_PARAMS

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	InternalSingleBucketAggregation(String name, long docCount, InternalAggregations aggregations, Map<String,Object> metadata)	Creates a single bucket aggregation.
protected	InternalSingleBucketAggregation(StreamInput in)	Read from a stream.

Method Summary

Modifier and Type	Method	Description
InternalAggregation	copyWithRewritenBuckets(Function<InternalAggregations,InternalAggregations> rewriter)	Rewrite the sub-aggregations in the buckets in this aggregation.
InternalSingleBucketAggregation	create(InternalAggregations subAggregations)	Create a new copy of this Aggregation with the same settings as this Aggregation and contains the provided sub-aggregations.
protected void	doWriteTo(StreamOutput out)
XContentBuilder	doXContentBody(XContentBuilder builder, ToXContent.Params params)
boolean	equals(Object obj)
void	forEachBucket(Consumer<InternalAggregations> consumer)	Run a Consumer over all buckets in this aggregation.
InternalAggregations	getAggregations()
long	getDocCount()
Object	getProperty(List<String> path)
int	hashCode()
protected boolean	mustReduceOnSingleInternalAgg()	Signal the framework if the InternalAggregation.reduce(List, ReduceContext) phase needs to be called when there is only one InternalAggregation.
protected abstract InternalSingleBucketAggregation	newAggregation(String name, long docCount, InternalAggregations subAggregations)	Create a new empty sub aggregation.
InternalAggregation	reduce(List<InternalAggregation> aggregations, InternalAggregation.ReduceContext reduceContext)	Reduces the given aggregations to a single one and returns it.
final InternalAggregation	reducePipelines(InternalAggregation reducedAggs, InternalAggregation.ReduceContext reduceContext, PipelineAggregator.PipelineTree pipelineTree)	Amulti-bucket agg needs to first reduce the buckets and *their* pipelines before allowing sibling pipelines to materialize.
final double	sortValue(String key)	Get value to use when sorting by this aggregation.
final double	sortValue(AggregationPath.PathElement head, Iterator<AggregationPath.PathElement> tail)	Get value to use when sorting by a descendant of this aggregation.

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

getMetadata, getName, getProperty, getType, isMapped, mergePipelineTreeForBWCSerialization, pipelineAggregatorsForBwcSerialization, readSize, toString, toXContent, writeSize, writeTo

Methods inherited from class java.lang.Object

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

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

getMetadata, getName, getType

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

getWriteableName

Methods inherited from interface org.elasticsearch.xcontent.ToXContent

toXContent

Methods inherited from interface org.elasticsearch.xcontent.ToXContentFragment

isFragment

Constructor Details

InternalSingleBucketAggregation

protected InternalSingleBucketAggregation(String name,
 long docCount,
 InternalAggregations aggregations,
 Map<String,Object> metadata)

Creates a single bucket aggregation.

Parameters:

name - The aggregation name.

docCount - The document count in the single bucket.

aggregations - The already built sub-aggregations that are associated with the bucket.

InternalSingleBucketAggregation

protected InternalSingleBucketAggregation(StreamInput in)
                                   throws IOException

Read from a stream.

Throws:

IOException

Method Details

doWriteTo

protected void doWriteTo(StreamOutput out)
                  throws IOException

Specified by:

doWriteTo in class InternalAggregation

Throws:

IOException

getDocCount

public long getDocCount()

Specified by:

getDocCount in interface SingleBucketAggregation

Returns:

The number of documents in this bucket

getAggregations

public InternalAggregations getAggregations()

Specified by:

getAggregations in interface HasAggregations

Specified by:

getAggregations in interface SingleBucketAggregation

Returns:

The sub-aggregations of this bucket

create

public InternalSingleBucketAggregation create(InternalAggregations subAggregations)

Create a new copy of this Aggregation with the same settings as this Aggregation and contains the provided sub-aggregations.

Parameters:

subAggregations - the buckets to use in the new Aggregation

Returns:

the new Aggregation

newAggregation

protected abstract InternalSingleBucketAggregation newAggregation(String name,
 long docCount,
 InternalAggregations subAggregations)

Create a new empty sub aggregation. This must be a new instance on each call.

reduce

public InternalAggregation reduce(List<InternalAggregation> aggregations,
 InternalAggregation.ReduceContext reduceContext)

Description copied from class: InternalAggregation

Reduces the given aggregations to a single one and returns it. In most cases, the assumption will be the all given aggregations are of the same type (the same type as this aggregation). For best efficiency, when implementing, try reusing an existing instance (typically the first in the given list) to save on redundant object construction.

Specified by:

reduce in class InternalAggregation

See Also:

• InternalAggregation.mustReduceOnSingleInternalAgg()

reducePipelines

public final InternalAggregation reducePipelines(InternalAggregation reducedAggs,
 InternalAggregation.ReduceContext reduceContext,
 PipelineAggregator.PipelineTree pipelineTree)

Amulti-bucket agg needs to first reduce the buckets and *their* pipelines before allowing sibling pipelines to materialize.

Overrides:

reducePipelines in class InternalAggregation

getProperty

public Object getProperty(List<String> path)

Specified by:

getProperty in class InternalAggregation

doXContentBody

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

Specified by:

doXContentBody in class InternalAggregation

Throws:

IOException

sortValue

public final double sortValue(String key)

Description copied from class: InternalAggregation

Get value to use when sorting by this aggregation.

Overrides:

sortValue in class InternalAggregation

sortValue

public final double sortValue(AggregationPath.PathElement head,
 Iterator<AggregationPath.PathElement> tail)

Description copied from class: InternalAggregation

Get value to use when sorting by a descendant of this aggregation.

Overrides:

sortValue in class InternalAggregation

mustReduceOnSingleInternalAgg

protected boolean mustReduceOnSingleInternalAgg()

Description copied from class: InternalAggregation

Signal the framework if the InternalAggregation.reduce(List, ReduceContext) phase needs to be called when there is only one InternalAggregation.

Specified by:

mustReduceOnSingleInternalAgg in class InternalAggregation

copyWithRewritenBuckets

public InternalAggregation copyWithRewritenBuckets(Function<InternalAggregations,InternalAggregations> rewriter)

Description copied from class: InternalAggregation

Rewrite the sub-aggregations in the buckets in this aggregation. Returns a copy of this InternalAggregation with the rewritten buckets, or, if there aren't any modifications to the buckets then this method will return this aggregation. Either way, it doesn't modify this aggregation.

Implementers of this should call the rewriter once per bucket with its InternalAggregations. The rewriter should return null if it doen't have any rewriting to do or it should return a new InternalAggregations to make changs.

The default implementation throws an exception because most aggregations don't have buckets in them. It should be overridden by aggregations that contain buckets. Implementers should respect the description above.

Overrides:

copyWithRewritenBuckets in class InternalAggregation

forEachBucket

public void forEachBucket(Consumer<InternalAggregations> consumer)

Description copied from class: InternalAggregation

Run a Consumer over all buckets in this aggregation.

Overrides:

forEachBucket in class InternalAggregation

equals

public boolean equals(Object obj)

Overrides:

equals in class InternalAggregation

hashCode

public int hashCode()

Overrides:

hashCode in class InternalAggregation