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
,ToXContent
,ToXContentObject
,QueryBuilder
,Rewriteable<QueryBuilder>
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.common.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 java.lang.String
NAME
static ParseField
SLOP_FIELD
static ParseField
ZERO_TERMS_QUERY_FIELD
Fields inherited from class org.elasticsearch.index.query.AbstractQueryBuilder
boost, BOOST_FIELD, DEFAULT_BOOST, NAME_FIELD, queryName
-
Constructor Summary
Constructors Constructor Description MatchPhraseQueryBuilder(java.lang.String fieldName, java.lang.Object value)
MatchPhraseQueryBuilder(StreamInput in)
Read from a stream. -
Method Summary
Modifier and Type Method Description java.lang.String
analyzer()
Get the analyzer to use, if previously set, otherwisenull
MatchPhraseQueryBuilder
analyzer(java.lang.String analyzer)
Explicitly set the analyzer to use.protected boolean
doEquals(MatchPhraseQueryBuilder 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(QueryShardContext context)
protected void
doWriteTo(StreamOutput out)
protected void
doXContent(XContentBuilder builder, ToXContent.Params params)
java.lang.String
fieldName()
Returns the field name used in this query.static MatchPhraseQueryBuilder
fromXContent(XContentParser parser)
java.lang.String
getWriteableName()
Returns the name of the writeable objectint
slop()
Get the slop factor for phrase queries.MatchPhraseQueryBuilder
slop(int slop)
Sets a slop factor for phrase queriesjava.lang.Object
value()
Returns the value used in this query.MatchQuery.ZeroTermsQuery
zeroTermsQuery()
MatchPhraseQueryBuilder
zeroTermsQuery(MatchQuery.ZeroTermsQuery 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, doRewrite, equals, extractInnerHitBuilders, getName, hashCode, parseInnerQueryBuilder, printBoostAndQueryName, queryName, queryName, requireValue, rewrite, throwParsingExceptionOnMultipleFields, toQuery, toString, toXContent, writeTo
-
Field Details
-
NAME
public static final java.lang.String NAME- See Also:
- Constant Field Values
-
SLOP_FIELD
-
ZERO_TERMS_QUERY_FIELD
-
-
Constructor Details
-
MatchPhraseQueryBuilder
public MatchPhraseQueryBuilder(java.lang.String fieldName, java.lang.Object value) -
MatchPhraseQueryBuilder
Read from a stream.- Throws:
java.io.IOException
-
-
Method Details
-
doWriteTo
- Specified by:
doWriteTo
in classAbstractQueryBuilder<MatchPhraseQueryBuilder>
- Throws:
java.io.IOException
-
fieldName
public java.lang.String fieldName()Returns the field name used in this query. -
value
public java.lang.Object value()Returns the value used in this query. -
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 java.lang.String analyzer()Get the analyzer to use, if previously set, otherwisenull
-
slop
Sets a slop factor for phrase queries -
slop
public int slop()Get the slop factor for phrase queries. -
zeroTermsQuery
Sets query to use in case no query terms are available, e.g. after analysis removed them. Defaults toMatchQuery.ZeroTermsQuery.NONE
, but can be set toMatchQuery.ZeroTermsQuery.ALL
instead. -
zeroTermsQuery
-
getWriteableName
public java.lang.String getWriteableName()Description copied from interface:NamedWriteable
Returns the name of the writeable object -
doXContent
protected void doXContent(XContentBuilder builder, ToXContent.Params params) throws java.io.IOException- Specified by:
doXContent
in classAbstractQueryBuilder<MatchPhraseQueryBuilder>
- Throws:
java.io.IOException
-
doToQuery
protected org.apache.lucene.search.Query doToQuery(QueryShardContext context) throws java.io.IOException- Specified by:
doToQuery
in classAbstractQueryBuilder<MatchPhraseQueryBuilder>
- Throws:
java.io.IOException
-
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<MatchPhraseQueryBuilder>
-
doHashCode
protected int doHashCode()- Specified by:
doHashCode
in classAbstractQueryBuilder<MatchPhraseQueryBuilder>
-
fromXContent
public static MatchPhraseQueryBuilder fromXContent(XContentParser parser) throws java.io.IOException- Throws:
java.io.IOException
-