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
A filter for a field based on several terms matching on any of them.
-
Nested Class Summary
Nested ClassesNested classes/interfaces inherited from interface org.elasticsearch.xcontent.ToXContent
ToXContent.DelegatingMapParams, ToXContent.MapParams, ToXContent.ParamsNested classes/interfaces inherited from interface org.elasticsearch.common.io.stream.Writeable
Writeable.Reader<V>, Writeable.Writer<V> -
Field Summary
FieldsFields inherited from class org.elasticsearch.index.query.AbstractQueryBuilder
boost, BOOST_FIELD, DEFAULT_BOOST, NAME_FIELD, queryNameFields inherited from interface org.elasticsearch.index.query.Rewriteable
MAX_REWRITE_ROUNDSFields inherited from interface org.elasticsearch.xcontent.ToXContent
EMPTY, EMPTY_PARAMS -
Constructor Summary
ConstructorsConstructorDescriptionTermsQueryBuilder(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, 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, Collection<?> values) A filter for a field based on several terms matching on any of them.TermsQueryBuilder(String fieldName, TermsLookup termsLookup) Read from a stream. -
Method Summary
Modifier and TypeMethodDescriptionprotected QueryBuilderdoCoordinatorRewrite(CoordinatorRewriteContext coordinatorRewriteContext) protected booleandoEquals(TermsQueryBuilder other) Indicates whether some otherQueryBuilderobject of the same type is "equal to" this one.protected intprotected QueryBuilderOptional rewrite logic that only needs access to index level metadata and services (e.g.protected QueryBuilderdoRewrite(QueryRewriteContext queryRewriteContext) protected org.apache.lucene.search.QuerydoToQuery(SearchExecutionContext context) protected voiddoWriteTo(StreamOutput out) protected voiddoXContent(XContentBuilder builder, ToXContent.Params params) static TermsQueryBuilderfromXContent(XContentParser parser) The minimal version of the recipient this object can be sent toReturns the name of the writeable objectvalues()get readable values only forAbstractQueryBuilder.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, doInnerHitsRewrite, doSearchRewrite, equals, extractInnerHitBuilders, getMaxNestedDepth, getName, hashCode, parseInnerQueryBuilder, parseTopLevelQuery, parseTopLevelQuery, printBoostAndQueryName, queryName, queryName, readQueries, requireValue, rewrite, setMaxNestedDepth, throwParsingExceptionOnMultipleFields, toQuery, toString, toXContent, writeQueries, writeToMethods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, waitMethods inherited from interface org.elasticsearch.xcontent.ToXContentObject
isFragment
-
Field Details
-
NAME
- See Also:
-
-
Constructor Details
-
TermsQueryBuilder
-
TermsQueryBuilder
A filter for a field based on several terms matching on any of them.- Parameters:
fieldName- The field namevalues- The terms
-
TermsQueryBuilder
A filter for a field based on several terms matching on any of them.- Parameters:
fieldName- The field namevalues- The terms
-
TermsQueryBuilder
A filter for a field based on several terms matching on any of them.- Parameters:
fieldName- The field namevalues- The terms
-
TermsQueryBuilder
A filter for a field based on several terms matching on any of them.- Parameters:
fieldName- The field namevalues- The terms
-
TermsQueryBuilder
A filter for a field based on several terms matching on any of them.- Parameters:
fieldName- The field namevalues- The terms
-
TermsQueryBuilder
A filter for a field based on several terms matching on any of them.- Parameters:
fieldName- The field namevalues- The terms
-
TermsQueryBuilder
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:
IOException
-
-
Method Details
-
doWriteTo
- Specified by:
doWriteToin classAbstractQueryBuilder<TermsQueryBuilder>- Throws:
IOException
-
fieldName
-
getValues
-
values
get readable values only forAbstractQueryBuilder.toXContent(org.elasticsearch.xcontent.XContentBuilder, org.elasticsearch.xcontent.ToXContent.Params)and tests, don't use this to construct a query. usegetValues()instead. -
termsLookup
-
doXContent
- Specified by:
doXContentin classAbstractQueryBuilder<TermsQueryBuilder>- Throws:
IOException
-
fromXContent
- Throws:
IOException
-
getWriteableName
Description copied from interface:VersionedNamedWriteableReturns the name of the writeable object -
doToQuery
protected org.apache.lucene.search.Query doToQuery(SearchExecutionContext context) throws IOException - Specified by:
doToQueryin classAbstractQueryBuilder<TermsQueryBuilder>- Throws:
IOException
-
doHashCode
protected int doHashCode()- Specified by:
doHashCodein classAbstractQueryBuilder<TermsQueryBuilder>
-
doEquals
Description copied from class:AbstractQueryBuilderIndicates whether some otherQueryBuilderobject of the same type is "equal to" this one.- Specified by:
doEqualsin classAbstractQueryBuilder<TermsQueryBuilder>
-
doRewrite
- Overrides:
doRewritein classAbstractQueryBuilder<TermsQueryBuilder>- Throws:
IOException
-
doIndexMetadataRewrite
Description copied from class:AbstractQueryBuilderOptional 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:
doIndexMetadataRewritein classAbstractQueryBuilder<TermsQueryBuilder>- Parameters:
context- anQueryRewriteContextinstance that has access the mappings and other index metadata- Returns:
- A
QueryBuilderrepresenting the rewritten query, that could be used to determine whether this query yields result.
-
doCoordinatorRewrite
- Overrides:
doCoordinatorRewritein classAbstractQueryBuilder<TermsQueryBuilder>- Parameters:
coordinatorRewriteContext- AQueryRewriteContextthat enables limited rewrite capabilities happening on the coordinator node before execution moves to the data node.- Returns:
- A
QueryBuilderrepresenting the rewritten query which could be executed without going to the date node.
-
getMinimalSupportedVersion
Description copied from interface:VersionedNamedWriteableThe minimal version of the recipient this object can be sent to
-