org.hibernate.criterion

Interface CriteriaQuery

All Known Implementing Classes:

CriteriaQueryTranslator

public interface CriteriaQuery

An instance of CriteriaQuery is passed to criterion, order and projection instances when actually compiling and executing the query. This interface is not used by application code.

Author:

Gavin King

Method Summary

Modifier and Type	Method and Description
String[]	findColumns(String propertyPath, Criteria criteria) Get the names of the columns mapped by a property path; if the property path is not found in criteria, try the "outer" query.
String	generateSQLAlias() Generate a unique SQL alias
String	getColumn(Criteria criteria, String propertyPath) Resolve a property path to the name of the column it maps to.
String[]	getColumns(String propertyPath, Criteria criteria) Resolve a property path to the names of the columns it maps to.
String[]	getColumnsUsingProjection(Criteria criteria, String propertyPath) Get the names of the columns mapped by a property path.
String	getEntityName(Criteria criteria) Get the entity name of an entity
String	getEntityName(Criteria criteria, String propertyPath) Get the entity name of an entity, taking into account the qualifier of the property path
SessionFactoryImplementor	getFactory() Provides access to the SessionFactory
String[]	getIdentifierColumns(Criteria criteria) Get the identifier column names of this entity
Type	getIdentifierType(Criteria criteria) Get the identifier type of this entity
String	getPropertyName(String propertyName) Get the property name, given a possibly qualified property name
String	getSQLAlias(Criteria criteria) Get the root table alias of an entity
String	getSQLAlias(Criteria criteria, String propertyPath) Get the root table alias of an entity, taking into account the qualifier of the property path
Type	getType(Criteria criteria, String propertyPath) Get the type of a property path.
TypedValue	getTypedIdentifierValue(Criteria criteria, Object value) Build a TypedValue for the given identifier value.
TypedValue	getTypedValue(Criteria criteria, String propertyPath, Object value) Build a typed-value for the property/value combo.
Type	getTypeUsingProjection(Criteria criteria, String propertyPath) Get the type of a property path.

Method Detail

getFactory

SessionFactoryImplementor getFactory()

Provides access to the SessionFactory

Returns:

The SessionFactory

getColumn

String getColumn(Criteria criteria,
                 String propertyPath)
          throws HibernateException

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

Parameters:

criteria - The overall criteria

propertyPath - The property path to resolve

Returns:

The column name

Throws:

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

See Also:

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

getColumns

String[] getColumns(String propertyPath,
                    Criteria criteria)
             throws HibernateException

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

Parameters:

criteria - The criteria

propertyPath - The property path to resolve

Returns:

The column names

Throws:

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

findColumns

String[] findColumns(String propertyPath,
                     Criteria criteria)
              throws HibernateException

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

Parameters:

criteria - The criteria

propertyPath - The property path to resolve

Returns:

The column names

Throws:

HibernateException - if the property could not be resolved

getType

Type getType(Criteria criteria,
             String propertyPath)
      throws HibernateException

Get the type of a property path.

Parameters:

criteria - The criteria

propertyPath - The property path to resolve

Returns:

The type

Throws:

HibernateException - if the property could not be resolved

getColumnsUsingProjection

String[] getColumnsUsingProjection(Criteria criteria,
                                   String propertyPath)
                            throws HibernateException

Get the names of the columns mapped by a property path. Here, the property path can refer to a projection alias.

Parameters:

criteria - The criteria

propertyPath - The property path to resolve or projection alias

Returns:

The column names

Throws:

HibernateException - if the property/alias could not be resolved

getTypeUsingProjection

Type getTypeUsingProjection(Criteria criteria,
                            String propertyPath)
                     throws HibernateException

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

Parameters:

criteria - The criteria

propertyPath - The property path to resolve or projection alias

Returns:

The type

Throws:

HibernateException - if the property/alias could not be resolved

getTypedValue

TypedValue getTypedValue(Criteria criteria,
                         String propertyPath,
                         Object value)
                  throws HibernateException

Build a typed-value for the property/value combo. Essentially the same as manually building a TypedValue using the given value and the resolved type using getTypeUsingProjection(org.hibernate.Criteria, java.lang.String).

Parameters:

criteria - The criteria query

propertyPath - 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

String getEntityName(Criteria criteria)

Get the entity name of an entity

Parameters:

criteria - The criteria

Returns:

The entity name

getEntityName

String getEntityName(Criteria criteria,
                     String propertyPath)

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

Parameters:

criteria - The criteria

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

Returns:

The entity name

getSQLAlias

String getSQLAlias(Criteria criteria)

Get the root table alias of an entity

Parameters:

criteria - The criteria

Returns:

The SQL table alias for the given criteria

getSQLAlias

String getSQLAlias(Criteria criteria,
                   String propertyPath)

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

Parameters:

criteria - The criteria

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

Returns:

The SQL table alias for the given criteria

getPropertyName

String getPropertyName(String propertyName)

Get the property name, given a possibly qualified property name

Parameters:

propertyName - The (possibly qualified) property name

Returns:

The simple property name

getIdentifierColumns

String[] getIdentifierColumns(Criteria criteria)

Get the identifier column names of this entity

Parameters:

criteria - The criteria

Returns:

The identifier column names

getIdentifierType

Type getIdentifierType(Criteria criteria)

Get the identifier type of this entity

Parameters:

criteria - The criteria

Returns:

The identifier type.

getTypedIdentifierValue

TypedValue getTypedIdentifierValue(Criteria criteria,
                                   Object value)

Build a TypedValue for the given identifier value.

Parameters:

criteria - The criteria whose identifier is referenced.

value - The identifier value

Returns:

The TypedValue

generateSQLAlias

String generateSQLAlias()

Generate a unique SQL alias

Returns:

The generated alias