javax.persistence.criteria
Interface Path<X>

Type Parameters:

X - Type referenced by the path

All Superinterfaces:

Expression<X>, Selection<X>, TupleElement<X>

All Known Subinterfaces:

CollectionJoin<Z,E>, From<Z,X>, Join<Z,X>, ListJoin<Z,E>, MapJoin<Z,K,V>, PluralJoin<Z,C,E>, Root<X>, SetJoin<Z,E>

public interface Path<X>
extends Expression<X>

Represents a simple or compound attribute path from a bound type or collection, and is a "primitive" expression.

Since:

Java Persistence 2.0

Method Summary

<K,V,M extends java.util.Map<K,V>> Expression<M>	get(MapAttribute<X,K,V> map) Return the path corresponding to the referenced map-valued attribute.
<E,C extends java.util.Collection<E>> Expression<C>	get(PluralAttribute<X,C,E> collection) Return the path corresponding to the referenced collection-valued attribute.
<Y> Path<Y>	get(SingularAttribute<? super X,Y> attribute) Return the path corresponding to the referenced non-collection valued attribute.
<Y> Path<Y>	get(java.lang.String attributeName) Return the path corresponding to the referenced attribute.
Bindable<X>	getModel() Return the Bindable object that corresponds to the path expression.
Path<?>	getParentPath() Return the parent "node" in the path.
Expression<java.lang.Class<? extends X>>	type() Return an expression corresponding to the type of the path.

Methods inherited from interface javax.persistence.criteria.Expression

as, in, in, in, in, isNotNull, isNull

Methods inherited from interface javax.persistence.criteria.Selection

setAlias

Methods inherited from interface javax.persistence.TupleElement

getAlias, getJavaType

Method Detail

getModel

Bindable<X> getModel()

Return the Bindable object that corresponds to the path expression.

Returns:

Bindable object corresponding to the path

getParentPath

Path<?> getParentPath()

Return the parent "node" in the path.

Returns:

parent

get

<Y> Path<Y> get(SingularAttribute<? super X,Y> attribute)

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

Parameters:

model - attribute

Returns:

path corresponding to the referenced attribute

get

<E,C extends java.util.Collection<E>> Expression<C> get(PluralAttribute<X,C,E> collection)

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

Parameters:

model - collection-valued attribute

Returns:

expression corresponding to the referenced attribute

get

<K,V,M extends java.util.Map<K,V>> Expression<M> get(MapAttribute<X,K,V> map)

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

Parameters:

model - map-valued attribute

Returns:

expression corresponding to the referenced attribute

type

Expression<java.lang.Class<? extends X>> type()

Return an expression corresponding to the type of the path.

Returns:

expression corresponding to the type of the path

get

<Y> Path<Y> get(java.lang.String attributeName)

Return the path corresponding to the referenced attribute.

Parameters:

attName - name of the attribute

Returns:

path corresponding to the referenced attribute