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

public Interface SqmAttributeJoin<O, T>

extends SqmQualifiedJoin<O, T>, JpaFetch<O, T>, JpaJoin<O, T>
Known Direct Implementers
org.hibernate.query.sqm.tree.domain.AbstractSqmAttributeJoin
Imports
org.hibernate.Remove, org.hibernate.metamodel.model.domain.EntityDomainType, org.hibernate.query.criteria.JpaFetch, .JpaJoin, org.hibernate.query.hql.spi.SqmCreationProcessingState, org.hibernate.query.sqm.SqmPathSource, org.hibernate.query.sqm.tree.predicate.SqmPredicate, org.hibernate.type.descriptor.java.JavaType
Models a join based on a mapped attribute reference.
Author
Steve Ebersole

Method Summary

Modifier and TypeMethod and Description
public JavaType<T>
getJavaTypeDescriptor()

Redeclares org.hibernate.query.criteria.JpaTupleElement.getJavaTypeDescriptor.

Redeclares as abstract: org.hibernate.query.sqm.tree.domain.SqmPath.getJavaTypeDescriptor.

public SqmPredicate
getJoinPredicate()

Redeclares org.hibernate.query.sqm.tree.from.SqmQualifiedJoin.getJoinPredicate.

Obtain the join predicate
public SqmFrom<?, O>
getLhs()

Redeclares org.hibernate.query.sqm.tree.domain.SqmPath.getLhs, org.hibernate.query.criteria.JpaPath.getLhs.

Get the left-hand side of this path - may be null, indicating a root, cross-join or entity-join
public SqmPathSource<T>
getReferencedPathSource()

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

The Navigable for an SqmFrom will always be a NavigableContainer The path source that this path refers to (and that most likely created it).
public boolean
isFetched()

public default boolean
isImplicitlySelectable()

Implements org.hibernate.query.sqm.tree.from.SqmJoin.isImplicitlySelectable.

When applicable, whether this join should be included in an implicit select clause
public @Remove SqmAttributeJoin<O, T>
makeCopy(SqmCreationProcessingState creationProcessingState)

Deprecated
public void
setJoinPredicate(SqmPredicate
The join predicate
predicate)

Redeclares org.hibernate.query.sqm.tree.from.SqmQualifiedJoin.setJoinPredicate.

Inject the join predicate
public <S extends T> SqmAttributeJoin<O, S>
treatAs(Class<S> treatJavaType)

Redeclares org.hibernate.query.sqm.tree.from.SqmFrom.treatAs, org.hibernate.query.criteria.JpaJoin.treatAs.

Support for JPA's explicit (TREAT) down-casting.
public <S extends T> SqmAttributeJoin<O, S>
treatAs(EntityDomainType<S> treatTarget)

Redeclares org.hibernate.query.sqm.tree.from.SqmFrom.treatAs, org.hibernate.query.criteria.JpaJoin.treatAs.

Support for JPA's explicit (TREAT) down-casting.
public <S extends T> SqmAttributeJoin<O, S>
treatAs(Class<S> treatJavaType, String alias)

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

public <S extends T> SqmAttributeJoin<O, S>
treatAs(EntityDomainType<S> treatJavaType, String alias)

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

public <S extends T> SqmAttributeJoin<O, S>
treatAs(Class<S> treatJavaType, String alias, boolean fetch)

public <S extends T> SqmAttributeJoin<O, S>
treatAs(EntityDomainType<S> treatJavaType, String alias, boolean fetch)

Inherited from org.hibernate.query.criteria.JpaFetch:
fetchfetchfetchfetchfetchfetchgetFetchesonon
Inherited from org.hibernate.query.criteria.JpaJoin:
getAttributeonononon

Method Detail

getJavaTypeDescriptorback to summary
public JavaType<T> getJavaTypeDescriptor()

Redeclares org.hibernate.query.criteria.JpaTupleElement.getJavaTypeDescriptor.

Redeclares as abstract: org.hibernate.query.sqm.tree.domain.SqmPath.getJavaTypeDescriptor.

Annotations
@Override
getJoinPredicateback to summary
public SqmPredicate getJoinPredicate()

Redeclares org.hibernate.query.sqm.tree.from.SqmQualifiedJoin.getJoinPredicate.

Doc from org.hibernate.query.sqm.tree.from.SqmQualifiedJoin.getJoinPredicate.

Obtain the join predicate

Returns:SqmPredicate

The join predicate

Annotations
@Override
getLhsback to summary
public SqmFrom<?, O> getLhs()

Redeclares org.hibernate.query.sqm.tree.domain.SqmPath.getLhs, org.hibernate.query.criteria.JpaPath.getLhs.

Doc from org.hibernate.query.sqm.tree.domain.SqmPath.getLhs.

Get the left-hand side of this path - may be null, indicating a root, cross-join or entity-join

Annotations
@Override
getReferencedPathSourceback to summary
public SqmPathSource<T> getReferencedPathSource()

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

Doc from org.hibernate.query.sqm.tree.from.SqmFrom.getReferencedPathSource.

The Navigable for an SqmFrom will always be a NavigableContainer The path source that this path refers to (and that most likely created it).

Annotations
@Override
isFetchedback to summary
public boolean isFetched()
isImplicitlySelectableback to summary
public default boolean isImplicitlySelectable()

Implements org.hibernate.query.sqm.tree.from.SqmJoin.isImplicitlySelectable.

Doc from org.hibernate.query.sqm.tree.from.SqmJoin.isImplicitlySelectable.

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

Annotations
@Override
makeCopyback to summary
public @Remove SqmAttributeJoin<O, T> makeCopy(SqmCreationProcessingState creationProcessingState)

Deprecated

Annotations
@Deprecated
@Remove
setJoinPredicateback to summary
public void setJoinPredicate(SqmPredicate predicate)

Redeclares org.hibernate.query.sqm.tree.from.SqmQualifiedJoin.setJoinPredicate.

Doc from org.hibernate.query.sqm.tree.from.SqmQualifiedJoin.setJoinPredicate.

Inject the join predicate

Parameters
predicate:SqmPredicate

The join predicate

treatAsback to summary
public <S extends T> SqmAttributeJoin<O, S> treatAs(Class<S> treatJavaType)

Redeclares org.hibernate.query.sqm.tree.from.SqmFrom.treatAs, org.hibernate.query.criteria.JpaJoin.treatAs.

Doc from org.hibernate.query.criteria.JpaPath.treatAs.

Support for JPA's explicit (TREAT) down-casting.

Annotations
@Override
treatAsback to summary
public <S extends T> SqmAttributeJoin<O, S> treatAs(EntityDomainType<S> treatTarget)

Redeclares org.hibernate.query.sqm.tree.from.SqmFrom.treatAs, org.hibernate.query.criteria.JpaJoin.treatAs.

Doc from org.hibernate.query.criteria.JpaPath.treatAs.

Support for JPA's explicit (TREAT) down-casting.

Annotations
@Override
treatAsback to summary
public <S extends T> SqmAttributeJoin<O, S> treatAs(Class<S> treatJavaType, String alias)

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

Annotations
@Override
treatAsback to summary
public <S extends T> SqmAttributeJoin<O, S> treatAs(EntityDomainType<S> treatJavaType, String alias)

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

Annotations
@Override
treatAsback to summary
public <S extends T> SqmAttributeJoin<O, S> treatAs(Class<S> treatJavaType, String alias, boolean fetch)
treatAsback to summary
public <S extends T> SqmAttributeJoin<O, S> treatAs(EntityDomainType<S> treatJavaType, String alias, boolean fetch)