org.hibernate.jpa.criteria.path

Class MapKeyHelpers.MapKeyPath<K>

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

org.hibernate.jpa.criteria.path.MapKeyHelpers.MapKeyPath<K>

Type Parameters:

K - The type of the map key.

All Implemented Interfaces:

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

Enclosing class:

MapKeyHelpers

public static class MapKeyHelpers.MapKeyPath<K>
extends AbstractPathImpl<K>
implements PathImplementor<K>, Serializable

Models a path to a map key. This is the actual return used from MapJoin.key()

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
MapKeyPath(CriteriaBuilderImpl criteriaBuilder, MapKeyHelpers.MapKeySource<K,?> source, MapKeyHelpers.MapKeyAttribute<K> mapKeyAttribute)

Method Summary

Modifier and Type	Method and Description
protected boolean	canBeDereferenced()
MapKeyHelpers.MapKeyAttribute<K>	getAttribute() Retrieve reference to the attribute this path represents.
Bindable<K>	getModel() Return the bindable object that corresponds to the path expression.
MapKeyHelpers.MapKeySource	getPathSource()
protected Attribute	locateAttributeInternal(String attributeName) Get the attribute by name from the underlying model.
String	render(RenderingContext renderingContext)
<T extends K> MapKeyHelpers.MapKeyPath<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, getPathSourceForSubPaths, illegalDereference, locateAttribute, prepareAlias, registerAttributePath, registerParameters, 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 org.hibernate.jpa.criteria.Renderable

renderProjection

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

getPathIdentifier, prepareAlias

Methods inherited from interface javax.persistence.criteria.Path

get, get, get, get, 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

MapKeyPath

public MapKeyPath(CriteriaBuilderImpl criteriaBuilder,
                  MapKeyHelpers.MapKeySource<K,?> source,
                  MapKeyHelpers.MapKeyAttribute<K> mapKeyAttribute)

Method Detail

getPathSource

public MapKeyHelpers.MapKeySource getPathSource()

Overrides:

getPathSource in class AbstractPathImpl<K>

getAttribute

public MapKeyHelpers.MapKeyAttribute<K> getAttribute()

Description copied from interface: PathImplementor

Retrieve reference to the attribute this path represents.

Specified by:

getAttribute in interface PathImplementor<K>

Returns:

The metamodel attribute.

canBeDereferenced

protected boolean canBeDereferenced()

Specified by:

canBeDereferenced in class AbstractPathImpl<K>

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

Parameters:

attributeName - The name of the attribute to locate

Returns:

The attribute; may be null.

getModel

public Bindable<K> getModel()

Description copied from interface: Path

Return the bindable object that corresponds to the path expression.

Specified by:

getModel in interface Path<K>

Returns:

bindable object corresponding to the path

treatAs

public <T extends K> MapKeyHelpers.MapKeyPath<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<K>

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.

render

public String render(RenderingContext renderingContext)

Specified by:

render in interface Renderable

Overrides:

render in class AbstractPathImpl<K>