Top Fields Constructors Methods
org.hibernate.loader.plan.build.internal.spaces

public Class JoinImpl

extends Object
implements JoinDefinedByMetadata
Class Inheritance
All Implemented Interfaces
org.hibernate.loader.plan.spi.JoinDefinedByMetadata, org.hibernate.loader.plan.spi.Join
Imports
org.hibernate.internal.util.StringHelper, org.hibernate.loader.plan.spi.JoinDefinedByMetadata, .QuerySpace, org.hibernate.type.Type

Author
Steve Ebersole

Field Summary

Modifier and TypeField and Description
private final Type
private final QuerySpace
private final String
private final String[]
private final QuerySpace
private final boolean

Constructor Summary

AccessConstructor and Description
public
JoinImpl(QuerySpace leftHandSide, String lhsPropertyName, QuerySpace rightHandSide, String[] rhsColumnNames, Type joinedPropertyType, boolean rightHandSideRequired)

Method Summary

Modifier and TypeMethod and Description
public String
getAnyAdditionalJoinConditions(String
The table alias.
rhsTableAlias
)

Implements org.hibernate.loader.plan.spi.Join.getAnyAdditionalJoinConditions.

Gets any additional conditions on the right-hand-side of the join using the specified table alias.
public String
getJoinedPropertyName()

Implements org.hibernate.loader.plan.spi.JoinDefinedByMetadata.getJoinedPropertyName.

Obtain the name of the property that defines the join, relative to the PropertyMapping (QuerySpace#toAliasedColumns(String, String)) of the left-hand-side (getLeftHandSide()) of the join
public Type
public QuerySpace
getLeftHandSide()

Implements org.hibernate.loader.plan.spi.Join.getLeftHandSide.

Get the QuerySpace from the left-hand-side of the join.
public QuerySpace
getRightHandSide()

Implements org.hibernate.loader.plan.spi.Join.getRightHandSide.

Get the QuerySpace from the right-hand-side of the join.
public boolean
isRightHandSideRequired()

Implements org.hibernate.loader.plan.spi.Join.isRightHandSideRequired.

Indicates if the joined attribute is required to be non-null.
public String[]
resolveAliasedLeftHandSideJoinConditionColumns(String
The table alias used to prefix the columns.
leftHandSideTableAlias
)

Implements org.hibernate.loader.plan.spi.Join.resolveAliasedLeftHandSideJoinConditionColumns.

Resolves the column names prefixed by the specified alias on the left-hand-side of the join.
public String[]
resolveNonAliasedRightHandSideJoinConditionColumns()

Implements org.hibernate.loader.plan.spi.Join.resolveNonAliasedRightHandSideJoinConditionColumns.

Resolves the raw (unaliased) column names on the right-hand-side of the join.
Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

joinedPropertyTypeback to summary
private final Type joinedPropertyType
leftHandSideback to summary
private final QuerySpace leftHandSide
lhsPropertyNameback to summary
private final String lhsPropertyName
rhsColumnNamesback to summary
private final String[] rhsColumnNames
rightHandSideback to summary
private final QuerySpace rightHandSide
rightHandSideRequiredback to summary
private final boolean rightHandSideRequired

Constructor Detail

JoinImplback to summary
public JoinImpl(QuerySpace leftHandSide, String lhsPropertyName, QuerySpace rightHandSide, String[] rhsColumnNames, Type joinedPropertyType, boolean rightHandSideRequired)

Method Detail

getAnyAdditionalJoinConditionsback to summary
public String getAnyAdditionalJoinConditions(String rhsTableAlias)

Implements org.hibernate.loader.plan.spi.Join.getAnyAdditionalJoinConditions.

Doc from org.hibernate.loader.plan.spi.Join.getAnyAdditionalJoinConditions.

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.

Annotations
@Override
getJoinedPropertyNameback to summary
public String getJoinedPropertyName()

Implements org.hibernate.loader.plan.spi.JoinDefinedByMetadata.getJoinedPropertyName.

Doc from org.hibernate.loader.plan.spi.JoinDefinedByMetadata.getJoinedPropertyName.

Obtain the name of the property that defines the join, relative to the PropertyMapping (QuerySpace#toAliasedColumns(String, String)) of the left-hand-side (getLeftHandSide()) of the join

Returns:String

The property name

Annotations
@Override
getJoinedPropertyTypeback to summary
public Type getJoinedPropertyType()

Implements org.hibernate.loader.plan.spi.JoinDefinedByMetadata.getJoinedPropertyType.

Doc from org.hibernate.loader.plan.spi.JoinDefinedByMetadata.getJoinedPropertyType.

Get the property type of the joined property.

Returns:Type

The property type.

Annotations
@Override
getLeftHandSideback to summary
public QuerySpace getLeftHandSide()

Implements org.hibernate.loader.plan.spi.Join.getLeftHandSide.

Doc from org.hibernate.loader.plan.spi.Join.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.

Annotations
@Override
getRightHandSideback to summary
public QuerySpace getRightHandSide()

Implements org.hibernate.loader.plan.spi.Join.getRightHandSide.

Doc from org.hibernate.loader.plan.spi.Join.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.

Annotations
@Override
isRightHandSideRequiredback to summary
public boolean isRightHandSideRequired()

Implements org.hibernate.loader.plan.spi.Join.isRightHandSideRequired.

Doc from org.hibernate.loader.plan.spi.Join.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.

Annotations
@Override
resolveAliasedLeftHandSideJoinConditionColumnsback to summary
public String[] resolveAliasedLeftHandSideJoinConditionColumns(String leftHandSideTableAlias)

Implements org.hibernate.loader.plan.spi.Join.resolveAliasedLeftHandSideJoinConditionColumns.

Doc from org.hibernate.loader.plan.spi.Join.resolveAliasedLeftHandSideJoinConditionColumns.

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.

Annotations
@Override
resolveNonAliasedRightHandSideJoinConditionColumnsback to summary
public String[] resolveNonAliasedRightHandSideJoinConditionColumns()

Implements org.hibernate.loader.plan.spi.Join.resolveNonAliasedRightHandSideJoinConditionColumns.

Doc from org.hibernate.loader.plan.spi.Join.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.

Annotations
@Override