org.hibernate.jpa.criteria.path

Class SingularAttributePath<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>

org.hibernate.jpa.criteria.path.SingularAttributePath<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:

SingularAttributePath.TreatedSingularAttributePath

public class SingularAttributePath<X>
extends AbstractPathImpl<X>
implements Serializable

Models a path for a SingularAttribute generally obtained from a Path.get(SingularAttribute) call

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SingularAttributePath.TreatedSingularAttributePath<T>

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

ParameterContainer.Helper

Constructor Summary

Constructors

Constructor and Description
SingularAttributePath(CriteriaBuilderImpl criteriaBuilder, Class<X> javaType, PathSource pathSource, SingularAttribute<?,X> attribute)

Method Summary

Methods

Modifier and Type	Method and Description
protected boolean	canBeDereferenced()
SingularAttribute<?,X>	getAttribute() Retrieve reference to the attribute this path represents.
Bindable<X>	getModel()
protected Attribute	locateAttributeInternal(String attributeName) Get the attribute by name from the underlying model.
<T extends X> SingularAttributePath<T>	treatAs(Class<T> treatAsType) Defines handling for the JPA 2.1 TREAT down-casting feature.

Methods inherited from class org.hibernate.jpa.criteria.path.AbstractPathImpl

get, get, get, get, getParentPath, getPathIdentifier, getPathSource, getPathSourceForSubPaths, illegalDereference, locateAttribute, prepareAlias, registerAttributePath, registerParameters, render, renderProjection, resolveCachedAttributePath, type, unknownAttribute

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

SingularAttributePath

public SingularAttributePath(CriteriaBuilderImpl criteriaBuilder,
                     Class<X> javaType,
                     PathSource pathSource,
                     SingularAttribute<?,X> attribute)

Method Detail

getAttribute

public SingularAttribute<?,X> getAttribute()

Description copied from interface: PathImplementor

Retrieve reference to the attribute this path represents.

Specified by:

getAttribute in interface PathImplementor<X>

Returns:

The metamodel attribute.

getModel

public Bindable<X> getModel()

Specified by:

getModel in interface Path<X>

canBeDereferenced

protected boolean canBeDereferenced()

Specified by:

canBeDereferenced in class AbstractPathImpl<X>

locateAttributeInternal

protected Attribute locateAttributeInternal(String attributeName)

Description copied from class: AbstractPathImpl

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

Specified by:

locateAttributeInternal in class AbstractPathImpl<X>

Parameters:

attributeName - The name of the attribute to locate

Returns:

The attribute; may be null.

treatAs

public <T extends X> SingularAttributePath<T> treatAs(Class<T> treatAsType)

Description copied from interface: PathImplementor

Defines handling for the JPA 2.1 TREAT down-casting feature.

Specified by:

treatAs in interface PathImplementor<X>

Type Parameters:

T - The parameterized type representation of treatAsType.

Parameters:

treatAsType - The type to treat the path as.

Returns:

The properly typed view of this path.