Top Description Inners Constructors Methods
org.hibernate.query.criteria.internal.path

public Class MapAttributeJoin<O, K, V>

extends PluralAttributeJoinSupport<O, Map<K, V>, V>
implements MapJoinImplementor<O, K, V>, Serializable
Class Inheritance
All Implemented Interfaces
java.io.Serializable, org.hibernate.query.criteria.internal.MapJoinImplementor, javax.persistence.criteria.MapJoin, javax.persistence.criteria.PluralJoin, javax.persistence.criteria.Join, javax.persistence.criteria.From, javax.persistence.criteria.FetchParent, javax.persistence.criteria.Path, javax.persistence.criteria.Expression, javax.persistence.criteria.Selection, javax.persistence.TupleElement, org.hibernate.query.criteria.internal.JoinImplementor, org.hibernate.query.criteria.internal.FromImplementor, org.hibernate.query.criteria.internal.PathImplementor, org.hibernate.query.criteria.internal.Renderable, org.hibernate.query.criteria.internal.PathSource, org.hibernate.query.criteria.internal.ExpressionImplementor, org.hibernate.query.criteria.internal.SelectionImplementor, org.hibernate.query.criteria.internal.TupleElementImplementor, javax.persistence.criteria.Fetch
Known Direct Subclasses
org.hibernate.query.criteria.internal.path.MapAttributeJoin.TreatedMapAttributeJoin
Imports
java.io.Serializable, java.util.Map, javax.persistence.criteria.Expression, .JoinType, .Path, .Predicate, javax.persistence.metamodel.ManagedType, .MapAttribute, org.hibernate.query.criteria.internal.CriteriaBuilderImpl, .CriteriaSubqueryImpl, .FromImplementor, .MapJoinImplementor, .PathImplementor, .PathSource, org.hibernate.query.criteria.internal.compile.RenderingContext, org.hibernate.query.criteria.internal.expression.MapEntryExpression
Models a join based on a map-style plural association attribute.
Author
Steve Ebersole

Nested and Inner Type Summary

Modifier and TypeClass and Description
public static class
MapAttributeJoin.TreatedMapAttributeJoin<O, K, T>

Constructor Summary

AccessConstructor and Description
public
MapAttributeJoin(CriteriaBuilderImpl criteriaBuilder, Class<V> javaType, PathSource<O> pathSource, MapAttribute<? super O, K, V> joinAttribute, JoinType joinType)

Method Summary

Modifier and TypeMethod and Description
public final MapAttributeJoin<O, K, V>
correlateTo(CriteriaSubqueryImpl<T> subquery)

Overrides org.hibernate.query.criteria.internal.path.AbstractJoinImpl.correlateTo.

Implements org.hibernate.query.criteria.internal.MapJoinImplementor.correlateTo, org.hibernate.query.criteria.internal.JoinImplementor.correlateTo, org.hibernate.query.criteria.internal.FromImplementor.correlateTo.

Refined return type
protected FromImplementor<O, V>
createCorrelationDelegate()

Implements abstract org.hibernate.query.criteria.internal.path.AbstractFromImpl.createCorrelationDelegate.

public Expression<Map.Entry<K, V>>
entry()

Implements javax.persistence.criteria.MapJoin.entry.

Create an expression that corresponds to the map entry.
public MapAttribute<? super O, K, V>
getAttribute()

Overrides org.hibernate.query.criteria.internal.path.PluralAttributeJoinSupport.getAttribute.

Implements javax.persistence.criteria.Join.getAttribute, javax.persistence.criteria.Fetch.getAttribute, org.hibernate.query.criteria.internal.PathImplementor.getAttribute.

Return the metamodel attribute corresponding to the join.
public MapAttribute<? super O, K, V>
getModel()

Overrides org.hibernate.query.criteria.internal.path.PluralAttributeJoinSupport.getModel.

Implements javax.persistence.criteria.Path.getModel, javax.persistence.criteria.MapJoin.getModel, javax.persistence.criteria.PluralJoin.getModel.

Return the metamodel representation for the map attribute.
public Path<K>
key()

Implements javax.persistence.criteria.MapJoin.key.

Create a path expression that corresponds to the map key.
public MapJoinImplementor<O, K, V>
on(Predicate...
zero or more restriction predicates
restrictions)

Overrides org.hibernate.query.criteria.internal.path.PluralAttributeJoinSupport.on.

Implements org.hibernate.query.criteria.internal.MapJoinImplementor.on, javax.persistence.criteria.Join.on, org.hibernate.query.criteria.internal.JoinImplementor.on.

Coordinate return type between Join#on(Predicate...) and Fetch#on(Predicate...)
public MapJoinImplementor<O, K, V>
on(Expression<Boolean>
a simple or compound boolean expression
restriction)

Overrides org.hibernate.query.criteria.internal.path.PluralAttributeJoinSupport.on.

Implements org.hibernate.query.criteria.internal.MapJoinImplementor.on, javax.persistence.criteria.Join.on, org.hibernate.query.criteria.internal.JoinImplementor.on.

Coordinate return type between Join#on(Expression) and Fetch#on(Expression)
public <T extends V> MapAttributeJoin<O, K, T>
treatAs(Class<T>
The type to treat the path as.
treatAsType)

Implements org.hibernate.query.criteria.internal.MapJoinImplementor.treatAs, org.hibernate.query.criteria.internal.JoinImplementor.treatAs, org.hibernate.query.criteria.internal.PathImplementor.treatAs.

Defines handling for the JPA 2.1 TREAT down-casting feature.
public Path<V>
value()

Implements javax.persistence.criteria.MapJoin.value.

Create a path expression that corresponds to the map value.
Inherited from org.hibernate.query.criteria.internal.path.PluralAttributeJoinSupport:
canBeDereferencedcanBeJoinSourceisBasicCollectionlocateManagedType

Constructor Detail

MapAttributeJoinback to summary
public MapAttributeJoin(CriteriaBuilderImpl criteriaBuilder, Class<V> javaType, PathSource<O> pathSource, MapAttribute<? super O, K, V> joinAttribute, JoinType joinType)

Method Detail

correlateToback to summary
public final MapAttributeJoin<O, K, V> correlateTo(CriteriaSubqueryImpl<T> subquery)

Overrides org.hibernate.query.criteria.internal.path.AbstractJoinImpl.correlateTo.

Implements org.hibernate.query.criteria.internal.MapJoinImplementor.correlateTo, org.hibernate.query.criteria.internal.JoinImplementor.correlateTo, org.hibernate.query.criteria.internal.FromImplementor.correlateTo.

Doc from org.hibernate.query.criteria.internal.JoinImplementor.correlateTo.

Refined return type

Annotations
@Override
createCorrelationDelegateback to summary
protected FromImplementor<O, V> createCorrelationDelegate()

Implements abstract org.hibernate.query.criteria.internal.path.AbstractFromImpl.createCorrelationDelegate.

Annotations
@Override
entryback to summary
public Expression<Map.Entry<K, V>> entry()

Implements javax.persistence.criteria.MapJoin.entry.

Doc from javax.persistence.criteria.MapJoin.entry.

Create an expression that corresponds to the map entry.

Returns:Expression<Map.Entry<K, V>>

expression corresponding to the map entry

Annotations
@Override
@SuppressWarnings:unchecked
getAttributeback to summary
public MapAttribute<? super O, K, V> getAttribute()

Overrides org.hibernate.query.criteria.internal.path.PluralAttributeJoinSupport.getAttribute.

Implements javax.persistence.criteria.Join.getAttribute, javax.persistence.criteria.Fetch.getAttribute, org.hibernate.query.criteria.internal.PathImplementor.getAttribute.

Doc from javax.persistence.criteria.Join.getAttribute.

Return the metamodel attribute corresponding to the join.

Returns:MapAttribute<? super O, K, V>

metamodel attribute corresponding to the join

Annotations
@Override
getModelback to summary
public MapAttribute<? super O, K, V> getModel()

Overrides org.hibernate.query.criteria.internal.path.PluralAttributeJoinSupport.getModel.

Implements javax.persistence.criteria.Path.getModel, javax.persistence.criteria.MapJoin.getModel, javax.persistence.criteria.PluralJoin.getModel.

Doc from javax.persistence.criteria.MapJoin.getModel.

Return the metamodel representation for the map attribute.

Returns:MapAttribute<? super O, K, V>

metamodel type representing the Map that is the target of the join

Annotations
@Override
keyback to summary
public Path<K> key()

Implements javax.persistence.criteria.MapJoin.key.

Doc from javax.persistence.criteria.MapJoin.key.

Create a path expression that corresponds to the map key.

Returns:Path<K>

path corresponding to map key

Annotations
@Override
@SuppressWarnings:unchecked
onback to summary
public MapJoinImplementor<O, K, V> on(Predicate... restrictions)

Overrides org.hibernate.query.criteria.internal.path.PluralAttributeJoinSupport.on.

Implements org.hibernate.query.criteria.internal.MapJoinImplementor.on, javax.persistence.criteria.Join.on, org.hibernate.query.criteria.internal.JoinImplementor.on.

Doc from org.hibernate.query.criteria.internal.JoinImplementor.on.

Coordinate return type between Join#on(Predicate...) and Fetch#on(Predicate...)

Parameters
restrictions:Predicate[]

Doc from javax.persistence.criteria.MapJoin.on.

zero or more restriction predicates

Returns:MapJoinImplementor<O, K, V>

Doc from javax.persistence.criteria.MapJoin.on.

the modified join object

Annotations
@Override
onback to summary
public MapJoinImplementor<O, K, V> on(Expression<Boolean> restriction)

Overrides org.hibernate.query.criteria.internal.path.PluralAttributeJoinSupport.on.

Implements org.hibernate.query.criteria.internal.MapJoinImplementor.on, javax.persistence.criteria.Join.on, org.hibernate.query.criteria.internal.JoinImplementor.on.

Doc from org.hibernate.query.criteria.internal.JoinImplementor.on.

Coordinate return type between Join#on(Expression) and Fetch#on(Expression)

Parameters
restriction:Expression<Boolean>

Doc from javax.persistence.criteria.MapJoin.on.

a simple or compound boolean expression

Returns:MapJoinImplementor<O, K, V>

Doc from javax.persistence.criteria.MapJoin.on.

the modified join object

Annotations
@Override
treatAsback to summary
public <T extends V> MapAttributeJoin<O, K, T> treatAs(Class<T> treatAsType)

Implements org.hibernate.query.criteria.internal.MapJoinImplementor.treatAs, org.hibernate.query.criteria.internal.JoinImplementor.treatAs, org.hibernate.query.criteria.internal.PathImplementor.treatAs.

Doc from org.hibernate.query.criteria.internal.PathImplementor.treatAs.

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

Parameters
<T>
The parameterized type representation of treatAsType.
treatAsType:Class<T>

The type to treat the path as.

Returns:MapAttributeJoin<O, K, T>

The properly typed view of this path.

Annotations
@Override
valueback to summary
public Path<V> value()

Implements javax.persistence.criteria.MapJoin.value.

Doc from javax.persistence.criteria.MapJoin.value.

Create a path expression that corresponds to the map value. This method is for stylistic use only: it just returns this.

Returns:Path<V>

path corresponding to the map value

Annotations
@Override
org.hibernate.query.criteria.internal.path back to summary

public Class MapAttributeJoin.TreatedMapAttributeJoin<O, K, T>

extends MapAttributeJoin<O, K, T>
Class Inheritance

Field Summary

Modifier and TypeField and Description
private final MapAttributeJoin<O, K, ? super T>
original

protected final Class<T>
treatAsType

Constructor Summary

AccessConstructor and Description
public
TreatedMapAttributeJoin(MapAttributeJoin<O, K, ? super T> original, Class<T> treatAsType)

Method Summary

Modifier and TypeMethod and Description
public String
getAlias()

Overrides org.hibernate.query.criteria.internal.path.AbstractFromImpl.getAlias.

Implements javax.persistence.TupleElement.getAlias.

Return the alias assigned to the tuple element or null, if no alias has been assigned.
public String
getPathIdentifier()

Overrides org.hibernate.query.criteria.internal.path.AbstractFromImpl.getPathIdentifier.

Implements org.hibernate.query.criteria.internal.PathSource.getPathIdentifier.

Get the string representation of this path as a navigation from one of the queries identification variables
protected PathSource<X>
getPathSourceForSubPaths()

Overrides org.hibernate.query.criteria.internal.path.AbstractPathImpl.getPathSourceForSubPaths.

protected ManagedType<T>
locateManagedType()

Overrides org.hibernate.query.criteria.internal.path.PluralAttributeJoinSupport.locateManagedType.

public void
prepareAlias(RenderingContext renderingContext)

Overrides org.hibernate.query.criteria.internal.path.AbstractFromImpl.prepareAlias.

Implements org.hibernate.query.criteria.internal.FromImplementor.prepareAlias, org.hibernate.query.criteria.internal.PathSource.prepareAlias.

public String
render(RenderingContext renderingContext)

Overrides org.hibernate.query.criteria.internal.path.AbstractFromImpl.render.

Implements org.hibernate.query.criteria.internal.Renderable.render.

Perform the rendering, returning the rendition
protected void
setAlias(String
The alias to use.
alias)

Overrides org.hibernate.query.criteria.internal.expression.AbstractTupleElement.setAlias.

Protected access to define the alias.
Inherited from org.hibernate.query.criteria.internal.path.MapAttributeJoin:
correlateTocreateCorrelationDelegateentrygetAttributegetModelkeyonontreatAsvalue

Field Detail

originalback to summary
private final MapAttributeJoin<O, K, ? super T> original
treatAsTypeback to summary
protected final Class<T> treatAsType

Constructor Detail

TreatedMapAttributeJoinback to summary
public TreatedMapAttributeJoin(MapAttributeJoin<O, K, ? super T> original, Class<T> treatAsType)
Annotations
@SuppressWarnings:unchecked

Method Detail

getAliasback to summary
public String getAlias()

Overrides org.hibernate.query.criteria.internal.path.AbstractFromImpl.getAlias.

Implements javax.persistence.TupleElement.getAlias.

Doc from javax.persistence.TupleElement.getAlias.

Return the alias assigned to the tuple element or null, if no alias has been assigned.

Returns:String

alias

Annotations
@Override
getPathIdentifierback to summary
public String getPathIdentifier()

Overrides org.hibernate.query.criteria.internal.path.AbstractFromImpl.getPathIdentifier.

Implements org.hibernate.query.criteria.internal.PathSource.getPathIdentifier.

Doc from org.hibernate.query.criteria.internal.PathSource.getPathIdentifier.

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

Returns:String

The path's identifier.

Annotations
@Override
getPathSourceForSubPathsback to summary
protected PathSource<X> getPathSourceForSubPaths()

Overrides org.hibernate.query.criteria.internal.path.AbstractPathImpl.getPathSourceForSubPaths.

Annotations
@Override
locateManagedTypeback to summary
protected ManagedType<T> locateManagedType()

Overrides org.hibernate.query.criteria.internal.path.PluralAttributeJoinSupport.locateManagedType.

Annotations
@Override
prepareAliasback to summary
public void prepareAlias(RenderingContext renderingContext)

Overrides org.hibernate.query.criteria.internal.path.AbstractFromImpl.prepareAlias.

Implements org.hibernate.query.criteria.internal.FromImplementor.prepareAlias, org.hibernate.query.criteria.internal.PathSource.prepareAlias.

Annotations
@Override
renderback to summary
public String render(RenderingContext renderingContext)

Overrides org.hibernate.query.criteria.internal.path.AbstractFromImpl.render.

Implements org.hibernate.query.criteria.internal.Renderable.render.

Doc from org.hibernate.query.criteria.internal.Renderable.render.

Perform the rendering, returning the rendition

Annotations
@Override
setAliasback to summary
protected void setAlias(String alias)

Overrides org.hibernate.query.criteria.internal.expression.AbstractTupleElement.setAlias.

Doc from org.hibernate.query.criteria.internal.expression.AbstractTupleElement.setAlias.

Protected access to define the alias.

Parameters
alias:String

The alias to use.

Annotations
@Override