Package org.elasticsearch.index.query
Class CommonTermsQueryBuilder
java.lang.Object
org.elasticsearch.index.query.AbstractQueryBuilder<CommonTermsQueryBuilder>
org.elasticsearch.index.query.CommonTermsQueryBuilder
- All Implemented Interfaces:
NamedWriteable,Writeable,org.elasticsearch.common.xcontent.ToXContent,org.elasticsearch.common.xcontent.ToXContentObject,QueryBuilder,Rewriteable<QueryBuilder>
@Deprecated public class CommonTermsQueryBuilder extends AbstractQueryBuilder<CommonTermsQueryBuilder>
Deprecated.
Since max_optimization optimization landed in 7.0, normal MatchQuery
will achieve the same result without any configuration.
CommonTermsQuery query is a query that executes high-frequency terms in a
optional sub-query to prevent slow queries due to "common" terms like
stopwords. This query basically builds 2 queries off the
#add(Term)
added terms where low-frequency terms are added to a required boolean clause
and high-frequency terms are added to an optional boolean clause. The
optional clause is only executed if the required "low-frequency' clause
matches.-
Nested Class Summary
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.ParamsNested 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.StringCOMMON_TERMS_QUERY_DEPRECATION_MSGDeprecated.static floatDEFAULT_CUTOFF_FREQDeprecated.static booleanDEFAULT_DISABLE_COORDDeprecated.static OperatorDEFAULT_HIGH_FREQ_OCCURDeprecated.static OperatorDEFAULT_LOW_FREQ_OCCURDeprecated.static java.lang.StringNAMEDeprecated.Fields inherited from class org.elasticsearch.index.query.AbstractQueryBuilder
boost, BOOST_FIELD, DEFAULT_BOOST, NAME_FIELD, queryName -
Constructor Summary
Constructors Constructor Description CommonTermsQueryBuilder(java.lang.String fieldName, java.lang.Object text)Deprecated.SeeCommonTermsQueryBuilderfor more details.CommonTermsQueryBuilder(StreamInput in)Deprecated.SeeCommonTermsQueryBuilderfor more details. -
Method Summary
Modifier and Type Method Description java.lang.Stringanalyzer()Deprecated.CommonTermsQueryBuilderanalyzer(java.lang.String analyzer)Deprecated.Explicitly set the analyzer to use.floatcutoffFrequency()Deprecated.CommonTermsQueryBuildercutoffFrequency(float cutoffFrequency)Deprecated.Sets the cutoff document frequency for high / low frequent terms.protected booleandoEquals(CommonTermsQueryBuilder other)Deprecated.Indicates whether some otherQueryBuilderobject of the same type is "equal to" this one.protected intdoHashCode()Deprecated.protected org.apache.lucene.search.QuerydoToQuery(QueryShardContext context)Deprecated.protected voiddoWriteTo(StreamOutput out)Deprecated.protected voiddoXContent(org.elasticsearch.common.xcontent.XContentBuilder builder, org.elasticsearch.common.xcontent.ToXContent.Params params)Deprecated.java.lang.StringfieldName()Deprecated.static CommonTermsQueryBuilderfromXContent(org.elasticsearch.common.xcontent.XContentParser parser)Deprecated.java.lang.StringgetWriteableName()Deprecated.Returns the name of the writeable objectjava.lang.StringhighFreqMinimumShouldMatch()Deprecated.CommonTermsQueryBuilderhighFreqMinimumShouldMatch(java.lang.String highFreqMinimumShouldMatch)Deprecated.Sets the minimum number of high frequent query terms that need to match in order to produce a hit when there are no low frequent terms.OperatorhighFreqOperator()Deprecated.CommonTermsQueryBuilderhighFreqOperator(Operator operator)Deprecated.Sets the operator to use for terms with a high document frequency (greater than or equal tocutoffFrequency(float).java.lang.StringlowFreqMinimumShouldMatch()Deprecated.CommonTermsQueryBuilderlowFreqMinimumShouldMatch(java.lang.String lowFreqMinimumShouldMatch)Deprecated.Sets the minimum number of low frequent query terms that need to match in order to produce a hit.OperatorlowFreqOperator()Deprecated.CommonTermsQueryBuilderlowFreqOperator(Operator operator)Deprecated.Sets the operator to use for terms with a low document frequency (less thancutoffFrequency(float).java.lang.Objectvalue()Deprecated.Methods inherited from class org.elasticsearch.index.query.AbstractQueryBuilder
addValidationError, boost, boost, checkNegativeBoost, declareStandardFields, doRewrite, equals, extractInnerHitBuilders, getName, hashCode, parseInnerQueryBuilder, printBoostAndQueryName, queryName, queryName, requireValue, rewrite, throwParsingExceptionOnMultipleFields, toQuery, toString, toXContent, writeTo
-
Field Details
-
COMMON_TERMS_QUERY_DEPRECATION_MSG
public static final java.lang.String COMMON_TERMS_QUERY_DEPRECATION_MSGDeprecated.- See Also:
- Constant Field Values
-
NAME
public static final java.lang.String NAMEDeprecated.- See Also:
- Constant Field Values
-
DEFAULT_CUTOFF_FREQ
public static final float DEFAULT_CUTOFF_FREQDeprecated.- See Also:
- Constant Field Values
-
DEFAULT_HIGH_FREQ_OCCUR
Deprecated. -
DEFAULT_LOW_FREQ_OCCUR
Deprecated. -
DEFAULT_DISABLE_COORD
public static final boolean DEFAULT_DISABLE_COORDDeprecated.- See Also:
- Constant Field Values
-
-
Constructor Details
-
CommonTermsQueryBuilder
@Deprecated public CommonTermsQueryBuilder(java.lang.String fieldName, java.lang.Object text)Deprecated.SeeCommonTermsQueryBuilderfor more details.Constructs a new common terms query. -
CommonTermsQueryBuilder
Deprecated.SeeCommonTermsQueryBuilderfor more details.Read from a stream.- Throws:
java.io.IOException
-
-
Method Details
-
doWriteTo
Deprecated.- Specified by:
doWriteToin classAbstractQueryBuilder<CommonTermsQueryBuilder>- Throws:
java.io.IOException
-
fieldName
public java.lang.String fieldName()Deprecated. -
value
public java.lang.Object value()Deprecated. -
highFreqOperator
Deprecated.Sets the operator to use for terms with a high document frequency (greater than or equal tocutoffFrequency(float). Defaults toAND. -
highFreqOperator
Deprecated. -
lowFreqOperator
Deprecated.Sets the operator to use for terms with a low document frequency (less thancutoffFrequency(float). Defaults toAND. -
lowFreqOperator
Deprecated. -
analyzer
Deprecated.Explicitly set the analyzer to use. Defaults to use explicit mapping config for the field, or, if not set, the default search analyzer. -
analyzer
public java.lang.String analyzer()Deprecated. -
cutoffFrequency
Deprecated.Sets the cutoff document frequency for high / low frequent terms. A value in [0..1] (or absolute number >=1) representing the maximum threshold of a terms document frequency to be considered a low frequency term. Defaults to{@value #DEFAULT_CUTOFF_FREQ} -
cutoffFrequency
public float cutoffFrequency()Deprecated. -
highFreqMinimumShouldMatch
public CommonTermsQueryBuilder highFreqMinimumShouldMatch(java.lang.String highFreqMinimumShouldMatch)Deprecated.Sets the minimum number of high frequent query terms that need to match in order to produce a hit when there are no low frequent terms. -
highFreqMinimumShouldMatch
public java.lang.String highFreqMinimumShouldMatch()Deprecated. -
lowFreqMinimumShouldMatch
public CommonTermsQueryBuilder lowFreqMinimumShouldMatch(java.lang.String lowFreqMinimumShouldMatch)Deprecated.Sets the minimum number of low frequent query terms that need to match in order to produce a hit. -
lowFreqMinimumShouldMatch
public java.lang.String lowFreqMinimumShouldMatch()Deprecated. -
doXContent
protected void doXContent(org.elasticsearch.common.xcontent.XContentBuilder builder, org.elasticsearch.common.xcontent.ToXContent.Params params) throws java.io.IOExceptionDeprecated.- Specified by:
doXContentin classAbstractQueryBuilder<CommonTermsQueryBuilder>- Throws:
java.io.IOException
-
fromXContent
public static CommonTermsQueryBuilder fromXContent(org.elasticsearch.common.xcontent.XContentParser parser) throws java.io.IOExceptionDeprecated.- Throws:
java.io.IOException
-
getWriteableName
public java.lang.String getWriteableName()Deprecated.Description copied from interface:NamedWriteableReturns the name of the writeable object -
doToQuery
protected org.apache.lucene.search.Query doToQuery(QueryShardContext context) throws java.io.IOExceptionDeprecated.- Specified by:
doToQueryin classAbstractQueryBuilder<CommonTermsQueryBuilder>- Throws:
java.io.IOException
-
doHashCode
protected int doHashCode()Deprecated.- Specified by:
doHashCodein classAbstractQueryBuilder<CommonTermsQueryBuilder>
-
doEquals
Deprecated.Description copied from class:AbstractQueryBuilderIndicates whether some otherQueryBuilderobject of the same type is "equal to" this one.- Specified by:
doEqualsin classAbstractQueryBuilder<CommonTermsQueryBuilder>
-