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 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 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(String fieldName, Object text)	Deprecated. See CommonTermsQueryBuilder for more details.
CommonTermsQueryBuilder(StreamInput in)	Deprecated. See CommonTermsQueryBuilder for more details.

Method Summary

Modifier and Type	Method	Description
String	analyzer()	Deprecated.
CommonTermsQueryBuilder	analyzer(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 other QueryBuilder 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.
String	fieldName()	Deprecated.
static CommonTermsQueryBuilder	fromXContent(org.elasticsearch.common.xcontent.XContentParser parser)	Deprecated.
String	getWriteableName()	Deprecated. Returns the name of the writeable object
String	highFreqMinimumShouldMatch()	Deprecated.
CommonTermsQueryBuilder	highFreqMinimumShouldMatch(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 to cutoffFrequency(float).
String	lowFreqMinimumShouldMatch()	Deprecated.
CommonTermsQueryBuilder	lowFreqMinimumShouldMatch(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 than cutoffFrequency(float).
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 String COMMON_TERMS_QUERY_DEPRECATION_MSG

Deprecated.

See Also:

Constant Field Values

NAME

public static final String NAME

Deprecated.

See Also:

Constant Field Values

DEFAULT_CUTOFF_FREQ

public static final float DEFAULT_CUTOFF_FREQ

Deprecated.

See Also:

Constant Field Values

DEFAULT_HIGH_FREQ_OCCUR

public static final Operator DEFAULT_HIGH_FREQ_OCCUR

Deprecated.

DEFAULT_LOW_FREQ_OCCUR

public static final Operator DEFAULT_LOW_FREQ_OCCUR

Deprecated.

DEFAULT_DISABLE_COORD

public static final boolean DEFAULT_DISABLE_COORD

Deprecated.

See Also:

Constant Field Values

Constructor Details

CommonTermsQueryBuilder

@Deprecated
public CommonTermsQueryBuilder(String fieldName,
 Object text)

Deprecated.

See CommonTermsQueryBuilder for more details.

Constructs a new common terms query.

CommonTermsQueryBuilder

@Deprecated
public CommonTermsQueryBuilder(StreamInput in)
                        throws IOException

Deprecated.

See CommonTermsQueryBuilder for more details.

Read from a stream.

Throws:

IOException

Method Details

doWriteTo

protected void doWriteTo(StreamOutput out)
                  throws IOException

Deprecated.

Specified by:

doWriteTo in class AbstractQueryBuilder<CommonTermsQueryBuilder>

Throws:

IOException

fieldName

public String fieldName()

Deprecated.

value

public Object value()

Deprecated.

highFreqOperator

public CommonTermsQueryBuilder highFreqOperator(Operator operator)

Deprecated.

Sets the operator to use for terms with a high document frequency (greater than or equal to cutoffFrequency(float). Defaults to AND.

highFreqOperator

public Operator highFreqOperator()

Deprecated.

lowFreqOperator

public CommonTermsQueryBuilder lowFreqOperator(Operator operator)

Deprecated.

Sets the operator to use for terms with a low document frequency (less than cutoffFrequency(float). Defaults to AND.

lowFreqOperator

public Operator lowFreqOperator()

Deprecated.

analyzer

public CommonTermsQueryBuilder analyzer(String 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 String analyzer()

Deprecated.

cutoffFrequency

public CommonTermsQueryBuilder cutoffFrequency(float 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(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 String highFreqMinimumShouldMatch()

Deprecated.

lowFreqMinimumShouldMatch

public CommonTermsQueryBuilder lowFreqMinimumShouldMatch(String lowFreqMinimumShouldMatch)

Deprecated.

Sets the minimum number of low frequent query terms that need to match in order to produce a hit.

lowFreqMinimumShouldMatch

public String lowFreqMinimumShouldMatch()

Deprecated.

doXContent

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

Deprecated.

Specified by:

doXContent in class AbstractQueryBuilder<CommonTermsQueryBuilder>

Throws:

IOException

fromXContent

public static CommonTermsQueryBuilder fromXContent(org.elasticsearch.common.xcontent.XContentParser parser)
                                            throws IOException

Deprecated.

Throws:

IOException

getWriteableName

public 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 IOException

Deprecated.

Specified by:

doToQuery in class AbstractQueryBuilder<CommonTermsQueryBuilder>

Throws:

IOException

doHashCode

protected int doHashCode()

Deprecated.

Specified by:

doHashCode in class AbstractQueryBuilder<CommonTermsQueryBuilder>

doEquals

protected boolean doEquals(CommonTermsQueryBuilder other)

Deprecated.

Description copied from class: AbstractQueryBuilder

Indicates whether some other QueryBuilder object of the same type is "equal to" this one.

Specified by:

doEquals in class AbstractQueryBuilder<CommonTermsQueryBuilder>