org.elasticsearch.index.query

Class MatchQueryBuilder

java.lang.Object

org.elasticsearch.action.support.ToXContentToBytes

org.elasticsearch.index.query.QueryBuilder

org.elasticsearch.index.query.MatchQueryBuilder

All Implemented Interfaces:

ToXContent, BoostableQueryBuilder<MatchQueryBuilder>

public class MatchQueryBuilder
extends QueryBuilder
implements BoostableQueryBuilder<MatchQueryBuilder>

Match query is a query that analyzes the text and constructs a query as the result of the analysis. It can construct different queries based on the type provided.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	MatchQueryBuilder.Operator
static class	MatchQueryBuilder.Type
static class	MatchQueryBuilder.ZeroTermsQuery

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
MatchQueryBuilder(String name, Object text) Constructs a new text query.

Method Summary

Methods

Modifier and Type	Method and Description
MatchQueryBuilder	analyzer(String analyzer) Explicitly set the analyzer to use.
MatchQueryBuilder	boost(float boost) Set the boost to apply to the query.
MatchQueryBuilder	cutoffFrequency(float cutoff) Set a cutoff value in [0..1] (or absolute number >=1) representing the maximum threshold of a terms document frequency to be considered a low frequency term.
void	doXContent(XContentBuilder builder, ToXContent.Params params)
MatchQueryBuilder	fuzziness(Object fuzziness) Sets the fuzziness used when evaluated to a fuzzy query type.
MatchQueryBuilder	fuzzyRewrite(String fuzzyRewrite)
MatchQueryBuilder	fuzzyTranspositions(boolean fuzzyTranspositions)
MatchQueryBuilder	maxExpansions(int maxExpansions) When using fuzzy or prefix type query, the number of term expansions to use.
MatchQueryBuilder	minimumShouldMatch(String minimumShouldMatch)
MatchQueryBuilder	operator(MatchQueryBuilder.Operator operator) Sets the operator to use when using a boolean query.
MatchQueryBuilder	prefixLength(int prefixLength)
MatchQueryBuilder	queryName(String queryName) Sets the query name for the filter that can be used when searching for matched_filters per hit.
MatchQueryBuilder	setLenient(boolean lenient) Sets whether format based failures will be ignored.
MatchQueryBuilder	slop(int slop) Set the phrase slop if evaluated to a phrase query type.
MatchQueryBuilder	type(MatchQueryBuilder.Type type) Sets the type of the text query.
MatchQueryBuilder	zeroTermsQuery(MatchQueryBuilder.ZeroTermsQuery zeroTermsQuery)

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

MatchQueryBuilder

public MatchQueryBuilder(String name,
                 Object text)

Constructs a new text query.

Method Detail

type

public MatchQueryBuilder type(MatchQueryBuilder.Type type)

Sets the type of the text query.

operator

public MatchQueryBuilder operator(MatchQueryBuilder.Operator operator)

Sets the operator to use when using a boolean query. Defaults to OR.

analyzer

public MatchQueryBuilder 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 MatchQueryBuilder boost(float boost)

Set the boost to apply to the query.

Specified by:

boost in interface BoostableQueryBuilder<MatchQueryBuilder>

slop

public MatchQueryBuilder slop(int slop)

Set the phrase slop if evaluated to a phrase query type.

fuzziness

public MatchQueryBuilder fuzziness(Object fuzziness)

Sets the fuzziness used when evaluated to a fuzzy query type. Defaults to "AUTO".

prefixLength

public MatchQueryBuilder prefixLength(int prefixLength)

maxExpansions

public MatchQueryBuilder maxExpansions(int maxExpansions)

When using fuzzy or prefix type query, the number of term expansions to use. Defaults to unbounded so its recommended to set it to a reasonable value for faster execution.

cutoffFrequency

public MatchQueryBuilder cutoffFrequency(float cutoff)

Set a cutoff value in [0..1] (or absolute number >=1) representing the maximum threshold of a terms document frequency to be considered a low frequency term.

minimumShouldMatch

public MatchQueryBuilder minimumShouldMatch(String minimumShouldMatch)

fuzzyRewrite

public MatchQueryBuilder fuzzyRewrite(String fuzzyRewrite)

fuzzyTranspositions

public MatchQueryBuilder fuzzyTranspositions(boolean fuzzyTranspositions)

setLenient

public MatchQueryBuilder setLenient(boolean lenient)

Sets whether format based failures will be ignored.

zeroTermsQuery

public MatchQueryBuilder zeroTermsQuery(MatchQueryBuilder.ZeroTermsQuery zeroTermsQuery)

queryName

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