org.hibernate.loader.criteria

Class CriteriaQueryTranslator

java.lang.Object

org.hibernate.loader.criteria.CriteriaQueryTranslator

All Implemented Interfaces:

CriteriaQuery

public class CriteriaQueryTranslator
extends Object
implements CriteriaQuery

Author:

Gavin King

Field Summary

Fields

Modifier and Type	Field and Description
static String	ROOT_SQL_ALIAS

Constructor Summary

Constructors

Constructor and Description
CriteriaQueryTranslator(SessionFactoryImplementor factory, CriteriaImpl criteria, String rootEntityName, String rootSQLAlias)
CriteriaQueryTranslator(SessionFactoryImplementor factory, CriteriaImpl criteria, String rootEntityName, String rootSQLAlias, CriteriaQuery outerQuery)

Method Summary

Modifier and Type	Method and Description
String[]	findColumns(String propertyName, Criteria subcriteria) Get the names of the columns mapped by a property path; if the property path is not found in subcriteria, try the "outer" query.
String	generateSQLAlias() Generate a unique SQL alias
String	getColumn(Criteria criteria, String propertyName) Resolve a property path to the name of the column it maps to.
String[]	getColumns(String propertyName, Criteria subcriteria) Resolve a property path to the names of the columns it maps to.
String[]	getColumnsUsingProjection(Criteria subcriteria, String propertyName) Get the names of the columns constrained by this criterion.
Criteria	getCriteria(String path)
String	getEntityName(Criteria criteria) Get the entity name of an entity
String	getEntityName(Criteria subcriteria, String propertyName) Get the entity name of an entity, taking into account the qualifier of the property path
SessionFactoryImplementor	getFactory() Provides access to the SessionFactory
String	getGroupBy()
String[]	getIdentifierColumns(Criteria criteria) Get the identifier column names of this entity
Type	getIdentifierType(Criteria criteria) Get the identifier type of this entity
JoinType	getJoinType(String path)
String	getOrderBy()
String[]	getProjectedAliases()
String[]	getProjectedColumnAliases()
Type[]	getProjectedTypes()
String	getPropertyName(String propertyName) Get the property name, given a possibly qualified property name
QueryParameters	getQueryParameters()
Set<Serializable>	getQuerySpaces()
CriteriaImpl	getRootCriteria()
String	getRootSQLALias()
String	getSelect()
String	getSQLAlias(Criteria criteria) Get the root table alias of an entity
String	getSQLAlias(Criteria criteria, String propertyName) Get the root table alias of an entity, taking into account the qualifier of the property path
int	getSQLAliasCount()
Type	getType(Criteria subcriteria, String propertyName) Get the type of a property path.
TypedValue	getTypedIdentifierValue(Criteria criteria, Object value) Build a TypedValue for the given identifier value.
TypedValue	getTypedValue(Criteria subcriteria, String propertyName, Object value) Get the a typed value for the given property value.
Type	getTypeUsingProjection(Criteria subcriteria, String propertyName) Get the type of a property path.
String	getWhereCondition()
String	getWithClause(String path)
boolean	hasProjection()
boolean	hasRestriction(String path)
boolean	isJoin(String path)

Methods inherited from class java.lang.Object

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

Field Detail

ROOT_SQL_ALIAS

public static final String ROOT_SQL_ALIAS

See Also:

Constant Field Values

Constructor Detail

CriteriaQueryTranslator

public CriteriaQueryTranslator(SessionFactoryImplementor factory,
                               CriteriaImpl criteria,
                               String rootEntityName,
                               String rootSQLAlias,
                               CriteriaQuery outerQuery)
                        throws HibernateException

Throws:

HibernateException

CriteriaQueryTranslator

public CriteriaQueryTranslator(SessionFactoryImplementor factory,
                               CriteriaImpl criteria,
                               String rootEntityName,
                               String rootSQLAlias)
                        throws HibernateException

Throws:

HibernateException

Method Detail

generateSQLAlias

public String generateSQLAlias()

Description copied from interface: CriteriaQuery

Generate a unique SQL alias

Specified by:

generateSQLAlias in interface CriteriaQuery

Returns:

The generated alias

getRootSQLALias

public String getRootSQLALias()

isJoin

public boolean isJoin(String path)

getJoinType

public JoinType getJoinType(String path)

getCriteria

public Criteria getCriteria(String path)

getQuerySpaces

public Set<Serializable> getQuerySpaces()

getSQLAliasCount

public int getSQLAliasCount()

getRootCriteria

public CriteriaImpl getRootCriteria()

getQueryParameters

public QueryParameters getQueryParameters()

hasProjection

public boolean hasProjection()

getGroupBy

public String getGroupBy()

getSelect

public String getSelect()

getProjectedTypes

public Type[] getProjectedTypes()

getProjectedColumnAliases

public String[] getProjectedColumnAliases()

getProjectedAliases

public String[] getProjectedAliases()

getWhereCondition

public String getWhereCondition()

getOrderBy

public String getOrderBy()

getFactory

public SessionFactoryImplementor getFactory()

Description copied from interface: CriteriaQuery

Provides access to the SessionFactory

Specified by:

getFactory in interface CriteriaQuery

Returns:

The SessionFactory

getSQLAlias

public String getSQLAlias(Criteria criteria)

Description copied from interface: CriteriaQuery

Get the root table alias of an entity

Specified by:

getSQLAlias in interface CriteriaQuery

Parameters:

criteria - The criteria

Returns:

The SQL table alias for the given criteria

getEntityName

public String getEntityName(Criteria criteria)

Description copied from interface: CriteriaQuery

Get the entity name of an entity

Specified by:

getEntityName in interface CriteriaQuery

Parameters:

criteria - The criteria

Returns:

The entity name

getColumn

public String getColumn(Criteria criteria,
                        String propertyName)

Description copied from interface: CriteriaQuery

Resolve a property path to the name of the column it maps to. Ignores projection aliases.

Specified by:

getColumn in interface CriteriaQuery

Parameters:

criteria - The overall criteria

propertyName - The property path to resolve

Returns:

The column name

See Also:

CriteriaQuery.getColumns(java.lang.String, org.hibernate.Criteria)

getColumnsUsingProjection

public String[] getColumnsUsingProjection(Criteria subcriteria,
                                          String propertyName)
                                   throws HibernateException

Get the names of the columns constrained by this criterion.

Specified by:

getColumnsUsingProjection in interface CriteriaQuery

Parameters:

subcriteria - The criteria

propertyName - The property path to resolve or projection alias

Returns:

The column names

Throws:

HibernateException - if the property/alias could not be resolved

getIdentifierColumns

public String[] getIdentifierColumns(Criteria criteria)

Description copied from interface: CriteriaQuery

Get the identifier column names of this entity

Specified by:

getIdentifierColumns in interface CriteriaQuery

Parameters:

criteria - The criteria

Returns:

The identifier column names

getIdentifierType

public Type getIdentifierType(Criteria criteria)

Description copied from interface: CriteriaQuery

Get the identifier type of this entity

Specified by:

getIdentifierType in interface CriteriaQuery

Parameters:

criteria - The criteria

Returns:

The identifier type.

getTypedIdentifierValue

public TypedValue getTypedIdentifierValue(Criteria criteria,
                                          Object value)

Description copied from interface: CriteriaQuery

Build a TypedValue for the given identifier value.

Specified by:

getTypedIdentifierValue in interface CriteriaQuery

Parameters:

criteria - The criteria whose identifier is referenced.

value - The identifier value

Returns:

The TypedValue

getColumns

public String[] getColumns(String propertyName,
                           Criteria subcriteria)
                    throws HibernateException

Description copied from interface: CriteriaQuery

Resolve a property path to the names of the columns it maps to. Ignores projection aliases

Specified by:

getColumns in interface CriteriaQuery

Parameters:

propertyName - The property path to resolve

subcriteria - The criteria

Returns:

The column names

Throws:

HibernateException - if the property maps to more than 1 column, or if the property could not be resolved

findColumns

public String[] findColumns(String propertyName,
                            Criteria subcriteria)
                     throws HibernateException

Get the names of the columns mapped by a property path; if the property path is not found in subcriteria, try the "outer" query. Projection aliases are ignored.

Specified by:

findColumns in interface CriteriaQuery

Parameters:

propertyName - The property path to resolve

subcriteria - The criteria

Returns:

The column names

Throws:

HibernateException - if the property could not be resolved

getTypeUsingProjection

public Type getTypeUsingProjection(Criteria subcriteria,
                                   String propertyName)
                            throws HibernateException

Description copied from interface: CriteriaQuery

Get the type of a property path. Here, the property path can refer to a projection alias.

Specified by:

getTypeUsingProjection in interface CriteriaQuery

Parameters:

subcriteria - The criteria

propertyName - The property path to resolve or projection alias

Returns:

The type

Throws:

HibernateException - if the property/alias could not be resolved

getType

public Type getType(Criteria subcriteria,
                    String propertyName)
             throws HibernateException

Description copied from interface: CriteriaQuery

Get the type of a property path.

Specified by:

getType in interface CriteriaQuery

Parameters:

subcriteria - The criteria

propertyName - The property path to resolve

Returns:

The type

Throws:

HibernateException - if the property could not be resolved

getTypedValue

public TypedValue getTypedValue(Criteria subcriteria,
                                String propertyName,
                                Object value)
                         throws HibernateException

Get the a typed value for the given property value.

Specified by:

getTypedValue in interface CriteriaQuery

Parameters:

subcriteria - The criteria query

propertyName - The property path/alias to resolve to type.

value - The value

Returns:

The TypedValue

Throws:

HibernateException - if the property/alias could not be resolved

getEntityName

public String getEntityName(Criteria subcriteria,
                            String propertyName)

Description copied from interface: CriteriaQuery

Get the entity name of an entity, taking into account the qualifier of the property path

Specified by:

getEntityName in interface CriteriaQuery

Parameters:

subcriteria - The criteria

propertyName - The property path that (supposedly) references an entity

Returns:

The entity name

getSQLAlias

public String getSQLAlias(Criteria criteria,
                          String propertyName)

Description copied from interface: CriteriaQuery

Get the root table alias of an entity, taking into account the qualifier of the property path

Specified by:

getSQLAlias in interface CriteriaQuery

Parameters:

criteria - The criteria

propertyName - The property path whose SQL alias should be returned.

Returns:

The SQL table alias for the given criteria

getPropertyName

public String getPropertyName(String propertyName)

Description copied from interface: CriteriaQuery

Get the property name, given a possibly qualified property name

Specified by:

getPropertyName in interface CriteriaQuery

Parameters:

propertyName - The (possibly qualified) property name

Returns:

The simple property name

getWithClause

public String getWithClause(String path)

hasRestriction

public boolean hasRestriction(String path)