FromImpl (OpenJPA Parent POM 2.4.0 API)

java.lang.Object
- org.apache.openjpa.persistence.criteria.SelectionImpl<X>
- - org.apache.openjpa.persistence.criteria.ExpressionImpl<X>
  - - org.apache.openjpa.persistence.criteria.PathImpl<Z,X>
    - - org.apache.openjpa.persistence.criteria.FromImpl<Z,X>

Type Parameters:
Z - the parent type of this receiver
X - the type represented by this receiver

All Implemented Interfaces:

javax.persistence.criteria.Expression<X>, javax.persistence.criteria.FetchParent<Z,X>, javax.persistence.criteria.From<Z,X>, javax.persistence.criteria.Path<X>, javax.persistence.criteria.Selection<X>, javax.persistence.TupleElement<X>, CriteriaExpression

Direct Known Subclasses:

Joins.AbstractCollection, Joins.SingularJoin, RootImpl
```
 class FromImpl<Z,X>
extends PathImpl<Z,X>
implements javax.persistence.criteria.From<Z,X>
```
Represents a bound type, usually an entity that appears in the from clause, but may also be an embeddable belonging to an entity in the from clause. Serves as a factory for Joins of associations, embeddables and collections belonging to the type, and for Paths of attributes belonging to the type.

Field Summary
- Fields inherited from class org.apache.openjpa.persistence.criteria.PathImpl
  _member, _parent

Constructor Summary

Constructors
Modifier	Constructor and Description
`protected`	`FromImpl(AbstractManagedType<X> type)` Supply the non-null managed type.
`protected`	`FromImpl(PathImpl<?,Z> parent, Members.Member<? super Z,?> m, Class<X> x)`

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`acceptVisit(CriteriaExpressionVisitor visitor)` Accept visit from the given visitor.
`(package private) void`	`assertJoinable(javax.persistence.metamodel.Type<?> type)`
`<Y> javax.persistence.criteria.Fetch<X,Y>`	`fetch(javax.persistence.metamodel.PluralAttribute<? super X,?,Y> assoc)`
`<Y> javax.persistence.criteria.Fetch<X,Y>`	`fetch(javax.persistence.metamodel.PluralAttribute<? super X,?,Y> assoc, javax.persistence.criteria.JoinType jt)`
`<Y> javax.persistence.criteria.Fetch<X,Y>`	`fetch(javax.persistence.metamodel.SingularAttribute<? super X,Y> assoc)`
`<Y> javax.persistence.criteria.Fetch<X,Y>`	`fetch(javax.persistence.metamodel.SingularAttribute<? super X,Y> assoc, javax.persistence.criteria.JoinType jt)`
`<X,Y> javax.persistence.criteria.Fetch<X,Y>`	`fetch(String assocName)`
`<X,Y> javax.persistence.criteria.Fetch<X,Y>`	`fetch(String name, javax.persistence.criteria.JoinType jt)`
`javax.persistence.criteria.From<Z,X>`	`getCorrelationParent()`
`Set<javax.persistence.criteria.Fetch<X,?>>`	`getFetches()`
`Set<javax.persistence.criteria.Join<X,?>>`	`getJoins()` Return the joins that have been made from this receiver.
`javax.persistence.metamodel.Type<?>`	`getType()`
`<Y> javax.persistence.criteria.CollectionJoin<X,Y>`	`join(javax.persistence.metamodel.CollectionAttribute<? super X,Y> collection)` Join to the given Collection-valued attribute using an inner join.
`<Y> javax.persistence.criteria.CollectionJoin<X,Y>`	`join(javax.persistence.metamodel.CollectionAttribute<? super X,Y> collection, javax.persistence.criteria.JoinType jt)` Join to the given Collection-valued attribute using the given join type.
`<Y> javax.persistence.criteria.ListJoin<X,Y>`	`join(javax.persistence.metamodel.ListAttribute<? super X,Y> list)` Join to the given List-valued attribute using an inner join.
`<Y> javax.persistence.criteria.ListJoin<X,Y>`	`join(javax.persistence.metamodel.ListAttribute<? super X,Y> list, javax.persistence.criteria.JoinType jt)` Join to the given List-valued attribute using the given join type.
`<K,V> javax.persistence.criteria.MapJoin<X,K,V>`	`join(javax.persistence.metamodel.MapAttribute<? super X,K,V> map)` Join to the given Map-valued attribute using an inner join.
`<K,V> javax.persistence.criteria.MapJoin<X,K,V>`	`join(javax.persistence.metamodel.MapAttribute<? super X,K,V> map, javax.persistence.criteria.JoinType jt)` Join to the given Map-valued attribute using the given join type.
`<Y> javax.persistence.criteria.SetJoin<X,Y>`	`join(javax.persistence.metamodel.SetAttribute<? super X,Y> set)` Join to the given Set-valued attribute using an inner join.
`<Y> javax.persistence.criteria.SetJoin<X,Y>`	`join(javax.persistence.metamodel.SetAttribute<? super X,Y> set, javax.persistence.criteria.JoinType jt)` Join to the given Set-valued attribute using the given join type.
`<Y> javax.persistence.criteria.Join<X,Y>`	`join(javax.persistence.metamodel.SingularAttribute<? super X,Y> attribute)` Join to the given attribute using an inner join.
`<Y> javax.persistence.criteria.Join<X,Y>`	`join(javax.persistence.metamodel.SingularAttribute<? super X,Y> attribute, javax.persistence.criteria.JoinType jt)` Join to the given attribute using the given join type.
`<W,Y> javax.persistence.criteria.Join<W,Y>`	`join(String attr)`
`<W,Y> javax.persistence.criteria.Join<W,Y>`	`join(String name, javax.persistence.criteria.JoinType jt)`
`<W,Y> javax.persistence.criteria.CollectionJoin<W,Y>`	`joinCollection(String attr)`
`<W,Y> javax.persistence.criteria.CollectionJoin<W,Y>`	`joinCollection(String attr, javax.persistence.criteria.JoinType jt)`
`<W,Y> javax.persistence.criteria.ListJoin<W,Y>`	`joinList(String attr)`
`<W,Y> javax.persistence.criteria.ListJoin<W,Y>`	`joinList(String attr, javax.persistence.criteria.JoinType jt)`
`<W,K,V> javax.persistence.criteria.MapJoin<W,K,V>`	`joinMap(String attr)`
`<W,K,V> javax.persistence.criteria.MapJoin<W,K,V>`	`joinMap(String attr, javax.persistence.criteria.JoinType jt)`
`<W,Y> javax.persistence.criteria.SetJoin<W,Y>`	`joinSet(String attr)`
`<W,Y> javax.persistence.criteria.SetJoin<W,Y>`	`joinSet(String attr, javax.persistence.criteria.JoinType jt)`

Methods inherited from class org.apache.openjpa.persistence.criteria.PathImpl
asValue, asVariable, get, get, get, get, getCorrelatedJoin, getCorrelatedPath, getCorrelatedRoot, getEmbeddedFieldMetaData, getInnermostMember, getInnermostParentPath, getMember, getModel, getParentPath, inSubquery, isCorrelated, setCorrelatedPath, toValue, traversePath, type

Methods inherited from class org.apache.openjpa.persistence.criteria.ExpressionImpl
as, in, in, in, in, isNotNull, isNull, toKernelExpression

Methods inherited from class org.apache.openjpa.persistence.criteria.SelectionImpl
alias, asProjection, assertValidName, getAlias, getCompoundSelectionItems, getJavaType, isAliased, isAutoAliased, isCompoundSelection, setAutoAlias

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface javax.persistence.criteria.From
isCorrelated

Methods inherited from interface javax.persistence.criteria.Path
get, get, get, get, getModel, getParentPath, type

Methods inherited from interface javax.persistence.criteria.Expression
as, in, in, in, in, isNotNull, isNull

Methods inherited from interface javax.persistence.criteria.Selection
alias, getCompoundSelectionItems, isCompoundSelection

Methods inherited from interface javax.persistence.TupleElement
getAlias, getJavaType

Constructor Detail

FromImpl

protected FromImpl(AbstractManagedType<X> type)

Supply the non-null managed type.

FromImpl

protected FromImpl(PathImpl<?,Z> parent,
        Members.Member<? super Z,?> m,
        Class<X> x)

Method Detail

getType

public javax.persistence.metamodel.Type<?> getType()

Overrides:: getType in class PathImpl<Z,X>

getJoins
```
public Set<javax.persistence.criteria.Join<X,?>> getJoins()
```
Return the joins that have been made from this receiver.

Specified by:

getJoins in interface javax.persistence.criteria.From<Z,X>

join

public <Y> javax.persistence.criteria.Join<X,Y> join(javax.persistence.metamodel.SingularAttribute<? super X,Y> attribute)

Join to the given attribute using an inner join.

Specified by:: join in interface javax.persistence.criteria.From<Z,X>

join

public <Y> javax.persistence.criteria.Join<X,Y> join(javax.persistence.metamodel.SingularAttribute<? super X,Y> attribute,
                                            javax.persistence.criteria.JoinType jt)

Join to the given attribute using the given join type.

Specified by:: join in interface javax.persistence.criteria.From<Z,X>

join

public <Y> javax.persistence.criteria.CollectionJoin<X,Y> join(javax.persistence.metamodel.CollectionAttribute<? super X,Y> collection)

Join to the given Collection-valued attribute using an inner join.

Specified by:: join in interface javax.persistence.criteria.From<Z,X>

join

public <Y> javax.persistence.criteria.CollectionJoin<X,Y> join(javax.persistence.metamodel.CollectionAttribute<? super X,Y> collection,
                                                      javax.persistence.criteria.JoinType jt)

Join to the given Collection-valued attribute using the given join type.

Specified by:: join in interface javax.persistence.criteria.From<Z,X>

join
```
public <Y> javax.persistence.criteria.SetJoin<X,Y> join(javax.persistence.metamodel.SetAttribute<? super X,Y> set)
```
Join to the given Set-valued attribute using an inner join.

Specified by:

join in interface javax.persistence.criteria.From<Z,X>

join

public <Y> javax.persistence.criteria.SetJoin<X,Y> join(javax.persistence.metamodel.SetAttribute<? super X,Y> set,
                                               javax.persistence.criteria.JoinType jt)

Join to the given Set-valued attribute using the given join type.

Specified by:: join in interface javax.persistence.criteria.From<Z,X>

join
```
public <Y> javax.persistence.criteria.ListJoin<X,Y> join(javax.persistence.metamodel.ListAttribute<? super X,Y> list)
```
Join to the given List-valued attribute using an inner join.

Specified by:

join in interface javax.persistence.criteria.From<Z,X>

join

public <Y> javax.persistence.criteria.ListJoin<X,Y> join(javax.persistence.metamodel.ListAttribute<? super X,Y> list,
                                                javax.persistence.criteria.JoinType jt)

Join to the given List-valued attribute using the given join type.

Specified by:: join in interface javax.persistence.criteria.From<Z,X>

join
```
public <K,V> javax.persistence.criteria.MapJoin<X,K,V> join(javax.persistence.metamodel.MapAttribute<? super X,K,V> map)
```
Join to the given Map-valued attribute using an inner join.

Specified by:

join in interface javax.persistence.criteria.From<Z,X>

join

public <K,V> javax.persistence.criteria.MapJoin<X,K,V> join(javax.persistence.metamodel.MapAttribute<? super X,K,V> map,
                                                   javax.persistence.criteria.JoinType jt)

Join to the given Map-valued attribute using the given join type.

Specified by:: join in interface javax.persistence.criteria.From<Z,X>

join

public <W,Y> javax.persistence.criteria.Join<W,Y> join(String attr)

Specified by:: join in interface javax.persistence.criteria.From<Z,X>

join

public <W,Y> javax.persistence.criteria.Join<W,Y> join(String name,
                                              javax.persistence.criteria.JoinType jt)

Specified by:: join in interface javax.persistence.criteria.From<Z,X>

joinCollection

public <W,Y> javax.persistence.criteria.CollectionJoin<W,Y> joinCollection(String attr)

Specified by:: joinCollection in interface javax.persistence.criteria.From<Z,X>

joinCollection

public <W,Y> javax.persistence.criteria.CollectionJoin<W,Y> joinCollection(String attr,
                                                                  javax.persistence.criteria.JoinType jt)

Specified by:: joinCollection in interface javax.persistence.criteria.From<Z,X>

joinList

public <W,Y> javax.persistence.criteria.ListJoin<W,Y> joinList(String attr)

Specified by:: joinList in interface javax.persistence.criteria.From<Z,X>

joinList

public <W,Y> javax.persistence.criteria.ListJoin<W,Y> joinList(String attr,
                                                      javax.persistence.criteria.JoinType jt)

Specified by:: joinList in interface javax.persistence.criteria.From<Z,X>

joinMap

public <W,K,V> javax.persistence.criteria.MapJoin<W,K,V> joinMap(String attr)

Specified by:: joinMap in interface javax.persistence.criteria.From<Z,X>

joinMap

public <W,K,V> javax.persistence.criteria.MapJoin<W,K,V> joinMap(String attr,
                                                        javax.persistence.criteria.JoinType jt)

Specified by:: joinMap in interface javax.persistence.criteria.From<Z,X>

joinSet

public <W,Y> javax.persistence.criteria.SetJoin<W,Y> joinSet(String attr)

Specified by:: joinSet in interface javax.persistence.criteria.From<Z,X>

joinSet

public <W,Y> javax.persistence.criteria.SetJoin<W,Y> joinSet(String attr,
                                                    javax.persistence.criteria.JoinType jt)

Specified by:: joinSet in interface javax.persistence.criteria.From<Z,X>

assertJoinable

void assertJoinable(javax.persistence.metamodel.Type<?> type)

fetch

public <Y> javax.persistence.criteria.Fetch<X,Y> fetch(javax.persistence.metamodel.SingularAttribute<? super X,Y> assoc,
                                              javax.persistence.criteria.JoinType jt)

Specified by:: fetch in interface javax.persistence.criteria.FetchParent<Z,X>

fetch

public <Y> javax.persistence.criteria.Fetch<X,Y> fetch(javax.persistence.metamodel.SingularAttribute<? super X,Y> assoc)

Specified by:: fetch in interface javax.persistence.criteria.FetchParent<Z,X>

fetch

public <Y> javax.persistence.criteria.Fetch<X,Y> fetch(javax.persistence.metamodel.PluralAttribute<? super X,?,Y> assoc,
                                              javax.persistence.criteria.JoinType jt)

Specified by:: fetch in interface javax.persistence.criteria.FetchParent<Z,X>

fetch

public <Y> javax.persistence.criteria.Fetch<X,Y> fetch(javax.persistence.metamodel.PluralAttribute<? super X,?,Y> assoc)

Specified by:: fetch in interface javax.persistence.criteria.FetchParent<Z,X>

fetch

public <X,Y> javax.persistence.criteria.Fetch<X,Y> fetch(String assocName)

Specified by:: fetch in interface javax.persistence.criteria.FetchParent<Z,X>

fetch

public <X,Y> javax.persistence.criteria.Fetch<X,Y> fetch(String name,
                                                javax.persistence.criteria.JoinType jt)

Specified by:: fetch in interface javax.persistence.criteria.FetchParent<Z,X>

getFetches
```
public Set<javax.persistence.criteria.Fetch<X,?>> getFetches()
```
Specified by:

getFetches in interface javax.persistence.criteria.FetchParent<Z,X>

acceptVisit
```
public void acceptVisit(CriteriaExpressionVisitor visitor)
```
Description copied from interface: CriteriaExpression

Accept visit from the given visitor. The receiver is responsible to propagate the visitor to the constituent sub-nodes if any.

Specified by:

acceptVisit in interface CriteriaExpression

Overrides:

acceptVisit in class SelectionImpl<X>

Parameters:
visitor - a processor to walk the nodes of a tree.

getCorrelationParent
```
public javax.persistence.criteria.From<Z,X> getCorrelationParent()
```
Specified by:

getCorrelationParent in interface javax.persistence.criteria.From<Z,X>

Class FromImpl<Z,X>

Field Summary

Fields inherited from class org.apache.openjpa.persistence.criteria.PathImpl

Constructor Summary

Method Summary

Methods inherited from class org.apache.openjpa.persistence.criteria.PathImpl

Methods inherited from class org.apache.openjpa.persistence.criteria.ExpressionImpl

Methods inherited from class org.apache.openjpa.persistence.criteria.SelectionImpl

Methods inherited from class java.lang.Object

Methods inherited from interface javax.persistence.criteria.From

Methods inherited from interface javax.persistence.criteria.Path

Methods inherited from interface javax.persistence.criteria.Expression

Methods inherited from interface javax.persistence.criteria.Selection

Methods inherited from interface javax.persistence.TupleElement

Constructor Detail

FromImpl

FromImpl

Method Detail

getType

getJoins

join

join

join

join

join

join

join

join

join

join

join

join

joinCollection

joinCollection

joinList

joinList

joinMap

joinMap

joinSet

joinSet

assertJoinable

fetch

fetch

fetch

fetch

fetch

fetch

getFetches

acceptVisit

getCorrelationParent