org.hibernate.loader.plan.spi

Interface Join

All Known Subinterfaces:

JoinDefinedByMetadata

All Known Implementing Classes:

JoinImpl

public interface Join

Represents a join in the QuerySpace-sense. In HQL/JP-QL, this would be an implicit/explicit join; in metamodel-driven LoadPlans, this would be joins indicated by the metamodel.

Method Summary

Modifier and Type	Method and Description
String	getAnyAdditionalJoinConditions(String rhsTableAlias) Gets any additional conditions on the right-hand-side of the join using the specified table alias.
QuerySpace	getLeftHandSide() Get the QuerySpace from the left-hand-side of the join.
QuerySpace	getRightHandSide() Get the QuerySpace from the right-hand-side of the join.
boolean	isRightHandSideRequired() Indicates if the joined attribute is required to be non-null.
String[]	resolveAliasedLeftHandSideJoinConditionColumns(String leftHandSideTableAlias) Resolves the column names prefixed by the specified alias on the left-hand-side of the join.
String[]	resolveNonAliasedRightHandSideJoinConditionColumns() Resolves the raw (unaliased) column names on the right-hand-side of the join.

Method Detail

getLeftHandSide

QuerySpace getLeftHandSide()

Get the QuerySpace from the left-hand-side of the join.

Returns:

the query space from the left-hand-side of the join.

getRightHandSide

QuerySpace getRightHandSide()

Get the QuerySpace from the right-hand-side of the join.

Returns:

the query space from the right-hand-side of the join.

isRightHandSideRequired

boolean isRightHandSideRequired()

Indicates if the joined attribute is required to be non-null.

Returns:

true, if the joined attribute is required to be non-null; false, otherwise.

resolveAliasedLeftHandSideJoinConditionColumns

String[] resolveAliasedLeftHandSideJoinConditionColumns(String leftHandSideTableAlias)

Resolves the column names prefixed by the specified alias on the left-hand-side of the join.

Parameters:

leftHandSideTableAlias - The table alias used to prefix the columns.

Returns:

the aliased columns on the left-hand-side of the join.

resolveNonAliasedRightHandSideJoinConditionColumns

String[] resolveNonAliasedRightHandSideJoinConditionColumns()

Resolves the raw (unaliased) column names on the right-hand-side of the join.

Returns:

the columns on the right-hand-side of the join.

getAnyAdditionalJoinConditions

String getAnyAdditionalJoinConditions(String rhsTableAlias)

Gets any additional conditions on the right-hand-side of the join using the specified table alias.

Parameters:

rhsTableAlias - The table alias.

Returns:

additional conditions on the right-hand-side of the join.