org.hibernate.jpa.criteria.path

Class AbstractPathImpl<X>

java.lang.Object

org.hibernate.jpa.criteria.AbstractNode

org.hibernate.jpa.criteria.expression.AbstractTupleElement<X>

org.hibernate.jpa.criteria.expression.SelectionImpl<T>

org.hibernate.jpa.criteria.expression.ExpressionImpl<X>

org.hibernate.jpa.criteria.path.AbstractPathImpl<X>

All Implemented Interfaces:

Serializable, Expression<X>, Path<X>, Selection<X>, TupleElement<X>, ExpressionImplementor<X>, ParameterContainer, PathImplementor<X>, PathSource<X>, Renderable, SelectionImplementor<X>, TupleElementImplementor<X>

Direct Known Subclasses:

AbstractFromImpl, MapKeyHelpers.MapKeyPath, MapKeyHelpers.MapKeySource, PluralAttributePath, SingularAttributePath

public abstract class AbstractPathImpl<X>
extends ExpressionImpl<X>
implements Path<X>, PathImplementor<X>, Serializable

Convenience base class for various Path implementations.

Author:

Steve Ebersole

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from interface org.hibernate.jpa.criteria.ParameterContainer

ParameterContainer.Helper

Constructor Summary

Constructors

Constructor and Description
AbstractPathImpl(CriteriaBuilderImpl criteriaBuilder, Class<X> javaType, PathSource pathSource) Constructs a basic path instance.

Method Summary

Modifier and Type	Method and Description
protected abstract boolean	canBeDereferenced()
<K,V,M extends Map<K,V>> Expression<M>	get(MapAttribute<X,K,V> attribute) Create a path corresponding to the referenced map-valued attribute.
<E,C extends Collection<E>> Expression<C>	get(PluralAttribute<X,C,E> attribute) Create a path corresponding to the referenced collection-valued attribute.
<Y> Path<Y>	get(SingularAttribute<? super X,Y> attribute) Create a path corresponding to the referenced single-valued attribute.
<Y> Path<Y>	get(String attributeName) Create a path corresponding to the referenced attribute.
PathSource<?>	getParentPath() Return the parent "node" in the path or null if no parent.
String	getPathIdentifier() Get the string representation of this path as a navigation from one of the queries identification variables
PathSource	getPathSource()
protected PathSource	getPathSourceForSubPaths()
protected RuntimeException	illegalDereference()
protected Attribute	locateAttribute(String attributeName) Get the attribute by name from the underlying model.
protected abstract Attribute	locateAttributeInternal(String attributeName) Get the attribute by name from the underlying model.
void	prepareAlias(RenderingContext renderingContext)
protected void	registerAttributePath(String attributeName, Path path)
void	registerParameters(ParameterRegistry registry) Register any parameters contained within this query component with the given registry.
String	render(RenderingContext renderingContext)
String	renderProjection(RenderingContext renderingContext)
protected Path	resolveCachedAttributePath(String attributeName)
Expression<Class<? extends X>>	type() Create an expression corresponding to the type of the path.
protected RuntimeException	unknownAttribute(String attributeName)

Methods inherited from class org.hibernate.jpa.criteria.expression.ExpressionImpl

as, asBigDecimal, asBigInteger, asDouble, asFloat, asInteger, asLong, asString, in, in, in, in, isNotNull, isNull

Methods inherited from class org.hibernate.jpa.criteria.expression.SelectionImpl

alias, getCompoundSelectionItems, getValueHandlers, isCompoundSelection

Methods inherited from class org.hibernate.jpa.criteria.expression.AbstractTupleElement

forceConversion, getAlias, getJavaType, getValueHandler, resetJavaType, setAlias

Methods inherited from class org.hibernate.jpa.criteria.AbstractNode

criteriaBuilder

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.hibernate.jpa.criteria.PathImplementor

getAttribute, treatAs

Methods inherited from interface org.hibernate.jpa.criteria.ExpressionImplementor

asBigDecimal, asBigInteger, asDouble, asFloat, asInteger, asLong, asString

Methods inherited from interface org.hibernate.jpa.criteria.SelectionImplementor

getValueHandlers

Methods inherited from interface org.hibernate.jpa.criteria.TupleElementImplementor

getValueHandler

Methods inherited from interface javax.persistence.criteria.Path

getModel

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

AbstractPathImpl

public AbstractPathImpl(CriteriaBuilderImpl criteriaBuilder,
                        Class<X> javaType,
                        PathSource pathSource)

Constructs a basic path instance.

Parameters:

criteriaBuilder - The criteria builder

javaType - The java type of this path

pathSource - The source (or origin) from which this path originates

Method Detail

getPathSource

public PathSource getPathSource()

getParentPath

public PathSource<?> getParentPath()

Description copied from interface: Path

Return the parent "node" in the path or null if no parent.

Specified by:

getParentPath in interface Path<X>

Returns:

parent

type

public Expression<Class<? extends X>> type()

Description copied from interface: Path

Create an expression corresponding to the type of the path.

Specified by:

type in interface Path<X>

Returns:

expression corresponding to the type of the path

getPathIdentifier

public String getPathIdentifier()

Description copied from interface: PathSource

Get the string representation of this path as a navigation from one of the queries identification variables

Specified by:

getPathIdentifier in interface PathSource<X>

Returns:

The path's identifier.

canBeDereferenced

protected abstract boolean canBeDereferenced()

illegalDereference

protected final RuntimeException illegalDereference()

unknownAttribute

protected final RuntimeException unknownAttribute(String attributeName)

resolveCachedAttributePath

protected final Path resolveCachedAttributePath(String attributeName)

registerAttributePath

protected final void registerAttributePath(String attributeName,
                                           Path path)

get

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

Description copied from interface: Path

Create a path corresponding to the referenced single-valued attribute.

Specified by:

get in interface Path<X>

Parameters:

attribute - single-valued attribute

Returns:

path corresponding to the referenced attribute

getPathSourceForSubPaths

protected PathSource getPathSourceForSubPaths()

get

public <E,C extends Collection<E>> Expression<C> get(PluralAttribute<X,C,E> attribute)

Description copied from interface: Path

Create a path corresponding to the referenced collection-valued attribute.

Specified by:

get in interface Path<X>

Parameters:

attribute - collection-valued attribute

Returns:

expression corresponding to the referenced attribute

get

public <K,V,M extends Map<K,V>> Expression<M> get(MapAttribute<X,K,V> attribute)

Description copied from interface: Path

Create a path corresponding to the referenced map-valued attribute.

Specified by:

get in interface Path<X>

Parameters:

attribute - map-valued attribute

Returns:

expression corresponding to the referenced attribute

get

public <Y> Path<Y> get(String attributeName)

Description copied from interface: Path

Create a path corresponding to the referenced attribute.

Note: Applications using the string-based API may need to specify the type resulting from the get operation in order to avoid the use of Path variables.

     For example:

     CriteriaQuery<Person> q = cb.createQuery(Person.class);
     Root<Person> p = q.from(Person.class);
     q.select(p)
      .where(cb.isMember("joe",
                         p.<Set<String>>get("nicknames")));

     rather than:

     CriteriaQuery<Person> q = cb.createQuery(Person.class);
     Root<Person> p = q.from(Person.class);
     Path<Set<String>> nicknames = p.get("nicknames");
     q.select(p)
      .where(cb.isMember("joe", nicknames));
  

Specified by:

get in interface Path<X>

Parameters:

attributeName - name of the attribute

Returns:

path corresponding to the referenced attribute

locateAttribute

protected final Attribute locateAttribute(String attributeName)

Get the attribute by name from the underlying model. This allows subclasses to define exactly how the attribute is derived.

Parameters:

attributeName - The name of the attribute to locate

Returns:

The attribute; should never return null.

Throws:

IllegalArgumentException - If no such attribute exists

locateAttributeInternal

protected abstract Attribute locateAttributeInternal(String attributeName)

Get the attribute by name from the underlying model. This allows subclasses to define exactly how the attribute is derived. Called from locateAttribute(java.lang.String) which also applies nullness checking for proper error reporting.

Parameters:

attributeName - The name of the attribute to locate

Returns:

The attribute; may be null.

Throws:

IllegalArgumentException - If no such attribute exists

registerParameters

public void registerParameters(ParameterRegistry registry)

Description copied from interface: ParameterContainer

Register any parameters contained within this query component with the given registry.

Specified by:

registerParameters in interface ParameterContainer

Parameters:

registry - The parameter registry with which to register.

prepareAlias

public void prepareAlias(RenderingContext renderingContext)

Specified by:

prepareAlias in interface PathSource<X>

render

public String render(RenderingContext renderingContext)

Specified by:

render in interface Renderable

renderProjection

public String renderProjection(RenderingContext renderingContext)

Specified by:

renderProjection in interface Renderable