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

public Class FromImpl<Z, X>

extends PathImpl<X>
implements From<Z, X>
Class Inheritance
All Implemented Interfaces
jakarta.persistence.criteria.From, jakarta.persistence.criteria.FetchParent, jakarta.persistence.criteria.Path, jakarta.persistence.criteria.Expression, jakarta.persistence.criteria.Selection, jakarta.persistence.TupleElement
Known Direct Subclasses
org.eclipse.persistence.internal.jpa.querydef.JoinImpl, org.eclipse.persistence.internal.jpa.querydef.RootImpl
Imports
java.util.ArrayList, .Collection, .HashSet, .List, .Map, .Set, .Stack, jakarta.persistence.criteria.CollectionJoin, .Expression, .Fetch, .From, .Join, .JoinType, .ListJoin, .MapJoin, .Path, .SetJoin, jakarta.persistence.metamodel.Attribute, .Attribute.PersistentAttributeType, .Bindable, .CollectionAttribute, .ListAttribute, .ManagedType, .MapAttribute, .Metamodel, .PluralAttribute, .PluralAttribute.CollectionType, .SingularAttribute, .Type.PersistenceType, org.eclipse.persistence.internal.expressions.ObjectExpression, org.eclipse.persistence.internal.helper.ClassConstants, org.eclipse.persistence.internal.localization.ExceptionLocalization

Purpose: Contains the implementation of the From interface of the JPA criteria API.

Description: This class represents a from clause element which could be the root of the query of the end node of a join statement.

Author
gyorke
Since
EclipseLink 1.2
See Also
From

Field Summary

Modifier and TypeField and Description
protected FromImpl<Z, X>
correlatedParent

protected Set<Fetch<X, ?>>
fetches

protected boolean
isFetch

protected boolean
isJoin

protected Set<Join<X, ?>>
joins

protected ManagedType<X>
managedType

Inherited from org.eclipse.persistence.internal.jpa.querydef.PathImpl:
modelArtifactpathParent

Constructor Summary

AccessConstructor and Description
public <T>
FromImpl(Path<Z> parentPath, ManagedType<X> managedType, Metamodel metamodel, Class<X> javaClass, Expression expressionNode, Bindable<T> modelArtifact)

public <T>
FromImpl(Path<Z> parentPath, ManagedType<X> managedType, Metamodel metamodel, Class<X> javaClass, Expression expressionNode, Bindable<T> modelArtifact, FromImpl<Z, X> correlatedParent)

Method Summary

Modifier and TypeMethod and Description
public <Y> Fetch<X, Y>

Returns:

the resulting fetch join
fetch(SingularAttribute<? super X, Y>
target of the join
assoc)

Implements jakarta.persistence.criteria.FetchParent.fetch.

Fetch join to the specified attribute using an inner join.
public <Y> Fetch<X, Y>

Returns:

the resulting fetch join
fetch(SingularAttribute<? super X, Y>
target of the join
assoc, JoinType
join type
jt)

Implements jakarta.persistence.criteria.FetchParent.fetch.

Fetch join to the specified attribute using the given join type.
public <Y> Fetch<X, Y>

Returns:

the resulting join
fetch(PluralAttribute<? super X, ?, Y>
target of the join
assoc)

Implements jakarta.persistence.criteria.FetchParent.fetch.

Fetch join to the specified collection using an inner join.
public <Y> Fetch<X, Y>

Returns:

the resulting join
fetch(PluralAttribute<? super X, ?, Y>
target of the join
assoc, JoinType
join type
jt)

Implements jakarta.persistence.criteria.FetchParent.fetch.

Fetch join to the specified collection using the given join type.
public <T, Y> Fetch<T, Y>

Returns:

the resulting fetch join
fetch(String
name of the attribute or association for the target of the join
assocName)

Implements jakarta.persistence.criteria.FetchParent.fetch.

Fetch join to the specified attribute or association using an inner join.
public <T, Y> Fetch<T, Y>

Returns:

the resulting fetch join
fetch(String
assocName of the attribute or association for the target of the join
assocName, JoinType
join type
jt)

Implements jakarta.persistence.criteria.FetchParent.fetch.

Fetch join to the specified attribute or association using the given join type.
public List<Expression>
findJoinFetches()

public void
findJoins(AbstractQueryImpl<T> query)

public <Y> Path<Y>

Returns:

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

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

Implements jakarta.persistence.criteria.Path.get.

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

Returns:

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

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

Implements jakarta.persistence.criteria.Path.get.

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

Returns:

expression corresponding to the referenced attribute
get(MapAttribute<X, K, V>
map-valued attribute
map)

Overrides org.eclipse.persistence.internal.jpa.querydef.PathImpl.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.PathImpl.get.

Implements jakarta.persistence.criteria.Path.get.

Create a path corresponding to the referenced attribute.
public From<Z, X>

Returns:

the parent of the correlated From object
getCorrelationParent()

Implements jakarta.persistence.criteria.From.getCorrelationParent.

Returns the parent From object from which the correlated From object has been obtained through correlation (use of a Subquery correlate method).
public Set<Fetch<X, ?>>

Returns:

fetch joins made from this type
getFetches()

Implements jakarta.persistence.criteria.FetchParent.getFetches.

Return the fetch joins that have been made from this type.
public Set<Join<X, ?>>
getJoins()

Implements jakarta.persistence.criteria.From.getJoins.

Return the joins that have been made from this bound type.
public boolean

Returns:

boolean indicating whether the object has been obtained through correlation
isCorrelated()

Implements jakarta.persistence.criteria.From.isCorrelated.

Whether the From object has been obtained as a result of correlation (use of a Subquery correlate method).
public boolean
isFrom()

Overrides org.eclipse.persistence.internal.jpa.querydef.SelectionImpl.isFrom.

Implements org.eclipse.persistence.internal.jpa.querydef.InternalSelection.isFrom.

public <Y> Join<X, Y>
join(SingularAttribute<? super X, Y>
target of the join
attribute)

Implements jakarta.persistence.criteria.From.join.

Create an inner join to the specified single-valued attribute.
public <Y> Join<X, Y>
join(SingularAttribute<? super X, Y>
target of the join
attribute, JoinType
join type
jt)

Implements jakarta.persistence.criteria.From.join.

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

Implements jakarta.persistence.criteria.From.join.

Create an inner join to the specified Collection-valued attribute.
public <Y> SetJoin<X, Y>
join(SetAttribute<? super X, Y>
target of the join
set)

Implements jakarta.persistence.criteria.From.join.

Create an inner join to the specified Set-valued attribute.
public <Y> ListJoin<X, Y>
join(ListAttribute<? super X, Y>
target of the join
list)

Implements jakarta.persistence.criteria.From.join.

Create an inner join to the specified List-valued attribute.
public <K, V> MapJoin<X, K, V>
join(MapAttribute<? super X, K, V>
target of the join
map)

Implements jakarta.persistence.criteria.From.join.

Create an inner join to the specified Map-valued attribute.
public <Y> CollectionJoin<X, Y>
join(CollectionAttribute<? super X, Y>
target of the join
collection, JoinType
join type
jt)

Implements jakarta.persistence.criteria.From.join.

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

Implements jakarta.persistence.criteria.From.join.

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

Implements jakarta.persistence.criteria.From.join.

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

Implements jakarta.persistence.criteria.From.join.

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

Implements jakarta.persistence.criteria.From.join.

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

Implements jakarta.persistence.criteria.From.join.

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

Implements jakarta.persistence.criteria.From.joinCollection.

Create an inner join to the specified Collection-valued attribute.
public <T, Y> CollectionJoin<T, Y>
joinCollection(String
name of the attribute for the target of the join
attributeName, JoinType
join type
jt)

Implements jakarta.persistence.criteria.From.joinCollection.

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

Implements jakarta.persistence.criteria.From.joinList.

Create an inner join to the specified List-valued attribute.
public <T, Y> ListJoin<T, Y>
joinList(String
name of the attribute for the target of the join
attributeName, JoinType
join type
jt)

Implements jakarta.persistence.criteria.From.joinList.

Create a join to the specified List-valued attribute using the given join type.
public <T, K, Y> MapJoin<T, K, Y>
joinMap(String
name of the attribute for the target of the join
attributeName)

Implements jakarta.persistence.criteria.From.joinMap.

Create an inner join to the specified Map-valued attribute.
public <T, K, Y> MapJoin<T, K, Y>
joinMap(String
name of the attribute for the target of the join
attributeName, JoinType
join type
jt)

Implements jakarta.persistence.criteria.From.joinMap.

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

Implements jakarta.persistence.criteria.From.joinSet.

Create an inner join to the specified Set-valued attribute.
public <T, Y> SetJoin<T, Y>
joinSet(String
name of the attribute for the target of the join
attributeName, JoinType
join type
jt)

Implements jakarta.persistence.criteria.From.joinSet.

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

Returns:

expression corresponding to the type of the path
type()

Overrides org.eclipse.persistence.internal.jpa.querydef.PathImpl.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.PathImpl:
clonefindRootAndParametersgetModelgetParentPath