Package org.elasticsearch.search.aggregations.bucket.terms

Class SignificantTextAggregationBuilder

java.lang.Object

org.elasticsearch.search.aggregations.AggregationBuilder

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

org.elasticsearch.search.aggregations.bucket.terms.SignificantTextAggregationBuilder

All Implemented Interfaces:

NamedWriteable, Writeable, org.elasticsearch.common.xcontent.ToXContent, org.elasticsearch.common.xcontent.ToXContentFragment, Rewriteable<AggregationBuilder>, BaseAggregationBuilder

public class SignificantTextAggregationBuilder
extends AbstractAggregationBuilder<SignificantTextAggregationBuilder>

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.common.xcontent.ToXContent

org.elasticsearch.common.xcontent.ToXContent.DelegatingMapParams, org.elasticsearch.common.xcontent.ToXContent.MapParams, org.elasticsearch.common.xcontent.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 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.common.xcontent.ToXContent

EMPTY_PARAMS

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
QueryBuilder	backgroundFilter()
SignificantTextAggregationBuilder	backgroundFilter(QueryBuilder backgroundFilter)
AggregationBuilder.BucketCardinality	bucketCardinality()	A rough count of the number of buckets that Aggregators built by this builder will contain per owning parent bucket.
TermsAggregator.BucketCountThresholds	bucketCountThresholds()
SignificantTextAggregationBuilder	bucketCountThresholds(TermsAggregator.BucketCountThresholds bucketCountThresholds)
protected AggregatorFactory	doBuild(AggregationContext context, AggregatorFactory parent, AggregatorFactories.Builder subFactoriesBuilder)
protected void	doWriteTo(StreamOutput out)
boolean	equals(Object obj)
SignificantTextAggregationBuilder	fieldName(String fieldName)	Sets the name of the text field that will be the subject of this aggregation.
SignificantTextAggregationBuilder	filterDuplicateText(boolean filterDuplicateText)	Control if duplicate paragraphs of text should try be filtered from the statistical text analysis.
protected TermsAggregator.BucketCountThresholds	getBucketCountThresholds()
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
SignificantTextAggregationBuilder	includeExclude(IncludeExclude includeExclude)	Set terms to include and exclude from the aggregation results
protected org.elasticsearch.common.xcontent.XContentBuilder	internalXContent(org.elasticsearch.common.xcontent.XContentBuilder builder, org.elasticsearch.common.xcontent.ToXContent.Params params)
SignificantTextAggregationBuilder	minDocCount(long minDocCount)	Set the minimum document count terms should have in order to appear in the response.
static SignificantTextAggregationBuilder	parse(String aggregationName, org.elasticsearch.common.xcontent.XContentParser parser)
protected AggregationBuilder	shallowCopy(AggregatorFactories.Builder factoriesBuilder, Map<String,Object> metadata)	Create a shallow copy of this builder and replacing AggregationBuilder.factoriesBuilder and metadata.
SignificantTextAggregationBuilder	shardMinDocCount(long shardMinDocCount)	Set the minimum document count terms should have on the shard in order to appear in the response.
SignificantTextAggregationBuilder	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()
SignificantTextAggregationBuilder	significanceHeuristic(SignificanceHeuristic significanceHeuristic)
SignificantTextAggregationBuilder	size(int size)	Sets the size - indicating how many term buckets should be returned (defaults to 10)
SignificantTextAggregationBuilder	sourceFieldNames(List<String> names)	Selects the fields to load from _source JSON and analyze.
SignificantTextAggregationBuilder	subAggregation(AggregationBuilder aggregation)	Add a sub aggregation to this builder.
SignificantTextAggregationBuilder	subAggregations(AggregatorFactories.Builder subFactories)	Registers sub-factories with this factory.

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

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

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

buildPipelineTree, bytesToPreallocate, doRewrite, getName, getOutputFieldNames, 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 String NAME

See Also:

Constant Field Values

Constructor Details

SignificantTextAggregationBuilder

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

SignificantTextAggregationBuilder

public SignificantTextAggregationBuilder(String name,
 String fieldName)

Parameters:

name - the name of this aggregation

fieldName - the name of the text field that will be the subject of this aggregation

SignificantTextAggregationBuilder

public SignificantTextAggregationBuilder(StreamInput in)
                                  throws IOException

Read from a stream.

Throws:

IOException

Method Details

parse

public static SignificantTextAggregationBuilder parse(String aggregationName,
 org.elasticsearch.common.xcontent.XContentParser parser)
                                               throws IOException

Throws:

IOException

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

getBucketCountThresholds

protected TermsAggregator.BucketCountThresholds getBucketCountThresholds()

bucketCountThresholds

public TermsAggregator.BucketCountThresholds bucketCountThresholds()

subAggregations

public SignificantTextAggregationBuilder subAggregations(AggregatorFactories.Builder subFactories)

Description copied from class: AbstractAggregationBuilder

Registers sub-factories with this factory. The sub-factory will be responsible for the creation of sub-aggregators under the aggregator created by this factory.

Specified by:

subAggregations in interface BaseAggregationBuilder

Overrides:

subAggregations in class AbstractAggregationBuilder<SignificantTextAggregationBuilder>

Parameters:

subFactories - The sub-factories

Returns:

this factory (fluent interface)

subAggregation

public SignificantTextAggregationBuilder subAggregation(AggregationBuilder aggregation)

Description copied from class: AggregationBuilder

Add a sub aggregation to this builder.

Overrides:

subAggregation in class AbstractAggregationBuilder<SignificantTextAggregationBuilder>

bucketCountThresholds

public SignificantTextAggregationBuilder bucketCountThresholds(TermsAggregator.BucketCountThresholds bucketCountThresholds)

size

public SignificantTextAggregationBuilder size(int size)

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

shardSize

public SignificantTextAggregationBuilder 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.

fieldName

public SignificantTextAggregationBuilder fieldName(String fieldName)

Sets the name of the text field that will be the subject of this aggregation.

sourceFieldNames

public SignificantTextAggregationBuilder sourceFieldNames(List<String> names)

Selects the fields to load from _source JSON and analyze. If none are specified, the indexed "fieldName" value is assumed to also be the name of the JSON field holding the value

filterDuplicateText

public SignificantTextAggregationBuilder filterDuplicateText(boolean filterDuplicateText)

Control if duplicate paragraphs of text should try be filtered from the statistical text analysis. Can improve results but slows down analysis. Default is false.

minDocCount

public SignificantTextAggregationBuilder minDocCount(long minDocCount)

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

shardMinDocCount

public SignificantTextAggregationBuilder shardMinDocCount(long shardMinDocCount)

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

backgroundFilter

public SignificantTextAggregationBuilder backgroundFilter(QueryBuilder backgroundFilter)

backgroundFilter

public QueryBuilder backgroundFilter()

includeExclude

public SignificantTextAggregationBuilder 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 SignificantTextAggregationBuilder significanceHeuristic(SignificanceHeuristic significanceHeuristic)

significanceHeuristic

public SignificanceHeuristic significanceHeuristic()

doWriteTo

protected void doWriteTo(StreamOutput out)
                  throws IOException

Specified by:

doWriteTo in class AbstractAggregationBuilder<SignificantTextAggregationBuilder>

Throws:

IOException

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<SignificantTextAggregationBuilder>

Throws:

IOException

internalXContent

protected org.elasticsearch.common.xcontent.XContentBuilder internalXContent(org.elasticsearch.common.xcontent.XContentBuilder builder,
 org.elasticsearch.common.xcontent.ToXContent.Params params)
                                                                      throws IOException

Specified by:

internalXContent in class AbstractAggregationBuilder<SignificantTextAggregationBuilder>

Throws:

IOException

hashCode

public int hashCode()

Overrides:

hashCode in class AbstractAggregationBuilder<SignificantTextAggregationBuilder>

equals

public boolean equals(Object obj)

Overrides:

equals in class AbstractAggregationBuilder<SignificantTextAggregationBuilder>

getType

public String getType()

Description copied from interface: BaseAggregationBuilder

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