Top Description Constructors Methods
org.eclipse.persistence.internal.jpa.querydef

public Class BasicCollectionJoinImpl<Z, E>

extends CollectionJoinImpl<Z, E>
Class Inheritance
Annotations
@SuppressWarnings:hiding
Imports
jakarta.persistence.criteria.CollectionJoin, .Expression, .Join, .JoinType, .ListJoin, .MapJoin, .Path, .SetJoin, jakarta.persistence.metamodel.Bindable, .CollectionAttribute, .ListAttribute, .MapAttribute, .Metamodel, .PluralAttribute, .SingularAttribute, org.eclipse.persistence.internal.localization.ExceptionLocalization

Purpose: Represents a Join to a ElementCollection of basics.

Description: Represents a Join to a ElementCollection of basics. Special type of Join that does not allow further joins.

Author
gyorke
Since
EclipseLink 1.2
See Also
CollectionJoin

Constructor Summary

AccessConstructor and Description
public <T>
BasicCollectionJoinImpl(Path<Z> parentPath, Metamodel metamodel, Class<E> javaClass, Expression expressionNode, Bindable<T> modelArtifact)

public <C, T>
BasicCollectionJoinImpl(Path<Z> parentPath, Metamodel metamodel, Class<E> javaClass, Expression expressionNode, Bindable<T> modelArtifact, JoinType joinType)

Method Summary

Modifier and TypeMethod and Description
public <Y> Path<Y>

Returns:

path corresponding to the referenced attribute
get(SingularAttribute<? super E, Y>
attribute
att)

Overrides org.eclipse.persistence.internal.jpa.querydef.FromImpl.get.

Implements jakarta.persistence.criteria.Path.get.

Return the path corresponding to the referenced non-collection valued attribute.
public <Y, C extends Collection<Y>> Expression<C>

Returns:

expression corresponding to the referenced attribute
get(PluralAttribute<E, C, Y>
collection-valued attribute
collection)

Overrides org.eclipse.persistence.internal.jpa.querydef.FromImpl.get.

Implements jakarta.persistence.criteria.Path.get.

Return the path corresponding to the referenced collection-valued attribute.
public <L, W, M extends Map<L, W>> Expression<M>

Returns:

expression corresponding to the referenced attribute
get(MapAttribute<E, L, W>
map-valued attribute
map)

Overrides org.eclipse.persistence.internal.jpa.querydef.FromImpl.get.

Implements jakarta.persistence.criteria.Path.get.

Return the path corresponding to the referenced map-valued attribute.
public <Y> Path<Y>
get(String
name of the attribute
attName)

Overrides org.eclipse.persistence.internal.jpa.querydef.FromImpl.get.

Implements jakarta.persistence.criteria.Path.get.

Create a path corresponding to the referenced attribute.
public <Y> Join<E, Y>
join(SingularAttribute<? super E, Y>
target of the join
attribute, JoinType
join type
jt)

Overrides org.eclipse.persistence.internal.jpa.querydef.FromImpl.join.

Implements jakarta.persistence.criteria.From.join.

Create a join to the specified single-valued attribute using the given join type.
public <Y> CollectionJoin<E, Y>
join(CollectionAttribute<? super E, Y>
target of the join
collection, JoinType
join type
jt)

Overrides org.eclipse.persistence.internal.jpa.querydef.FromImpl.join.

Implements jakarta.persistence.criteria.From.join.

Create a join to the specified Collection-valued attribute using the given join type.
public <Y> SetJoin<E, Y>
join(SetAttribute<? super E, Y>
target of the join
set, JoinType
join type
jt)

Overrides org.eclipse.persistence.internal.jpa.querydef.FromImpl.join.

Implements jakarta.persistence.criteria.From.join.

Create a join to the specified Set-valued attribute using the given join type.
public <Y> ListJoin<E, Y>
join(ListAttribute<? super E, Y>
target of the join
list, JoinType
join type
jt)

Overrides org.eclipse.persistence.internal.jpa.querydef.FromImpl.join.

Implements jakarta.persistence.criteria.From.join.

Create a join to the specified List-valued attribute using the given join type.
public <L, W> MapJoin<E, L, W>
join(MapAttribute<? super E, L, W>
target of the join
map, JoinType
join type
jt)

Overrides org.eclipse.persistence.internal.jpa.querydef.FromImpl.join.

Implements jakarta.persistence.criteria.From.join.

Create a join to the specified Map-valued attribute using the given join type.
public <E, Y> Join<E, Y>
join(String
name of the attribute for the target of the join
attributeName, JoinType
join type
jt)

Overrides org.eclipse.persistence.internal.jpa.querydef.FromImpl.join.

Implements jakarta.persistence.criteria.From.join.

Create a join to the specified attribute using the given join type.
public <E, Y> CollectionJoin<E, Y>
joinCollection(String
name of the attribute for the target of the join
attributeName, JoinType
join type
jt)

Overrides org.eclipse.persistence.internal.jpa.querydef.FromImpl.joinCollection.

Implements jakarta.persistence.criteria.From.joinCollection.

Create a join to the specified Collection-valued attribute using the given join type.
public <E, Y> ListJoin<E, Y>
joinList(String
name of the attribute for the target of the join
attributeName, JoinType
join type
jt)

Overrides org.eclipse.persistence.internal.jpa.querydef.FromImpl.joinList.

Implements jakarta.persistence.criteria.From.joinList.

Create a join to the specified List-valued attribute using the given join type.
public <E, L, W> MapJoin<E, L, W>
joinMap(String
name of the attribute for the target of the join
attributeName, JoinType
join type
jt)

Overrides org.eclipse.persistence.internal.jpa.querydef.FromImpl.joinMap.

Implements jakarta.persistence.criteria.From.joinMap.

Create a join to the specified Map-valued attribute using the given join type.
public <E, Y> SetJoin<E, Y>
joinSet(String
name of the attribute for the target of the join
attributeName, JoinType
join type
jt)

Overrides org.eclipse.persistence.internal.jpa.querydef.FromImpl.joinSet.

Implements jakarta.persistence.criteria.From.joinSet.

Create a join to the specified Set-valued attribute using the given join type.
public Expression<Class<? extends E>>

Returns:

expression corresponding to the type of the path
type()

Overrides org.eclipse.persistence.internal.jpa.querydef.FromImpl.type.

Implements jakarta.persistence.criteria.Path.type.

Return an expression corresponding to the type of the path.
Inherited from org.eclipse.persistence.internal.jpa.querydef.CollectionJoinImpl:
getModelonon

Constructor Detail

BasicCollectionJoinImplback to summary
public <T> BasicCollectionJoinImpl(Path<Z> parentPath, Metamodel metamodel, Class<E> javaClass, Expression expressionNode, Bindable<T> modelArtifact)
BasicCollectionJoinImplback to summary
public <C, T> BasicCollectionJoinImpl(Path<Z> parentPath, Metamodel metamodel, Class<E> javaClass, Expression expressionNode, Bindable<T> modelArtifact, JoinType joinType)

Method Detail

getback to summary
public <Y> Path<Y> get(SingularAttribute<? super E, Y> att)

Overrides org.eclipse.persistence.internal.jpa.querydef.FromImpl.get.

Implements jakarta.persistence.criteria.Path.get.

Return the path corresponding to the referenced non-collection valued attribute.

Parameters
att:SingularAttribute<? super E, Y>

attribute

Returns:Path<Y>

path corresponding to the referenced attribute

Annotations
@Override
getback to summary
public <Y, C extends Collection<Y>> Expression<C> get(PluralAttribute<E, C, Y> collection)

Overrides org.eclipse.persistence.internal.jpa.querydef.FromImpl.get.

Implements jakarta.persistence.criteria.Path.get.

Return the path corresponding to the referenced collection-valued attribute.

Parameters
collection:PluralAttribute<E, C, Y>

collection-valued attribute

Returns:Expression<C>

expression corresponding to the referenced attribute

Annotations
@Override
getback to summary
public <L, W, M extends Map<L, W>> Expression<M> get(MapAttribute<E, L, W> map)

Overrides org.eclipse.persistence.internal.jpa.querydef.FromImpl.get.

Implements jakarta.persistence.criteria.Path.get.

Return the path corresponding to the referenced map-valued attribute.

Parameters
map:MapAttribute<E, L, W>

map-valued attribute

Returns:Expression<M>

expression corresponding to the referenced attribute

Annotations
@Override
getback to summary
public <Y> Path<Y> get(String attName)

Overrides org.eclipse.persistence.internal.jpa.querydef.FromImpl.get.

Implements jakarta.persistence.criteria.Path.get.

Doc from jakarta.persistence.criteria.Path.get.

Create a path corresponding to the referenced attribute.

Note

Applications using the string-based API may need to specify the type resulting from the get operation in order to avoid the use of Path variables. 

   For example:

   CriteriaQuery<Person> q = cb.createQuery(Person.class);
   Root<Person> p = q.from(Person.class);
   q.select(p)
    .where(cb.isMember("joe",
                       p.<Set<String>>get("nicknames")));

   rather than:

   CriteriaQuery<Person> q = cb.createQuery(Person.class);
   Root<Person> p = q.from(Person.class);
   Path<Set<String>> nicknames = p.get("nicknames");
   q.select(p)
    .where(cb.isMember("joe", nicknames));
Parameters
attName:String

name of the attribute

Returns:Path<Y>

path corresponding to the referenced attribute

Annotations
@Override
joinback to summary
public <Y> Join<E, Y> join(SingularAttribute<? super E, Y> attribute, JoinType jt)

Overrides org.eclipse.persistence.internal.jpa.querydef.FromImpl.join.

Implements jakarta.persistence.criteria.From.join.

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

Create a join to the specified single-valued attribute using the given join type.

Parameters
attribute:SingularAttribute<? super E, Y>

target of the join

jt:JoinType

join type

Returns:Join<E, Y>

the resulting join

Annotations
@Override
joinback to summary
public <Y> CollectionJoin<E, Y> join(CollectionAttribute<? super E, Y> collection, JoinType jt)

Overrides org.eclipse.persistence.internal.jpa.querydef.FromImpl.join.

Implements jakarta.persistence.criteria.From.join.

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

Create a join to the specified Collection-valued attribute using the given join type.

Parameters
collection:CollectionAttribute<? super E, Y>

target of the join

jt:JoinType

join type

Returns:CollectionJoin<E, Y>

the resulting join

Annotations
@Override
joinback to summary
public <Y> SetJoin<E, Y> join(SetAttribute<? super E, Y> set, JoinType jt)

Overrides org.eclipse.persistence.internal.jpa.querydef.FromImpl.join.

Implements jakarta.persistence.criteria.From.join.

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

Create a join to the specified Set-valued attribute using the given join type.

Parameters
set:SetAttribute<? super E, Y>

target of the join

jt:JoinType

join type

Returns:SetJoin<E, Y>

the resulting join

Annotations
@Override
joinback to summary
public <Y> ListJoin<E, Y> join(ListAttribute<? super E, Y> list, JoinType jt)

Overrides org.eclipse.persistence.internal.jpa.querydef.FromImpl.join.

Implements jakarta.persistence.criteria.From.join.

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

Create a join to the specified List-valued attribute using the given join type.

Parameters
list:ListAttribute<? super E, Y>

target of the join

jt:JoinType

join type

Returns:ListJoin<E, Y>

the resulting join

Annotations
@Override
joinback to summary
public <L, W> MapJoin<E, L, W> join(MapAttribute<? super E, L, W> map, JoinType jt)

Overrides org.eclipse.persistence.internal.jpa.querydef.FromImpl.join.

Implements jakarta.persistence.criteria.From.join.

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

Create a join to the specified Map-valued attribute using the given join type.

Parameters
map:MapAttribute<? super E, L, W>

target of the join

jt:JoinType

join type

Returns:MapJoin<E, L, W>

the resulting join

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

Overrides org.eclipse.persistence.internal.jpa.querydef.FromImpl.join.

Implements jakarta.persistence.criteria.From.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:Join<E, Y>

the resulting join

Annotations
@Override
joinCollectionback to summary
public <E, Y> CollectionJoin<E, Y> joinCollection(String attributeName, JoinType jt)

Overrides org.eclipse.persistence.internal.jpa.querydef.FromImpl.joinCollection.

Implements jakarta.persistence.criteria.From.joinCollection.

Doc from jakarta.persistence.criteria.From.joinCollection.

Create a join to the specified Collection-valued attribute using the given join type.

Parameters
attributeName:String

name of the attribute for the target of the join

jt:JoinType

join type

Returns:CollectionJoin<E, Y>

the resulting join

Annotations
@Override
joinListback to summary
public <E, Y> ListJoin<E, Y> joinList(String attributeName, JoinType jt)

Overrides org.eclipse.persistence.internal.jpa.querydef.FromImpl.joinList.

Implements jakarta.persistence.criteria.From.joinList.

Doc from jakarta.persistence.criteria.From.joinList.

Create a join to the specified List-valued attribute using the given join type.

Parameters
attributeName:String

name of the attribute for the target of the join

jt:JoinType

join type

Returns:ListJoin<E, Y>

the resulting join

Annotations
@Override
joinMapback to summary
public <E, L, W> MapJoin<E, L, W> joinMap(String attributeName, JoinType jt)

Overrides org.eclipse.persistence.internal.jpa.querydef.FromImpl.joinMap.

Implements jakarta.persistence.criteria.From.joinMap.

Doc from jakarta.persistence.criteria.From.joinMap.

Create a join to the specified Map-valued attribute using the given join type.

Parameters
attributeName:String

name of the attribute for the target of the join

jt:JoinType

join type

Returns:MapJoin<E, L, W>

the resulting join

Annotations
@Override
joinSetback to summary
public <E, Y> SetJoin<E, Y> joinSet(String attributeName, JoinType jt)

Overrides org.eclipse.persistence.internal.jpa.querydef.FromImpl.joinSet.

Implements jakarta.persistence.criteria.From.joinSet.

Doc from jakarta.persistence.criteria.From.joinSet.

Create a join to the specified Set-valued attribute using the given join type.

Parameters
attributeName:String

name of the attribute for the target of the join

jt:JoinType

join type

Returns:SetJoin<E, Y>

the resulting join

Annotations
@Override
typeback to summary
public Expression<Class<? extends E>> type()

Overrides org.eclipse.persistence.internal.jpa.querydef.FromImpl.type.

Implements jakarta.persistence.criteria.Path.type.

Return an expression corresponding to the type of the path.

Returns:Expression<Class<? extends E>>

expression corresponding to the type of the path

Annotations
@Override