Module org.elasticsearch.server
Package org.elasticsearch.index.query
Class CombinedFieldsQueryBuilder
java.lang.Object
org.elasticsearch.index.query.AbstractQueryBuilder<CombinedFieldsQueryBuilder>
org.elasticsearch.index.query.CombinedFieldsQueryBuilder
- All Implemented Interfaces:
NamedWriteable,VersionedNamedWriteable,Writeable,QueryBuilder,Rewriteable<QueryBuilder>,ToXContent,ToXContentObject
public final class CombinedFieldsQueryBuilder
extends AbstractQueryBuilder<CombinedFieldsQueryBuilder>
A query that matches on multiple text fields, as if the field contents had been indexed
into a single combined field.
-
Nested Class Summary
Nested 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
ConstructorsConstructorDescriptionCombinedFieldsQueryBuilder(Object value, String... fields) Constructs a new text query.Read from a stream. -
Method Summary
Modifier and TypeMethodDescriptionbooleanWhether phrase queries should be automatically generated for multi terms synonyms.autoGenerateSynonymsPhraseQuery(boolean enable) protected booleanIndicates whether some otherQueryBuilderobject of the same type is "equal to" this one.protected intprotected org.apache.lucene.search.QuerydoToQuery(SearchExecutionContext context) protected voiddoWriteTo(StreamOutput out) voiddoXContent(XContentBuilder builder, ToXContent.Params params) Adds a field to run the query against.Adds a field to run the query against with a specific boost.fields()Add several fields to run the query against with a specific boost.static CombinedFieldsQueryBuilderfromXContent(XContentParser parser) The minimal version of the recipient this object can be sent toReturns the name of the writeable objectminimumShouldMatch(String minimumShouldMatch) operator()Sets the operator to use for the top-level boolean query.value()zeroTermsQuery(ZeroTermsQueryOption zeroTermsQuery) Methods inherited from class org.elasticsearch.index.query.AbstractQueryBuilder
addValidationError, boost, boost, boostAndQueryNameToXContent, checkNegativeBoost, declareStandardFields, doCoordinatorRewrite, doIndexMetadataRewrite, doInnerHitsRewrite, doRewrite, 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
-
CombinedFieldsQueryBuilder
Constructs a new text query. -
CombinedFieldsQueryBuilder
Read from a stream.- Throws:
IOException
-
-
Method Details
-
doWriteTo
- Specified by:
doWriteToin classAbstractQueryBuilder<CombinedFieldsQueryBuilder>- Throws:
IOException
-
value
-
field
Adds a field to run the query against. -
field
Adds a field to run the query against with a specific boost. -
fields
Add several fields to run the query against with a specific boost. -
fields
-
operator
Sets the operator to use for the top-level boolean query. Defaults toOR. -
operator
-
minimumShouldMatch
-
minimumShouldMatch
-
zeroTermsQuery
-
zeroTermsQuery
-
autoGenerateSynonymsPhraseQuery
-
autoGenerateSynonymsPhraseQuery
public boolean autoGenerateSynonymsPhraseQuery()Whether phrase queries should be automatically generated for multi terms synonyms. Defaults totrue. -
doXContent
- Specified by:
doXContentin classAbstractQueryBuilder<CombinedFieldsQueryBuilder>- 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<CombinedFieldsQueryBuilder>- Throws:
IOException
-
doHashCode
protected int doHashCode()- Specified by:
doHashCodein classAbstractQueryBuilder<CombinedFieldsQueryBuilder>
-
doEquals
Description copied from class:AbstractQueryBuilderIndicates whether some otherQueryBuilderobject of the same type is "equal to" this one.- Specified by:
doEqualsin classAbstractQueryBuilder<CombinedFieldsQueryBuilder>
-
getMinimalSupportedVersion
Description copied from interface:VersionedNamedWriteableThe minimal version of the recipient this object can be sent to
-