public interface CriteriaQuery
An instance of <tt>CriteriaQuery</tt> is passed to criterion, order and projection instances when actually compiling and executing the query. This interface is not used by application code.
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.
|
SessionFactoryImplementor getFactory()
Provides access to the SessionFactory
String getColumn(Criteria criteria, String propertyPath) throws HibernateException
Resolve a property path to the name of the column it maps to. Ignores projection aliases.
criteria
- The overall criteriapropertyPath
- The property path to resolveHibernateException
- if the property maps to more than 1 column, or if the property could not be resolvedgetColumns(java.lang.String, org.hibernate.Criteria)
String[] getColumns(String propertyPath, Criteria criteria) throws HibernateException
Resolve a property path to the names of the columns it maps to. Ignores projection aliases
criteria
- The criteriapropertyPath
- The property path to resolveHibernateException
- if the property maps to more than 1 column, or if the property could not be resolvedString[] 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.
criteria
- The criteriapropertyPath
- The property path to resolveHibernateException
- if the property could not be resolvedType getType(Criteria criteria, String propertyPath) throws HibernateException
Get the type of a property path.
criteria
- The criteriapropertyPath
- The property path to resolveHibernateException
- if the property could not be resolvedString[] 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.
criteria
- The criteriapropertyPath
- The property path to resolve or projection aliasHibernateException
- if the property/alias could not be resolvedType getTypeUsingProjection(Criteria criteria, String propertyPath) throws HibernateException
Get the type of a property path. Here, the property path can refer to a projection alias.
criteria
- The criteriapropertyPath
- The property path to resolve or projection aliasHibernateException
- if the property/alias could not be resolvedTypedValue 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)
.
criteria
- The criteria querypropertyPath
- The property path/alias to resolve to type.value
- The valueHibernateException
- if the property/alias could not be resolvedString getEntityName(Criteria criteria)
Get the entity name of an entity
criteria
- The criteriaString getEntityName(Criteria criteria, String propertyPath)
Get the entity name of an entity, taking into account the qualifier of the property path
criteria
- The criteriapropertyPath
- The property path that (supposedly) references an entityString getSQLAlias(Criteria criteria)
Get the root table alias of an entity
criteria
- The criteriaString getSQLAlias(Criteria criteria, String propertyPath)
Get the root table alias of an entity, taking into account the qualifier of the property path
criteria
- The criteriapropertyPath
- The property path whose SQL alias should be returned.String getPropertyName(String propertyName)
Get the property name, given a possibly qualified property name
propertyName
- The (possibly qualified) property nameString[] getIdentifierColumns(Criteria criteria)
Get the identifier column names of this entity
criteria
- The criteriaType getIdentifierType(Criteria criteria)
Get the identifier type of this entity
criteria
- The criteriaTypedValue getTypedIdentifierValue(Criteria criteria, Object value)
Build a TypedValue for the given identifier value.
criteria
- The criteria whose identifier is referenced.value
- The identifier valueString generateSQLAlias()
Generate a unique SQL alias
Copyright © 2001-2018 Red Hat, Inc. All Rights Reserved.