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

public Class CollectionAttributeJoin<O, E>

extends PluralAttributeJoinSupport<O, Collection<E>, E>
implements CollectionJoinImplementor<O, E>, Serializable
Class Inheritance
All Implemented Interfaces
java.io.Serializable, org.hibernate.query.criteria.internal.CollectionJoinImplementor, javax.persistence.criteria.CollectionJoin, 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.CollectionAttributeJoin.TreatedCollectionAttributeJoin
Imports
java.io.Serializable, java.util.Collection, javax.persistence.criteria.Expression, .JoinType, .Predicate, javax.persistence.metamodel.CollectionAttribute, .ManagedType, org.hibernate.query.criteria.internal.CollectionJoinImplementor, .CriteriaBuilderImpl, .CriteriaSubqueryImpl, .FromImplementor, .PathImplementor, .PathSource, org.hibernate.query.criteria.internal.compile.RenderingContext
Models a join based on a plural association attribute.
Author
Steve Ebersole

Nested and Inner Type Summary

Modifier and TypeClass and Description
public static class
CollectionAttributeJoin.TreatedCollectionAttributeJoin<O, T>

Constructor Summary

AccessConstructor and Description
public
CollectionAttributeJoin(CriteriaBuilderImpl criteriaBuilder, Class<E> javaType, PathSource<O> pathSource, CollectionAttribute<? super O, E> joinAttribute, JoinType joinType)

Method Summary

Modifier and TypeMethod and Description
public final CollectionAttributeJoin<O, E>
correlateTo(CriteriaSubqueryImpl<T> subquery)

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

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

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

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

public CollectionAttribute<? super O, E>
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 CollectionAttribute<? super O, E>
getModel()

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

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

Return the metamodel representation for the collection attribute.
public CollectionAttributeJoin<O, E>
on(Predicate...
zero or more restriction predicates
restrictions)

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

Implements org.hibernate.query.criteria.internal.CollectionJoinImplementor.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 CollectionAttributeJoin<O, E>
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.CollectionJoinImplementor.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 E> CollectionAttributeJoin<O, T>
treatAs(Class<T>
The type to treat the path as.
treatAsType)

Implements org.hibernate.query.criteria.internal.CollectionJoinImplementor.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.
Inherited from org.hibernate.query.criteria.internal.path.PluralAttributeJoinSupport:
canBeDereferencedcanBeJoinSourceisBasicCollectionlocateManagedType

Constructor Detail

CollectionAttributeJoinback to summary
public CollectionAttributeJoin(CriteriaBuilderImpl criteriaBuilder, Class<E> javaType, PathSource<O> pathSource, CollectionAttribute<? super O, E> joinAttribute, JoinType joinType)

Method Detail

correlateToback to summary
public final CollectionAttributeJoin<O, E> correlateTo(CriteriaSubqueryImpl<T> subquery)

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

Implements org.hibernate.query.criteria.internal.CollectionJoinImplementor.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

createCorrelationDelegateback to summary
protected FromImplementor<O, E> createCorrelationDelegate()

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

Annotations
@Override
getAttributeback to summary
public CollectionAttribute<? super O, E> 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:CollectionAttribute<? super O, E>

metamodel attribute corresponding to the join

Annotations
@Override
getModelback to summary
public CollectionAttribute<? super O, E> getModel()

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

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

Doc from javax.persistence.criteria.CollectionJoin.getModel.

Return the metamodel representation for the collection attribute.

Returns:CollectionAttribute<? super O, E>

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

Annotations
@Override
onback to summary
public CollectionAttributeJoin<O, E> on(Predicate... restrictions)

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

Implements org.hibernate.query.criteria.internal.CollectionJoinImplementor.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.CollectionJoin.on.

zero or more restriction predicates

Returns:CollectionAttributeJoin<O, E>

Doc from javax.persistence.criteria.CollectionJoin.on.

the modified join object

Annotations
@Override
onback to summary
public CollectionAttributeJoin<O, E> on(Expression<Boolean> restriction)

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

Implements org.hibernate.query.criteria.internal.CollectionJoinImplementor.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.CollectionJoin.on.

a simple or compound boolean expression

Returns:CollectionAttributeJoin<O, E>

Doc from javax.persistence.criteria.CollectionJoin.on.

the modified join object

Annotations
@Override
treatAsback to summary
public <T extends E> CollectionAttributeJoin<O, T> treatAs(Class<T> treatAsType)

Implements org.hibernate.query.criteria.internal.CollectionJoinImplementor.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:CollectionAttributeJoin<O, T>

The properly typed view of this path.

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

public Class CollectionAttributeJoin.TreatedCollectionAttributeJoin<O, T>

extends CollectionAttributeJoin<O, T>
Class Inheritance

Field Summary

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

private final Class<T>
treatAsType

Constructor Summary

AccessConstructor and Description
public
TreatedCollectionAttributeJoin(CollectionAttributeJoin<O, ? 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.CollectionAttributeJoin:
correlateTocreateCorrelationDelegategetAttributegetModelonontreatAs

Field Detail

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

Constructor Detail

TreatedCollectionAttributeJoinback to summary
public TreatedCollectionAttributeJoin(CollectionAttributeJoin<O, ? 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