java.lang.Object
org.elasticsearch.index.query.AbstractQueryBuilder<MatchPhraseQueryBuilder>
org.elasticsearch.index.query.MatchPhraseQueryBuilder
- All Implemented Interfaces:
NamedWriteable
,VersionedNamedWriteable
,Writeable
,QueryBuilder
,Rewriteable<QueryBuilder>
,ToXContent
,ToXContentObject
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
FieldsModifier and TypeFieldDescriptionstatic final String
static final ParseField
static final ParseField
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 -
Method Summary
Modifier and TypeMethodDescriptionanalyzer()
Get the analyzer to use, if previously set, otherwisenull
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
protected QueryBuilder
Optional rewrite logic that only needs access to index level metadata and services (e.g.protected org.apache.lucene.search.Query
doToQuery
(SearchExecutionContext context) protected void
doWriteTo
(StreamOutput out) protected void
doXContent
(XContentBuilder builder, ToXContent.Params params) Returns the field name used in this query.static MatchPhraseQueryBuilder
fromXContent
(XContentParser parser) The minimal version of the recipient this object can be sent toReturns the name of the writeable objectint
slop()
Get the slop factor for phrase queries.slop
(int slop) Sets a slop factor for phrase queriesvalue()
Returns the value used in this query.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, boostAndQueryNameToXContent, checkNegativeBoost, declareStandardFields, doCoordinatorRewrite, 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
- See Also:
-
SLOP_FIELD
-
ZERO_TERMS_QUERY_FIELD
-
-
Constructor Details
-
MatchPhraseQueryBuilder
-
MatchPhraseQueryBuilder
Read from a stream.- Throws:
IOException
-
-
Method Details
-
doWriteTo
- Specified by:
doWriteTo
in classAbstractQueryBuilder<MatchPhraseQueryBuilder>
- Throws:
IOException
-
fieldName
Returns the field name used in this query. -
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
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 toZeroTermsQueryOption.NONE
, but can be set toZeroTermsQueryOption.ALL
instead. -
zeroTermsQuery
-
getWriteableName
Description copied from interface:VersionedNamedWriteable
Returns the name of the writeable object -
doXContent
- Specified by:
doXContent
in classAbstractQueryBuilder<MatchPhraseQueryBuilder>
- Throws:
IOException
-
doIndexMetadataRewrite
Description copied from class:AbstractQueryBuilder
Optional rewrite logic that only needs access to index level metadata and services (e.g. index settings and mappings) on the data node, but not the shard / Lucene index. The can_match phase can use this logic to early terminate a search without doing any search related i/o.- Overrides:
doIndexMetadataRewrite
in classAbstractQueryBuilder<MatchPhraseQueryBuilder>
- Parameters:
context
- anQueryRewriteContext
instance that has access the mappings and other index metadata- Returns:
- A
QueryBuilder
representing the rewritten query, that could be used to determine whether this query yields result. - Throws:
IOException
-
doToQuery
protected org.apache.lucene.search.Query doToQuery(SearchExecutionContext context) throws IOException - Specified by:
doToQuery
in classAbstractQueryBuilder<MatchPhraseQueryBuilder>
- Throws:
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
- Throws:
IOException
-
getMinimalSupportedVersion
Description copied from interface:VersionedNamedWriteable
The minimal version of the recipient this object can be sent to
-