Package com.attivio.sdk.search.query

Enum JoinMode

  • All Implemented Interfaces:
    java.io.Serializable, java.lang.Comparable<JoinMode>
    public enum JoinMode
extends java.lang.Enum<JoinMode>
    The JoinMode for a JoinClause.

    • Enum Constant Summary

      Enum Constants 
      Enum Constant Description
      INNER
      Perform inner join on this clause
      OUTER
      Perform outer join on this clause

    • Method Summary

      All Methods Static Methods Instance Methods Abstract Methods Concrete Methods 
      Modifier and Type Method Description
      static JoinMode fromExternal​(java.lang.String value)
      Converts an external value to a JoinMode value.
      abstract boolean isRequired()
      true if the clause with this mode must match.
      static JoinMode valueOf​(java.lang.String name)
      Returns the enum constant of this type with the specified name.
      static JoinMode[] 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

      • INNER

        public static final JoinMode INNER
        Perform inner join on this clause

      • OUTER

        public static final JoinMode OUTER
        Perform outer join on this clause

    • Method Detail

      • values

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

      • valueOf

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

      • isRequired

        public abstract boolean isRequired()
        true if the clause with this mode must match.

      • fromExternal

        public static JoinMode fromExternal​(java.lang.String value)
        Converts an external value to a JoinMode value.
        Parameters:
        value - the external value
        Returns:
        the type