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
,Writeable
,org.elasticsearch.common.xcontent.ToXContent
,org.elasticsearch.common.xcontent.ToXContentObject
,QueryBuilder
,Rewriteable<QueryBuilder>
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.common.xcontent.ToXContent
org.elasticsearch.common.xcontent.ToXContent.DelegatingMapParams, org.elasticsearch.common.xcontent.ToXContent.MapParams, org.elasticsearch.common.xcontent.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 java.lang.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.common.xcontent.ToXContent
EMPTY_PARAMS
-
Constructor Summary
Constructors Constructor Description TermsQueryBuilder(java.lang.String fieldName, double... values)
A filter for a field based on several terms matching on any of them.TermsQueryBuilder(java.lang.String fieldName, float... values)
A filter for a field based on several terms matching on any of them.TermsQueryBuilder(java.lang.String fieldName, int... values)
A filter for a field based on several terms matching on any of them.TermsQueryBuilder(java.lang.String fieldName, long... values)
A filter for a field based on several terms matching on any of them.TermsQueryBuilder(java.lang.String fieldName, java.lang.Iterable<?> values)
A filter for a field based on several terms matching on any of them.TermsQueryBuilder(java.lang.String fieldName, java.lang.Object... values)
A filter for a field based on several terms matching on any of them.TermsQueryBuilder(java.lang.String fieldName, java.lang.String... values)
A filter for a field based on several terms matching on any of them.TermsQueryBuilder(java.lang.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 otherQueryBuilder
object of the same type is "equal to" this one.protected int
doHashCode()
protected QueryBuilder
doRewrite(QueryRewriteContext queryRewriteContext)
protected org.apache.lucene.search.Query
doToQuery(SearchExecutionContext context)
protected void
doWriteTo(StreamOutput out)
protected void
doXContent(org.elasticsearch.common.xcontent.XContentBuilder builder, org.elasticsearch.common.xcontent.ToXContent.Params params)
java.lang.String
fieldName()
static TermsQueryBuilder
fromXContent(org.elasticsearch.common.xcontent.XContentParser parser)
org.elasticsearch.index.query.TermsQueryBuilder.Values
getValues()
java.lang.String
getWriteableName()
Returns the name of the writeable objectboolean
isTypeless()
TermsLookup
termsLookup()
java.util.List<java.lang.Object>
values()
get readable values only forAbstractQueryBuilder.toXContent(org.elasticsearch.common.xcontent.XContentBuilder, org.elasticsearch.common.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, checkNegativeBoost, declareStandardFields, equals, extractInnerHitBuilders, getName, hashCode, parseInnerQueryBuilder, 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.elasticsearch.common.xcontent.ToXContentObject
isFragment
-
Field Details
-
NAME
public static final java.lang.String NAME- See Also:
- Constant Field Values
-
-
Constructor Details
-
TermsQueryBuilder
-
TermsQueryBuilder
public TermsQueryBuilder(java.lang.String fieldName, java.lang.String... values)A filter for a field based on several terms matching on any of them.- Parameters:
fieldName
- The field namevalues
- The terms
-
TermsQueryBuilder
public TermsQueryBuilder(java.lang.String fieldName, int... values)A filter for a field based on several terms matching on any of them.- Parameters:
fieldName
- The field namevalues
- The terms
-
TermsQueryBuilder
public TermsQueryBuilder(java.lang.String fieldName, long... values)A filter for a field based on several terms matching on any of them.- Parameters:
fieldName
- The field namevalues
- The terms
-
TermsQueryBuilder
public TermsQueryBuilder(java.lang.String fieldName, float... values)A filter for a field based on several terms matching on any of them.- Parameters:
fieldName
- The field namevalues
- The terms
-
TermsQueryBuilder
public TermsQueryBuilder(java.lang.String fieldName, double... values)A filter for a field based on several terms matching on any of them.- Parameters:
fieldName
- The field namevalues
- The terms
-
TermsQueryBuilder
public TermsQueryBuilder(java.lang.String fieldName, java.lang.Object... values)A filter for a field based on several terms matching on any of them.- Parameters:
fieldName
- The field namevalues
- The terms
-
TermsQueryBuilder
public TermsQueryBuilder(java.lang.String fieldName, java.lang.Iterable<?> values)A filter for a field based on several terms matching on any of them.- Parameters:
fieldName
- The field namevalues
- The terms
-
TermsQueryBuilder
Read from a stream.- Throws:
java.io.IOException
-
-
Method Details
-
doWriteTo
- Specified by:
doWriteTo
in classAbstractQueryBuilder<TermsQueryBuilder>
- Throws:
java.io.IOException
-
fieldName
public java.lang.String fieldName() -
getValues
public org.elasticsearch.index.query.TermsQueryBuilder.Values getValues() -
values
public java.util.List<java.lang.Object> values()get readable values only forAbstractQueryBuilder.toXContent(org.elasticsearch.common.xcontent.XContentBuilder, org.elasticsearch.common.xcontent.ToXContent.Params)
and tests, don't use this to construct a query. usegetValues()
instead. -
termsLookup
-
isTypeless
public boolean isTypeless() -
doXContent
protected void doXContent(org.elasticsearch.common.xcontent.XContentBuilder builder, org.elasticsearch.common.xcontent.ToXContent.Params params) throws java.io.IOException- Specified by:
doXContent
in classAbstractQueryBuilder<TermsQueryBuilder>
- Throws:
java.io.IOException
-
fromXContent
public static TermsQueryBuilder fromXContent(org.elasticsearch.common.xcontent.XContentParser parser) throws java.io.IOException- Throws:
java.io.IOException
-
getWriteableName
public java.lang.String getWriteableName()Description copied from interface:NamedWriteable
Returns the name of the writeable object -
doToQuery
protected org.apache.lucene.search.Query doToQuery(SearchExecutionContext context) throws java.io.IOException- Specified by:
doToQuery
in classAbstractQueryBuilder<TermsQueryBuilder>
- Throws:
java.io.IOException
-
doHashCode
protected int doHashCode()- Specified by:
doHashCode
in classAbstractQueryBuilder<TermsQueryBuilder>
-
doEquals
Description copied from class:AbstractQueryBuilder
Indicates whether some otherQueryBuilder
object of the same type is "equal to" this one.- Specified by:
doEquals
in classAbstractQueryBuilder<TermsQueryBuilder>
-
doRewrite
- Overrides:
doRewrite
in classAbstractQueryBuilder<TermsQueryBuilder>
-