Package org.opensearch.index.query

Class TermQueryBuilder

java.lang.Object

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

org.opensearch.index.query.BaseTermQueryBuilder<TermQueryBuilder>

org.opensearch.index.query.TermQueryBuilder

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 TermQueryBuilder
extends BaseTermQueryBuilder<TermQueryBuilder>

A Query that matches documents containing a term.

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

fieldName, value

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
TermQueryBuilder(String fieldName, boolean value)
TermQueryBuilder(String fieldName, double value)
TermQueryBuilder(String fieldName, float value)
TermQueryBuilder(String fieldName, int value)
TermQueryBuilder(String fieldName, long value)
TermQueryBuilder(String fieldName, Object value)
TermQueryBuilder(String fieldName, String value)
TermQueryBuilder(org.opensearch.core.common.io.stream.StreamInput in)	Read from a stream.

Method Summary

Modifier and Type	Method	Description
protected void	addExtraXContent(org.opensearch.core.xcontent.XContentBuilder builder, org.opensearch.core.xcontent.ToXContent.Params params)
boolean	caseInsensitive()
TermQueryBuilder	caseInsensitive(boolean caseInsensitive)
protected final boolean	doEquals(TermQueryBuilder 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)
static TermQueryBuilder	fromXContent(org.opensearch.core.xcontent.XContentParser parser)
String	getWriteableName()

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

doXContent, fieldName, 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

visit

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

isFragment

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

TermQueryBuilder

public TermQueryBuilder(String fieldName,
 String value)

See Also:

• BaseTermQueryBuilder(String, String)

TermQueryBuilder

public TermQueryBuilder(String fieldName,
 int value)

See Also:

• BaseTermQueryBuilder(String, int)

TermQueryBuilder

public TermQueryBuilder(String fieldName,
 long value)

See Also:

• BaseTermQueryBuilder(String, long)

TermQueryBuilder

public TermQueryBuilder(String fieldName,
 float value)

See Also:

• BaseTermQueryBuilder(String, float)

TermQueryBuilder

public TermQueryBuilder(String fieldName,
 double value)

See Also:

• BaseTermQueryBuilder(String, double)

TermQueryBuilder

public TermQueryBuilder(String fieldName,
 boolean value)

See Also:

• BaseTermQueryBuilder(String, boolean)

TermQueryBuilder

public TermQueryBuilder(String fieldName,
 Object value)

See Also:

• BaseTermQueryBuilder(String, Object)

TermQueryBuilder

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

Read from a stream.

Throws:

IOException

Method Details

caseInsensitive

public TermQueryBuilder caseInsensitive(boolean caseInsensitive)

caseInsensitive

public boolean caseInsensitive()

doWriteTo

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

Overrides:

doWriteTo in class BaseTermQueryBuilder<TermQueryBuilder>

Throws:

IOException

fromXContent

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

Throws:

IOException

addExtraXContent

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

Overrides:

addExtraXContent in class BaseTermQueryBuilder<TermQueryBuilder>

Throws:

IOException

doRewrite

protected QueryBuilder doRewrite(QueryRewriteContext queryRewriteContext)
                          throws IOException

Overrides:

doRewrite in class AbstractQueryBuilder<TermQueryBuilder>

Throws:

IOException

doToQuery

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

Specified by:

doToQuery in class AbstractQueryBuilder<TermQueryBuilder>

Throws:

IOException

getWriteableName

public String getWriteableName()

doHashCode

protected final int doHashCode()

Overrides:

doHashCode in class BaseTermQueryBuilder<TermQueryBuilder>

doEquals

protected final boolean doEquals(TermQueryBuilder other)

Description copied from class: AbstractQueryBuilder

Indicates whether some other QueryBuilder object of the same type is "equal to" this one.

Overrides:

doEquals in class BaseTermQueryBuilder<TermQueryBuilder>