Enum TdbFacetSortOrder

  • All Implemented Interfaces:
    java.io.Serializable, java.lang.Comparable<TdbFacetSortOrder>

    public enum TdbFacetSortOrder
    extends java.lang.Enum<TdbFacetSortOrder>
    Sort order for facets.
    • Enum Constant Summary

      Enum Constants 
      Enum Constant Description
      Default
      Default sort order, determined by server and depending on facet type.
      FrequencyAscending
      Sort by frequency, lowest occurrence first.
      FrequencyDescending
      Sort by frequency, highest occurrence first.
      ValueAscending
      Sort by value, alphabetical order.
      ValueDescending
      Sort by value, reverse alphabetical order.
    • Method Summary

      All Methods Static Methods Concrete Methods 
      Modifier and Type Method Description
      static TdbFacetSortOrder valueOf​(java.lang.String name)
      Returns the enum constant of this type with the specified name.
      static TdbFacetSortOrder[] values()
      Returns an array containing the constants of this enum type, in the order they are declared.
      • Methods inherited from class java.lang.Enum

        compareTo, equals, getDeclaringClass, hashCode, name, ordinal, toString, valueOf
      • Methods inherited from class java.lang.Object

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

      • Default

        public static final TdbFacetSortOrder Default
        Default sort order, determined by server and depending on facet type.
      • FrequencyAscending

        public static final TdbFacetSortOrder FrequencyAscending
        Sort by frequency, lowest occurrence first.

        NOTE: This option is not yet fully supported, and its use should be avoided for now.

      • FrequencyDescending

        public static final TdbFacetSortOrder FrequencyDescending
        Sort by frequency, highest occurrence first.
      • ValueAscending

        public static final TdbFacetSortOrder ValueAscending
        Sort by value, alphabetical order.
      • ValueDescending

        public static final TdbFacetSortOrder ValueDescending
        Sort by value, reverse alphabetical order.

        NOTE: This option is not yet fully supported, and its use should be avoided for now.

    • Method Detail

      • values

        public static TdbFacetSortOrder[] values()
        Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:
        for (TdbFacetSortOrder c : TdbFacetSortOrder.values())
            System.out.println(c);
        
        Returns:
        an array containing the constants of this enum type, in the order they are declared
      • valueOf

        public static TdbFacetSortOrder 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