Package org.hibernate.loader.plan.spi
Interface Join
-
- All Known Subinterfaces:
JoinDefinedByMetadata
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
All Methods Instance Methods Abstract Methods Modifier and Type Method Description java.lang.String
getAnyAdditionalJoinConditions(java.lang.String rhsTableAlias)
Gets any additional conditions on the right-hand-side of the join using the specified table alias.QuerySpace
getLeftHandSide()
Get theQuerySpace
from the left-hand-side of the join.QuerySpace
getRightHandSide()
Get theQuerySpace
from the right-hand-side of the join.boolean
isRightHandSideRequired()
Indicates if the joined attribute is required to be non-null.java.lang.String[]
resolveAliasedLeftHandSideJoinConditionColumns(java.lang.String leftHandSideTableAlias)
Resolves the column names prefixed by the specified alias on the left-hand-side of the join.java.lang.String[]
resolveNonAliasedRightHandSideJoinConditionColumns()
Resolves the raw (unaliased) column names on the right-hand-side of the join.
-
-
-
Method Detail
-
getLeftHandSide
QuerySpace getLeftHandSide()
Get theQuerySpace
from the left-hand-side of the join.- Returns:
- the query space from the left-hand-side of the join.
-
getRightHandSide
QuerySpace getRightHandSide()
Get theQuerySpace
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
java.lang.String[] resolveAliasedLeftHandSideJoinConditionColumns(java.lang.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
java.lang.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
java.lang.String getAnyAdditionalJoinConditions(java.lang.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.
-
-