org.elasticsearch.index.query

Class CommonTermsQueryBuilder

java.lang.Object

org.elasticsearch.action.support.ToXContentToBytes

org.elasticsearch.index.query.QueryBuilder

org.elasticsearch.index.query.CommonTermsQueryBuilder

All Implemented Interfaces:

ToXContent, BoostableQueryBuilder<CommonTermsQueryBuilder>

public class CommonTermsQueryBuilder
extends QueryBuilder
implements BoostableQueryBuilder<CommonTermsQueryBuilder>

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. Scores produced by this query will be slightly different to plain BooleanQuery scorer mainly due to differences in the number of leave queries in the required boolean clause. In the most cases high-frequency terms are unlikely to significantly contribute to the document score unless at least one of the low-frequency terms are matched such that this query can improve query execution times significantly if applicable.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CommonTermsQueryBuilder.Operator

Nested classes/interfaces inherited from interface org.elasticsearch.common.xcontent.ToXContent

ToXContent.DelegatingMapParams, ToXContent.MapParams, ToXContent.Params

Field Summary

Fields inherited from interface org.elasticsearch.common.xcontent.ToXContent

EMPTY_PARAMS

Constructor Summary

Constructors

Constructor and Description
CommonTermsQueryBuilder(String name, Object text) Constructs a new common terms query.

Method Summary

Methods

Modifier and Type	Method and Description
CommonTermsQueryBuilder	analyzer(String analyzer) Explicitly set the analyzer to use.
CommonTermsQueryBuilder	boost(float boost) Set the boost to apply to the query.
CommonTermsQueryBuilder	cutoffFrequency(float cutoffFrequency) Sets the cutoff document frequency for high / low frequent terms.
CommonTermsQueryBuilder	disableCoord(boolean disableCoord)
void	doXContent(XContentBuilder builder, ToXContent.Params params)
CommonTermsQueryBuilder	highFreqMinimumShouldMatch(String highFreqMinimumShouldMatch) Sets the minimum number of high frequent query terms that need to match in order to produce a hit when there are no low frequen terms.
CommonTermsQueryBuilder	highFreqOperator(CommonTermsQueryBuilder.Operator operator) Sets the operator to use for terms with a high document frequency (greater than or equal to cutoffFrequency(float).
CommonTermsQueryBuilder	lowFreqMinimumShouldMatch(String lowFreqMinimumShouldMatch) Sets the minimum number of low frequent query terms that need to match in order to produce a hit.
CommonTermsQueryBuilder	lowFreqOperator(CommonTermsQueryBuilder.Operator operator) Sets the operator to use for terms with a low document frequency (less than cutoffFrequency(float).
CommonTermsQueryBuilder	queryName(String queryName) Sets the query name for the filter that can be used when searching for matched_filters per hit.

Methods inherited from class org.elasticsearch.index.query.QueryBuilder

toXContent

Methods inherited from class org.elasticsearch.action.support.ToXContentToBytes

buildAsBytes, buildAsBytes, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

CommonTermsQueryBuilder

public CommonTermsQueryBuilder(String name,
                       Object text)

Constructs a new common terms query.

Method Detail

highFreqOperator

public CommonTermsQueryBuilder highFreqOperator(CommonTermsQueryBuilder.Operator operator)

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

lowFreqOperator

public CommonTermsQueryBuilder lowFreqOperator(CommonTermsQueryBuilder.Operator operator)

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

analyzer

public CommonTermsQueryBuilder analyzer(String analyzer)

Explicitly set the analyzer to use. Defaults to use explicit mapping config for the field, or, if not set, the default search analyzer.

boost

public CommonTermsQueryBuilder boost(float boost)

Set the boost to apply to the query.

Specified by:

boost in interface BoostableQueryBuilder<CommonTermsQueryBuilder>

cutoffFrequency

public CommonTermsQueryBuilder cutoffFrequency(float cutoffFrequency)

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

highFreqMinimumShouldMatch

public CommonTermsQueryBuilder highFreqMinimumShouldMatch(String highFreqMinimumShouldMatch)

Sets the minimum number of high frequent query terms that need to match in order to produce a hit when there are no low frequen terms.

lowFreqMinimumShouldMatch

public CommonTermsQueryBuilder lowFreqMinimumShouldMatch(String lowFreqMinimumShouldMatch)

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

disableCoord

public CommonTermsQueryBuilder disableCoord(boolean disableCoord)

queryName

public CommonTermsQueryBuilder queryName(String queryName)

Sets the query name for the filter that can be used when searching for matched_filters per hit.

doXContent

public void doXContent(XContentBuilder builder,
              ToXContent.Params params)
                throws IOException

Specified by:

doXContent in class QueryBuilder

Throws:

IOException