Package org.elasticsearch.index.query

Class MatchPhraseQueryBuilder

java.lang.Object

org.elasticsearch.index.query.AbstractQueryBuilder<MatchPhraseQueryBuilder>

org.elasticsearch.index.query.MatchPhraseQueryBuilder

All Implemented Interfaces:

NamedWriteable, Writeable, QueryBuilder, Rewriteable<QueryBuilder>, ToXContent, ToXContentObject

public class MatchPhraseQueryBuilder
extends AbstractQueryBuilder<MatchPhraseQueryBuilder>

Match query is a query that analyzes the text and constructs a phrase query as the result of the analysis.

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
static final ParseField	SLOP_FIELD
static final ParseField	ZERO_TERMS_QUERY_FIELD

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_PARAMS

Constructor Summary

Constructors

Constructor	Description
MatchPhraseQueryBuilder(String fieldName, Object value)
MatchPhraseQueryBuilder(StreamInput in)	Read from a stream.

Method Summary

Modifier and Type	Method	Description
String	analyzer()	Get the analyzer to use, if previously set, otherwise null
MatchPhraseQueryBuilder	analyzer(String analyzer)	Explicitly set the analyzer to use.
protected boolean	doEquals(MatchPhraseQueryBuilder other)	Indicates whether some other QueryBuilder 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(XContentBuilder builder, ToXContent.Params params)
String	fieldName()	Returns the field name used in this query.
static MatchPhraseQueryBuilder	fromXContent(XContentParser parser)
String	getWriteableName()	Returns the name of the writeable object
int	slop()	Get the slop factor for phrase queries.
MatchPhraseQueryBuilder	slop(int slop)	Sets a slop factor for phrase queries
Object	value()	Returns the value used in this query.
ZeroTermsQueryOption	zeroTermsQuery()
MatchPhraseQueryBuilder	zeroTermsQuery(ZeroTermsQueryOption zeroTermsQuery)	Sets query to use in case no query terms are available, e.g.

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.xcontent.ToXContentObject

isFragment

Field Details

NAME

public static final String NAME

See Also:

• Constant Field Values

SLOP_FIELD

public static final ParseField SLOP_FIELD

ZERO_TERMS_QUERY_FIELD

public static final ParseField ZERO_TERMS_QUERY_FIELD

Constructor Details

MatchPhraseQueryBuilder

public MatchPhraseQueryBuilder(String fieldName,
 Object value)

MatchPhraseQueryBuilder

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

Throws:

IOException

fieldName

public String fieldName()

Returns the field name used in this query.

value

public Object value()

Returns the value used in this query.

analyzer

public MatchPhraseQueryBuilder analyzer(String analyzer)

Explicitly set the analyzer to use. Defaults to use explicit mapping config for the field, or, if not set, the default search analyzer.

analyzer

public String analyzer()

Get the analyzer to use, if previously set, otherwise null

slop

public MatchPhraseQueryBuilder slop(int slop)

Sets a slop factor for phrase queries

slop

public int slop()

Get the slop factor for phrase queries.

zeroTermsQuery

public MatchPhraseQueryBuilder zeroTermsQuery(ZeroTermsQueryOption zeroTermsQuery)

Sets query to use in case no query terms are available, e.g. after analysis removed them. Defaults to ZeroTermsQueryOption.NONE, but can be set to ZeroTermsQueryOption.ALL instead.

zeroTermsQuery

public ZeroTermsQueryOption zeroTermsQuery()

getWriteableName

public String getWriteableName()

Description copied from interface: NamedWriteable

Returns the name of the writeable object

doXContent

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

Specified by:

doXContent in class AbstractQueryBuilder<MatchPhraseQueryBuilder>

Throws:

IOException

doRewrite

protected QueryBuilder doRewrite(QueryRewriteContext queryRewriteContext)
                          throws IOException

Overrides:

doRewrite in class AbstractQueryBuilder<MatchPhraseQueryBuilder>

Throws:

IOException

doToQuery

protected org.apache.lucene.search.Query doToQuery(SearchExecutionContext context)
                                            throws IOException

Specified by:

doToQuery in class AbstractQueryBuilder<MatchPhraseQueryBuilder>

Throws:

IOException

doEquals

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

doHashCode

protected int doHashCode()

Specified by:

doHashCode in class AbstractQueryBuilder<MatchPhraseQueryBuilder>

fromXContent

public static MatchPhraseQueryBuilder fromXContent(XContentParser parser)
                                            throws IOException

Throws:

IOException