org.batoo.jpa.core.impl.criteria.join

Class AbstractFrom<Z,X>

java.lang.Object

org.batoo.jpa.core.impl.criteria.TupleElementImpl<X>

org.batoo.jpa.core.impl.criteria.AbstractSelection<T>

org.batoo.jpa.core.impl.criteria.expression.AbstractExpression<X>

org.batoo.jpa.core.impl.criteria.path.AbstractPath<X>

org.batoo.jpa.core.impl.criteria.path.ParentPath<Z,X>

org.batoo.jpa.core.impl.criteria.join.AbstractFrom<Z,X>

Type Parameters:

Z - the source type

X - the target type

All Implemented Interfaces:

javax.persistence.criteria.Expression<X>, javax.persistence.criteria.FetchParent<Z,X>, javax.persistence.criteria.From<Z,X>, javax.persistence.criteria.Path<X>, javax.persistence.criteria.Selection<X>, javax.persistence.TupleElement<X>, Joinable

Direct Known Subclasses:

AbstractJoin, RootImpl

public abstract class AbstractFrom<Z,X>
extends ParentPath<Z,X>
implements javax.persistence.criteria.From<Z,X>, Joinable

Represents a bound type, usually an entity that appears in the from clause, but may also be an embeddable belonging to an entity in the from clause.

Serves as a factory for Joins of associations, embeddables, and collections belonging to the type, and for Paths of attributes belonging to the type.

Since:

2.0.0

Author:

hceylan

Constructor Summary

Constructors

Constructor and Description
AbstractFrom(AbstractFrom<?,Z> parent, TypeImpl<X> type, JoinedMapping<? super Z,?,X> mapping, javax.persistence.criteria.JoinType joinType) Constructor for joined types
AbstractFrom(EntityTypeImpl<X> entity) Constructor for root types

Method Summary

Methods

Modifier and Type	Method and Description
protected void	ensureAlias(BaseQueryImpl<?> query) Ensure that the alias is assigned.
<Y> javax.persistence.criteria.Fetch<X,Y>	fetch(javax.persistence.metamodel.PluralAttribute<? super X,?,Y> attribute)
<Y> javax.persistence.criteria.Fetch<X,Y>	fetch(javax.persistence.metamodel.PluralAttribute<? super X,?,Y> attribute, javax.persistence.criteria.JoinType jt)
<Y> javax.persistence.criteria.Fetch<X,Y>	fetch(javax.persistence.metamodel.SingularAttribute<? super X,Y> attribute)
<Y> javax.persistence.criteria.Fetch<X,Y>	fetch(javax.persistence.metamodel.SingularAttribute<? super X,Y> attribute, javax.persistence.criteria.JoinType jt)
<Y> javax.persistence.criteria.Fetch<X,Y>	fetch(String attributeName)
<Y> javax.persistence.criteria.Fetch<X,Y>	fetch(String attributeName, javax.persistence.criteria.JoinType jt)
String	generateDiscrimination(boolean noQualification) Returns the restriction based on discrimination.
String	generateJpqlJoins(AbstractCriteriaQueryImpl<?> criteriaQuery) Returns the JPQL joins fragment.
String	generateJpqlRestriction(BaseQueryImpl<?> query) Returns the JPQL where fragment.
String	generateJpqlSelect(AbstractCriteriaQueryImpl<?> query, boolean selected) Returns the JPQL select fragment.
void	generateSqlJoins(AbstractCriteriaQueryImpl<?> query, Map<Joinable,String> joins) Generates SQL joins fragment.
String	generateSqlSelect(AbstractCriteriaQueryImpl<?> query, boolean selected) Returns the SQL select fragment.
javax.persistence.criteria.From<Z,X>	getCorrelationParent()
EntityTypeImpl<X>	getEntity() Returns the entity of the from.
Set<javax.persistence.criteria.Fetch<X,?>>	getFetches()
FetchParentImpl<Z,X>	getFetchRoot() Returns the fetchRoot of the AbstractFrom.
Set<javax.persistence.criteria.Join<X,?>>	getJoins()
String[]	getSqlRestrictionFragments(BaseQueryImpl<?> query) Returns the SQL restriction fragments.
String[]	getSqlRestrictionFragments(BaseQueryImpl<?> query, MapJoinImpl.MapSelectType selectType) Returns the SQL restriction in pairs of table alias and column.
String	getTableAlias(BaseQueryImpl<?> query, AbstractTable table) Returns the alias for the table.
X	handle(QueryImpl<?> query, SessionImpl session, ResultSet row) Handles the row.
boolean	isCorrelated()
boolean	isEntityList() Returns if the selection is comprises of entities only.
<Y> CollectionJoinImpl<X,Y>	join(javax.persistence.metamodel.CollectionAttribute<? super X,Y> collection)
<Y> CollectionJoinImpl<X,Y>	join(javax.persistence.metamodel.CollectionAttribute<? super X,Y> collection, javax.persistence.criteria.JoinType jt)
<Y> ListJoinImpl<X,Y>	join(javax.persistence.metamodel.ListAttribute<? super X,Y> list)
<Y> ListJoinImpl<X,Y>	join(javax.persistence.metamodel.ListAttribute<? super X,Y> list, javax.persistence.criteria.JoinType jt)
<K,V> MapJoinImpl<X,K,V>	join(javax.persistence.metamodel.MapAttribute<? super X,K,V> map)
<K,V> MapJoinImpl<X,K,V>	join(javax.persistence.metamodel.MapAttribute<? super X,K,V> map, javax.persistence.criteria.JoinType jt)
<Y> SetJoinImpl<X,Y>	join(javax.persistence.metamodel.SetAttribute<? super X,Y> set)
<Y> SetJoinImpl<X,Y>	join(javax.persistence.metamodel.SetAttribute<? super X,Y> set, javax.persistence.criteria.JoinType jt)
<Y> AbstractJoin<X,Y>	join(javax.persistence.metamodel.SingularAttribute<? super X,Y> attribute)
<Y> AbstractJoin<X,Y>	join(javax.persistence.metamodel.SingularAttribute<? super X,Y> attribute, javax.persistence.criteria.JoinType jt)
<Y> AbstractJoin<X,Y>	join(String attributeName)
<Y> AbstractJoin<X,Y>	join(String attributeName, javax.persistence.criteria.JoinType jt)
<Y> CollectionJoinImpl<X,Y>	joinCollection(String attributeName)
<Y> CollectionJoinImpl<X,Y>	joinCollection(String attributeName, javax.persistence.criteria.JoinType jt)
<Y> ListJoinImpl<X,Y>	joinList(String attributeName)
<Y> ListJoinImpl<X,Y>	joinList(String attributeName, javax.persistence.criteria.JoinType jt)
<K,V> MapJoinImpl<X,K,V>	joinMap(String attributeName)
<K,V> MapJoinImpl<X,K,V>	joinMap(String attributeName, javax.persistence.criteria.JoinType jt)
<Y> SetJoinImpl<X,Y>	joinSet(String attributeName)
<Y> SetJoinImpl<X,Y>	joinSet(String attributeName, javax.persistence.criteria.JoinType jt)
void	select(boolean selected) Updates the selected status.
javax.persistence.criteria.Expression<Class<? extends X>>	type()

Methods inherited from class org.batoo.jpa.core.impl.criteria.path.ParentPath

get, get, get, get, getColumnAlias, getExpression, getMapping

Methods inherited from class org.batoo.jpa.core.impl.criteria.path.AbstractPath

cannotDereference, getParentPath, getRootPath

Methods inherited from class org.batoo.jpa.core.impl.criteria.expression.AbstractExpression

as, getConverter, in, in, in, in, isNotNull, isNull, notIn, notIn, notIn, notIn, setConverter

Methods inherited from class org.batoo.jpa.core.impl.criteria.AbstractSelection

alias, getAlias, getCompoundSelectionItems, isCompoundSelection

Methods inherited from class org.batoo.jpa.core.impl.criteria.TupleElementImpl

getJavaType

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface javax.persistence.criteria.From

join, join, joinCollection, joinCollection, joinList, joinList, joinMap, joinMap, joinSet, joinSet

Methods inherited from interface javax.persistence.criteria.Path

get, get, get, get, getModel, getParentPath

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

Methods inherited from interface javax.persistence.criteria.FetchParent

fetch, fetch

Constructor Detail

AbstractFrom

public AbstractFrom(AbstractFrom<?,Z> parent,
            TypeImpl<X> type,
            JoinedMapping<? super Z,?,X> mapping,
            javax.persistence.criteria.JoinType joinType)

Constructor for joined types

Parameters:

parent - the parent

type - the joined type

mapping - the join mapping

joinType - the join type

Since:

2.0.0

AbstractFrom

public AbstractFrom(EntityTypeImpl<X> entity)

Constructor for root types

Parameters:

entity - the entity

Since:

2.0.0

Method Detail

ensureAlias

protected void ensureAlias(BaseQueryImpl<?> query)

Ensure that the alias is assigned.

Parameters:

query - the criteria query

Since:

2.0.0

fetch

public <Y> javax.persistence.criteria.Fetch<X,Y> fetch(javax.persistence.metamodel.PluralAttribute<? super X,?,Y> attribute)

Specified by:

fetch in interface javax.persistence.criteria.FetchParent<Z,X>

fetch

public <Y> javax.persistence.criteria.Fetch<X,Y> fetch(javax.persistence.metamodel.PluralAttribute<? super X,?,Y> attribute,
                                              javax.persistence.criteria.JoinType jt)

Specified by:

fetch in interface javax.persistence.criteria.FetchParent<Z,X>

fetch

public <Y> javax.persistence.criteria.Fetch<X,Y> fetch(javax.persistence.metamodel.SingularAttribute<? super X,Y> attribute)

Specified by:

fetch in interface javax.persistence.criteria.FetchParent<Z,X>

fetch

public <Y> javax.persistence.criteria.Fetch<X,Y> fetch(javax.persistence.metamodel.SingularAttribute<? super X,Y> attribute,
                                              javax.persistence.criteria.JoinType jt)

Specified by:

fetch in interface javax.persistence.criteria.FetchParent<Z,X>

fetch

public <Y> javax.persistence.criteria.Fetch<X,Y> fetch(String attributeName)

fetch

public <Y> javax.persistence.criteria.Fetch<X,Y> fetch(String attributeName,
                                              javax.persistence.criteria.JoinType jt)

generateDiscrimination

public String generateDiscrimination(boolean noQualification)

Returns the restriction based on discrimination.

Parameters:

noQualification - if the fields should not be qualified

Returns:

the restriction based on discrimination, null

Since:

2.0.0

generateJpqlJoins

public String generateJpqlJoins(AbstractCriteriaQueryImpl<?> criteriaQuery)

Returns the JPQL joins fragment.

Parameters:

criteriaQuery - the criteria query

Returns:

the JPQL joins fragment

Since:

2.0.0

generateJpqlRestriction

public String generateJpqlRestriction(BaseQueryImpl<?> query)

Returns the JPQL where fragment.

Specified by:

generateJpqlRestriction in class AbstractExpression<X>

Parameters:

query - the query

Returns:

the JPQL where fragment

generateJpqlSelect

public String generateJpqlSelect(AbstractCriteriaQueryImpl<?> query,
                        boolean selected)

Returns the JPQL select fragment.

Specified by:

generateJpqlSelect in class AbstractSelection<X>

Parameters:

query - the criteria query

selected - if the selection is selected

Returns:

the JPQL select fragment

generateSqlJoins

public void generateSqlJoins(AbstractCriteriaQueryImpl<?> query,
                    Map<Joinable,String> joins)

Generates SQL joins fragment.

Parameters:

query - the query

joins - the map of joins

Since:

2.0.0

generateSqlSelect

public String generateSqlSelect(AbstractCriteriaQueryImpl<?> query,
                       boolean selected)

Returns the SQL select fragment.

Specified by:

generateSqlSelect in class AbstractSelection<X>

Parameters:

query - the query

selected - if the selection is selected

Returns:

the SQL select fragment

getCorrelationParent

public javax.persistence.criteria.From<Z,X> getCorrelationParent()

Specified by:

getCorrelationParent in interface javax.persistence.criteria.From<Z,X>

getEntity

public EntityTypeImpl<X> getEntity()

Returns the entity of the from.

Specified by:

getEntity in interface Joinable

Returns:

the entity of the from

Since:

2.0.0

getFetches

public Set<javax.persistence.criteria.Fetch<X,?>> getFetches()

Specified by:

getFetches in interface javax.persistence.criteria.FetchParent<Z,X>

getFetchRoot

public FetchParentImpl<Z,X> getFetchRoot()

Returns the fetchRoot of the AbstractFrom.

Specified by:

getFetchRoot in class ParentPath<Z,X>

Returns:

the fetchRoot of the AbstractFrom

Since:

2.0.0

getJoins

public Set<javax.persistence.criteria.Join<X,?>> getJoins()

Specified by:

getJoins in interface javax.persistence.criteria.From<Z,X>

getSqlRestrictionFragments

public String[] getSqlRestrictionFragments(BaseQueryImpl<?> query)

Returns the SQL restriction fragments.

Specified by:

getSqlRestrictionFragments in class AbstractSelection<X>

Parameters:

query - the query

Returns:

the SQL restriction fragments

getSqlRestrictionFragments

public String[] getSqlRestrictionFragments(BaseQueryImpl<?> query,
                                  MapJoinImpl.MapSelectType selectType)

Returns the SQL restriction in pairs of table alias and column.

Parameters:

query - the query

selectType - the select type

Returns:

the SQL restriction in pairs of table alias and column

Since:

2.0.0

getTableAlias

public String getTableAlias(BaseQueryImpl<?> query,
                   AbstractTable table)

Returns the alias for the table.

if table does not have an alias, it is generated.

Specified by:

getTableAlias in interface Joinable

Parameters:

query - the query

table - the table

Returns:

the alias for the table

Since:

2.0.0

handle

public X handle(QueryImpl<?> query,
       SessionImpl session,
       ResultSet row)
         throws SQLException

Handles the row.

Specified by:

handle in class AbstractSelection<X>

Parameters:

query - the query

session - the session

row - the row

Returns:

the managed instance

Throws:

SQLException - thrown in case of an underlying SQL Error

isCorrelated

public boolean isCorrelated()

Specified by:

isCorrelated in interface javax.persistence.criteria.From<Z,X>

isEntityList

public boolean isEntityList()

Returns if the selection is comprises of entities only.

Overrides:

isEntityList in class AbstractSelection<X>

Returns:

true if the selection is comprises of entities only, false otherwise

join

public <Y> CollectionJoinImpl<X,Y> join(javax.persistence.metamodel.CollectionAttribute<? super X,Y> collection)

Specified by:

join in interface javax.persistence.criteria.From<Z,X>

join

public <Y> CollectionJoinImpl<X,Y> join(javax.persistence.metamodel.CollectionAttribute<? super X,Y> collection,
                               javax.persistence.criteria.JoinType jt)

Specified by:

join in interface javax.persistence.criteria.From<Z,X>

join

public <Y> ListJoinImpl<X,Y> join(javax.persistence.metamodel.ListAttribute<? super X,Y> list)

Specified by:

join in interface javax.persistence.criteria.From<Z,X>

join

public <Y> ListJoinImpl<X,Y> join(javax.persistence.metamodel.ListAttribute<? super X,Y> list,
                         javax.persistence.criteria.JoinType jt)

Specified by:

join in interface javax.persistence.criteria.From<Z,X>

join

public <K,V> MapJoinImpl<X,K,V> join(javax.persistence.metamodel.MapAttribute<? super X,K,V> map)

Specified by:

join in interface javax.persistence.criteria.From<Z,X>

join

public <K,V> MapJoinImpl<X,K,V> join(javax.persistence.metamodel.MapAttribute<? super X,K,V> map,
                            javax.persistence.criteria.JoinType jt)

Specified by:

join in interface javax.persistence.criteria.From<Z,X>

join

public <Y> SetJoinImpl<X,Y> join(javax.persistence.metamodel.SetAttribute<? super X,Y> set)

Specified by:

join in interface javax.persistence.criteria.From<Z,X>

join

public <Y> SetJoinImpl<X,Y> join(javax.persistence.metamodel.SetAttribute<? super X,Y> set,
                        javax.persistence.criteria.JoinType jt)

Specified by:

join in interface javax.persistence.criteria.From<Z,X>

join

public <Y> AbstractJoin<X,Y> join(javax.persistence.metamodel.SingularAttribute<? super X,Y> attribute)

Specified by:

join in interface javax.persistence.criteria.From<Z,X>

join

public <Y> AbstractJoin<X,Y> join(javax.persistence.metamodel.SingularAttribute<? super X,Y> attribute,
                         javax.persistence.criteria.JoinType jt)

Specified by:

join in interface javax.persistence.criteria.From<Z,X>

join

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

join

public <Y> AbstractJoin<X,Y> join(String attributeName,
                         javax.persistence.criteria.JoinType jt)

joinCollection

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

joinCollection

public <Y> CollectionJoinImpl<X,Y> joinCollection(String attributeName,
                                         javax.persistence.criteria.JoinType jt)

joinList

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

joinList

public <Y> ListJoinImpl<X,Y> joinList(String attributeName,
                             javax.persistence.criteria.JoinType jt)

joinMap

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

joinMap

public <K,V> MapJoinImpl<X,K,V> joinMap(String attributeName,
                               javax.persistence.criteria.JoinType jt)

joinSet

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

joinSet

public <Y> SetJoinImpl<X,Y> joinSet(String attributeName,
                           javax.persistence.criteria.JoinType jt)

select

public void select(boolean selected)

Updates the selected status.

Parameters:

selected - if selected

Since:

2.0.0

type

public javax.persistence.criteria.Expression<Class<? extends X>> type()

Specified by:

type in interface javax.persistence.criteria.Path<X>