org.hibernate.ejb.criteria.path

Class AbstractFromImpl<Z,X>

java.lang.Object

org.hibernate.ejb.criteria.AbstractNode

org.hibernate.ejb.criteria.expression.AbstractTupleElement<X>

org.hibernate.ejb.criteria.expression.SelectionImpl<T>

org.hibernate.ejb.criteria.expression.ExpressionImpl<X>

org.hibernate.ejb.criteria.path.AbstractPathImpl<X>

org.hibernate.ejb.criteria.path.AbstractFromImpl<Z,X>

All Implemented Interfaces:

Serializable, Expression<X>, FetchParent<Z,X>, From<Z,X>, Path<X>, Selection<X>, TupleElement<X>, ExpressionImplementor<X>, FromImplementor<Z,X>, ParameterContainer, PathImplementor<X>, PathSource<X>, Renderable, SelectionImplementor<X>, TupleElementImplementor<X>

Direct Known Subclasses:

AbstractJoinImpl, RootImpl

public abstract class AbstractFromImpl<Z,X>
extends AbstractPathImpl<X>
implements From<Z,X>, FromImplementor<Z,X>, Serializable

Convenience base class for various From implementors.

Author:

Steve Ebersole

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected class	AbstractFromImpl.BasicJoinScope
protected class	AbstractFromImpl.CorrelationJoinScope
static interface	AbstractFromImpl.JoinScope<X> Helper contract used to define who/what keeps track of joins and fetches made from this FROM.

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

ParameterContainer.Helper

Field Summary

Fields

Modifier and Type	Field and Description
static JoinType	DEFAULT_JOIN_TYPE

Constructor Summary

Constructors

Constructor and Description
AbstractFromImpl(CriteriaBuilderImpl criteriaBuilder, Class<X> javaType)
AbstractFromImpl(CriteriaBuilderImpl criteriaBuilder, Class<X> javaType, PathSource pathSource)

Method Summary

Methods

Modifier and Type	Method and Description
protected boolean	canBeDereferenced()
protected boolean	canBeFetchSource()
protected abstract boolean	canBeJoinSource()
FromImplementor<Z,X>	correlateTo(CriteriaSubqueryImpl subquery)
protected abstract FromImplementor<Z,X>	createCorrelationDelegate()
<Y> Fetch<X,Y>	fetch(PluralAttribute<? super X,?,Y> pluralAttribute) Create a fetch join to the specified collection-valued attribute using an inner join.
<Y> Fetch<X,Y>	fetch(PluralAttribute<? super X,?,Y> pluralAttribute, JoinType jt) Create a fetch join to the specified collection-valued attribute using the given join type.
<Y> Fetch<X,Y>	fetch(SingularAttribute<? super X,Y> singularAttribute) Create a fetch join to the specified single-valued attribute using an inner join.
<Y> Fetch<X,Y>	fetch(SingularAttribute<? super X,Y> attribute, JoinType jt) Create a fetch join to the specified single-valued attribute using the given join type.
<X,Y> Fetch<X,Y>	fetch(String attributeName) Create a fetch join to the specified attribute using an inner join.
<X,Y> Fetch<X,Y>	fetch(String attributeName, JoinType jt) Create a fetch join to the specified attribute using the given join type.
String	getAlias() Return the alias assigned to the tuple element or null, if no alias has been assigned.
Attribute<?,?>	getAttribute() Retrieve reference to the attribute this path represents.
FromImplementor<Z,X>	getCorrelationParent() Returns the parent From object from which the correlated From object has been obtained through correlation (use of a Subquery correlate method).
Set<Fetch<X,?>>	getFetches() Return the fetch joins that have been made from this type.
Set<Join<X,?>>	getJoins() Return the joins that have been made from this bound type.
From<?,Z>	getParent()
String	getPathIdentifier() Get the string representation of this path as a navigation from one of the queries identification variables
PathSource<Z>	getPathSource()
boolean	isCorrelated() Whether the From object has been obtained as a result of correlation (use of a Subquery correlate method).
<Y> CollectionJoin<X,Y>	join(CollectionAttribute<? super X,Y> collection) Create an inner join to the specified Collection-valued attribute.
<Y> CollectionJoin<X,Y>	join(CollectionAttribute<? super X,Y> collection, JoinType jt) Create a join to the specified Collection-valued attribute using the given join type.
<Y> ListJoin<X,Y>	join(ListAttribute<? super X,Y> list) Create an inner join to the specified List-valued attribute.
<Y> ListJoin<X,Y>	join(ListAttribute<? super X,Y> list, JoinType jt) Create a join to the specified List-valued attribute using the given join type.
<K,V> MapJoin<X,K,V>	join(MapAttribute<? super X,K,V> map) Create an inner join to the specified Map-valued attribute.
<K,V> MapJoin<X,K,V>	join(MapAttribute<? super X,K,V> map, JoinType jt) Create a join to the specified Map-valued attribute using the given join type.
<Y> SetJoin<X,Y>	join(SetAttribute<? super X,Y> set) Create an inner join to the specified Set-valued attribute.
<Y> SetJoin<X,Y>	join(SetAttribute<? super X,Y> set, JoinType jt) Create a join to the specified Set-valued attribute using the given join type.
<Y> Join<X,Y>	join(SingularAttribute<? super X,Y> singularAttribute) Create an inner join to the specified single-valued attribute.
<Y> Join<X,Y>	join(SingularAttribute<? super X,Y> attribute, JoinType jt) Create a join to the specified single-valued attribute using the given join type.
<X,Y> Join<X,Y>	join(String attributeName) Create an inner join to the specified attribute.
<X,Y> Join<X,Y>	join(String attributeName, JoinType jt) Create a join to the specified attribute using the given join type.
<X,Y> CollectionJoin<X,Y>	joinCollection(String attributeName) Create an inner join to the specified Collection-valued attribute.
<X,Y> CollectionJoin<X,Y>	joinCollection(String attributeName, JoinType jt) Create a join to the specified Collection-valued attribute using the given join type.
<X,Y> ListJoin<X,Y>	joinList(String attributeName) Create an inner join to the specified List-valued attribute.
<X,Y> ListJoin<X,Y>	joinList(String attributeName, JoinType jt) Create a join to the specified List-valued attribute using the given join type.
<X,K,V> MapJoin<X,K,V>	joinMap(String attributeName) Create an inner join to the specified Map-valued attribute.
<X,K,V> MapJoin<X,K,V>	joinMap(String attributeName, JoinType jt) Create a join to the specified Map-valued attribute using the given join type.
<X,Y> SetJoin<X,Y>	joinSet(String attributeName) Create an inner join to the specified Set-valued attribute.
<X,Y> SetJoin<X,Y>	joinSet(String attributeName, JoinType jt) Create a join to the specified Set-valued attribute using the given join type.
protected Attribute<X,?>	locateAttributeInternal(String name) Get the attribute by name from the underlying model.
protected ManagedType<? super X>	locateManagedType()
void	prepareAlias(CriteriaQueryCompiler.RenderingContext renderingContext)
void	prepareCorrelationDelegate(FromImplementor<Z,X> parent)
String	render(CriteriaQueryCompiler.RenderingContext renderingContext)
String	renderProjection(CriteriaQueryCompiler.RenderingContext renderingContext)

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

get, get, get, get, getParentPath, illegalDereference, locateAttribute, registerAttributePath, registerParameters, resolveCachedAttributePath, type, unknownAttribute

Methods inherited from class org.hibernate.ejb.criteria.expression.ExpressionImpl

as, asBigDecimal, asBigInteger, asDouble, asFloat, asInteger, asLong, asString, in, in, in, in, isNotNull, isNull

Methods inherited from class org.hibernate.ejb.criteria.expression.SelectionImpl

alias, getCompoundSelectionItems, getValueHandlers, isCompoundSelection

Methods inherited from class org.hibernate.ejb.criteria.expression.AbstractTupleElement

forceConversion, getJavaType, getValueHandler, resetJavaType, setAlias

Methods inherited from class org.hibernate.ejb.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.ejb.criteria.FromImplementor

renderTableExpression

Methods inherited from interface org.hibernate.ejb.criteria.ExpressionImplementor

asBigDecimal, asBigInteger, asDouble, asFloat, asInteger, asLong, asString

Methods inherited from interface org.hibernate.ejb.criteria.SelectionImplementor

getValueHandlers

Methods inherited from interface org.hibernate.ejb.criteria.TupleElementImplementor

getValueHandler

Methods inherited from interface javax.persistence.criteria.Path

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

getJavaType

Field Detail

DEFAULT_JOIN_TYPE

public static final JoinType DEFAULT_JOIN_TYPE

Constructor Detail

AbstractFromImpl

public AbstractFromImpl(CriteriaBuilderImpl criteriaBuilder,
                Class<X> javaType)

AbstractFromImpl

public AbstractFromImpl(CriteriaBuilderImpl criteriaBuilder,
                Class<X> javaType,
                PathSource pathSource)

Method Detail

getPathSource

public PathSource<Z> getPathSource()

Overrides:

getPathSource in class AbstractPathImpl<X>

getPathIdentifier

public String getPathIdentifier()

Description copied from class: AbstractPathImpl

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

Specified by:

getPathIdentifier in interface PathSource<X>

Overrides:

getPathIdentifier in class AbstractPathImpl<X>

Returns:

The path's identifier.

canBeDereferenced

protected boolean canBeDereferenced()

Specified by:

canBeDereferenced in class AbstractPathImpl<X>

prepareAlias

public void prepareAlias(CriteriaQueryCompiler.RenderingContext renderingContext)

Specified by:

prepareAlias in interface FromImplementor<Z,X>

Specified by:

prepareAlias in interface PathSource<X>

Overrides:

prepareAlias in class AbstractPathImpl<X>

renderProjection

public String renderProjection(CriteriaQueryCompiler.RenderingContext renderingContext)

Description copied from class: AbstractPathImpl

Specified by:

renderProjection in interface Renderable

Overrides:

renderProjection in class AbstractPathImpl<X>

render

public String render(CriteriaQueryCompiler.RenderingContext renderingContext)

Description copied from class: AbstractPathImpl

Specified by:

render in interface Renderable

Overrides:

render in class AbstractPathImpl<X>

getAttribute

public Attribute<?,?> 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.

getParent

public From<?,Z> getParent()

locateAttributeInternal

protected Attribute<X,?> locateAttributeInternal(String name)

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:

name - The name of the attribute to locate

Returns:

The attribute; may be null.

locateManagedType

protected ManagedType<? super X> locateManagedType()

isCorrelated

public boolean isCorrelated()

Description copied from interface: From

Whether the From object has been obtained as a result of correlation (use of a Subquery correlate method).

Specified by:

isCorrelated in interface From<Z,X>

Returns:

boolean indicating whether the object has been obtained through correlation

getCorrelationParent

public FromImplementor<Z,X> getCorrelationParent()

Description copied from interface: From

Returns the parent From object from which the correlated From object has been obtained through correlation (use of a Subquery correlate method).

Specified by:

getCorrelationParent in interface From<Z,X>

Specified by:

getCorrelationParent in interface FromImplementor<Z,X>

Returns:

the parent of the correlated From object

correlateTo

public FromImplementor<Z,X> correlateTo(CriteriaSubqueryImpl subquery)

Specified by:

correlateTo in interface FromImplementor<Z,X>

createCorrelationDelegate

protected abstract FromImplementor<Z,X> createCorrelationDelegate()

prepareCorrelationDelegate

public void prepareCorrelationDelegate(FromImplementor<Z,X> parent)

Specified by:

prepareCorrelationDelegate in interface FromImplementor<Z,X>

getAlias

public String getAlias()

Description copied from class: AbstractTupleElement

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

Specified by:

getAlias in interface TupleElement<X>

Overrides:

getAlias in class AbstractTupleElement<X>

Returns:

alias

canBeJoinSource

protected abstract boolean canBeJoinSource()

getJoins

public Set<Join<X,?>> getJoins()

Description copied from interface: From

Return the joins that have been made from this bound type. Returns empty set if no joins have been made from this bound type. Modifications to the set do not affect the query.

Specified by:

getJoins in interface From<Z,X>

Returns:

joins made from this type

join

public <Y> Join<X,Y> join(SingularAttribute<? super X,Y> singularAttribute)

Description copied from interface: From

Create an inner join to the specified single-valued attribute.

Specified by:

join in interface From<Z,X>

Parameters:

singularAttribute - target of the join

Returns:

the resulting join

join

public <Y> Join<X,Y> join(SingularAttribute<? super X,Y> attribute,
                 JoinType jt)

Description copied from interface: From

Create a join to the specified single-valued attribute using the given join type.

Specified by:

join in interface From<Z,X>

Parameters:

attribute - target of the join

jt - join type

Returns:

the resulting join

join

public <Y> CollectionJoin<X,Y> join(CollectionAttribute<? super X,Y> collection)

Description copied from interface: From

Create an inner join to the specified Collection-valued attribute.

Specified by:

join in interface From<Z,X>

Parameters:

collection - target of the join

Returns:

the resulting join

join

public <Y> CollectionJoin<X,Y> join(CollectionAttribute<? super X,Y> collection,
                           JoinType jt)

Description copied from interface: From

Create a join to the specified Collection-valued attribute using the given join type.

Specified by:

join in interface From<Z,X>

Parameters:

collection - target of the join

jt - join type

Returns:

the resulting join

join

public <Y> SetJoin<X,Y> join(SetAttribute<? super X,Y> set)

Description copied from interface: From

Create an inner join to the specified Set-valued attribute.

Specified by:

join in interface From<Z,X>

Parameters:

set - target of the join

Returns:

the resulting join

join

public <Y> SetJoin<X,Y> join(SetAttribute<? super X,Y> set,
                    JoinType jt)

Description copied from interface: From

Create a join to the specified Set-valued attribute using the given join type.

Specified by:

join in interface From<Z,X>

Parameters:

set - target of the join

jt - join type

Returns:

the resulting join

join

public <Y> ListJoin<X,Y> join(ListAttribute<? super X,Y> list)

Description copied from interface: From

Create an inner join to the specified List-valued attribute.

Specified by:

join in interface From<Z,X>

Parameters:

list - target of the join

Returns:

the resulting join

join

public <Y> ListJoin<X,Y> join(ListAttribute<? super X,Y> list,
                     JoinType jt)

Description copied from interface: From

Create a join to the specified List-valued attribute using the given join type.

Specified by:

join in interface From<Z,X>

Parameters:

list - target of the join

jt - join type

Returns:

the resulting join

join

public <K,V> MapJoin<X,K,V> join(MapAttribute<? super X,K,V> map)

Description copied from interface: From

Create an inner join to the specified Map-valued attribute.

Specified by:

join in interface From<Z,X>

Parameters:

map - target of the join

Returns:

the resulting join

join

public <K,V> MapJoin<X,K,V> join(MapAttribute<? super X,K,V> map,
                        JoinType jt)

Description copied from interface: From

Create a join to the specified Map-valued attribute using the given join type.

Specified by:

join in interface From<Z,X>

Parameters:

map - target of the join

jt - join type

Returns:

the resulting join

join

public <X,Y> Join<X,Y> join(String attributeName)

Description copied from interface: From

Create an inner join to the specified attribute.

Specified by:

join in interface From<Z,X>

Parameters:

attributeName - name of the attribute for the target of the join

Returns:

the resulting join

join

public <X,Y> Join<X,Y> join(String attributeName,
                   JoinType jt)

Description copied from interface: From

Create a join to the specified attribute using the given join type.

Specified by:

join in interface From<Z,X>

Parameters:

attributeName - name of the attribute for the target of the join

jt - join type

Returns:

the resulting join

joinCollection

public <X,Y> CollectionJoin<X,Y> joinCollection(String attributeName)

Description copied from interface: From

Create an inner join to the specified Collection-valued attribute.

Specified by:

joinCollection in interface From<Z,X>

Parameters:

attributeName - name of the attribute for the target of the join

Returns:

the resulting join

joinCollection

public <X,Y> CollectionJoin<X,Y> joinCollection(String attributeName,
                                       JoinType jt)

Description copied from interface: From

Create a join to the specified Collection-valued attribute using the given join type.

Specified by:

joinCollection in interface From<Z,X>

Parameters:

attributeName - name of the attribute for the target of the join

jt - join type

Returns:

the resulting join

joinSet

public <X,Y> SetJoin<X,Y> joinSet(String attributeName)

Description copied from interface: From

Create an inner join to the specified Set-valued attribute.

Specified by:

joinSet in interface From<Z,X>

Parameters:

attributeName - name of the attribute for the target of the join

Returns:

the resulting join

joinSet

public <X,Y> SetJoin<X,Y> joinSet(String attributeName,
                         JoinType jt)

Description copied from interface: From

Create a join to the specified Set-valued attribute using the given join type.

Specified by:

joinSet in interface From<Z,X>

Parameters:

attributeName - name of the attribute for the target of the join

jt - join type

Returns:

the resulting join

joinList

public <X,Y> ListJoin<X,Y> joinList(String attributeName)

Description copied from interface: From

Create an inner join to the specified List-valued attribute.

Specified by:

joinList in interface From<Z,X>

Parameters:

attributeName - name of the attribute for the target of the join

Returns:

the resulting join

joinList

public <X,Y> ListJoin<X,Y> joinList(String attributeName,
                           JoinType jt)

Description copied from interface: From

Create a join to the specified List-valued attribute using the given join type.

Specified by:

joinList in interface From<Z,X>

Parameters:

attributeName - name of the attribute for the target of the join

jt - join type

Returns:

the resulting join

joinMap

public <X,K,V> MapJoin<X,K,V> joinMap(String attributeName)

Description copied from interface: From

Create an inner join to the specified Map-valued attribute.

Specified by:

joinMap in interface From<Z,X>

Parameters:

attributeName - name of the attribute for the target of the join

Returns:

the resulting join

joinMap

public <X,K,V> MapJoin<X,K,V> joinMap(String attributeName,
                             JoinType jt)

Description copied from interface: From

Create a join to the specified Map-valued attribute using the given join type.

Specified by:

joinMap in interface From<Z,X>

Parameters:

attributeName - name of the attribute for the target of the join

jt - join type

Returns:

the resulting join

canBeFetchSource

protected boolean canBeFetchSource()

getFetches

public Set<Fetch<X,?>> getFetches()

Description copied from interface: FetchParent

Return the fetch joins that have been made from this type. Returns empty set if no fetch joins have been made from this type. Modifications to the set do not affect the query.

Specified by:

getFetches in interface FetchParent<Z,X>

Returns:

fetch joins made from this type

fetch

public <Y> Fetch<X,Y> fetch(SingularAttribute<? super X,Y> singularAttribute)

Description copied from interface: FetchParent

Create a fetch join to the specified single-valued attribute using an inner join.

Specified by:

fetch in interface FetchParent<Z,X>

Parameters:

singularAttribute - target of the join

Returns:

the resulting fetch join

fetch

public <Y> Fetch<X,Y> fetch(SingularAttribute<? super X,Y> attribute,
                   JoinType jt)

Description copied from interface: FetchParent

Create a fetch join to the specified single-valued attribute using the given join type.

Specified by:

fetch in interface FetchParent<Z,X>

Parameters:

attribute - target of the join

jt - join type

Returns:

the resulting fetch join

fetch

public <Y> Fetch<X,Y> fetch(PluralAttribute<? super X,?,Y> pluralAttribute)

Description copied from interface: FetchParent

Create a fetch join to the specified collection-valued attribute using an inner join.

Specified by:

fetch in interface FetchParent<Z,X>

Parameters:

pluralAttribute - target of the join

Returns:

the resulting join

fetch

public <Y> Fetch<X,Y> fetch(PluralAttribute<? super X,?,Y> pluralAttribute,
                   JoinType jt)

Description copied from interface: FetchParent

Create a fetch join to the specified collection-valued attribute using the given join type.

Specified by:

fetch in interface FetchParent<Z,X>

Parameters:

pluralAttribute - target of the join

jt - join type

Returns:

the resulting join

fetch

public <X,Y> Fetch<X,Y> fetch(String attributeName)

Description copied from interface: FetchParent

Create a fetch join to the specified attribute using an inner join.

Specified by:

fetch in interface FetchParent<Z,X>

Parameters:

attributeName - name of the attribute for the target of the join

Returns:

the resulting fetch join

fetch

public <X,Y> Fetch<X,Y> fetch(String attributeName,
                     JoinType jt)

Description copied from interface: FetchParent

Create a fetch join to the specified attribute using the given join type.

Specified by:

fetch in interface FetchParent<Z,X>

Parameters:

attributeName - name of the attribute for the target of the join

jt - join type

Returns:

the resulting fetch join