Package org.opensearch.index.query

Class MatchBoolPrefixQueryBuilder

java.lang.Object

org.opensearch.index.query.AbstractQueryBuilder<MatchBoolPrefixQueryBuilder>

org.opensearch.index.query.MatchBoolPrefixQueryBuilder

All Implemented Interfaces:

org.opensearch.core.common.io.stream.NamedWriteable, org.opensearch.core.common.io.stream.Writeable, org.opensearch.core.xcontent.ToXContent, org.opensearch.core.xcontent.ToXContentObject, QueryBuilder, Rewriteable<QueryBuilder>, WithFieldName

public class MatchBoolPrefixQueryBuilder
extends AbstractQueryBuilder<MatchBoolPrefixQueryBuilder>
implements WithFieldName

The boolean prefix query analyzes the input text and creates a boolean query containing a Term query for each term, except for the last term, which is used to create a prefix query

Opensearch.internal:

Nested Class Summary

Nested classes/interfaces inherited from interface org.opensearch.core.xcontent.ToXContent

org.opensearch.core.xcontent.ToXContent.DelegatingMapParams, org.opensearch.core.xcontent.ToXContent.MapParams, org.opensearch.core.xcontent.ToXContent.Params

Nested classes/interfaces inherited from interface org.opensearch.core.common.io.stream.Writeable

org.opensearch.core.common.io.stream.Writeable.Reader<V>, org.opensearch.core.common.io.stream.Writeable.WriteableRegistry, org.opensearch.core.common.io.stream.Writeable.Writer<V>

Field Summary

Fields

Modifier and Type	Field	Description
static final String	NAME

Fields inherited from class org.opensearch.index.query.AbstractQueryBuilder

boost, BOOST_FIELD, DEFAULT_BOOST, NAME_FIELD, queryName

Fields inherited from interface org.opensearch.index.query.Rewriteable

MAX_REWRITE_ROUNDS

Fields inherited from interface org.opensearch.core.xcontent.ToXContent

EMPTY_PARAMS

Constructor Summary

Constructors

Constructor	Description
MatchBoolPrefixQueryBuilder(String fieldName, Object value)
MatchBoolPrefixQueryBuilder(org.opensearch.core.common.io.stream.StreamInput in)

Method Summary

Modifier and Type	Method	Description
String	analyzer()	Get the analyzer to use, if previously set, otherwise null
MatchBoolPrefixQueryBuilder	analyzer(String analyzer)	Explicitly set the analyzer to use.
protected boolean	doEquals(MatchBoolPrefixQueryBuilder 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(org.opensearch.core.common.io.stream.StreamOutput out)
protected void	doXContent(org.opensearch.core.xcontent.XContentBuilder builder, org.opensearch.core.xcontent.ToXContent.Params params)
String	fieldName()	Returns the field name used in this query.
static MatchBoolPrefixQueryBuilder	fromXContent(org.opensearch.core.xcontent.XContentParser parser)
Fuzziness	fuzziness()	Gets the fuzziness used when evaluated to a fuzzy query type.
MatchBoolPrefixQueryBuilder	fuzziness(Object fuzziness)	Deprecated.
MatchBoolPrefixQueryBuilder	fuzziness(Fuzziness fuzziness)	Sets the fuzziness used when evaluated to a fuzzy query type.
String	fuzzyRewrite()	Get the fuzzy_rewrite parameter
MatchBoolPrefixQueryBuilder	fuzzyRewrite(String fuzzyRewrite)	Sets the fuzzy_rewrite parameter controlling how the fuzzy query will get rewritten
boolean	fuzzyTranspositions()	Gets the fuzzy query transposition setting.
MatchBoolPrefixQueryBuilder	fuzzyTranspositions(boolean fuzzyTranspositions)	Sets whether transpositions are supported in fuzzy queries.
String	getWriteableName()
int	maxExpansions()	Get the (optional) number of term expansions when using fuzzy or prefix type query.
MatchBoolPrefixQueryBuilder	maxExpansions(int maxExpansions)	When using fuzzy or prefix type query, the number of term expansions to use.
String	minimumShouldMatch()	Gets the minimumShouldMatch value
MatchBoolPrefixQueryBuilder	minimumShouldMatch(String minimumShouldMatch)	Sets optional minimumShouldMatch value to apply to the query
Operator	operator()	Returns the operator to use in a boolean query.
MatchBoolPrefixQueryBuilder	operator(Operator operator)	Sets the operator to use when using a boolean query.
int	prefixLength()	Gets the length of a length of common (non-fuzzy) prefix for fuzzy match queries
MatchBoolPrefixQueryBuilder	prefixLength(int prefixLength)	Sets the length of a length of common (non-fuzzy) prefix for fuzzy match queries
Object	value()	Returns the value used in this query.

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

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

Methods inherited from class java.lang.Object

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

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

visit

Methods inherited from interface org.opensearch.core.xcontent.ToXContentObject

isFragment

Field Details

NAME

public static final String NAME

See Also:

• Constant Field Values

Constructor Details

MatchBoolPrefixQueryBuilder

public MatchBoolPrefixQueryBuilder(String fieldName,
 Object value)

MatchBoolPrefixQueryBuilder

public MatchBoolPrefixQueryBuilder(org.opensearch.core.common.io.stream.StreamInput in)
                            throws IOException

Throws:

IOException

Method Details

doWriteTo

protected void doWriteTo(org.opensearch.core.common.io.stream.StreamOutput out)
                  throws IOException

Specified by:

doWriteTo in class AbstractQueryBuilder<MatchBoolPrefixQueryBuilder>

Throws:

IOException

fieldName

public String fieldName()

Returns the field name used in this query.

Specified by:

fieldName in interface WithFieldName

value

public Object value()

Returns the value used in this query.

analyzer

public String analyzer()

Get the analyzer to use, if previously set, otherwise null

analyzer

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

operator

public MatchBoolPrefixQueryBuilder operator(Operator operator)

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

operator

public Operator operator()

Returns the operator to use in a boolean query.

minimumShouldMatch

public MatchBoolPrefixQueryBuilder minimumShouldMatch(String minimumShouldMatch)

Sets optional minimumShouldMatch value to apply to the query

minimumShouldMatch

public String minimumShouldMatch()

Gets the minimumShouldMatch value

fuzziness

@Deprecated
public MatchBoolPrefixQueryBuilder fuzziness(Object fuzziness)

Deprecated.

fuzziness

public MatchBoolPrefixQueryBuilder fuzziness(Fuzziness fuzziness)

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

fuzziness

public Fuzziness fuzziness()

Gets the fuzziness used when evaluated to a fuzzy query type.

prefixLength

public MatchBoolPrefixQueryBuilder prefixLength(int prefixLength)

Sets the length of a length of common (non-fuzzy) prefix for fuzzy match queries

Parameters:

prefixLength - non-negative length of prefix

Throws:

IllegalArgumentException - in case the prefix is negative

prefixLength

public int prefixLength()

Gets the length of a length of common (non-fuzzy) prefix for fuzzy match queries

maxExpansions

public MatchBoolPrefixQueryBuilder maxExpansions(int maxExpansions)

When using fuzzy or prefix type query, the number of term expansions to use.

maxExpansions

public int maxExpansions()

Get the (optional) number of term expansions when using fuzzy or prefix type query.

fuzzyTranspositions

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

fuzzyTranspositions

public boolean fuzzyTranspositions()

Gets the fuzzy query transposition setting.

fuzzyRewrite

public MatchBoolPrefixQueryBuilder fuzzyRewrite(String fuzzyRewrite)

Sets the fuzzy_rewrite parameter controlling how the fuzzy query will get rewritten

fuzzyRewrite

public String fuzzyRewrite()

Get the fuzzy_rewrite parameter

See Also:

• fuzzyRewrite(String)

doXContent

protected void doXContent(org.opensearch.core.xcontent.XContentBuilder builder,
 org.opensearch.core.xcontent.ToXContent.Params params)
                   throws IOException

Specified by:

doXContent in class AbstractQueryBuilder<MatchBoolPrefixQueryBuilder>

Throws:

IOException

fromXContent

public static MatchBoolPrefixQueryBuilder fromXContent(org.opensearch.core.xcontent.XContentParser parser)
                                                throws IOException

Throws:

IOException

doToQuery

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

Specified by:

doToQuery in class AbstractQueryBuilder<MatchBoolPrefixQueryBuilder>

Throws:

IOException

doEquals

protected boolean doEquals(MatchBoolPrefixQueryBuilder 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<MatchBoolPrefixQueryBuilder>

doHashCode

protected int doHashCode()

Specified by:

doHashCode in class AbstractQueryBuilder<MatchBoolPrefixQueryBuilder>

getWriteableName

public String getWriteableName()

Specified by:

getWriteableName in interface org.opensearch.core.common.io.stream.NamedWriteable