Package org.opensearch.index.query

Class PrefixQueryBuilder

java.lang.Object

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

org.opensearch.index.query.PrefixQueryBuilder

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, MultiTermQueryBuilder, QueryBuilder, Rewriteable<QueryBuilder>, WithFieldName

public class PrefixQueryBuilder
extends AbstractQueryBuilder<PrefixQueryBuilder>
implements MultiTermQueryBuilder

A Query that matches documents containing terms with a specified prefix.

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 boolean	DEFAULT_CASE_INSENSITIVITY
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
PrefixQueryBuilder(String fieldName, String value)	A Query that matches documents containing terms with a specified prefix.
PrefixQueryBuilder(org.opensearch.core.common.io.stream.StreamInput in)	Read from a stream.

Method Summary

Modifier and Type	Method	Description
boolean	caseInsensitive()
PrefixQueryBuilder	caseInsensitive(boolean caseInsensitive)
protected boolean	doEquals(PrefixQueryBuilder other)	Indicates whether some other QueryBuilder object of the same type is "equal to" this one.
protected final int	doHashCode()
protected QueryBuilder	doRewrite(QueryRewriteContext queryRewriteContext)
protected org.apache.lucene.search.Query	doToQuery(QueryShardContext context)
protected void	doWriteTo(org.opensearch.core.common.io.stream.StreamOutput out)
void	doXContent(org.opensearch.core.xcontent.XContentBuilder builder, org.opensearch.core.xcontent.ToXContent.Params params)
String	fieldName()	Get the field name for this query.
static PrefixQueryBuilder	fromXContent(org.opensearch.core.xcontent.XContentParser parser)
String	getWriteableName()
String	rewrite()
PrefixQueryBuilder	rewrite(String rewrite)
String	value()

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

addValidationError, boost, boost, checkNegativeBoost, declareStandardFields, 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

boost, boost, getName, queryName, queryName, rewrite, toQuery, visit

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

toXContent

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

isFragment

Methods inherited from interface org.opensearch.core.common.io.stream.Writeable

writeTo

Field Details

NAME

public static final String NAME

See Also:

• Constant Field Values

DEFAULT_CASE_INSENSITIVITY

public static final boolean DEFAULT_CASE_INSENSITIVITY

See Also:

• Constant Field Values

Constructor Details

PrefixQueryBuilder

public PrefixQueryBuilder(String fieldName,
 String value)

A Query that matches documents containing terms with a specified prefix.

Parameters:

fieldName - The name of the field

value - The prefix query

PrefixQueryBuilder

public PrefixQueryBuilder(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<PrefixQueryBuilder>

Throws:

IOException

fieldName

public String fieldName()

Description copied from interface: WithFieldName

Get the field name for this query.

Specified by:

fieldName in interface WithFieldName

value

public String value()

caseInsensitive

public PrefixQueryBuilder caseInsensitive(boolean caseInsensitive)

caseInsensitive

public boolean caseInsensitive()

rewrite

public PrefixQueryBuilder rewrite(String rewrite)

rewrite

public String rewrite()

doXContent

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

Specified by:

doXContent in class AbstractQueryBuilder<PrefixQueryBuilder>

Throws:

IOException

fromXContent

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

Throws:

IOException

getWriteableName

public String getWriteableName()

Specified by:

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

doRewrite

protected QueryBuilder doRewrite(QueryRewriteContext queryRewriteContext)
                          throws IOException

Overrides:

doRewrite in class AbstractQueryBuilder<PrefixQueryBuilder>

Throws:

IOException

doToQuery

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

Specified by:

doToQuery in class AbstractQueryBuilder<PrefixQueryBuilder>

Throws:

IOException

doHashCode

protected final int doHashCode()

Specified by:

doHashCode in class AbstractQueryBuilder<PrefixQueryBuilder>

doEquals

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