Module org.elasticsearch.server

Package org.elasticsearch.index.query

Class TermsQueryBuilder

java.lang.Object

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

org.elasticsearch.index.query.TermsQueryBuilder

All Implemented Interfaces:

NamedWriteable, VersionedNamedWriteable, Writeable, QueryBuilder, Rewriteable<QueryBuilder>, ToXContent, ToXContentObject

public class TermsQueryBuilder
extends AbstractQueryBuilder<TermsQueryBuilder>

A filter for a field based on several terms matching on any of them.

Nested Class Summary

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

ToXContent.DelegatingMapParams, ToXContent.MapParams, ToXContent.Params

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

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

Field Summary

Fields

Modifier and Type	Field	Description
static final 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.index.query.Rewriteable

MAX_REWRITE_ROUNDS

Fields inherited from interface org.elasticsearch.xcontent.ToXContent

EMPTY, EMPTY_PARAMS

Constructor Summary

Constructors

Constructor	Description
TermsQueryBuilder(String fieldName, double... values)	A filter for a field based on several terms matching on any of them.
TermsQueryBuilder(String fieldName, float... values)	A filter for a field based on several terms matching on any of them.
TermsQueryBuilder(String fieldName, int... values)	A filter for a field based on several terms matching on any of them.
TermsQueryBuilder(String fieldName, long... values)	A filter for a field based on several terms matching on any of them.
TermsQueryBuilder(String fieldName, Iterable<?> values)	A filter for a field based on several terms matching on any of them.
TermsQueryBuilder(String fieldName, Object... values)	A filter for a field based on several terms matching on any of them.
TermsQueryBuilder(String fieldName, String... values)	A filter for a field based on several terms matching on any of them.
TermsQueryBuilder(String fieldName, TermsLookup termsLookup)
TermsQueryBuilder(StreamInput in)	Read from a stream.

Method Summary

Modifier and Type	Method	Description
protected boolean	doEquals(TermsQueryBuilder other)	Indicates whether some other QueryBuilder object of the same type is "equal to" this one.
protected int	doHashCode()
protected QueryBuilder	doIndexMetadataRewrite(QueryRewriteContext context)	Optional rewrite logic that only needs access to index level metadata and services (e.g.
protected QueryBuilder	doRewrite(QueryRewriteContext queryRewriteContext)
protected org.apache.lucene.search.Query	doToQuery(SearchExecutionContext context)
protected void	doWriteTo(StreamOutput out)
protected void	doXContent(XContentBuilder builder, ToXContent.Params params)
String	fieldName()
static TermsQueryBuilder	fromXContent(XContentParser parser)
TransportVersion	getMinimalSupportedVersion()	The minimal version of the recipient this object can be sent to
org.elasticsearch.index.query.TermsQueryBuilder.Values	getValues()
String	getWriteableName()	Returns the name of the writeable object
TermsLookup	termsLookup()
List<Object>	values()	get readable values only for AbstractQueryBuilder.toXContent(org.elasticsearch.xcontent.XContentBuilder, org.elasticsearch.xcontent.ToXContent.Params) and tests, don't use this to construct a query.

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

addValidationError, boost, boost, boostAndQueryNameToXContent, checkNegativeBoost, declareStandardFields, doCoordinatorRewrite, doSearchRewrite, equals, extractInnerHitBuilders, getMaxNestedDepth, getName, hashCode, parseInnerQueryBuilder, parseTopLevelQuery, parseTopLevelQuery, printBoostAndQueryName, queryName, queryName, readQueries, requireValue, rewrite, setMaxNestedDepth, throwParsingExceptionOnMultipleFields, toQuery, toString, toXContent, writeQueries, writeTo

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.elasticsearch.xcontent.ToXContentObject

isFragment

Field Details

NAME

public static final String NAME

See Also:

• Constant Field Values

Constructor Details

TermsQueryBuilder

public TermsQueryBuilder(String fieldName,
 TermsLookup termsLookup)

TermsQueryBuilder

public TermsQueryBuilder(String fieldName,
 String... values)

A filter for a field based on several terms matching on any of them.

Parameters:

fieldName - The field name

values - The terms

TermsQueryBuilder

public TermsQueryBuilder(String fieldName,
 int... values)

A filter for a field based on several terms matching on any of them.

Parameters:

fieldName - The field name

values - The terms

TermsQueryBuilder

public TermsQueryBuilder(String fieldName,
 long... values)

A filter for a field based on several terms matching on any of them.

Parameters:

fieldName - The field name

values - The terms

TermsQueryBuilder

public TermsQueryBuilder(String fieldName,
 float... values)

A filter for a field based on several terms matching on any of them.

Parameters:

fieldName - The field name

values - The terms

TermsQueryBuilder

public TermsQueryBuilder(String fieldName,
 double... values)

A filter for a field based on several terms matching on any of them.

Parameters:

fieldName - The field name

values - The terms

TermsQueryBuilder

public TermsQueryBuilder(String fieldName,
 Object... values)

A filter for a field based on several terms matching on any of them.

Parameters:

fieldName - The field name

values - The terms

TermsQueryBuilder

public TermsQueryBuilder(String fieldName,
 Iterable<?> values)

A filter for a field based on several terms matching on any of them.

Parameters:

fieldName - The field name

values - The terms

TermsQueryBuilder

public TermsQueryBuilder(StreamInput in)
                  throws IOException

Read from a stream.

Throws:

IOException

Method Details

doWriteTo

protected void doWriteTo(StreamOutput out)
                  throws IOException

Specified by:

doWriteTo in class AbstractQueryBuilder<TermsQueryBuilder>

Throws:

IOException

fieldName

public String fieldName()

getValues

public org.elasticsearch.index.query.TermsQueryBuilder.Values getValues()

values

public List<Object> values()

get readable values only for AbstractQueryBuilder.toXContent(org.elasticsearch.xcontent.XContentBuilder, org.elasticsearch.xcontent.ToXContent.Params) and tests, don't use this to construct a query. use getValues() instead.

termsLookup

public TermsLookup termsLookup()

doXContent

protected void doXContent(XContentBuilder builder,
 ToXContent.Params params)
                   throws IOException

Specified by:

doXContent in class AbstractQueryBuilder<TermsQueryBuilder>

Throws:

IOException

fromXContent

public static TermsQueryBuilder fromXContent(XContentParser parser)
                                      throws IOException

Throws:

IOException

getWriteableName

public String getWriteableName()

Description copied from interface: VersionedNamedWriteable

Returns the name of the writeable object

doToQuery

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

Specified by:

doToQuery in class AbstractQueryBuilder<TermsQueryBuilder>

Throws:

IOException

doHashCode

protected int doHashCode()

Specified by:

doHashCode in class AbstractQueryBuilder<TermsQueryBuilder>

doEquals

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

doRewrite

protected QueryBuilder doRewrite(QueryRewriteContext queryRewriteContext)
                          throws IOException

Overrides:

doRewrite in class AbstractQueryBuilder<TermsQueryBuilder>

Throws:

IOException

doIndexMetadataRewrite

protected QueryBuilder doIndexMetadataRewrite(QueryRewriteContext context)
                                       throws IOException

Description copied from class: AbstractQueryBuilder

Optional rewrite logic that only needs access to index level metadata and services (e.g. index settings and mappings) on the data node, but not the shard / Lucene index. The can_match phase can use this logic to early terminate a search without doing any search related i/o.

Overrides:

doIndexMetadataRewrite in class AbstractQueryBuilder<TermsQueryBuilder>

Parameters:

context - an QueryRewriteContext instance that has access the mappings and other index metadata

Returns:

A QueryBuilder representing the rewritten query, that could be used to determine whether this query yields result.

Throws:

IOException

getMinimalSupportedVersion

public TransportVersion getMinimalSupportedVersion()

Description copied from interface: VersionedNamedWriteable

The minimal version of the recipient this object can be sent to