Enum MultiMatchQueryBuilder.Type

java.lang.Object
java.lang.Enum<MultiMatchQueryBuilder.Type>
org.elasticsearch.index.query.MultiMatchQueryBuilder.Type
All Implemented Interfaces:
java.io.Serializable, java.lang.Comparable<MultiMatchQueryBuilder.Type>, java.lang.constant.Constable, Writeable
Enclosing class:
MultiMatchQueryBuilder

public static enum MultiMatchQueryBuilder.Type
extends java.lang.Enum<MultiMatchQueryBuilder.Type>
implements Writeable
  • Nested Class Summary

    Nested classes/interfaces inherited from class java.lang.Enum

    java.lang.Enum.EnumDesc<E extends java.lang.Enum<E>>

    Nested classes/interfaces inherited from interface org.elasticsearch.common.io.stream.Writeable

    Writeable.Reader<V>, Writeable.Writer<V>
  • Enum Constant Summary

    Enum Constants
    Enum Constant Description
    BEST_FIELDS
    Uses the best matching boolean field as main score and uses a tie-breaker to adjust the score based on remaining field matches
    BOOL_PREFIX
    Uses the sum of the matching boolean fields to score the query
    CROSS_FIELDS
    Uses a blended DocumentFrequency to dynamically combine the queried fields into a single field given the configured analysis is identical.
    MOST_FIELDS
    Uses the sum of the matching boolean fields to score the query
    PHRASE
    Uses the best matching phrase field as main score and uses a tie-breaker to adjust the score based on remaining field matches
    PHRASE_PREFIX
    Uses the best matching phrase-prefix field as main score and uses a tie-breaker to adjust the score based on remaining field matches
  • Method Summary

    Modifier and Type Method Description
    MatchQueryParser.Type matchQueryType()  
    static MultiMatchQueryBuilder.Type parse​(java.lang.String value, org.elasticsearch.common.xcontent.DeprecationHandler deprecationHandler)  
    org.elasticsearch.common.ParseField parseField()  
    static MultiMatchQueryBuilder.Type readFromStream​(StreamInput in)  
    float tieBreaker()  
    static MultiMatchQueryBuilder.Type valueOf​(java.lang.String name)
    Returns the enum constant of this type with the specified name.
    static MultiMatchQueryBuilder.Type[] values()
    Returns an array containing the constants of this enum type, in the order they are declared.
    void writeTo​(StreamOutput out)
    Write this into the StreamOutput.

    Methods inherited from class java.lang.Enum

    clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

    Methods inherited from class java.lang.Object

    getClass, notify, notifyAll, wait, wait, wait
  • Enum Constant Details

    • BEST_FIELDS

      public static final MultiMatchQueryBuilder.Type BEST_FIELDS
      Uses the best matching boolean field as main score and uses a tie-breaker to adjust the score based on remaining field matches
    • MOST_FIELDS

      public static final MultiMatchQueryBuilder.Type MOST_FIELDS
      Uses the sum of the matching boolean fields to score the query
    • CROSS_FIELDS

      public static final MultiMatchQueryBuilder.Type CROSS_FIELDS
      Uses a blended DocumentFrequency to dynamically combine the queried fields into a single field given the configured analysis is identical. This type uses a tie-breaker to adjust the score based on remaining matches per analyzed terms
    • PHRASE

      public static final MultiMatchQueryBuilder.Type PHRASE
      Uses the best matching phrase field as main score and uses a tie-breaker to adjust the score based on remaining field matches
    • PHRASE_PREFIX

      public static final MultiMatchQueryBuilder.Type PHRASE_PREFIX
      Uses the best matching phrase-prefix field as main score and uses a tie-breaker to adjust the score based on remaining field matches
    • BOOL_PREFIX

      public static final MultiMatchQueryBuilder.Type BOOL_PREFIX
      Uses the sum of the matching boolean fields to score the query
  • Method Details

    • values

      public static MultiMatchQueryBuilder.Type[] values()
      Returns an array containing the constants of this enum type, in the order they are declared.
      Returns:
      an array containing the constants of this enum type, in the order they are declared
    • valueOf

      public static MultiMatchQueryBuilder.Type valueOf​(java.lang.String name)
      Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
      Parameters:
      name - the name of the enum constant to be returned.
      Returns:
      the enum constant with the specified name
      Throws:
      java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
      java.lang.NullPointerException - if the argument is null
    • tieBreaker

      public float tieBreaker()
    • matchQueryType

      public MatchQueryParser.Type matchQueryType()
    • parseField

      public org.elasticsearch.common.ParseField parseField()
    • parse

      public static MultiMatchQueryBuilder.Type parse​(java.lang.String value, org.elasticsearch.common.xcontent.DeprecationHandler deprecationHandler)
    • readFromStream

      public static MultiMatchQueryBuilder.Type readFromStream​(StreamInput in) throws java.io.IOException
      Throws:
      java.io.IOException
    • writeTo

      public void writeTo​(StreamOutput out) throws java.io.IOException
      Description copied from interface: Writeable
      Write this into the StreamOutput.
      Specified by:
      writeTo in interface Writeable
      Throws:
      java.io.IOException