Top Methods
org.hibernate.query.sqm.tree.from

public Interface SqmJoin<O, T>

extends SqmFrom<O, T>
Known Direct Subinterfaces
org.hibernate.query.sqm.tree.from.SqmQualifiedJoin
Known Direct Implementers
org.hibernate.query.sqm.tree.domain.AbstractSqmJoin, org.hibernate.query.sqm.tree.from.SqmCrossJoin
Imports
jakarta.persistence.criteria.JoinType, org.hibernate.query.sqm.tree.SqmCopyContext, .SqmJoinType
Author
Steve Ebersole

Method Summary

Modifier and TypeMethod and Description
public SqmJoin<O, T>
copy(SqmCopyContext context)

Redeclares org.hibernate.query.sqm.tree.from.SqmFrom.copy.

public SqmJoinType
getSqmJoinType()

The type of join - inner, cross, etc

public boolean
isImplicitlySelectable()

When applicable, whether this join should be included in an implicit select clause

public <X, Y> SqmAttributeJoin<X, Y>
join(String
name of the attribute for the target of the join
attributeName)

Redeclares org.hibernate.query.sqm.tree.from.SqmFrom.join.

Create an inner join to the specified attribute.
public <X, Y> SqmAttributeJoin<X, Y>
join(String
name of the attribute for the target of the join
attributeName, JoinType
join type
jt)

Redeclares org.hibernate.query.sqm.tree.from.SqmFrom.join.

Create a join to the specified attribute using the given join type.
Inherited from org.hibernate.query.sqm.tree.from.SqmFrom:
addSqmJoingetCorrelationParentgetReferencedPathSourcegetSqmJoinsgetSqmTreatshasJoinshasTreatsjoinjoinjoinjoinjoinjoinjoinjoinjoinjoinjoinCollectionjoinCollectionjoinListjoinListjoinMapjoinMapjoinSetjoinSettreatAstreatAstreatAstreatAsvisitSqmJoins

Method Detail

copyback to summary
public SqmJoin<O, T> copy(SqmCopyContext context)

Redeclares org.hibernate.query.sqm.tree.from.SqmFrom.copy.

Annotations
@Override
getSqmJoinTypeback to summary
public SqmJoinType getSqmJoinType()

The type of join - inner, cross, etc

isImplicitlySelectableback to summary
public boolean isImplicitlySelectable()

When applicable, whether this join should be included in an implicit select clause

joinback to summary
public <X, Y> SqmAttributeJoin<X, Y> join(String attributeName)

Redeclares org.hibernate.query.sqm.tree.from.SqmFrom.join.

Doc from jakarta.persistence.criteria.From.join.

Create an inner join to the specified attribute.

Parameters
attributeName:String

name of the attribute for the target of the join

Returns:SqmAttributeJoin<X, Y>

the resulting join

Annotations
@Override
joinback to summary
public <X, Y> SqmAttributeJoin<X, Y> join(String attributeName, JoinType jt)

Redeclares org.hibernate.query.sqm.tree.from.SqmFrom.join.

Doc from jakarta.persistence.criteria.From.join.

Create a join to the specified attribute using the given join type.

Parameters
attributeName:String

name of the attribute for the target of the join

jt:JoinType

join type

Returns:SqmAttributeJoin<X, Y>

the resulting join

Annotations
@Override