Package org.opensearch.index.query

Class MatchPhrasePrefixQueryBuilder

java.lang.Object

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

org.opensearch.index.query.MatchPhrasePrefixQueryBuilder

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>

public class MatchPhrasePrefixQueryBuilder
extends AbstractQueryBuilder<MatchPhrasePrefixQueryBuilder>

Match query is a query that analyzes the text and constructs a phrase prefix query as the result of the analysis.

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 org.opensearch.core.ParseField	MAX_EXPANSIONS_FIELD
static final String	NAME
static final org.opensearch.core.ParseField	ZERO_TERMS_QUERY_FIELD

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
MatchPhrasePrefixQueryBuilder(String fieldName, Object value)
MatchPhrasePrefixQueryBuilder(org.opensearch.core.common.io.stream.StreamInput in)	Read from a stream.

Method Summary

Modifier and Type	Method	Description
String	analyzer()	Get the analyzer to use, if previously set, otherwise null
MatchPhrasePrefixQueryBuilder	analyzer(String analyzer)	Explicitly set the analyzer to use.
protected boolean	doEquals(MatchPhrasePrefixQueryBuilder 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 MatchPhrasePrefixQueryBuilder	fromXContent(org.opensearch.core.xcontent.XContentParser parser)
String	getWriteableName()
int	maxExpansions()	Get the (optional) number of term expansions when using fuzzy or prefix type query.
MatchPhrasePrefixQueryBuilder	maxExpansions(int maxExpansions)	The number of term expansions to use.
int	slop()	Get the slop factor for phrase queries.
MatchPhrasePrefixQueryBuilder	slop(int slop)	Sets a slop factor for phrase queries
Object	value()	Returns the value used in this query.
MatchQuery.ZeroTermsQuery	zeroTermsQuery()
MatchPhrasePrefixQueryBuilder	zeroTermsQuery(MatchQuery.ZeroTermsQuery zeroTermsQuery)	Sets query to use in case no query terms are available, e.g.

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

MAX_EXPANSIONS_FIELD

public static final org.opensearch.core.ParseField MAX_EXPANSIONS_FIELD

ZERO_TERMS_QUERY_FIELD

public static final org.opensearch.core.ParseField ZERO_TERMS_QUERY_FIELD

Constructor Details

MatchPhrasePrefixQueryBuilder

public MatchPhrasePrefixQueryBuilder(String fieldName,
 Object value)

MatchPhrasePrefixQueryBuilder

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

Read from a stream.

Throws:

IOException

Method Details

doWriteTo

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

Specified by:

doWriteTo in class AbstractQueryBuilder<MatchPhrasePrefixQueryBuilder>

Throws:

IOException

fieldName

public String fieldName()

Returns the field name used in this query.

value

public Object value()

Returns the value used in this query.

analyzer

public MatchPhrasePrefixQueryBuilder 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()

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

slop

public MatchPhrasePrefixQueryBuilder slop(int slop)

Sets a slop factor for phrase queries

slop

public int slop()

Get the slop factor for phrase queries.

maxExpansions

public MatchPhrasePrefixQueryBuilder maxExpansions(int maxExpansions)

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.

zeroTermsQuery

public MatchPhrasePrefixQueryBuilder zeroTermsQuery(MatchQuery.ZeroTermsQuery zeroTermsQuery)

Sets query to use in case no query terms are available, e.g. after analysis removed them. Defaults to MatchQuery.ZeroTermsQuery.NONE, but can be set to MatchQuery.ZeroTermsQuery.ALL instead.

zeroTermsQuery

public MatchQuery.ZeroTermsQuery zeroTermsQuery()

getWriteableName

public String getWriteableName()

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

Throws:

IOException

doToQuery

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

Specified by:

doToQuery in class AbstractQueryBuilder<MatchPhrasePrefixQueryBuilder>

Throws:

IOException

doEquals

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

doHashCode

protected int doHashCode()

Specified by:

doHashCode in class AbstractQueryBuilder<MatchPhrasePrefixQueryBuilder>

fromXContent

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

Throws:

IOException