Package org.elasticsearch.search.aggregations.bucket.significant

Class SignificantTermsAggregationBuilder

java.lang.Object

org.elasticsearch.search.aggregations.AggregationBuilder

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

org.elasticsearch.search.aggregations.support.ValuesSourceAggregationBuilder<ValuesSource,SignificantTermsAggregationBuilder>

org.elasticsearch.search.aggregations.bucket.significant.SignificantTermsAggregationBuilder

All Implemented Interfaces:

NamedWriteable, Writeable, ToXContent, ToXContentFragment, BaseAggregationBuilder, MultiBucketAggregationBuilder

public class SignificantTermsAggregationBuilder
extends ValuesSourceAggregationBuilder<ValuesSource,SignificantTermsAggregationBuilder>
implements MultiBucketAggregationBuilder

Nested Class Summary

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

ValuesSourceAggregationBuilder.LeafOnly<VS extends ValuesSource,AB extends ValuesSourceAggregationBuilder<VS,AB>>

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

AggregationBuilder.CommonFields

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
static java.lang.String	NAME

Fields inherited from class org.elasticsearch.search.aggregations.support.ValuesSourceAggregationBuilder

config

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

metaData

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

factoriesBuilder, name

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

EMPTY_PARAMS

Constructor Summary

Constructors

Modifier	Constructor	Description
	SignificantTermsAggregationBuilder(java.lang.String name, ValueType valueType)
	SignificantTermsAggregationBuilder(StreamInput in)	Read from a Stream.
protected	SignificantTermsAggregationBuilder(SignificantTermsAggregationBuilder clone, AggregatorFactories.Builder factoriesBuilder, java.util.Map<java.lang.String,java.lang.Object> metaData)

Method Summary

Modifier and Type	Method	Description
QueryBuilder	backgroundFilter()
SignificantTermsAggregationBuilder	backgroundFilter(QueryBuilder backgroundFilter)
TermsAggregator.BucketCountThresholds	bucketCountThresholds()
SignificantTermsAggregationBuilder	bucketCountThresholds(TermsAggregator.BucketCountThresholds bucketCountThresholds)
protected XContentBuilder	doXContentBody(XContentBuilder builder, ToXContent.Params params)
boolean	equals(java.lang.Object obj)
java.lang.String	executionHint()	Expert: gets an execution hint to the aggregation.
SignificantTermsAggregationBuilder	executionHint(java.lang.String executionHint)	Expert: sets an execution hint to the aggregation.
protected TermsAggregator.BucketCountThresholds	getBucketCountThresholds()
java.lang.String	getType()	The name of the type of aggregation built by this builder.
int	hashCode()
IncludeExclude	includeExclude()	Get terms to include and exclude from the aggregation results
SignificantTermsAggregationBuilder	includeExclude(IncludeExclude includeExclude)	Set terms to include and exclude from the aggregation results
protected ValuesSourceAggregatorFactory<ValuesSource>	innerBuild(QueryShardContext queryShardContext, ValuesSourceConfig<ValuesSource> config, AggregatorFactory parent, AggregatorFactories.Builder subFactoriesBuilder)
protected void	innerWriteTo(StreamOutput out)	Write subclass's state to the stream.
SignificantTermsAggregationBuilder	minDocCount(long minDocCount)	Set the minimum document count terms should have in order to appear in the response.
static SignificantTermsAggregationBuilder	parse(java.lang.String aggregationName, XContentParser parser)
protected boolean	serializeTargetValueType(Version version)	Should this builder serialize its targetValueType? Defaults to false.
protected AggregationBuilder	shallowCopy(AggregatorFactories.Builder factoriesBuilder, java.util.Map<java.lang.String,java.lang.Object> metaData)	Create a shallow copy of this builder and replacing AggregationBuilder.factoriesBuilder and metaData.
SignificantTermsAggregationBuilder	shardMinDocCount(long shardMinDocCount)	Set the minimum document count terms should have on the shard in order to appear in the response.
SignificantTermsAggregationBuilder	shardSize(int shardSize)	Sets the shard_size - indicating the number of term buckets each shard will return to the coordinating node (the node that coordinates the search execution).
SignificanceHeuristic	significanceHeuristic()
SignificantTermsAggregationBuilder	significanceHeuristic(SignificanceHeuristic significanceHeuristic)
SignificantTermsAggregationBuilder	size(int size)	Sets the size - indicating how many term buckets should be returned (defaults to 10)

Methods inherited from class org.elasticsearch.search.aggregations.support.ValuesSourceAggregationBuilder

defaultValueType, doBuild, doWriteTo, field, field, format, format, internalXContent, missing, missing, resolveConfig, resolveScriptAny, script, script, timeZone, timeZone, valueType, valueType

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

doRewrite, getName, getPipelineAggregations, getSubAggregations, rewrite, toString

Methods inherited from class java.lang.Object

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

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

isFragment

Field Details

NAME

public static final java.lang.String NAME

See Also:

Constant Field Values

Constructor Details

SignificantTermsAggregationBuilder

public SignificantTermsAggregationBuilder(java.lang.String name, ValueType valueType)

SignificantTermsAggregationBuilder

public SignificantTermsAggregationBuilder(StreamInput in) throws java.io.IOException

Read from a Stream.

Throws:

java.io.IOException

SignificantTermsAggregationBuilder

protected SignificantTermsAggregationBuilder(SignificantTermsAggregationBuilder clone, AggregatorFactories.Builder factoriesBuilder, java.util.Map<java.lang.String,java.lang.Object> metaData)

Method Details

parse

public static SignificantTermsAggregationBuilder parse(java.lang.String aggregationName, XContentParser parser) throws java.io.IOException

Throws:

java.io.IOException

shallowCopy

protected AggregationBuilder shallowCopy(AggregatorFactories.Builder factoriesBuilder, java.util.Map<java.lang.String,java.lang.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

innerWriteTo

protected void innerWriteTo(StreamOutput out) throws java.io.IOException

Description copied from class: ValuesSourceAggregationBuilder

Write subclass's state to the stream.

Specified by:

innerWriteTo in class ValuesSourceAggregationBuilder<ValuesSource,SignificantTermsAggregationBuilder>

Throws:

java.io.IOException

serializeTargetValueType

protected boolean serializeTargetValueType(Version version)

Description copied from class: ValuesSourceAggregationBuilder

Should this builder serialize its targetValueType? Defaults to false. All subclasses that override this to true should use the three argument read constructor rather than the four argument version.

Overrides:

serializeTargetValueType in class ValuesSourceAggregationBuilder<ValuesSource,SignificantTermsAggregationBuilder>

Parameters:

version - For backwards compatibility, subclasses can change behavior based on the version

getBucketCountThresholds

protected TermsAggregator.BucketCountThresholds getBucketCountThresholds()

bucketCountThresholds

public TermsAggregator.BucketCountThresholds bucketCountThresholds()

bucketCountThresholds

public SignificantTermsAggregationBuilder bucketCountThresholds(TermsAggregator.BucketCountThresholds bucketCountThresholds)

size

public SignificantTermsAggregationBuilder size(int size)

Sets the size - indicating how many term buckets should be returned (defaults to 10)

shardSize

public SignificantTermsAggregationBuilder shardSize(int shardSize)

Sets the shard_size - indicating the number of term buckets each shard will return to the coordinating node (the node that coordinates the search execution). The higher the shard size is, the more accurate the results are.

minDocCount

public SignificantTermsAggregationBuilder minDocCount(long minDocCount)

Set the minimum document count terms should have in order to appear in the response.

shardMinDocCount

public SignificantTermsAggregationBuilder shardMinDocCount(long shardMinDocCount)

Set the minimum document count terms should have on the shard in order to appear in the response.

executionHint

public SignificantTermsAggregationBuilder executionHint(java.lang.String executionHint)

Expert: sets an execution hint to the aggregation.

executionHint

public java.lang.String executionHint()

Expert: gets an execution hint to the aggregation.

backgroundFilter

public SignificantTermsAggregationBuilder backgroundFilter(QueryBuilder backgroundFilter)

backgroundFilter

public QueryBuilder backgroundFilter()

includeExclude

public SignificantTermsAggregationBuilder includeExclude(IncludeExclude includeExclude)

Set terms to include and exclude from the aggregation results

includeExclude

public IncludeExclude includeExclude()

Get terms to include and exclude from the aggregation results

significanceHeuristic

public SignificantTermsAggregationBuilder significanceHeuristic(SignificanceHeuristic significanceHeuristic)

significanceHeuristic

public SignificanceHeuristic significanceHeuristic()

innerBuild

protected ValuesSourceAggregatorFactory<ValuesSource> innerBuild(QueryShardContext queryShardContext, ValuesSourceConfig<ValuesSource> config, AggregatorFactory parent, AggregatorFactories.Builder subFactoriesBuilder) throws java.io.IOException

Specified by:

innerBuild in class ValuesSourceAggregationBuilder<ValuesSource,SignificantTermsAggregationBuilder>

Throws:

java.io.IOException

doXContentBody

protected XContentBuilder doXContentBody(XContentBuilder builder, ToXContent.Params params) throws java.io.IOException

Specified by:

doXContentBody in class ValuesSourceAggregationBuilder<ValuesSource,SignificantTermsAggregationBuilder>

Throws:

java.io.IOException

hashCode

public int hashCode()

Overrides:

hashCode in class ValuesSourceAggregationBuilder<ValuesSource,SignificantTermsAggregationBuilder>

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class ValuesSourceAggregationBuilder<ValuesSource,SignificantTermsAggregationBuilder>

getType

public java.lang.String getType()

Description copied from interface: BaseAggregationBuilder

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

Specified by:

getType in interface BaseAggregationBuilder