Package org.hibernate.search.engine.search.common

Enum Class SortMode

java.lang.Object
java.lang.Enum<SortMode>
org.hibernate.search.engine.search.common.SortMode
All Implemented Interfaces:
Serializable, Comparable<SortMode>, Constable
public enum SortMode extends Enum<SortMode>
Defines how to pick the value to sort on for multi-valued fields.

  • Nested Class Summary

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

    Enum.EnumDesc<E extends Enum<E>>

  • Enum Constant Summary

    Enum Constants
    Enum Constant
    Description
    AVG
    When a field has multiple values, compute the average of all the values.
    MAX
    When a field has multiple values, pick the highest value.
    MEDIAN
    When a field has multiple values, compute the median of all the values.
    MIN
    When a field has multiple values, pick the lowest value.
    SUM
    When a field has multiple values, compute the sum of all the values.

  • Method Summary

    Modifier and Type
    Method
    Description
    static SortMode
    valueOf(String name)
    Returns the enum constant of this class with the specified name.
    static SortMode[]
    values()
    Returns an array containing the constants of this enum class, in the order they are declared.

    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

    • SUM

      public static final SortMode SUM
      When a field has multiple values, compute the sum of all the values.

    • MIN

      public static final SortMode MIN
      When a field has multiple values, pick the lowest value.

    • MAX

      public static final SortMode MAX
      When a field has multiple values, pick the highest value.

    • AVG

      public static final SortMode AVG
      When a field has multiple values, compute the average of all the values.

    • MEDIAN

      public static final SortMode MEDIAN
      When a field has multiple values, compute the median of all the values.

  • Method Details

    • values

      public static SortMode[] 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 SortMode valueOf(String 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:
      IllegalArgumentException - if this enum class has no constant with the specified name
      NullPointerException - if the argument is null