Package com.attivio.sdk.search

Enum FieldCollapse.Mode

    • Enum Constant Summary

      Enum Constants 
      Enum Constant Description
      DEFAULT
      Default Field Collapsing.
      TWO_DIMENSIONAL
      2-D Search.

    • Method Summary

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

      • Methods inherited from class java.lang.Enum

        clone, compareTo, equals, finalize, 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 FieldCollapse.Mode DEFAULT
        Default Field Collapsing.

        Default group ordering for default field collapsing is by internal id (natural ordering).

        NOTE: Default field collapsing only supports a single level sort specification. Specifying a multi-level sort specification will result in query error.

      • TWO_DIMENSIONAL

        public static final FieldCollapse.Mode TWO_DIMENSIONAL
        2-D Search.

        Default group ordering for 2-D search is by score descending.

        NOTE: when using 2-D search, the QueryRequest must be sorted by score descending (default sort).

    • Method Detail

      • values

        public static FieldCollapse.Mode[] 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 (FieldCollapse.Mode c : FieldCollapse.Mode.values())
    System.out.println(c);
        Returns:
        an array containing the constants of this enum type, in the order they are declared

      • valueOf

        public static FieldCollapse.Mode 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

      • fromExternal

        public static FieldCollapse.Mode fromExternal​(java.lang.String value)