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.ParamsNested classes/interfaces inherited from interface org.elasticsearch.common.io.stream.Writeable
Writeable.Reader<V>, Writeable.Writer<V> -
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final Stringstatic final ParseFieldstatic final ParseFieldFields inherited from class org.elasticsearch.index.query.AbstractQueryBuilder
boost, BOOST_FIELD, DEFAULT_BOOST, NAME_FIELD, queryNameFields inherited from interface org.elasticsearch.index.query.Rewriteable
MAX_REWRITE_ROUNDSFields 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, otherwisenullExplicitly set the analyzer to use.protected booleandoEquals(MatchPhraseQueryBuilder other) Indicates whether some otherQueryBuilderobject of the same type is "equal to" this one.protected intprotected QueryBuilderOptional rewrite logic that only needs access to index level metadata and services (e.g.protected org.apache.lucene.search.QuerydoToQuery(SearchExecutionContext context) protected voiddoWriteTo(StreamOutput out) protected voiddoXContent(XContentBuilder builder, ToXContent.Params params) Returns the field name used in this query.static MatchPhraseQueryBuilderfromXContent(XContentParser parser) The minimal version of the recipient this object can be sent toReturns the name of the writeable objectintslop()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(String zeroTermsQueryString) 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, writeToMethods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, waitMethods 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:
doWriteToin 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.ALLinstead. -
zeroTermsQuery
-
zeroTermsQuery
-
getWriteableName
Description copied from interface:VersionedNamedWriteableReturns the name of the writeable object -
doXContent
- Specified by:
doXContentin classAbstractQueryBuilder<MatchPhraseQueryBuilder>- Throws:
IOException
-
doIndexMetadataRewrite
Description copied from class:AbstractQueryBuilderOptional 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:
doIndexMetadataRewritein classAbstractQueryBuilder<MatchPhraseQueryBuilder>- Parameters:
context- anQueryRewriteContextinstance that has access the mappings and other index metadata- Returns:
- A
QueryBuilderrepresenting 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:
doToQueryin classAbstractQueryBuilder<MatchPhraseQueryBuilder>- Throws:
IOException
-
doEquals
Description copied from class:AbstractQueryBuilderIndicates whether some otherQueryBuilderobject of the same type is "equal to" this one.- Specified by:
doEqualsin classAbstractQueryBuilder<MatchPhraseQueryBuilder>
-
doHashCode
protected int doHashCode()- Specified by:
doHashCodein classAbstractQueryBuilder<MatchPhraseQueryBuilder>
-
fromXContent
- Throws:
IOException
-
getMinimalSupportedVersion
Description copied from interface:VersionedNamedWriteableThe minimal version of the recipient this object can be sent to
-