org.elasticsearch.index.query

Class MultiMatchQueryBuilder

java.lang.Object

org.elasticsearch.action.support.ToXContentToBytes

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

org.elasticsearch.index.query.MultiMatchQueryBuilder

All Implemented Interfaces:

NamedWriteable, Writeable, ToXContent, QueryBuilder

public class MultiMatchQueryBuilder
extends AbstractQueryBuilder<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.io.stream.Writeable

Writeable.Reader<V>, Writeable.Writer<V>

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

ToXContent.DelegatingMapParams, ToXContent.MapParams, ToXContent.Params

Field Summary

Fields

Modifier and Type	Field and Description
static boolean	DEFAULT_LENIENCY
static int	DEFAULT_MAX_EXPANSIONS
static Operator	DEFAULT_OPERATOR
static int	DEFAULT_PHRASE_SLOP
static int	DEFAULT_PREFIX_LENGTH
static MultiMatchQueryBuilder.Type	DEFAULT_TYPE
static MatchQuery.ZeroTermsQuery	DEFAULT_ZERO_TERMS_QUERY
static java.lang.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.common.xcontent.ToXContent

EMPTY_PARAMS

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
java.lang.String	analyzer()
MultiMatchQueryBuilder	analyzer(java.lang.String analyzer) Explicitly set the analyzer to use.
java.lang.Float	cutoffFrequency()
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.
MultiMatchQueryBuilder	cutoffFrequency(java.lang.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.
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(QueryShardContext context)
protected void	doWriteTo(StreamOutput out)
void	doXContent(XContentBuilder builder, ToXContent.Params params)
MultiMatchQueryBuilder	field(java.lang.String field) Adds a field to run the multi match against.
MultiMatchQueryBuilder	field(java.lang.String field, float boost) Adds a field to run the multi match against with a specific boost.
java.util.Map<java.lang.String,java.lang.Float>	fields()
MultiMatchQueryBuilder	fields(java.util.Map<java.lang.String,java.lang.Float> fields) Add several fields to run the query against with a specific boost.
static java.util.Optional<MultiMatchQueryBuilder>	fromXContent(QueryParseContext parseContext)
Fuzziness	fuzziness()
MultiMatchQueryBuilder	fuzziness(java.lang.Object fuzziness) Sets the fuzziness used when evaluated to a fuzzy query type.
java.lang.String	fuzzyRewrite()
MultiMatchQueryBuilder	fuzzyRewrite(java.lang.String fuzzyRewrite)
MultiMatchQueryBuilder.Type	getType() Returns the type (for testing)
java.lang.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.
java.lang.String	minimumShouldMatch()
MultiMatchQueryBuilder	minimumShouldMatch(java.lang.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.
java.lang.Float	tieBreaker()
MultiMatchQueryBuilder	tieBreaker(float tieBreaker) Tie-Breaker for "best-match" disjunction queries (OR-Queries).
MultiMatchQueryBuilder	tieBreaker(java.lang.Float tieBreaker) Tie-Breaker for "best-match" disjunction queries (OR-Queries).
MultiMatchQueryBuilder.Type	type()
MultiMatchQueryBuilder	type(MultiMatchQueryBuilder.Type type) Sets the type of the text query.
MultiMatchQueryBuilder	type(java.lang.Object type) Sets the type of the text query.
java.lang.Boolean	useDisMax()
MultiMatchQueryBuilder	useDisMax(java.lang.Boolean useDisMax) Deprecated. use a tieBreaker of 1.0f to disable "dis-max" query or select the appropriate MultiMatchQueryBuilder.Type
java.lang.Object	value()
MatchQuery.ZeroTermsQuery	zeroTermsQuery()
MultiMatchQueryBuilder	zeroTermsQuery(MatchQuery.ZeroTermsQuery zeroTermsQuery)

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

addValidationError, boost, boost, convertToBytesRefIfString, convertToStringIfBytesRef, declareStandardFields, doRewrite, equals, extractInnerHitBuilders, getName, hashCode, printBoostAndQueryName, queryName, queryName, readQueries, requireValue, rewrite, throwParsingExceptionOnMultipleFields, toFilter, toQueries, toQuery, toXContent, writeQueries, writeTo

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

buildAsBytes, buildAsBytes, toString, toString

Methods inherited from class java.lang.Object

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

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

rewriteQuery

Field Detail

NAME

public static final java.lang.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_LENIENCY

public static final boolean DEFAULT_LENIENCY

See Also:

Constant Field Values

DEFAULT_ZERO_TERMS_QUERY

public static final MatchQuery.ZeroTermsQuery DEFAULT_ZERO_TERMS_QUERY

Constructor Detail

MultiMatchQueryBuilder

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

Constructs a new text query.

MultiMatchQueryBuilder

public MultiMatchQueryBuilder(StreamInput in)
                       throws java.io.IOException

Read from a stream.

Throws:

java.io.IOException

Method Detail

getType

public MultiMatchQueryBuilder.Type getType()

Returns the type (for testing)

doWriteTo

protected void doWriteTo(StreamOutput out)
                  throws java.io.IOException

Specified by:

doWriteTo in class AbstractQueryBuilder<MultiMatchQueryBuilder>

Throws:

java.io.IOException

value

public java.lang.Object value()

field

public MultiMatchQueryBuilder field(java.lang.String field)

Adds a field to run the multi match against.

field

public MultiMatchQueryBuilder field(java.lang.String field,
                                    float boost)

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

fields

public MultiMatchQueryBuilder fields(java.util.Map<java.lang.String,java.lang.Float> fields)

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

fields

public java.util.Map<java.lang.String,java.lang.Float> fields()

type

public MultiMatchQueryBuilder type(MultiMatchQueryBuilder.Type type)

Sets the type of the text query.

type

public MultiMatchQueryBuilder type(java.lang.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(java.lang.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 java.lang.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(java.lang.Object 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(java.lang.String minimumShouldMatch)

minimumShouldMatch

public java.lang.String minimumShouldMatch()

fuzzyRewrite

public MultiMatchQueryBuilder fuzzyRewrite(java.lang.String fuzzyRewrite)

fuzzyRewrite

public java.lang.String fuzzyRewrite()

useDisMax

@Deprecated
public MultiMatchQueryBuilder useDisMax(java.lang.Boolean useDisMax)

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

useDisMax

public java.lang.Boolean useDisMax()

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(java.lang.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 java.lang.Float tieBreaker()

lenient

public MultiMatchQueryBuilder lenient(boolean lenient)

Sets whether format based failures will be ignored.

lenient

public boolean lenient()

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.

cutoffFrequency

public MultiMatchQueryBuilder cutoffFrequency(java.lang.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.

cutoffFrequency

public java.lang.Float cutoffFrequency()

zeroTermsQuery

public MultiMatchQueryBuilder zeroTermsQuery(MatchQuery.ZeroTermsQuery zeroTermsQuery)

zeroTermsQuery

public MatchQuery.ZeroTermsQuery zeroTermsQuery()

doXContent

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

Specified by:

doXContent in class AbstractQueryBuilder<MultiMatchQueryBuilder>

Throws:

java.io.IOException

fromXContent

public static java.util.Optional<MultiMatchQueryBuilder> fromXContent(QueryParseContext parseContext)
                                                               throws java.io.IOException

Throws:

java.io.IOException

getWriteableName

public java.lang.String getWriteableName()

Description copied from interface: NamedWriteable

Returns the name of the writeable object

doToQuery

protected org.apache.lucene.search.Query doToQuery(QueryShardContext context)
                                            throws java.io.IOException

Specified by:

doToQuery in class AbstractQueryBuilder<MultiMatchQueryBuilder>

Throws:

java.io.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>