Package org.elasticsearch.search.suggest

Enum Class SortBy

<SortBy>
org.elasticsearch.search.suggest.SortBy
All Implemented Interfaces:
, <, Writeable
public enum SortBy extends <SortBy> implements Writeable
An enum representing the valid sorting options

  • Nested Class Summary

    Nested classes/interfaces inherited from class java.lang.

    < extends <>>

    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
    FREQUENCY
    Sort should first be based on document frequency, then score and then the term itself.
    SCORE
    Sort should first be based on score, then document frequency and then the term itself.

  • Method Summary

    Modifier and Type
    Method
    Description
    static SortBy
    readFromStream​(StreamInput in)
     
    static SortBy
     str)
     
    static SortBy
     name)
    Returns the enum constant of this class with the specified name.
    static SortBy[]
    values()
    Returns an array containing the constants of this enum class, in the order they are declared.
    void
    writeTo​(StreamOutput out)
    Write this into the StreamOutput.

    Methods inherited from class java.lang.

    , , , , , , , , , ,

    Methods inherited from class java.lang.

    , , , , ,

  • Enum Constant Details

    • SCORE

      public static final SortBy SCORE
      Sort should first be based on score, then document frequency and then the term itself.

    • FREQUENCY

      public static final SortBy FREQUENCY
      Sort should first be based on document frequency, then score and then the term itself.

  • Method Details

    • values

      public static SortBy[] values()
      Returns an array containing the constants of this enum class, in the order they are declared.
      Returns:
      an array containing the constants of this enum class, in the order they are declared

    • valueOf

      public static  name)
      Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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:
      - if this enum class has no constant with the specified name
      - if the argument is null

    • writeTo

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

    • readFromStream

      public static SortBy readFromStream​(StreamInput in) throws
      Throws:

    • resolve

      public static  str)