Module org.elasticsearch.server

Package org.elasticsearch.search.aggregations.bucket.filter

Class InternalFilter

java.lang.Object

org.elasticsearch.search.aggregations.InternalAggregation

org.elasticsearch.search.aggregations.bucket.InternalSingleBucketAggregation

org.elasticsearch.search.aggregations.bucket.filter.InternalFilter

All Implemented Interfaces:

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

public class InternalFilter
extends InternalSingleBucketAggregation
implements Filter

Nested Class Summary

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, EMPTY_PARAMS

Constructor Summary

Constructors

Constructor	Description
InternalFilter(StreamInput in)	Stream from a stream.

Method Summary

Modifier and Type	Method	Description
InternalAggregation	finalizeSampling(SamplingContext samplingContext)	Called by the parent sampling context.
String	getWriteableName()	Returns the name of the writeable object
protected InternalSingleBucketAggregation	newAggregation(String name, long docCount, InternalAggregations subAggregations)	Create a new empty sub aggregation.

Methods inherited from class org.elasticsearch.search.aggregations.bucket.InternalSingleBucketAggregation

copyWithRewritenBuckets, create, doWriteTo, doXContentBody, equals, forEachBucket, getAggregations, getDocCount, getLeaderReducer, getProperty, hashCode, mustReduceOnSingleInternalAgg, reducePipelines, sortValue, sortValue

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

canLeadReduction, getMetadata, getName, getProperty, getReducer, getType, 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.search.aggregations.bucket.SingleBucketAggregation

getAggregations, getDocCount

Methods inherited from interface org.elasticsearch.xcontent.ToXContent

toXContent

Methods inherited from interface org.elasticsearch.xcontent.ToXContentFragment

isFragment

Constructor Details

InternalFilter

public InternalFilter(StreamInput in)
               throws IOException

Stream from a stream.

Throws:

IOException

Method Details

getWriteableName

public String getWriteableName()

Description copied from interface: NamedWriteable

Returns the name of the writeable object

Specified by:

getWriteableName in interface NamedWriteable

newAggregation

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

Description copied from class: InternalSingleBucketAggregation

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

Specified by:

newAggregation in class InternalSingleBucketAggregation

finalizeSampling

public InternalAggregation finalizeSampling(SamplingContext samplingContext)

Description copied from class: InternalAggregation

Called by the parent sampling context. Should only ever be called once as some aggregations scale their internal values

Overrides:

finalizeSampling in class InternalAggregation

Parameters:

samplingContext - the current sampling context

Returns:

new aggregation with the sampling context applied, could be the same aggregation instance if nothing needs to be done