org.elasticsearch.index.query

Class MultiMatchQueryBuilder

java.lang.Object

org.elasticsearch.action.support.ToXContentToBytes

org.elasticsearch.index.query.QueryBuilder

org.elasticsearch.index.query.MultiMatchQueryBuilder

All Implemented Interfaces:

ToXContent, BoostableQueryBuilder<MultiMatchQueryBuilder>

public class MultiMatchQueryBuilder
extends QueryBuilder
implements BoostableQueryBuilder<MultiMatchQueryBuilder>

Same as MatchQueryBuilder but supports multiple fields.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	MultiMatchQueryBuilder.Type

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

Method Summary

Methods

Modifier and Type	Method and Description
MultiMatchQueryBuilder	analyzer(String analyzer) Explicitly set the analyzer to use.
MultiMatchQueryBuilder	boost(float boost) Set the boost to apply to the query.
MultiMatchQueryBuilder	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)
MultiMatchQueryBuilder	field(String field) Adds a field to run the multi match against.
MultiMatchQueryBuilder	field(String field, float boost) Adds a field to run the multi match against with a specific boost.
MultiMatchQueryBuilder	fuzziness(Object fuzziness) Sets the fuzziness used when evaluated to a fuzzy query type.
MultiMatchQueryBuilder	fuzzyRewrite(String fuzzyRewrite)
MultiMatchQueryBuilder.Type	getType() Returns the type (for testing)
MultiMatchQueryBuilder	lenient(boolean lenient) Sets whether format based failures will be ignored.
MultiMatchQueryBuilder	maxExpansions(int maxExpansions) When using fuzzy or prefix type query, the number of term expansions to use.
MultiMatchQueryBuilder	minimumShouldMatch(String minimumShouldMatch)
MultiMatchQueryBuilder	operator(MatchQueryBuilder.Operator operator) Sets the operator to use when using a boolean query.
MultiMatchQueryBuilder	prefixLength(int prefixLength)
MultiMatchQueryBuilder	queryName(String queryName) Sets the query name for the filter that can be used when searching for matched_filters per hit.
MultiMatchQueryBuilder	slop(int slop) Set the phrase slop if evaluated to a phrase query type.
MultiMatchQueryBuilder	tieBreaker(float tieBreaker) Tie-Breaker for "best-match" disjunction queries (OR-Queries).
MultiMatchQueryBuilder	type(MultiMatchQueryBuilder.Type type) Sets the type of the text query.
MultiMatchQueryBuilder	type(Object type) Sets the type of the text query.
MultiMatchQueryBuilder	useDisMax(boolean useDisMax) Deprecated. use a tieBreaker of 1.0f to disable "dis-max" query or select the appropriate MultiMatchQueryBuilder.Type
MultiMatchQueryBuilder	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

MultiMatchQueryBuilder

public MultiMatchQueryBuilder(Object text,
                      String... fields)

Constructs a new text query.

Method Detail

getType

public MultiMatchQueryBuilder.Type getType()

Returns the type (for testing)

field

public MultiMatchQueryBuilder field(String field)

Adds a field to run the multi match against.

field

public MultiMatchQueryBuilder field(String field,
                           float boost)

Adds a field to run the multi match against with a specific boost.

type

public MultiMatchQueryBuilder type(MultiMatchQueryBuilder.Type type)

Sets the type of the text query.

type

public MultiMatchQueryBuilder type(Object type)

Sets the type of the text query.

operator

public MultiMatchQueryBuilder operator(MatchQueryBuilder.Operator operator)

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

analyzer

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

Set the boost to apply to the query.

Specified by:

boost in interface BoostableQueryBuilder<MultiMatchQueryBuilder>

slop

public MultiMatchQueryBuilder slop(int slop)

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

fuzziness

public MultiMatchQueryBuilder fuzziness(Object fuzziness)

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

prefixLength

public MultiMatchQueryBuilder prefixLength(int prefixLength)

maxExpansions

public MultiMatchQueryBuilder 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.

minimumShouldMatch

public MultiMatchQueryBuilder minimumShouldMatch(String minimumShouldMatch)

fuzzyRewrite

public MultiMatchQueryBuilder fuzzyRewrite(String fuzzyRewrite)

useDisMax

@Deprecated
public MultiMatchQueryBuilder useDisMax(boolean useDisMax)

Deprecated. use a tieBreaker of 1.0f to disable "dis-max" query or select the appropriate MultiMatchQueryBuilder.Type

tieBreaker

public MultiMatchQueryBuilder tieBreaker(float tieBreaker)

Tie-Breaker for "best-match" disjunction queries (OR-Queries). The tie breaker capability allows documents that match more than one query clause (in this case on more than one field) to be scored better than documents that match only the best of the fields, without confusing this with the better case of two distinct matches in the multiple fields.

A tie-breaker value of 1.0 is interpreted as a signal to score queries as "most-match" queries where all matching query clauses are considered for scoring.

See Also:

MultiMatchQueryBuilder.Type

lenient

public MultiMatchQueryBuilder lenient(boolean lenient)

Sets whether format based failures will be ignored.

cutoffFrequency

public MultiMatchQueryBuilder 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.

zeroTermsQuery

public MultiMatchQueryBuilder zeroTermsQuery(MatchQueryBuilder.ZeroTermsQuery zeroTermsQuery)

queryName

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