Package io.micronaut.data.model.jpa.criteria

Interface PersistentAssociationPath<OwnerType,AssociatedEntityType>

Type Parameters:

OwnerType - The association owner type

AssociatedEntityType - The association entity type

All Superinterfaces:

jakarta.persistence.criteria.Expression<AssociatedEntityType>, jakarta.persistence.criteria.FetchParent<OwnerType,AssociatedEntityType>, jakarta.persistence.criteria.From<OwnerType,AssociatedEntityType>, IExpression<AssociatedEntityType>, ISelection<AssociatedEntityType>, jakarta.persistence.criteria.Join<OwnerType,AssociatedEntityType>, jakarta.persistence.criteria.Path<AssociatedEntityType>, PersistentEntityFrom<OwnerType,AssociatedEntityType>, PersistentEntityJoin<OwnerType,AssociatedEntityType>, PersistentEntityPath<AssociatedEntityType>, PersistentPropertyPath<AssociatedEntityType>, jakarta.persistence.criteria.Selection<AssociatedEntityType>, jakarta.persistence.TupleElement<AssociatedEntityType>

All Known Subinterfaces:

PersistentCollectionAssociationPath<OwnerType,AssociatedEntityType>, PersistentListAssociationPath<OwnerType,AssociatedEntityType>, PersistentSetAssociationPath<OwnerType,AssociatedEntityType>

public interface PersistentAssociationPath<OwnerType,AssociatedEntityType>
extends PersistentEntityJoin<OwnerType,AssociatedEntityType>, PersistentPropertyPath<AssociatedEntityType>

The persistent entity association path.

Since:

3.2

Author:

Denis Stepanov

Method Summary

Modifier and Type	Method	Description
default List<Association>	asPath()
default <K, V, M extends Map<K, V>> jakarta.persistence.criteria.Expression<M>	get(jakarta.persistence.metamodel.MapAttribute<AssociatedEntityType,K,V> map)
default <E, C extends Collection<E>> jakarta.persistence.criteria.Expression<C>	get(jakarta.persistence.metamodel.PluralAttribute<AssociatedEntityType,C,E> collection)
default <Y> PersistentPropertyPath<Y>	get(jakarta.persistence.metamodel.SingularAttribute<? super AssociatedEntityType,Y> attribute)
<Y> PersistentPropertyPath<Y>	get(String attributeName)	Get a persistent property path.
Association	getAssociation()
Join.Type	getAssociationJoinType()
default jakarta.persistence.metamodel.Attribute<? super OwnerType,?>	getAttribute()
default jakarta.persistence.criteria.JoinType	getJoinType()
default jakarta.persistence.metamodel.Bindable<AssociatedEntityType>	getModel()
default @Nullable jakarta.persistence.criteria.Predicate	getOn()
Association	getProperty()
default PersistentAssociationPath	getPropertyPath()
<Y> PersistentAssociationPath<AssociatedEntityType,Y>	join(jakarta.persistence.metamodel.SingularAttribute<? super AssociatedEntityType,Y> attribute)
<Y> PersistentAssociationPath<AssociatedEntityType,Y>	join(jakarta.persistence.metamodel.SingularAttribute<? super AssociatedEntityType,Y> attribute, Join.Type jt)	Joins the entity with specific join type.
<Y> PersistentAssociationPath<AssociatedEntityType,Y>	join(jakarta.persistence.metamodel.SingularAttribute<? super AssociatedEntityType,Y> attribute, jakarta.persistence.criteria.JoinType jt)
<X, Y> PersistentAssociationPath<X,Y>	join(String attributeName)
<X, Y> PersistentAssociationPath<X,Y>	join(String attributeName, Join.Type joinType)	Joins the entity with specific join type.
<X, Y> PersistentAssociationPath<X,Y>	join(String attributeName, Join.Type joinType, String alias)	Joins the entity with specific join type.
<X, Y> PersistentAssociationPath<X,Y>	join(String attributeName, jakarta.persistence.criteria.JoinType jt)
default jakarta.persistence.criteria.Join<OwnerType,AssociatedEntityType>	on(jakarta.persistence.criteria.Expression<Boolean> restriction)
default jakarta.persistence.criteria.Join<OwnerType,AssociatedEntityType>	on(jakarta.persistence.criteria.Predicate... restrictions)
void	setAlias(String alias)	Set join alias.
void	setAssociationJoinType(Join.Type type)	Set join type.
default void	visitExpression(ExpressionVisitor expressionVisitor)	Visit the expression.

Methods inherited from interface jakarta.persistence.criteria.Expression

cast, equalTo, equalTo, notEqualTo, notEqualTo

Methods inherited from interface jakarta.persistence.criteria.FetchParent

fetch, fetch, fetch, fetch, fetch, fetch, getFetches

Methods inherited from interface jakarta.persistence.criteria.From

getCorrelationParent, getJoins, isCorrelated, join, join, join, join, join, join, joinMap, joinMap

Methods inherited from interface io.micronaut.data.model.jpa.criteria.IExpression

as, getJavaType, in, in, in, in, visitSelection

Methods inherited from interface io.micronaut.data.model.jpa.criteria.ISelection

alias, getAlias, getCompoundSelectionItems, isCompoundSelection

Methods inherited from interface jakarta.persistence.criteria.Join

getParent

Methods inherited from interface jakarta.persistence.criteria.Path

get, get, getParentPath, type

Methods inherited from interface io.micronaut.data.model.jpa.criteria.PersistentEntityFrom

getPersistentJoins, join, join, join, join, join, join, joinCollection, joinCollection, joinList, joinList, joinSet, joinSet

Methods inherited from interface io.micronaut.data.model.jpa.criteria.PersistentEntityPath

getPersistentEntity

Methods inherited from interface io.micronaut.data.model.jpa.criteria.PersistentPropertyPath

getAssociations, getExpressionType, getPathAsString, isNotNull, isNull

Method Details

getProperty

Association getProperty()

Specified by:

getProperty in interface PersistentPropertyPath<OwnerType>

getAssociation

Association getAssociation()

getPropertyPath

default PersistentAssociationPath getPropertyPath()

Specified by:

getPropertyPath in interface PersistentPropertyPath<OwnerType>

getAssociationJoinType

Join.Type getAssociationJoinType()

Returns:

The join type

getJoinType

default jakarta.persistence.criteria.JoinType getJoinType()

Specified by:

getJoinType in interface jakarta.persistence.criteria.Join<OwnerType,AssociatedEntityType>

setAssociationJoinType

void setAssociationJoinType(Join.Type type)

Set join type.

Parameters:

type - The join type

setAlias

void setAlias(String alias)

Set join alias.

Parameters:

alias - The alias

asPath

default List<Association> asPath()

on

default jakarta.persistence.criteria.Join<OwnerType,AssociatedEntityType> on(jakarta.persistence.criteria.Expression<Boolean> restriction)

Specified by:

on in interface jakarta.persistence.criteria.Join<OwnerType,AssociatedEntityType>

on

default jakarta.persistence.criteria.Join<OwnerType,AssociatedEntityType> on(jakarta.persistence.criteria.Predicate... restrictions)

Specified by:

on in interface jakarta.persistence.criteria.Join<OwnerType,AssociatedEntityType>

getOn

default @Nullable jakarta.persistence.criteria.Predicate getOn()

Specified by:

getOn in interface jakarta.persistence.criteria.Join<OwnerType,AssociatedEntityType>

getAttribute

default jakarta.persistence.metamodel.Attribute<? super OwnerType,?> getAttribute()

Specified by:

getAttribute in interface jakarta.persistence.criteria.Join<OwnerType,AssociatedEntityType>

getModel

default jakarta.persistence.metamodel.Bindable<AssociatedEntityType> getModel()

Specified by:

getModel in interface jakarta.persistence.criteria.Path<OwnerType>

visitExpression

default void visitExpression(ExpressionVisitor expressionVisitor)

Description copied from interface: IExpression

Visit the expression.

Specified by:

visitExpression in interface IExpression<OwnerType>

Parameters:

expressionVisitor - The expression visitor

get

<Y> PersistentPropertyPath<Y> get(String attributeName)

Description copied from interface: PersistentEntityPath

Get a persistent property path.

Specified by:

get in interface jakarta.persistence.criteria.Path<OwnerType>

Specified by:

get in interface PersistentEntityPath<OwnerType>

Specified by:

get in interface PersistentPropertyPath<OwnerType>

Type Parameters:

Y - The property type

Parameters:

attributeName - The property name

Returns:

The property path

get

default <Y> PersistentPropertyPath<Y> get(jakarta.persistence.metamodel.SingularAttribute<? super AssociatedEntityType,Y> attribute)

Specified by:

get in interface jakarta.persistence.criteria.Path<OwnerType>

Specified by:

get in interface PersistentEntityPath<OwnerType>

Specified by:

get in interface PersistentPropertyPath<OwnerType>

get

default <E,
C extends Collection<E>>
jakarta.persistence.criteria.Expression<C> get(jakarta.persistence.metamodel.PluralAttribute<AssociatedEntityType,C,E> collection)

Specified by:

get in interface PersistentEntityPath<OwnerType>

Specified by:

get in interface PersistentPropertyPath<OwnerType>

get

default <K,
V,
M extends Map<K,
V>>
jakarta.persistence.criteria.Expression<M> get(jakarta.persistence.metamodel.MapAttribute<AssociatedEntityType,K,V> map)

Specified by:

get in interface PersistentEntityPath<OwnerType>

Specified by:

get in interface PersistentPropertyPath<OwnerType>

join

<X,
Y> PersistentAssociationPath<X,Y> join(String attributeName)

Specified by:

join in interface jakarta.persistence.criteria.From<OwnerType,AssociatedEntityType>

Specified by:

join in interface PersistentEntityFrom<OwnerType,AssociatedEntityType>

join

<X,
Y> PersistentAssociationPath<X,Y> join(String attributeName,
 Join.Type joinType)

Description copied from interface: PersistentEntityFrom

Joins the entity with specific join type.

Specified by:

join in interface PersistentEntityFrom<OwnerType,AssociatedEntityType>

Type Parameters:

X - The association owner type

Y - The association entity type

Parameters:

attributeName - The joined associated property

joinType - The join type

Returns:

The joined entity

join

<X,
Y> PersistentAssociationPath<X,Y> join(String attributeName,
 Join.Type joinType,
 String alias)

Description copied from interface: PersistentEntityFrom

Joins the entity with specific join type.

Specified by:

join in interface PersistentEntityFrom<OwnerType,AssociatedEntityType>

Type Parameters:

X - The association owner type

Y - The association entity type

Parameters:

attributeName - The joined associated property

joinType - The join type

alias - The join alias

Returns:

The joined entity

join

<X,
Y> PersistentAssociationPath<X,Y> join(String attributeName,
 jakarta.persistence.criteria.JoinType jt)

Specified by:

join in interface jakarta.persistence.criteria.From<OwnerType,AssociatedEntityType>

Specified by:

join in interface PersistentEntityFrom<OwnerType,AssociatedEntityType>

join

<Y>
PersistentAssociationPath<AssociatedEntityType,Y> join(jakarta.persistence.metamodel.SingularAttribute<? super AssociatedEntityType,Y> attribute,
 jakarta.persistence.criteria.JoinType jt)

Specified by:

join in interface jakarta.persistence.criteria.From<OwnerType,AssociatedEntityType>

Specified by:

join in interface PersistentEntityFrom<OwnerType,AssociatedEntityType>

join

<Y>
PersistentAssociationPath<AssociatedEntityType,Y> join(jakarta.persistence.metamodel.SingularAttribute<? super AssociatedEntityType,Y> attribute)

Specified by:

join in interface jakarta.persistence.criteria.From<OwnerType,AssociatedEntityType>

Specified by:

join in interface PersistentEntityFrom<OwnerType,AssociatedEntityType>

join

<Y>
PersistentAssociationPath<AssociatedEntityType,Y> join(jakarta.persistence.metamodel.SingularAttribute<? super AssociatedEntityType,Y> attribute,
 Join.Type jt)

Description copied from interface: PersistentEntityFrom

Joins the entity with specific join type.

Specified by:

join in interface PersistentEntityFrom<OwnerType,AssociatedEntityType>

Type Parameters:

Y - The association entity type

Parameters:

attribute - The attribute

jt - The join type

Returns:

The joined entity