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.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
CombinedFieldsQueryBuilder(Object value, 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 other QueryBuilder 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(XContentBuilder builder, ToXContent.Params params)
CombinedFieldsQueryBuilder	field(String field)	Adds a field to run the query against.
CombinedFieldsQueryBuilder	field(String field, float boost)	Adds a field to run the query against with a specific boost.
Map<String,Float>	fields()
CombinedFieldsQueryBuilder	fields(Map<String,Float> fields)	Add several fields to run the query against with a specific boost.
static CombinedFieldsQueryBuilder	fromXContent(XContentParser parser)
TransportVersion	getMinimalSupportedVersion()	The minimal version of the recipient this object can be sent to
String	getWriteableName()	Returns the name of the writeable object
String	minimumShouldMatch()
CombinedFieldsQueryBuilder	minimumShouldMatch(String minimumShouldMatch)
Operator	operator()
CombinedFieldsQueryBuilder	operator(Operator operator)	Sets the operator to use for the top-level boolean query.
Object	value()
ZeroTermsQueryOption	zeroTermsQuery()
CombinedFieldsQueryBuilder	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, 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

CombinedFieldsQueryBuilder

public CombinedFieldsQueryBuilder(Object value,
 String... fields)

Constructs a new text query.

CombinedFieldsQueryBuilder

public CombinedFieldsQueryBuilder(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<CombinedFieldsQueryBuilder>

Throws:

IOException

value

public Object value()

field

public CombinedFieldsQueryBuilder field(String field)

Adds a field to run the query against.

field

public CombinedFieldsQueryBuilder field(String field,
 float boost)

Adds a field to run the query against with a specific boost.

fields

public CombinedFieldsQueryBuilder fields(Map<String,Float> fields)

Add several fields to run the query against with a specific boost.

fields

public Map<String,Float> fields()

operator

public CombinedFieldsQueryBuilder operator(Operator operator)

Sets the operator to use for the top-level boolean query. Defaults to OR.

operator

public Operator operator()

minimumShouldMatch

public CombinedFieldsQueryBuilder minimumShouldMatch(String minimumShouldMatch)

minimumShouldMatch

public String minimumShouldMatch()

zeroTermsQuery

public CombinedFieldsQueryBuilder zeroTermsQuery(ZeroTermsQueryOption zeroTermsQuery)

zeroTermsQuery

public ZeroTermsQueryOption zeroTermsQuery()

autoGenerateSynonymsPhraseQuery

public CombinedFieldsQueryBuilder autoGenerateSynonymsPhraseQuery(boolean enable)

autoGenerateSynonymsPhraseQuery

public boolean autoGenerateSynonymsPhraseQuery()

Whether phrase queries should be automatically generated for multi terms synonyms. Defaults to true.

doXContent

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

Specified by:

doXContent in class AbstractQueryBuilder<CombinedFieldsQueryBuilder>

Throws:

IOException

fromXContent

public static CombinedFieldsQueryBuilder 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<CombinedFieldsQueryBuilder>

Throws:

IOException

doHashCode

protected int doHashCode()

Specified by:

doHashCode in class AbstractQueryBuilder<CombinedFieldsQueryBuilder>

doEquals

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

getMinimalSupportedVersion

public TransportVersion getMinimalSupportedVersion()

Description copied from interface: VersionedNamedWriteable

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