PathImpl (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>

Type Parameters:
Z - the type of the parent path
X - the type of this path

All Implemented Interfaces:

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

Direct Known Subclasses:

FetchPathImpl, FromImpl, Joins.MapKey
```
 class PathImpl<Z,X>
extends ExpressionImpl<X>
implements javax.persistence.criteria.Path<X>
```
Path is an expression representing a persistent attribute traversed from a parent path. The type of the path is the type of the persistent attribute. If the persistent attribute is bindable, then further path can be traversed from this path.

Author:

Pinaki Poddar, Fay Wang

Field Summary

Fields
Modifier and Type Field and Description

protected Members.Member<? super Z,?> _member

protected PathImpl<?,Z> _parent

Fields
Modifier and Type	Field and Description
`protected Members.Member<? super Z,?>`	`_member`
`protected PathImpl<?,Z>`	`_parent`

Constructor Summary

Constructors
Modifier	Constructor and Description
`protected`	`PathImpl(Class<X> cls)` Protected constructor use by root path which neither represent a member nor has a parent.
	`PathImpl(PathImpl<?,Z> parent, Members.Member<? super Z,?> member, Class<X> cls)` Create a path from the given parent representing the given member.

Method Summary

Methods
Modifier and Type	Method and Description
`StringBuilder`	`asValue(AliasContext q)` Get a string representation of this node as a value in the context of the given query.
`StringBuilder`	`asVariable(AliasContext q)` Get a string representation of this node as a variable in the context of the given query.
`<K,V,M extends Map<K,V>> javax.persistence.criteria.Expression<M>`	`get(javax.persistence.metamodel.MapAttribute<X,K,V> map)` Gets a new path that represents the given map-valued attribute from this path.
`<E,C extends Collection<E>> javax.persistence.criteria.Expression<C>`	`get(javax.persistence.metamodel.PluralAttribute<X,C,E> coll)` Gets a new path that represents the given multi-valued attribute from this path.
`<Y> javax.persistence.criteria.Path<Y>`	`get(javax.persistence.metamodel.SingularAttribute<? super X,Y> attr)` Gets a new path that represents the given single-valued attribute from this path.
`<Y> javax.persistence.criteria.Path<Y>`	`get(String attName)` Gets a new path that represents the attribute of the given name from this path.
`PathImpl<?,?>`	`getCorrelatedJoin(PathImpl<?,?> path)`
`PathImpl<?,?>`	`getCorrelatedPath()` Gets the path correlated to this path, if any.
`PathImpl<?,?>`	`getCorrelatedRoot(SubqueryImpl<?> subquery)`
`protected FieldMetaData`	`getEmbeddedFieldMetaData(FieldMetaData fmd)` Gets the field that may have been embedded inside the given field.
`protected Members.Member<?,?>`	`getInnermostMember(PathImpl<?,?> parent, Members.Member<?,?> member)`
`PathImpl<?,?>`	`getInnermostParentPath()` Gets the path that originates this traversal.
`Members.Member<? extends Z,X>`	`getMember()`
`javax.persistence.metamodel.Bindable<X>`	`getModel()` Gets the bindable object that corresponds to the path expression.
`javax.persistence.criteria.Path<Z>`	`getParentPath()` Gets the parent of this path or null if this path is the root.
`javax.persistence.metamodel.Type<?>`	`getType()`
`boolean`	`inSubquery(SubqueryImpl<?> subquery)` Affirms if this receiver occurs in the roots of the given subquery.
`boolean`	`isCorrelated()` Affirms if this path is correlated to another path.
`void`	`setCorrelatedPath(PathImpl<?,?> correlatedPath)` Makes this path correlated to the given path.
`Value`	`toValue(ExpressionFactory factory, CriteriaQueryImpl<?> q)` Convert this path to a kernel path.
`protected void`	`traversePath(PathImpl<?,?> parent, Path path, FieldMetaData fmd)`
`javax.persistence.criteria.Expression<Class<? extends X>>`	`type()` Get the type() expression corresponding to this path.

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
acceptVisit, 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.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

- Field Detail
  - _parent
```
protected final PathImpl<?,Z> _parent
```
  - _member
```
protected final Members.Member<? super Z,?> _member
```
- Constructor Detail
  - PathImpl
```
protected PathImpl(Class<X> cls)
```
    Protected constructor use by root path which neither represent a member nor has a parent.
  - PathImpl
```
public PathImpl(PathImpl<?,Z> parent,
        Members.Member<? super Z,?> member,
        Class<X> cls)
```
    Create a path from the given parent representing the given member.
    
    Parameters:
    parent - the path from which this path needs to be constructed. Must not be null.
    member - the persistent property that represents this path.
    cls - denotes the type expressed by this path.
- Method Detail
  - getModel
```
public javax.persistence.metamodel.Bindable<X> getModel()
```
    Gets the bindable object that corresponds to the path expression.
    
    Specified by:
    
    getModel in interface javax.persistence.criteria.Path<X>
    
    Throws:
    
    IllegalArgumentException - if this path is not bindable
  - getParentPath
```
public final javax.persistence.criteria.Path<Z> getParentPath()
```
    Gets the parent of this path or null if this path is the root.
    
    Specified by:
    
    getParentPath in interface javax.persistence.criteria.Path<X>
  - getInnermostParentPath
```
public PathImpl<?,?> getInnermostParentPath()
```
    Gets the path that originates this traversal. Can be itself if this path is the root.
  - getEmbeddedFieldMetaData
```
protected FieldMetaData getEmbeddedFieldMetaData(FieldMetaData fmd)
```
    Gets the field that may have been embedded inside the given field. For example, a given primary key field which is using an embedded class as a complex primary key.
    
    Parameters:
    fmd - a given field
    
    Returns:
    the embedded field or the given field itself
  - getInnermostMember
```
protected Members.Member<?,?> getInnermostMember(PathImpl<?,?> parent,
                                     Members.Member<?,?> member)
```
  - setCorrelatedPath
```
public void setCorrelatedPath(PathImpl<?,?> correlatedPath)
```
    Makes this path correlated to the given path.
  - getCorrelatedPath
```
public PathImpl<?,?> getCorrelatedPath()
```
    Gets the path correlated to this path, if any.
  - isCorrelated
```
public boolean isCorrelated()
```
    Affirms if this path is correlated to another path.
  - toValue
```
public Value toValue(ExpressionFactory factory,
            CriteriaQueryImpl<?> q)
```
    Convert this path to a kernel path.
    
    Specified by:
    
    toValue in class ExpressionImpl<X>
    
    Parameters:
    factory - creates the kernel expression
    q - the query definition context of this expression
    
    Returns:
    an equivalent kernel value
  - getCorrelatedRoot
```
public PathImpl<?,?> getCorrelatedRoot(SubqueryImpl<?> subquery)
```
  - getCorrelatedJoin
```
public PathImpl<?,?> getCorrelatedJoin(PathImpl<?,?> path)
```
  - inSubquery
```
public boolean inSubquery(SubqueryImpl<?> subquery)
```
    Affirms if this receiver occurs in the roots of the given subquery.
  - traversePath
```
protected void traversePath(PathImpl<?,?> parent,
                Path path,
                FieldMetaData fmd)
```
  - get
```
public <Y> javax.persistence.criteria.Path<Y> get(javax.persistence.metamodel.SingularAttribute<? super X,Y> attr)
```
    Gets a new path that represents the given single-valued attribute from this path.
    
    Specified by:
    
    get in interface javax.persistence.criteria.Path<X>
  - get
```
public <E,C extends Collection<E>> javax.persistence.criteria.Expression<C> get(javax.persistence.metamodel.PluralAttribute<X,C,E> coll)
```
    Gets a new path that represents the given multi-valued attribute from this path.
    
    Specified by:
    
    get in interface javax.persistence.criteria.Path<X>
  - get
```
public <K,V,M extends Map<K,V>> javax.persistence.criteria.Expression<M> get(javax.persistence.metamodel.MapAttribute<X,K,V> map)
```
    Gets a new path that represents the given map-valued attribute from this path.
    
    Specified by:
    
    get in interface javax.persistence.criteria.Path<X>
  - get
```
public <Y> javax.persistence.criteria.Path<Y> get(String attName)
```
    Gets a new path that represents the attribute of the given name from this path.
    
    Specified by:
    
    get in interface javax.persistence.criteria.Path<X>
    
    Throws:
    
    IllegalArgumentException - if this path represents a basic attribute that is can not be traversed further.
  - getType
```
public javax.persistence.metamodel.Type<?> getType()
```
  - getMember
```
public Members.Member<? extends Z,X> getMember()
```
  - type
```
public javax.persistence.criteria.Expression<Class<? extends X>> type()
```
    Get the type() expression corresponding to this path.
    
    Specified by:
    
    type in interface javax.persistence.criteria.Path<X>
  - asValue
```
public StringBuilder asValue(AliasContext q)
```
    Description copied from interface: CriteriaExpression
    
    Get a string representation of this node as a value in the context of the given query.
    
    Specified by:
    
    asValue in interface CriteriaExpression
    
    Overrides:
    
    asValue in class SelectionImpl<X>
  - asVariable
```
public StringBuilder asVariable(AliasContext q)
```
    Description copied from interface: CriteriaExpression
    
    Get a string representation of this node as a variable in the context of the given query.
    
    Specified by:
    
    asVariable in interface CriteriaExpression
    
    Overrides:
    
    asVariable in class SelectionImpl<X>

Class PathImpl<Z,X>

Field Summary

Constructor Summary

Method Summary

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.Expression

Methods inherited from interface javax.persistence.criteria.Selection

Methods inherited from interface javax.persistence.TupleElement

Field Detail

_parent

_member

Constructor Detail

PathImpl

PathImpl

Method Detail

getModel

getParentPath

getInnermostParentPath

getEmbeddedFieldMetaData

getInnermostMember

setCorrelatedPath

getCorrelatedPath

isCorrelated

toValue

getCorrelatedRoot

getCorrelatedJoin

inSubquery

traversePath

get

get

get

get

getType

getMember

type

asValue

asVariable