Module org.elasticsearch.server
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,VersionedNamedWriteable,Writeable,Rewriteable<AggregationBuilder>,BaseAggregationBuilder,ToXContent,ToXContentFragment
public class SignificantTextAggregationBuilder
extends AbstractAggregationBuilder<SignificantTextAggregationBuilder>
-
Nested Class Summary
Nested classes/interfaces inherited from class org.elasticsearch.search.aggregations.AggregationBuilder
AggregationBuilder.BucketCardinality, AggregationBuilder.CommonFieldsNested classes/interfaces inherited from interface org.elasticsearch.xcontent.ToXContent
ToXContent.DelegatingMapParams, ToXContent.MapParams, ToXContent.ParamsNested classes/interfaces inherited from interface org.elasticsearch.common.io.stream.Writeable
Writeable.Reader<V>, Writeable.Writer<V> -
Field Summary
FieldsFields inherited from class org.elasticsearch.search.aggregations.AbstractAggregationBuilder
metadataFields inherited from class org.elasticsearch.search.aggregations.AggregationBuilder
DEFAULT_PREALLOCATION, factoriesBuilder, nameFields inherited from interface org.elasticsearch.index.query.Rewriteable
MAX_REWRITE_ROUNDSFields inherited from interface org.elasticsearch.xcontent.ToXContent
EMPTY, EMPTY_PARAMS -
Constructor Summary
ConstructorsModifierConstructorDescriptionSignificantTextAggregationBuilder(String name, String fieldName) Read from a stream.protectedSignificantTextAggregationBuilder(SignificantTextAggregationBuilder clone, AggregatorFactories.Builder factoriesBuilder, Map<String, Object> metadata) -
Method Summary
Modifier and TypeMethodDescriptionbackgroundFilter(QueryBuilder backgroundFilter) A rough count of the number of buckets thatAggregators built by this builder will contain per owning parent bucket.protected AggregatorFactorydoBuild(AggregationContext context, AggregatorFactory parent, AggregatorFactories.Builder subFactoriesBuilder) protected voiddoWriteTo(StreamOutput out) booleanSets the name of the text field that will be the subject of this aggregation.filterDuplicateText(boolean filterDuplicateText) Control if duplicate paragraphs of text should try be filtered from the statistical text analysis.The minimal version of the recipient this object can be sent togetType()The name of the type of aggregation built by this builder.inthashCode()Get terms to include and exclude from the aggregation resultsincludeExclude(IncludeExclude includeExclude) Set terms to include and exclude from the aggregation resultsprotected XContentBuilderinternalXContent(XContentBuilder builder, ToXContent.Params params) minDocCount(long minDocCount) Set the minimum document count terms should have in order to appear in the response.parse(String aggregationName, XContentParser parser) protected AggregationBuildershallowCopy(AggregatorFactories.Builder factoriesBuilder, Map<String, Object> metadata) Create a shallow copy of this builder and replacingAggregationBuilder.factoriesBuilderandmetadata.shardMinDocCount(long shardMinDocCount) Set the minimum document count terms should have on the shard in order to appear in the response.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 significanceHeuristic) size(int size) Sets the size - indicating how many term buckets should be returned (defaults to 10)sourceFieldNames(List<String> names) Selects the fields to load from _source JSON and analyze.subAggregation(AggregationBuilder aggregation) Add a sub aggregation to this builder.subAggregations(AggregatorFactories.Builder subFactories) Registers sub-factories with this factory.booleanDoes this aggregation support running with in a sampling context.Methods inherited from class org.elasticsearch.search.aggregations.AbstractAggregationBuilder
build, getMetadata, getWriteableName, setMetadata, subAggregation, toXContent, writeToMethods inherited from class org.elasticsearch.search.aggregations.AggregationBuilder
buildPipelineTree, bytesToPreallocate, deepCopy, doRewrite, getName, getOutputFieldNames, getPipelineAggregations, getQuery, getSubAggregations, isInSortOrderExecutionRequired, rewrite, supportsParallelCollection, toString, validateSequentiallyOrdered, validateSequentiallyOrderedWithoutGapsMethods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, waitMethods inherited from interface org.elasticsearch.xcontent.ToXContentFragment
isFragment
-
Field Details
-
NAME
- See Also:
-
-
Constructor Details
-
SignificantTextAggregationBuilder
protected SignificantTextAggregationBuilder(SignificantTextAggregationBuilder clone, AggregatorFactories.Builder factoriesBuilder, Map<String, Object> metadata) -
SignificantTextAggregationBuilder
- Parameters:
name- the name of this aggregationfieldName- the name of the text field that will be the subject of this aggregation
-
SignificantTextAggregationBuilder
Read from a stream.- Throws:
IOException
-
-
Method Details
-
parse
public static SignificantTextAggregationBuilder parse(String aggregationName, XContentParser parser) throws IOException - Throws:
IOException
-
supportsSampling
public boolean supportsSampling()Description copied from class:AggregationBuilderDoes this aggregation support running with in a sampling context. By default, it's false for all aggregations. If the sub-classed builder supports sampling, be sure of the following that the resulting internal aggregation objects override theInternalAggregation.finalizeSampling(SamplingContext)and scales any values that require scaling.- Overrides:
supportsSamplingin classAggregationBuilder- Returns:
- does this aggregation builder support sampling
-
shallowCopy
protected AggregationBuilder shallowCopy(AggregatorFactories.Builder factoriesBuilder, Map<String, Object> metadata) Description copied from class:AggregationBuilderCreate a shallow copy of this builder and replacingAggregationBuilder.factoriesBuilderandmetadata.- Specified by:
shallowCopyin classAggregationBuilder
-
bucketCountThresholds
-
subAggregations
Description copied from class:AbstractAggregationBuilderRegisters 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:
subAggregationsin interfaceBaseAggregationBuilder- Overrides:
subAggregationsin classAbstractAggregationBuilder<SignificantTextAggregationBuilder>- Parameters:
subFactories- The sub-factories- Returns:
- this factory (fluent interface)
-
subAggregation
Description copied from class:AggregationBuilderAdd a sub aggregation to this builder.- Overrides:
subAggregationin classAbstractAggregationBuilder<SignificantTextAggregationBuilder>
-
size
Sets the size - indicating how many term buckets should be returned (defaults to 10) -
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
Sets the name of the text field that will be the subject of this aggregation. -
sourceFieldNames
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
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
Set the minimum document count terms should have in order to appear in the response. -
shardMinDocCount
Set the minimum document count terms should have on the shard in order to appear in the response. -
backgroundFilter
-
includeExclude
Set terms to include and exclude from the aggregation results -
includeExclude
Get terms to include and exclude from the aggregation results -
significanceHeuristic
public SignificantTextAggregationBuilder significanceHeuristic(SignificanceHeuristic significanceHeuristic) -
doWriteTo
- Specified by:
doWriteToin classAbstractAggregationBuilder<SignificantTextAggregationBuilder>- Throws:
IOException
-
bucketCardinality
Description copied from class:AggregationBuilderA rough count of the number of buckets thatAggregators built by this builder will contain per owning parent bucket.- Specified by:
bucketCardinalityin classAggregationBuilder
-
doBuild
protected AggregatorFactory doBuild(AggregationContext context, AggregatorFactory parent, AggregatorFactories.Builder subFactoriesBuilder) throws IOException - Specified by:
doBuildin classAbstractAggregationBuilder<SignificantTextAggregationBuilder>- Throws:
IOException
-
internalXContent
protected XContentBuilder internalXContent(XContentBuilder builder, ToXContent.Params params) throws IOException - Specified by:
internalXContentin classAbstractAggregationBuilder<SignificantTextAggregationBuilder>- Throws:
IOException
-
hashCode
public int hashCode()- Overrides:
hashCodein classAbstractAggregationBuilder<SignificantTextAggregationBuilder>
-
equals
- Overrides:
equalsin classAbstractAggregationBuilder<SignificantTextAggregationBuilder>
-
getType
Description copied from interface:BaseAggregationBuilderThe name of the type of aggregation built by this builder. -
getMinimalSupportedVersion
Description copied from interface:VersionedNamedWriteableThe minimal version of the recipient this object can be sent to
-