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
,Writeable
,org.elasticsearch.common.xcontent.ToXContent
,org.elasticsearch.common.xcontent.ToXContentObject
,QueryBuilder
,Rewriteable<QueryBuilder>
public 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.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 CombinedFieldsQueryBuilder(java.lang.Object value, java.lang.String... fields)
Constructs a new text query.CombinedFieldsQueryBuilder(StreamInput in)
Read from a stream. -
Method Summary
Modifier and Type Method Description boolean
autoGenerateSynonymsPhraseQuery()
Whether phrase queries should be automatically generated for multi terms synonyms.CombinedFieldsQueryBuilder
autoGenerateSynonymsPhraseQuery(boolean enable)
protected boolean
doEquals(CombinedFieldsQueryBuilder other)
Indicates whether some otherQueryBuilder
object of the same type is "equal to" this one.protected int
doHashCode()
protected org.apache.lucene.search.Query
doToQuery(SearchExecutionContext context)
protected void
doWriteTo(StreamOutput out)
void
doXContent(org.elasticsearch.common.xcontent.XContentBuilder builder, org.elasticsearch.common.xcontent.ToXContent.Params params)
CombinedFieldsQueryBuilder
field(java.lang.String field)
Adds a field to run the query against.CombinedFieldsQueryBuilder
field(java.lang.String field, float boost)
Adds a field to run the query against with a specific boost.java.util.Map<java.lang.String,java.lang.Float>
fields()
CombinedFieldsQueryBuilder
fields(java.util.Map<java.lang.String,java.lang.Float> fields)
Add several fields to run the query against with a specific boost.static CombinedFieldsQueryBuilder
fromXContent(org.elasticsearch.common.xcontent.XContentParser parser)
java.lang.String
getWriteableName()
Returns the name of the writeable objectjava.lang.String
minimumShouldMatch()
CombinedFieldsQueryBuilder
minimumShouldMatch(java.lang.String minimumShouldMatch)
Operator
operator()
CombinedFieldsQueryBuilder
operator(Operator operator)
Sets the operator to use for the top-level boolean query.java.lang.Object
value()
ZeroTermsQueryOption
zeroTermsQuery()
CombinedFieldsQueryBuilder
zeroTermsQuery(ZeroTermsQueryOption zeroTermsQuery)
Methods inherited from class org.elasticsearch.index.query.AbstractQueryBuilder
addValidationError, boost, boost, checkNegativeBoost, declareStandardFields, doRewrite, 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
-
CombinedFieldsQueryBuilder
public CombinedFieldsQueryBuilder(java.lang.Object value, java.lang.String... fields)Constructs a new text query. -
CombinedFieldsQueryBuilder
Read from a stream.- Throws:
java.io.IOException
-
-
Method Details
-
doWriteTo
- Specified by:
doWriteTo
in classAbstractQueryBuilder<CombinedFieldsQueryBuilder>
- Throws:
java.io.IOException
-
value
public java.lang.Object 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
public java.util.Map<java.lang.String,java.lang.Float> fields() -
operator
Sets the operator to use for the top-level boolean query. Defaults toOR
. -
operator
-
minimumShouldMatch
-
minimumShouldMatch
public java.lang.String minimumShouldMatch() -
zeroTermsQuery
-
zeroTermsQuery
-
autoGenerateSynonymsPhraseQuery
-
autoGenerateSynonymsPhraseQuery
public boolean autoGenerateSynonymsPhraseQuery()Whether phrase queries should be automatically generated for multi terms synonyms. Defaults totrue
. -
doXContent
public void doXContent(org.elasticsearch.common.xcontent.XContentBuilder builder, org.elasticsearch.common.xcontent.ToXContent.Params params) throws java.io.IOException- Specified by:
doXContent
in classAbstractQueryBuilder<CombinedFieldsQueryBuilder>
- Throws:
java.io.IOException
-
fromXContent
public static CombinedFieldsQueryBuilder 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<CombinedFieldsQueryBuilder>
- Throws:
java.io.IOException
-
doHashCode
protected int doHashCode()- Specified by:
doHashCode
in classAbstractQueryBuilder<CombinedFieldsQueryBuilder>
-
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<CombinedFieldsQueryBuilder>
-