Module org.elasticsearch.server
Package org.elasticsearch.index.query
Class MatchPhrasePrefixQueryBuilder
java.lang.Object
org.elasticsearch.index.query.AbstractQueryBuilder<MatchPhrasePrefixQueryBuilder>
org.elasticsearch.index.query.MatchPhrasePrefixQueryBuilder
- All Implemented Interfaces:
NamedWriteable,VersionedNamedWriteable,Writeable,QueryBuilder,Rewriteable<QueryBuilder>,ToXContent,ToXContentObject
public class MatchPhrasePrefixQueryBuilder
extends AbstractQueryBuilder<MatchPhrasePrefixQueryBuilder>
Match query is a query that analyzes the text and constructs a phrase prefix
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 ParseFieldstatic final Stringstatic 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
ConstructorsConstructorDescriptionMatchPhrasePrefixQueryBuilder(String fieldName, Object value) Read from a stream. -
Method Summary
Modifier and TypeMethodDescriptionExplicitly set the analyzer to use.protected booleanIndicates whether some otherQueryBuilderobject of the same type is "equal to" this one.protected intprotected 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.fromXContent(XContentParser parser) The minimal version of the recipient this object can be sent toReturns the name of the writeable objectintGet the (optional) number of term expansions when using fuzzy or prefix type query.maxExpansions(int maxExpansions) The number of term expansions to use.intslop()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, doIndexMetadataRewrite, 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:
-
MAX_EXPANSIONS_FIELD
-
ZERO_TERMS_QUERY_FIELD
-
-
Constructor Details
-
MatchPhrasePrefixQueryBuilder
-
MatchPhrasePrefixQueryBuilder
Read from a stream.- Throws:
IOException
-
-
Method Details
-
doWriteTo
- Specified by:
doWriteToin classAbstractQueryBuilder<MatchPhrasePrefixQueryBuilder>- 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. -
slop
Sets a slop factor for phrase queries -
slop
public int slop()Get the slop factor for phrase queries. -
maxExpansions
The number of term expansions to use. -
maxExpansions
public int maxExpansions()Get the (optional) number of term expansions when using fuzzy or prefix type query. -
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
-
getWriteableName
Description copied from interface:VersionedNamedWriteableReturns the name of the writeable object -
doXContent
- Specified by:
doXContentin classAbstractQueryBuilder<MatchPhrasePrefixQueryBuilder>- Throws:
IOException
-
doToQuery
protected org.apache.lucene.search.Query doToQuery(SearchExecutionContext context) throws IOException - Specified by:
doToQueryin classAbstractQueryBuilder<MatchPhrasePrefixQueryBuilder>- Throws:
IOException
-
doEquals
Description copied from class:AbstractQueryBuilderIndicates whether some otherQueryBuilderobject of the same type is "equal to" this one.- Specified by:
doEqualsin classAbstractQueryBuilder<MatchPhrasePrefixQueryBuilder>
-
doHashCode
protected int doHashCode()- Specified by:
doHashCodein classAbstractQueryBuilder<MatchPhrasePrefixQueryBuilder>
-
fromXContent
- Throws:
IOException
-
getMinimalSupportedVersion
Description copied from interface:VersionedNamedWriteableThe minimal version of the recipient this object can be sent to
-