Class SignificantTextAggregationBuilder
- java.lang.Object
-
- org.elasticsearch.search.aggregations.AggregationBuilder
-
- org.elasticsearch.search.aggregations.AbstractAggregationBuilder<SignificantTextAggregationBuilder>
-
- org.elasticsearch.search.aggregations.bucket.significant.SignificantTextAggregationBuilder
-
- All Implemented Interfaces:
NamedWriteable
,Writeable
,ToXContent
,ToXContentFragment
,BaseAggregationBuilder
public class SignificantTextAggregationBuilder extends AbstractAggregationBuilder<SignificantTextAggregationBuilder>
-
-
Nested Class Summary
-
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.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 SignificantTextAggregationBuilder(java.lang.String name, java.lang.String fieldName)
SignificantTextAggregationBuilder(StreamInput in)
Read from a stream.protected
SignificantTextAggregationBuilder(SignificantTextAggregationBuilder clone, AggregatorFactories.Builder factoriesBuilder, java.util.Map<java.lang.String,java.lang.Object> metaData)
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description QueryBuilder
backgroundFilter()
SignificantTextAggregationBuilder
backgroundFilter(QueryBuilder backgroundFilter)
TermsAggregator.BucketCountThresholds
bucketCountThresholds()
SignificantTextAggregationBuilder
bucketCountThresholds(TermsAggregator.BucketCountThresholds bucketCountThresholds)
protected AggregatorFactory<?>
doBuild(SearchContext context, AggregatorFactory<?> parent, AggregatorFactories.Builder subFactoriesBuilder)
protected boolean
doEquals(java.lang.Object obj)
protected int
doHashCode()
protected void
doWriteTo(StreamOutput out)
SignificantTextAggregationBuilder
fieldName(java.lang.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()
static Aggregator.Parser
getParser(ParseFieldRegistry<SignificanceHeuristicParser> significanceHeuristicParserRegistry)
java.lang.String
getType()
The name of the type of aggregation built by this builder.IncludeExclude
includeExclude()
Get terms to include and exclude from the aggregation resultsSignificantTextAggregationBuilder
includeExclude(IncludeExclude includeExclude)
Set terms to include and exclude from the aggregation resultsprotected XContentBuilder
internalXContent(XContentBuilder builder, ToXContent.Params params)
SignificantTextAggregationBuilder
minDocCount(long minDocCount)
Set the minimum document count terms should have in order to appear in the response.protected AggregationBuilder
shallowCopy(AggregatorFactories.Builder factoriesBuilder, java.util.Map<java.lang.String,java.lang.Object> metaData)
Create a shallow copy of this builder and replacingAggregationBuilder.factoriesBuilder
andmetaData
.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(java.util.List<java.lang.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, equals, getMetaData, getWriteableName, hashCode, setMetaData, subAggregation, 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 Detail
-
NAME
public static final java.lang.String NAME
- See Also:
- Constant Field Values
-
-
Constructor Detail
-
SignificantTextAggregationBuilder
protected SignificantTextAggregationBuilder(SignificantTextAggregationBuilder clone, AggregatorFactories.Builder factoriesBuilder, java.util.Map<java.lang.String,java.lang.Object> metaData)
-
SignificantTextAggregationBuilder
public SignificantTextAggregationBuilder(java.lang.String name, java.lang.String fieldName)
- Parameters:
name
- the name of this aggregationfieldName
- the name of the text field that will be the subject of this aggregation
-
SignificantTextAggregationBuilder
public SignificantTextAggregationBuilder(StreamInput in) throws java.io.IOException
Read from a stream.- Throws:
java.io.IOException
-
-
Method Detail
-
getParser
public static Aggregator.Parser getParser(ParseFieldRegistry<SignificanceHeuristicParser> significanceHeuristicParserRegistry)
-
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 replacingAggregationBuilder.factoriesBuilder
andmetaData
. Used byAggregationBuilder.rewrite(QueryRewriteContext)
.- Specified by:
shallowCopy
in classAggregationBuilder
-
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 interfaceBaseAggregationBuilder
- Overrides:
subAggregations
in classAbstractAggregationBuilder<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 classAbstractAggregationBuilder<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(java.lang.String fieldName)
Sets the name of the text field that will be the subject of this aggregation.
-
sourceFieldNames
public SignificantTextAggregationBuilder sourceFieldNames(java.util.List<java.lang.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 java.io.IOException
- Specified by:
doWriteTo
in classAbstractAggregationBuilder<SignificantTextAggregationBuilder>
- Throws:
java.io.IOException
-
doBuild
protected AggregatorFactory<?> doBuild(SearchContext context, AggregatorFactory<?> parent, AggregatorFactories.Builder subFactoriesBuilder) throws java.io.IOException
- Specified by:
doBuild
in classAbstractAggregationBuilder<SignificantTextAggregationBuilder>
- Throws:
java.io.IOException
-
internalXContent
protected XContentBuilder internalXContent(XContentBuilder builder, ToXContent.Params params) throws java.io.IOException
- Specified by:
internalXContent
in classAbstractAggregationBuilder<SignificantTextAggregationBuilder>
- Throws:
java.io.IOException
-
doHashCode
protected int doHashCode()
- Specified by:
doHashCode
in classAbstractAggregationBuilder<SignificantTextAggregationBuilder>
-
doEquals
protected boolean doEquals(java.lang.Object obj)
- Specified by:
doEquals
in classAbstractAggregationBuilder<SignificantTextAggregationBuilder>
-
getType
public java.lang.String getType()
Description copied from interface:BaseAggregationBuilder
The name of the type of aggregation built by this builder.
-
-