org.eclipse.persistence.internal.jpa.querydef

Class FromImpl<Z,X>

java.lang.Object

org.eclipse.persistence.internal.jpa.querydef.SelectionImpl<X>

org.eclipse.persistence.internal.jpa.querydef.ExpressionImpl<X>

org.eclipse.persistence.internal.jpa.querydef.PathImpl<X>

org.eclipse.persistence.internal.jpa.querydef.FromImpl<Z,X>

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable, InternalExpression, InternalSelection

Direct Known Subclasses:

JoinImpl, RootImpl

public class FromImpl<Z,X>
extends PathImpl<X>

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.

Since:

EclipseLink 1.2

Author:

gyorke

See Also:

From, Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected FromImpl	correlatedParent
protected java.util.Set<<any>>	fetches
protected boolean	isFetch
protected boolean	isJoin
protected java.util.Set<<any>>	joins
protected ManagedType	managedType

Fields inherited from class org.eclipse.persistence.internal.jpa.querydef.PathImpl

modelArtifact, pathParent

Fields inherited from class org.eclipse.persistence.internal.jpa.querydef.ExpressionImpl

isLiteral, literal, metamodel

Fields inherited from class org.eclipse.persistence.internal.jpa.querydef.SelectionImpl

alias, currentNode, javaType

Constructor Summary

Constructors

Constructor and Description
FromImpl(<any> parentPath, ManagedType managedType, Metamodel metamodel, java.lang.Class<X> javaClass, org.eclipse.persistence.expressions.Expression expressionNode, <any> modelArtifact)
FromImpl(<any> parentPath, ManagedType managedType, Metamodel metamodel, java.lang.Class<X> javaClass, org.eclipse.persistence.expressions.Expression expressionNode, <any> modelArtifact, FromImpl correlatedParent)

Method Summary

Modifier and Type	Method and Description
<Y> <any>	fetch(<any> assoc) Fetch join to the specified attribute using an inner join.
<Y> <any>	fetch(<any> assoc) Fetch join to the specified collection using an inner join.
<Y> <any>	fetch(<any> assoc, JoinType jt) Fetch join to the specified attribute using the given join type.
<Y> <any>	fetch(<any> assoc, JoinType jt) Fetch join to the specified collection using the given join type.
<T,Y> <any>	fetch(java.lang.String assocName) Fetch join to the specified attribute or association using an inner join.
<T,Y> <any>	fetch(java.lang.String assocName, JoinType jt) Fetch join to the specified attribute or association using the given join type.
java.util.List<org.eclipse.persistence.expressions.Expression>	findJoinFetches()
void	findJoins(AbstractQueryImpl query)
<E,C extends java.util.Collection<E>> <any>	get(<any> collection) Return the path corresponding to the referenced collection-valued attribute.
<K,V,M extends java.util.Map<K,V>> <any>	get(<any> map) Return the path corresponding to the referenced map-valued attribute.
<Y> <any>	get(<any> att) Return the path corresponding to the referenced non-collection valued attribute.
<Y> <any>	get(java.lang.String attName)
<any>	getCorrelationParent() Returns the parent From object from which the correlated From object has been obtained through correlation (use of a Subquery correlate method).
java.util.Set<<any>>	getFetches() Return the fetch joins that have been made from this type.
java.util.Set<<any>>	getJoins()
boolean	isCorrelated() Whether the From object has been obtained as a result of correlation (use of a Subquery correlate method).
boolean	isFrom()
<K,V> <any>	join(<any> map)
<Y> <any>	join(<any> attribute)
<Y> <any>	join(<any> collection)
<Y> <any>	join(<any> set)
<Y> <any>	join(<any> list)
<K,V> <any>	join(<any> map, JoinType jt)
<Y> <any>	join(<any> attribute, JoinType jt)
<Y> <any>	join(<any> collection, JoinType jt)
<Y> <any>	join(<any> set, JoinType jt)
<Y> <any>	join(<any> list, JoinType jt)
<T,Y> <any>	join(java.lang.String attributeName)
<T,Y> <any>	join(java.lang.String attributeName, JoinType jt)
<T,Y> <any>	joinCollection(java.lang.String attributeName)
<T,Y> <any>	joinCollection(java.lang.String attributeName, JoinType jt)
<T,Y> <any>	joinList(java.lang.String attributeName)
<T,Y> <any>	joinList(java.lang.String attributeName, JoinType jt)
<T,K,Y> <any>	joinMap(java.lang.String attributeName)
<T,K,Y> <any>	joinMap(java.lang.String attributeName, JoinType jt)
<T,Y> <any>	joinSet(java.lang.String attributeName)
<T,Y> <any>	joinSet(java.lang.String attributeName, JoinType jt)
<any>	type() Return an expression corresponding to the type of the path.

Methods inherited from class org.eclipse.persistence.internal.jpa.querydef.PathImpl

clone, findRootAndParameters, getModel, getParentPath

Methods inherited from class org.eclipse.persistence.internal.jpa.querydef.ExpressionImpl

as, buildExpressionForAs, in, in, in, in, isCompoundExpression, isExpression, isJunction, isLiteral, isNotNull, isNull, isParameter, isPredicate, isSubquery

Methods inherited from class org.eclipse.persistence.internal.jpa.querydef.SelectionImpl

alias, getAlias, getCompoundSelectionItems, getCurrentNode, getJavaType, isCompoundSelection, isConstructor, isRoot

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

managedType

protected ManagedType managedType

joins

protected java.util.Set<<any>> joins

fetches

protected java.util.Set<<any>> fetches

isJoin

protected boolean isJoin

isFetch

protected boolean isFetch

correlatedParent

protected FromImpl correlatedParent

Constructor Detail

FromImpl

public FromImpl(<any> parentPath,
                ManagedType managedType,
                Metamodel metamodel,
                java.lang.Class<X> javaClass,
                org.eclipse.persistence.expressions.Expression expressionNode,
                <any> modelArtifact)

FromImpl

public FromImpl(<any> parentPath,
                ManagedType managedType,
                Metamodel metamodel,
                java.lang.Class<X> javaClass,
                org.eclipse.persistence.expressions.Expression expressionNode,
                <any> modelArtifact,
                FromImpl correlatedParent)

Method Detail

getFetches

public java.util.Set<<any>> getFetches()

Return the fetch joins that have been made from this type.

Returns:

fetch joins made from this type

isCorrelated

public boolean isCorrelated()

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

Returns:

boolean indicating whether the object has been obtained through correlation

getCorrelationParent

public <any> getCorrelationParent()

Returns the parent From object from which the correlated From object has been obtained through correlation (use of a Subquery correlate method).

Returns:

the parent of the correlated From object

Throws:

java.lang.IllegalStateException - if the From object has not been obtained through correlation

fetch

public <Y> <any> fetch(<any> assoc)

Fetch join to the specified attribute using an inner join.

Parameters:

assoc - target of the join

Returns:

the resulting fetch join

fetch

public <Y> <any> fetch(<any> assoc,
                       JoinType jt)

Fetch join to the specified attribute using the given join type.

Parameters:

assoc - target of the join

jt - join type

Returns:

the resulting fetch join

fetch

public <Y> <any> fetch(<any> assoc)

Fetch join to the specified collection using an inner join.

Parameters:

assoc - target of the join

Returns:

the resulting join

fetch

public <Y> <any> fetch(<any> assoc,
                       JoinType jt)

Fetch join to the specified collection using the given join type.

Parameters:

assoc - target of the join

jt - join type

Returns:

the resulting join

fetch

public <T,Y> <any> fetch(java.lang.String assocName)

Fetch join to the specified attribute or association using an inner join.

Parameters:

assocName - name of the attribute or association for the target of the join

Returns:

the resulting fetch join

fetch

public <T,Y> <any> fetch(java.lang.String assocName,
                         JoinType jt)

Fetch join to the specified attribute or association using the given join type.

Parameters:

assocName - assocName of the attribute or association for the target of the join

jt - join type

Returns:

the resulting fetch join

getJoins

public java.util.Set<<any>> getJoins()

get

public <Y> <any> get(<any> att)

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

Overrides:

get in class PathImpl<X>

Parameters:

att - attribute

Returns:

path corresponding to the referenced attribute

get

public <E,C extends java.util.Collection<E>> <any> get(<any> collection)

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

Overrides:

get in class PathImpl<X>

Parameters:

collection - collection-valued attribute

Returns:

expression corresponding to the referenced attribute

get

public <K,V,M extends java.util.Map<K,V>> <any> get(<any> map)

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

Overrides:

get in class PathImpl<X>

Parameters:

map - map-valued attribute

Returns:

expression corresponding to the referenced attribute

type

public <any> type()

Return an expression corresponding to the type of the path.

Overrides:

type in class PathImpl<X>

Returns:

expression corresponding to the type of the path

get

public <Y> <any> get(java.lang.String attName)

Overrides:

get in class PathImpl<X>

join

public <Y> <any> join(<any> attribute)

join

public <Y> <any> join(<any> attribute,
                      JoinType jt)

join

public <Y> <any> join(<any> collection)

join

public <Y> <any> join(<any> set)

join

public <Y> <any> join(<any> list)

join

public <K,V> <any> join(<any> map)

join

public <Y> <any> join(<any> collection,
                      JoinType jt)

join

public <Y> <any> join(<any> set,
                      JoinType jt)

join

public <Y> <any> join(<any> list,
                      JoinType jt)

join

public <K,V> <any> join(<any> map,
                        JoinType jt)

join

public <T,Y> <any> join(java.lang.String attributeName)

join

public <T,Y> <any> join(java.lang.String attributeName,
                        JoinType jt)

joinCollection

public <T,Y> <any> joinCollection(java.lang.String attributeName)

joinCollection

public <T,Y> <any> joinCollection(java.lang.String attributeName,
                                  JoinType jt)

joinList

public <T,Y> <any> joinList(java.lang.String attributeName)

joinList

public <T,Y> <any> joinList(java.lang.String attributeName,
                            JoinType jt)

joinMap

public <T,K,Y> <any> joinMap(java.lang.String attributeName)

joinMap

public <T,K,Y> <any> joinMap(java.lang.String attributeName,
                             JoinType jt)

joinSet

public <T,Y> <any> joinSet(java.lang.String attributeName)

joinSet

public <T,Y> <any> joinSet(java.lang.String attributeName,
                           JoinType jt)

findJoins

public void findJoins(AbstractQueryImpl query)

findJoinFetches

public java.util.List<org.eclipse.persistence.expressions.Expression> findJoinFetches()

isFrom

public boolean isFrom()

Specified by:

isFrom in interface InternalSelection

Overrides:

isFrom in class SelectionImpl<X>