Module org.elasticsearch.server

Package org.elasticsearch.index.query

Class MultiMatchQueryBuilder

java.lang.Object

org.elasticsearch.index.query.AbstractQueryBuilder<MultiMatchQueryBuilder>

org.elasticsearch.index.query.MultiMatchQueryBuilder

All Implemented Interfaces:

NamedWriteable, VersionedNamedWriteable, Writeable, QueryBuilder, Rewriteable<QueryBuilder>, ToXContent, ToXContentObject

public class MultiMatchQueryBuilder
extends AbstractQueryBuilder<MultiMatchQueryBuilder>

Same as MatchQueryBuilder but supports multiple fields.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	MultiMatchQueryBuilder.Type

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

ToXContent.DelegatingMapParams, ToXContent.MapParams, 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 final boolean	DEFAULT_FUZZY_TRANSPOSITIONS
static final int	DEFAULT_MAX_EXPANSIONS
static final Operator	DEFAULT_OPERATOR
static final int	DEFAULT_PHRASE_SLOP
static final int	DEFAULT_PREFIX_LENGTH
static final MultiMatchQueryBuilder.Type	DEFAULT_TYPE
static final ZeroTermsQueryOption	DEFAULT_ZERO_TERMS_QUERY
static final String	NAME

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.xcontent.ToXContent

EMPTY_PARAMS

Constructor Summary

Constructors

Constructor	Description
MultiMatchQueryBuilder(Object value, String... fields)	Constructs a new text query.
MultiMatchQueryBuilder(StreamInput in)	Read from a stream.

Method Summary

Modifier and Type	Method	Description
String	analyzer()
MultiMatchQueryBuilder	analyzer(String analyzer)	Explicitly set the analyzer to use.
boolean	autoGenerateSynonymsPhraseQuery()	Whether phrase queries should be automatically generated for multi terms synonyms.
MultiMatchQueryBuilder	autoGenerateSynonymsPhraseQuery(boolean enable)
protected boolean	doEquals(MultiMatchQueryBuilder other)	Indicates whether some other QueryBuilder object of the same type is "equal to" this one.
protected int	doHashCode()
protected org.apache.lucene.search.Query	doToQuery(SearchExecutionContext context)
protected void	doWriteTo(StreamOutput out)
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.
Map<String,Float>	fields()
MultiMatchQueryBuilder	fields(Map<String,Float> fields)	Add several fields to run the query against with a specific boost.
static MultiMatchQueryBuilder	fromXContent(XContentParser parser)
Fuzziness	fuzziness()
MultiMatchQueryBuilder	fuzziness(Fuzziness fuzziness)	Sets the fuzziness used when evaluated to a fuzzy query type.
String	fuzzyRewrite()
MultiMatchQueryBuilder	fuzzyRewrite(String fuzzyRewrite)
boolean	fuzzyTranspositions()
MultiMatchQueryBuilder	fuzzyTranspositions(boolean fuzzyTranspositions)	Sets whether transpositions are supported in fuzzy queries.
Version	getMinimalSupportedVersion()	The minimal version of the recipient this object can be sent to
MultiMatchQueryBuilder.Type	getType()	Returns the type (for testing)
String	getWriteableName()	Returns the name of the writeable object
boolean	lenient()
MultiMatchQueryBuilder	lenient(boolean lenient)	Sets whether format based failures will be ignored.
int	maxExpansions()
MultiMatchQueryBuilder	maxExpansions(int maxExpansions)	When using fuzzy or prefix type query, the number of term expansions to use.
String	minimumShouldMatch()
MultiMatchQueryBuilder	minimumShouldMatch(String minimumShouldMatch)
Operator	operator()
MultiMatchQueryBuilder	operator(Operator operator)	Sets the operator to use when using a boolean query.
int	prefixLength()
MultiMatchQueryBuilder	prefixLength(int prefixLength)
int	slop()
MultiMatchQueryBuilder	slop(int slop)	Set the phrase slop if evaluated to a phrase query type.
Float	tieBreaker()
MultiMatchQueryBuilder	tieBreaker(float tieBreaker)	Tie-Breaker for "best-match" disjunction queries (OR-Queries).
MultiMatchQueryBuilder	tieBreaker(Float tieBreaker)	Tie-Breaker for "best-match" disjunction queries (OR-Queries).
MultiMatchQueryBuilder.Type	type()
MultiMatchQueryBuilder	type(Object type)	Sets the type of the text query.
MultiMatchQueryBuilder	type(MultiMatchQueryBuilder.Type type)	Sets the type of the text query.
Object	value()
ZeroTermsQueryOption	zeroTermsQuery()
MultiMatchQueryBuilder	zeroTermsQuery(ZeroTermsQueryOption zeroTermsQuery)

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

addValidationError, boost, boost, boostAndQueryNameToXContent, checkNegativeBoost, declareStandardFields, doRewrite, equals, extractInnerHitBuilders, getName, hashCode, parseInnerQueryBuilder, parseInnerQueryBuilder, printBoostAndQueryName, queryName, queryName, readQueries, requireValue, rewrite, throwParsingExceptionOnMultipleFields, toQuery, toString, toXContent, writeQueries, writeTo

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.elasticsearch.xcontent.ToXContentObject

isFragment

Field Details

NAME

public static final String NAME

See Also:

• Constant Field Values

DEFAULT_TYPE

public static final MultiMatchQueryBuilder.Type DEFAULT_TYPE

DEFAULT_OPERATOR

public static final Operator DEFAULT_OPERATOR

DEFAULT_PHRASE_SLOP

public static final int DEFAULT_PHRASE_SLOP

See Also:

• Constant Field Values

DEFAULT_PREFIX_LENGTH

public static final int DEFAULT_PREFIX_LENGTH

See Also:

• Constant Field Values

DEFAULT_MAX_EXPANSIONS

public static final int DEFAULT_MAX_EXPANSIONS

See Also:

• Constant Field Values

DEFAULT_ZERO_TERMS_QUERY

public static final ZeroTermsQueryOption DEFAULT_ZERO_TERMS_QUERY

DEFAULT_FUZZY_TRANSPOSITIONS

public static final boolean DEFAULT_FUZZY_TRANSPOSITIONS

See Also:

• Constant Field Values

Constructor Details

MultiMatchQueryBuilder

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

Constructs a new text query.

MultiMatchQueryBuilder

public MultiMatchQueryBuilder(StreamInput in)
                       throws IOException

Read from a stream.

Throws:

IOException

Method Details

getType

public MultiMatchQueryBuilder.Type getType()

Returns the type (for testing)

doWriteTo

protected void doWriteTo(StreamOutput out)
                  throws IOException

Specified by:

doWriteTo in class AbstractQueryBuilder<MultiMatchQueryBuilder>

Throws:

IOException

value

public Object value()

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.

fields

public MultiMatchQueryBuilder fields(Map<String,Float> fields)

Add several fields to run the query against with a specific boost.

fields

public Map<String,Float> fields()

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.

type

public MultiMatchQueryBuilder.Type type()

operator

public MultiMatchQueryBuilder operator(Operator operator)

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

operator

public Operator operator()

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.

analyzer

public String analyzer()

slop

public MultiMatchQueryBuilder slop(int slop)

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

slop

public int slop()

fuzziness

public MultiMatchQueryBuilder fuzziness(Fuzziness fuzziness)

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

fuzziness

public Fuzziness fuzziness()

prefixLength

public MultiMatchQueryBuilder prefixLength(int prefixLength)

prefixLength

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

maxExpansions

public int maxExpansions()

minimumShouldMatch

public MultiMatchQueryBuilder minimumShouldMatch(String minimumShouldMatch)

minimumShouldMatch

public String minimumShouldMatch()

fuzzyRewrite

public MultiMatchQueryBuilder fuzzyRewrite(String fuzzyRewrite)

fuzzyRewrite

public String fuzzyRewrite()

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

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

tieBreaker

public Float tieBreaker()

lenient

public MultiMatchQueryBuilder lenient(boolean lenient)

Sets whether format based failures will be ignored.

lenient

public boolean lenient()

zeroTermsQuery

public MultiMatchQueryBuilder zeroTermsQuery(ZeroTermsQueryOption zeroTermsQuery)

zeroTermsQuery

public ZeroTermsQueryOption zeroTermsQuery()

autoGenerateSynonymsPhraseQuery

public MultiMatchQueryBuilder autoGenerateSynonymsPhraseQuery(boolean enable)

autoGenerateSynonymsPhraseQuery

public boolean autoGenerateSynonymsPhraseQuery()

Whether phrase queries should be automatically generated for multi terms synonyms. Defaults to true.

fuzzyTranspositions

public boolean fuzzyTranspositions()

fuzzyTranspositions

public MultiMatchQueryBuilder fuzzyTranspositions(boolean fuzzyTranspositions)

Sets whether transpositions are supported in fuzzy queries.

The default metric used by fuzzy queries to determine a match is the Damerau-Levenshtein distance formula which supports transpositions. Setting transposition to false will switch to classic Levenshtein distance.
If not set, Damerau-Levenshtein distance metric will be used.

doXContent

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

Specified by:

doXContent in class AbstractQueryBuilder<MultiMatchQueryBuilder>

Throws:

IOException

fromXContent

public static MultiMatchQueryBuilder fromXContent(XContentParser parser)
                                           throws IOException

Throws:

IOException

getWriteableName

public String getWriteableName()

Description copied from interface: VersionedNamedWriteable

Returns the name of the writeable object

doToQuery

protected org.apache.lucene.search.Query doToQuery(SearchExecutionContext context)
                                            throws IOException

Specified by:

doToQuery in class AbstractQueryBuilder<MultiMatchQueryBuilder>

Throws:

IOException

doHashCode

protected int doHashCode()

Specified by:

doHashCode in class AbstractQueryBuilder<MultiMatchQueryBuilder>

doEquals

protected boolean doEquals(MultiMatchQueryBuilder other)

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

getMinimalSupportedVersion

public Version getMinimalSupportedVersion()

Description copied from interface: VersionedNamedWriteable

The minimal version of the recipient this object can be sent to