Top Description Methods
org.hibernate.loader.plan.spi

public Interface Join

Known Direct Subinterfaces
org.hibernate.loader.plan.spi.JoinDefinedByMetadata

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 TypeMethod and Description
public String

Returns:

additional conditions on the right-hand-side of the join.
getAnyAdditionalJoinConditions
(String
The table alias.
rhsTableAlias
)

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

public QuerySpace

Returns:

the query space from the left-hand-side of the join.
getLeftHandSide
()

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

public QuerySpace

Returns:

the query space from the right-hand-side of the join.
getRightHandSide
()

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

public boolean

Returns:

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

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

public String[]

Returns:

the aliased columns on the left-hand-side of the join.
resolveAliasedLeftHandSideJoinConditionColumns
(String
The table alias used to prefix the columns.
leftHandSideTableAlias
)

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

public String[]

Returns:

the columns on the right-hand-side of the join.
resolveNonAliasedRightHandSideJoinConditionColumns
()

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

Method Detail

getAnyAdditionalJoinConditionsback to summary
public String getAnyAdditionalJoinConditions(String rhsTableAlias)

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

Parameters
rhsTableAlias:String

The table alias.

Returns:String

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

getLeftHandSideback to summary
public QuerySpace getLeftHandSide()

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

Returns:QuerySpace

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

getRightHandSideback to summary
public QuerySpace getRightHandSide()

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

Returns:QuerySpace

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

isRightHandSideRequiredback to summary
public boolean isRightHandSideRequired()

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

Returns:boolean

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

resolveAliasedLeftHandSideJoinConditionColumnsback to summary
public String[] resolveAliasedLeftHandSideJoinConditionColumns(String leftHandSideTableAlias)

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

Parameters
leftHandSideTableAlias:String

The table alias used to prefix the columns.

Returns:String[]

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

resolveNonAliasedRightHandSideJoinConditionColumnsback to summary
public String[] resolveNonAliasedRightHandSideJoinConditionColumns()

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

Returns:String[]

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