Package com.attivio.sdk.search

Enum JoinFacetMode

  • All Implemented Interfaces:
    java.io.Serializable, java.lang.Comparable<JoinFacetMode>
    public enum JoinFacetMode
extends java.lang.Enum<JoinFacetMode>
    Enumeration listing the possible facet modes for joined documents.

    • Enum Constant Summary

      Enum Constants 
      Enum Constant Description
      DISTINCT
      A child document will only be included in facet counts once, even it it is a child of multiple parent documents.
      FULL
      A child document will be included in facet counts once for every parent document containing the child document.

    • Method Summary

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

      • DISTINCT

        public static final JoinFacetMode DISTINCT
        A child document will only be included in facet counts once, even it it is a child of multiple parent documents.

      • FULL

        public static final JoinFacetMode FULL
        A child document will be included in facet counts once for every parent document containing the child document.

        NOTE: Using this mode will require significantly more memory during query execution.

    • Method Detail

      • values

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

      • valueOf

        public static JoinFacetMode 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 JoinFacetMode fromExternal​(java.lang.String value)
        Converts an external value to a type value.