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, org.elasticsearch.common.xcontent.ToXContent, org.elasticsearch.common.xcontent.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

  • Field Details

  • Constructor Details

    • MatchBoolPrefixQueryBuilder

      public MatchBoolPrefixQueryBuilder​(java.lang.String fieldName, java.lang.Object value)

    • MatchBoolPrefixQueryBuilder

      public MatchBoolPrefixQueryBuilder​(StreamInput in) throws java.io.IOException
      Throws:
      java.io.IOException

  • Method Details

    • doWriteTo

      protected void doWriteTo​(StreamOutput out) throws java.io.IOException
      Specified by:
      doWriteTo in class AbstractQueryBuilder<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, otherwise null

    • analyzer

      public MatchBoolPrefixQueryBuilder analyzer​(java.lang.String 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

      public MatchBoolPrefixQueryBuilder operator​(Operator operator)
      Sets the operator to use when using a boolean query. Defaults to OR.

    • operator

      public Operator operator()
      Returns the operator to use in a boolean query.

    • minimumShouldMatch

      public MatchBoolPrefixQueryBuilder minimumShouldMatch​(java.lang.String minimumShouldMatch)
      Sets optional minimumShouldMatch value to apply to the query

    • minimumShouldMatch

      public java.lang.String minimumShouldMatch()
      Gets the minimumShouldMatch value

    • fuzziness

      public MatchBoolPrefixQueryBuilder fuzziness​(java.lang.Object fuzziness)
      Sets the fuzziness used when evaluated to a fuzzy query type. Defaults to "AUTO".

    • fuzziness

      public Fuzziness fuzziness()
      Gets the fuzziness used when evaluated to a fuzzy query type.

    • prefixLength

      public MatchBoolPrefixQueryBuilder prefixLength​(int 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

      public MatchBoolPrefixQueryBuilder maxExpansions​(int 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

      public MatchBoolPrefixQueryBuilder fuzzyTranspositions​(boolean 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

      public MatchBoolPrefixQueryBuilder fuzzyRewrite​(java.lang.String 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​(org.elasticsearch.common.xcontent.XContentBuilder builder, org.elasticsearch.common.xcontent.ToXContent.Params params) throws java.io.IOException
      Specified by:
      doXContent in class AbstractQueryBuilder<MatchBoolPrefixQueryBuilder>
      Throws:
      java.io.IOException

    • fromXContent

      public static MatchBoolPrefixQueryBuilder fromXContent​(org.elasticsearch.common.xcontent.XContentParser parser) throws java.io.IOException
      Throws:
      java.io.IOException

    • doToQuery

      protected org.apache.lucene.search.Query doToQuery​(SearchExecutionContext context) throws java.io.IOException
      Specified by:
      doToQuery in class AbstractQueryBuilder<MatchBoolPrefixQueryBuilder>
      Throws:
      java.io.IOException

    • doEquals

      protected boolean doEquals​(MatchBoolPrefixQueryBuilder other)
      Description copied from class: AbstractQueryBuilder
      Indicates whether some other QueryBuilder object of the same type is "equal to" this one.
      Specified by:
      doEquals in class AbstractQueryBuilder<MatchBoolPrefixQueryBuilder>

    • doHashCode

      protected int doHashCode()
      Specified by:
      doHashCode in class AbstractQueryBuilder<MatchBoolPrefixQueryBuilder>

    • getWriteableName

      public java.lang.String getWriteableName()
      Description copied from interface: NamedWriteable
      Returns the name of the writeable object