Package com.attivio.sdk.search.facet

Enum ShallowMode

  • All Implemented Interfaces:
    java.io.Serializable, java.lang.Comparable<ShallowMode>
    public enum ShallowMode
extends java.lang.Enum<ShallowMode>
implements java.io.Serializable
    Mode for executing facets that support shallow computations.

    • Enum Constant Summary

      Enum Constants 
      Enum Constant Description
      POPULATION
      Facet is computed over the entire result set.
      SAMPLE
      Facet is computed over sample of result the set.

    • Method Summary

      All Methods Static Methods Concrete Methods 
      Modifier and Type Method Description
      static ShallowMode valueOf​(java.lang.String name)
      Returns the enum constant of this type with the specified name.
      static ShallowMode[] 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

      • POPULATION

        public static final ShallowMode POPULATION
        Facet is computed over the entire result set.

        NOTE: This method can be slow as it may require accessing stored fields for all matching documents.

    • Method Detail

      • values

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

      • valueOf

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