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.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
COMMON_TERMS_QUERY_DEPRECATION_MSG
Deprecated.static float
DEFAULT_CUTOFF_FREQ
Deprecated.static boolean
DEFAULT_DISABLE_COORD
Deprecated.static Operator
DEFAULT_HIGH_FREQ_OCCUR
Deprecated.static Operator
DEFAULT_LOW_FREQ_OCCUR
Deprecated.static java.lang.String
NAME
Deprecated.Fields inherited from class org.elasticsearch.index.query.AbstractQueryBuilder
boost, BOOST_FIELD, DEFAULT_BOOST, NAME_FIELD, queryName
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 Constructor Description CommonTermsQueryBuilder(java.lang.String fieldName, java.lang.Object text)
Deprecated.SeeCommonTermsQueryBuilder
for more details.CommonTermsQueryBuilder(StreamInput in)
Deprecated.SeeCommonTermsQueryBuilder
for more details. -
Method Summary
Modifier and Type Method Description java.lang.String
analyzer()
Deprecated.CommonTermsQueryBuilder
analyzer(java.lang.String analyzer)
Deprecated.Explicitly set the analyzer to use.float
cutoffFrequency()
Deprecated.CommonTermsQueryBuilder
cutoffFrequency(float cutoffFrequency)
Deprecated.Sets the cutoff document frequency for high / low frequent terms.protected boolean
doEquals(CommonTermsQueryBuilder other)
Deprecated.Indicates whether some otherQueryBuilder
object of the same type is "equal to" this one.protected int
doHashCode()
Deprecated.protected org.apache.lucene.search.Query
doToQuery(SearchExecutionContext context)
Deprecated.protected void
doWriteTo(StreamOutput out)
Deprecated.protected void
doXContent(org.elasticsearch.common.xcontent.XContentBuilder builder, org.elasticsearch.common.xcontent.ToXContent.Params params)
Deprecated.java.lang.String
fieldName()
Deprecated.static CommonTermsQueryBuilder
fromXContent(org.elasticsearch.common.xcontent.XContentParser parser)
Deprecated.java.lang.String
getWriteableName()
Deprecated.Returns the name of the writeable objectjava.lang.String
highFreqMinimumShouldMatch()
Deprecated.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.Operator
highFreqOperator()
Deprecated.CommonTermsQueryBuilder
highFreqOperator(Operator operator)
Deprecated.Sets the operator to use for terms with a high document frequency (greater than or equal tocutoffFrequency(float)
.java.lang.String
lowFreqMinimumShouldMatch()
Deprecated.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.Operator
lowFreqOperator()
Deprecated.CommonTermsQueryBuilder
lowFreqOperator(Operator operator)
Deprecated.Sets the operator to use for terms with a low document frequency (less thancutoffFrequency(float)
.java.lang.Object
value()
Deprecated.Methods inherited from class org.elasticsearch.index.query.AbstractQueryBuilder
addValidationError, boost, boost, checkNegativeBoost, declareStandardFields, doRewrite, equals, extractInnerHitBuilders, getName, hashCode, parseInnerQueryBuilder, parseInnerQueryBuilder, printBoostAndQueryName, queryName, queryName, requireValue, rewrite, throwParsingExceptionOnMultipleFields, toQuery, toString, toXContent, writeTo
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
Methods inherited from interface org.elasticsearch.common.xcontent.ToXContentObject
isFragment
-
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.SeeCommonTermsQueryBuilder
for more details.Constructs a new common terms query. -
CommonTermsQueryBuilder
Deprecated.SeeCommonTermsQueryBuilder
for more details.Read from a stream.- Throws:
java.io.IOException
-
-
Method Details
-
doWriteTo
Deprecated.- Specified by:
doWriteTo
in 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:
doXContent
in 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:NamedWriteable
Returns the name of the writeable object -
doToQuery
protected org.apache.lucene.search.Query doToQuery(SearchExecutionContext context) throws java.io.IOExceptionDeprecated.- Specified by:
doToQuery
in classAbstractQueryBuilder<CommonTermsQueryBuilder>
- Throws:
java.io.IOException
-
doHashCode
protected int doHashCode()Deprecated.- Specified by:
doHashCode
in classAbstractQueryBuilder<CommonTermsQueryBuilder>
-
doEquals
Deprecated.Description copied from class:AbstractQueryBuilder
Indicates whether some otherQueryBuilder
object of the same type is "equal to" this one.- Specified by:
doEquals
in classAbstractQueryBuilder<CommonTermsQueryBuilder>
-