Package org.hibernate.query.sqm.tree

Enum Class SqmJoinType

java.lang.Object

java.lang.Enum<SqmJoinType>

org.hibernate.query.sqm.tree.SqmJoinType

All Implemented Interfaces:

Serializable, Comparable<SqmJoinType>, Constable

public enum SqmJoinType
extends Enum<SqmJoinType>

Represents a canonical join type.

Note that currently HQL really only supports inner and left outer joins (though cross joins can also be achieved). This is because joins in HQL are always defined in relation to a mapped association. However, when we start allowing users to specify ad-hoc joins this may need to change to allow the full spectrum of join types. Thus the others are provided here currently just for completeness and for future expansion.

Author:

Steve Ebersole

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
CROSS	Represents a cross join (aka a cartesian product).
FULL	Represents a full join.
INNER	Represents an inner join.
LEFT	Represents a left outer join.
RIGHT	Represents a right outer join.

Method Summary

Modifier and Type	Method	Description
static SqmJoinType	from(JoinType jpaJoinType)
JoinType	getCorrespondingJpaJoinType()
SqlAstJoinType	getCorrespondingSqlJoinType()
String	getText()
String	toString()
static SqmJoinType	valueOf(String name)	Returns the enum constant of this class with the specified name.
static SqmJoinType[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

INNER

public static final SqmJoinType INNER

Represents an inner join.

LEFT

public static final SqmJoinType LEFT

Represents a left outer join.

RIGHT

public static final SqmJoinType RIGHT

Represents a right outer join.

CROSS

public static final SqmJoinType CROSS

Represents a cross join (aka a cartesian product).

FULL

public static final SqmJoinType FULL

Represents a full join.

Method Details

values

public static SqmJoinType[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

an array containing the constants of this enum class, in the order they are declared

valueOf

public static SqmJoinType valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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:

IllegalArgumentException - if this enum class has no constant with the specified name

NullPointerException - if the argument is null

toString

public String toString()

Overrides:

toString in class Enum<SqmJoinType>

getText

public String getText()

getCorrespondingSqlJoinType

public SqlAstJoinType getCorrespondingSqlJoinType()

getCorrespondingJpaJoinType

public JoinType getCorrespondingJpaJoinType()

from

public static SqmJoinType from(JoinType jpaJoinType)