Package org.apache.jackrabbit.oak.jcr.query.qom

Enum JoinType

  • All Implemented Interfaces:
    java.io.Serializable, java.lang.Comparable<JoinType>
    public enum JoinType
extends java.lang.Enum<JoinType>
    Enumeration of the JCR 2.0 join types.
    Since:
    Apache Jackrabbit 2.0

    • Enum Constant Summary

      Enum Constants 
      Enum Constant Description
      INNER  
      LEFT  
      RIGHT  

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      java.lang.String formatSql​(java.lang.Object left, java.lang.Object right, java.lang.Object condition)
      Formats an SQL join with this join type and the given sources and join condition.
      static JoinType getJoinTypeByName​(java.lang.String name)
      Returns the join type with the given JCR name.
      Join join​(QueryObjectModelFactory factory, Source left, Source right, JoinCondition condition)
      Returns the join of the given sources.
      java.lang.String toString()
      Returns the JCR 2.0 name of this join type.
      static JoinType valueOf​(java.lang.String name)
      Returns the enum constant of this type with the specified name.
      static JoinType[] 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, valueOf

      • Methods inherited from class java.lang.Object

        getClass, notify, notifyAll, wait, wait, wait

    • Enum Constant Detail

      • INNER

        public static final JoinType INNER

      • LEFT

        public static final JoinType LEFT

      • RIGHT

        public static final JoinType RIGHT

    • Method Detail

      • values

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

      • valueOf

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

      • formatSql

        public java.lang.String formatSql​(java.lang.Object left,
                                  java.lang.Object right,
                                  java.lang.Object condition)
        Formats an SQL join with this join type and the given sources and join condition. The sources and condition are simply used as-is, without any quoting or escaping.
        Parameters:
        left - left source
        right - right source
        condition - join condition
        Returns:
        SQL join, left join right

      • toString

        public java.lang.String toString()
        Returns the JCR 2.0 name of this join type.
        Overrides:
        toString in class java.lang.Enum<JoinType>
        Returns:
        JCR name of this join type
        See Also:
        QueryObjectModelConstants

      • getJoinTypeByName

        public static JoinType getJoinTypeByName​(java.lang.String name)
        Returns the join type with the given JCR name.
        Parameters:
        name - JCR name of a join type
        Returns:
        join type with the given name