Package org.elasticsearch.index.query
Class MatchBoolPrefixQueryBuilder
java.lang.Object
org.elasticsearch.index.query.AbstractQueryBuilder<MatchBoolPrefixQueryBuilder>
org.elasticsearch.index.query.MatchBoolPrefixQueryBuilder
- All Implemented Interfaces:
NamedWriteable
,Writeable
,ToXContent
,ToXContentObject
,QueryBuilder
,Rewriteable<QueryBuilder>
public class MatchBoolPrefixQueryBuilder extends AbstractQueryBuilder<MatchBoolPrefixQueryBuilder>
The boolean prefix query analyzes the input text and creates a boolean query containing a Term query for each term, except
for the last term, which is used to create a prefix query
-
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
Fields inherited from class org.elasticsearch.index.query.AbstractQueryBuilder
boost, BOOST_FIELD, DEFAULT_BOOST, NAME_FIELD, queryName
-
Constructor Summary
Constructors Constructor Description MatchBoolPrefixQueryBuilder(java.lang.String fieldName, java.lang.Object value)
MatchBoolPrefixQueryBuilder(StreamInput in)
-
Method Summary
Modifier and Type Method Description java.lang.String
analyzer()
Get the analyzer to use, if previously set, otherwisenull
MatchBoolPrefixQueryBuilder
analyzer(java.lang.String analyzer)
Explicitly set the analyzer to use.protected boolean
doEquals(MatchBoolPrefixQueryBuilder 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 MatchBoolPrefixQueryBuilder
fromXContent(XContentParser parser)
Fuzziness
fuzziness()
Gets the fuzziness used when evaluated to a fuzzy query type.MatchBoolPrefixQueryBuilder
fuzziness(java.lang.Object fuzziness)
Sets the fuzziness used when evaluated to a fuzzy query type.java.lang.String
fuzzyRewrite()
Get the fuzzy_rewrite parameterMatchBoolPrefixQueryBuilder
fuzzyRewrite(java.lang.String fuzzyRewrite)
Sets the fuzzy_rewrite parameter controlling how the fuzzy query will get rewrittenboolean
fuzzyTranspositions()
Gets the fuzzy query transposition setting.MatchBoolPrefixQueryBuilder
fuzzyTranspositions(boolean fuzzyTranspositions)
Sets whether transpositions are supported in fuzzy queries.java.lang.String
getWriteableName()
Returns the name of the writeable objectint
maxExpansions()
Get the (optional) number of term expansions when using fuzzy or prefix type query.MatchBoolPrefixQueryBuilder
maxExpansions(int maxExpansions)
When using fuzzy or prefix type query, the number of term expansions to use.java.lang.String
minimumShouldMatch()
Gets the minimumShouldMatch valueMatchBoolPrefixQueryBuilder
minimumShouldMatch(java.lang.String minimumShouldMatch)
Sets optional minimumShouldMatch value to apply to the queryOperator
operator()
Returns the operator to use in a boolean query.MatchBoolPrefixQueryBuilder
operator(Operator operator)
Sets the operator to use when using a boolean query.int
prefixLength()
Gets the length of a length of common (non-fuzzy) prefix for fuzzy match queriesMatchBoolPrefixQueryBuilder
prefixLength(int prefixLength)
Sets the length of a length of common (non-fuzzy) prefix for fuzzy match queriesjava.lang.Object
value()
Returns the value used in this query.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
-
-
Constructor Details
-
MatchBoolPrefixQueryBuilder
public MatchBoolPrefixQueryBuilder(java.lang.String fieldName, java.lang.Object value) -
MatchBoolPrefixQueryBuilder
- Throws:
java.io.IOException
-
-
Method Details
-
doWriteTo
- Specified by:
doWriteTo
in classAbstractQueryBuilder<MatchBoolPrefixQueryBuilder>
- 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
public java.lang.String analyzer()Get the analyzer to use, if previously set, otherwisenull
-
analyzer
Explicitly set the analyzer to use. Defaults to use explicit mapping config for the field, or, if not set, the default search analyzer. -
operator
Sets the operator to use when using a boolean query. Defaults toOR
. -
operator
Returns the operator to use in a boolean query. -
minimumShouldMatch
Sets optional minimumShouldMatch value to apply to the query -
minimumShouldMatch
public java.lang.String minimumShouldMatch()Gets the minimumShouldMatch value -
fuzziness
Sets the fuzziness used when evaluated to a fuzzy query type. Defaults to "AUTO". -
fuzziness
Gets the fuzziness used when evaluated to a fuzzy query type. -
prefixLength
Sets the length of a length of common (non-fuzzy) prefix for fuzzy match queries- Parameters:
prefixLength
- non-negative length of prefix- Throws:
java.lang.IllegalArgumentException
- in case the prefix is negative
-
prefixLength
public int prefixLength()Gets the length of a length of common (non-fuzzy) prefix for fuzzy match queries -
maxExpansions
When using fuzzy or prefix type query, 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. -
fuzzyTranspositions
Sets whether transpositions are supported in fuzzy queries.The default metric used by fuzzy queries to determine a match is the Damerau-Levenshtein distance formula which supports transpositions. Setting transposition to false will switch to classic Levenshtein distance.
If not set, Damerau-Levenshtein distance metric will be used. -
fuzzyTranspositions
public boolean fuzzyTranspositions()Gets the fuzzy query transposition setting. -
fuzzyRewrite
Sets the fuzzy_rewrite parameter controlling how the fuzzy query will get rewritten -
fuzzyRewrite
public java.lang.String fuzzyRewrite()Get the fuzzy_rewrite parameter- See Also:
fuzzyRewrite(String)
-
doXContent
protected void doXContent(XContentBuilder builder, ToXContent.Params params) throws java.io.IOException- Specified by:
doXContent
in classAbstractQueryBuilder<MatchBoolPrefixQueryBuilder>
- Throws:
java.io.IOException
-
fromXContent
public static MatchBoolPrefixQueryBuilder fromXContent(XContentParser parser) throws java.io.IOException- Throws:
java.io.IOException
-
doToQuery
protected org.apache.lucene.search.Query doToQuery(QueryShardContext context) throws java.io.IOException- Specified by:
doToQuery
in classAbstractQueryBuilder<MatchBoolPrefixQueryBuilder>
- 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<MatchBoolPrefixQueryBuilder>
-
doHashCode
protected int doHashCode()- Specified by:
doHashCode
in classAbstractQueryBuilder<MatchBoolPrefixQueryBuilder>
-
getWriteableName
public java.lang.String getWriteableName()Description copied from interface:NamedWriteable
Returns the name of the writeable object
-