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

public Class SingularAttributeJoin<O, X>

extends AbstractJoinImpl<O, X>
Class Inheritance
Known Direct Subclasses
org.hibernate.query.criteria.internal.path.SingularAttributeJoin.TreatedSingularAttributeJoin
Type Parameters
<O>
Represents the parameterized type of the attribute owner
<X>
Represents the parameterized type of the attribute
Imports
javax.persistence.criteria.JoinType, javax.persistence.metamodel.Attribute, .Bindable, .ManagedType, .PluralAttribute, .SingularAttribute, .Type, org.hibernate.query.criteria.internal.CriteriaBuilderImpl, .CriteriaSubqueryImpl, .FromImplementor, .PathSource, org.hibernate.query.criteria.internal.compile.RenderingContext
Models a join based on a singular attribute
Author
Steve Ebersole

Nested and Inner Type Summary

Modifier and TypeClass and Description
public static class
SingularAttributeJoin.TreatedSingularAttributeJoin<O, T>

Field Summary

Modifier and TypeField and Description
private final Bindable<X>
model

Constructor Summary

AccessConstructor and Description
public
SingularAttributeJoin(CriteriaBuilderImpl criteriaBuilder, Class<X> javaType, PathSource<O> pathSource, SingularAttribute<? super O, ?> joinAttribute, JoinType joinType)

Method Summary

Modifier and TypeMethod and Description
protected boolean
canBeJoinSource()

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

public SingularAttributeJoin<O, X>
correlateTo(CriteriaSubqueryImpl<T> subquery)

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

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

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

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

public SingularAttribute<? super O, ?>
getAttribute()

Overrides org.hibernate.query.criteria.internal.path.AbstractJoinImpl.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 Bindable<X>
getModel()

Implements javax.persistence.criteria.Path.getModel.

Return the bindable object that corresponds to the path expression.
protected ManagedType<? super X>
locateManagedType()

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

public <T extends X> SingularAttributeJoin<O, T>
treatAs(Class<T>
The type to treat the path as.
treatAsType)

Implements 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.AbstractJoinImpl:
getJoinTypegetOngetParentononrenderTableExpression

Field Detail

modelback to summary
private final Bindable<X> model

Constructor Detail

SingularAttributeJoinback to summary
public SingularAttributeJoin(CriteriaBuilderImpl criteriaBuilder, Class<X> javaType, PathSource<O> pathSource, SingularAttribute<? super O, ?> joinAttribute, JoinType joinType)
Annotations
@SuppressWarnings:unchecked

Method Detail

canBeJoinSourceback to summary
protected boolean canBeJoinSource()

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

Annotations
@Override
correlateToback to summary
public SingularAttributeJoin<O, X> correlateTo(CriteriaSubqueryImpl<T> subquery)

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

Implements 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, X> createCorrelationDelegate()

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

Annotations
@Override
getAttributeback to summary
public SingularAttribute<? super O, ?> getAttribute()

Overrides org.hibernate.query.criteria.internal.path.AbstractJoinImpl.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:SingularAttribute<? super O, ?>

metamodel attribute corresponding to the join

Annotations
@Override
getModelback to summary
public Bindable<X> getModel()

Implements javax.persistence.criteria.Path.getModel.

Doc from javax.persistence.criteria.Path.getModel.

Return the bindable object that corresponds to the path expression.

Returns:Bindable<X>

bindable object corresponding to the path

locateManagedTypeback to summary
protected ManagedType<? super X> locateManagedType()

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

Annotations
@Override
@SuppressWarnings:unchecked
treatAsback to summary
public <T extends X> SingularAttributeJoin<O, T> treatAs(Class<T> treatAsType)

Implements 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:SingularAttributeJoin<O, T>

The properly typed view of this path.

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

public Class SingularAttributeJoin.TreatedSingularAttributeJoin<O, T>

extends SingularAttributeJoin<O, T>
Class Inheritance

Field Summary

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

private final Class<T>
treatAsType

Constructor Summary

AccessConstructor and Description
public
TreatedSingularAttributeJoin(SingularAttributeJoin<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.
protected ManagedType<T>
locateManagedType()

Overrides org.hibernate.query.criteria.internal.path.SingularAttributeJoin.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.SingularAttributeJoin:
canBeJoinSourcecorrelateTocreateCorrelationDelegategetAttributegetModeltreatAs

Field Detail

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

Constructor Detail

TreatedSingularAttributeJoinback to summary
public TreatedSingularAttributeJoin(SingularAttributeJoin<O, ? super T> original, Class<T> treatAsType)

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
locateManagedTypeback to summary
protected ManagedType<T> locateManagedType()

Overrides org.hibernate.query.criteria.internal.path.SingularAttributeJoin.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