Package org.hibernate.query.spi

Interface QueryProducerImplementor

All Superinterfaces:

QueryProducer

All Known Subinterfaces:

EventSource, SessionImplementor, SharedSessionContractImplementor

All Known Implementing Classes:

AbstractDelegateSessionImplementor, AbstractSharedSessionContract, SessionDelegatorBaseImpl, SessionImpl, SharedSessionDelegatorBaseImpl, StatelessSessionImpl, ToOneDelegateSessionImplementor

public interface QueryProducerImplementor
extends QueryProducer

The internal contract for QueryProducer implementations. Acts as the value passed to produced queries and provides them with access to needed functionality.

Method Summary

Modifier and Type	Method	Description
MutationQuery	createMutationQuery(CriteriaDelete deleteQuery)	Create a MutationQuery from the given delete criteria tree
MutationQuery	createMutationQuery(CriteriaUpdate updateQuery)	Create a MutationQuery from the given update criteria tree
MutationQuery	createMutationQuery(String statementString)	Create a MutationQuery reference for the given HQL insert, update, or delete statement.
MutationQuery	createNamedMutationQuery(String name)	Create a MutationQuery instance for the given named insert, update, or delete HQL query.
QueryImplementor	createNamedQuery(String name)	Deprecated.
<R> QueryImplementor<R>	createNamedQuery(String name, Class<R> resultClass)	Create a typed Query instance for the given named query.
MutationQuery	createNativeMutationQuery(String sqlString)	Create a NativeQuery instance for the given native SQL statement.
NativeQueryImplementor	createNativeQuery(String sqlString)	Deprecated.
<R> NativeQueryImplementor<R>	createNativeQuery(String sqlString, Class<R> resultClass)	Create a NativeQuery instance for the given native SQL query using an implicit mapping to the specified Java type.
<R> NativeQueryImplementor<R>	createNativeQuery(String sqlString, Class<R> resultClass, String tableAlias)	Create a NativeQuery instance for the given native SQL query using an implicit mapping to the specified Java entity type.
NativeQueryImplementor	createNativeQuery(String sqlString, String resultSetMappingName)	Deprecated.
<R> NativeQueryImplementor<R>	createNativeQuery(String sqlString, String resultSetMappingName, Class<R> resultClass)	Create a NativeQuery instance for the given native SQL query using an explicit mapping to the specified Java type.
QueryImplementor	createQuery(CriteriaDelete deleteQuery)	Deprecated.
<R> QueryImplementor<R>	createQuery(CriteriaQuery<R> criteriaQuery)	Create a Query for the given JPA CriteriaQuery.
QueryImplementor	createQuery(CriteriaUpdate updateQuery)	Deprecated.
<R> QueryImplementor<R>	createQuery(TypedQueryReference<R> typedQueryReference)	Create a typed Query instance for the given typed query reference.
QueryImplementor	createQuery(String queryString)	Deprecated.
<R> QueryImplementor<R>	createQuery(String queryString, Class<R> resultClass)	Create a typed Query instance for the given HQL query string and given query result type.
CacheMode	getCacheMode()
SessionFactoryImplementor	getFactory()
FlushMode	getHibernateFlushMode()
NativeQueryImplementor	getNamedNativeQuery(String name)	Deprecated.
NativeQueryImplementor	getNamedNativeQuery(String name, String resultSetMapping)	Deprecated.
QueryImplementor	getNamedQuery(String queryName)	Create a Query instance for the named query.

Methods inherited from interface org.hibernate.query.QueryProducer

createMutationQuery, createMutationQuery, createNamedSelectionQuery, createNamedSelectionQuery, createSelectionQuery, createSelectionQuery, createSelectionQuery

Method Details

getFactory

SessionFactoryImplementor getFactory()

getHibernateFlushMode

FlushMode getHibernateFlushMode()

getCacheMode

CacheMode getCacheMode()

getNamedQuery

QueryImplementor getNamedQuery(String queryName)

Description copied from interface: QueryProducer

Create a Query instance for the named query.

Specified by:

getNamedQuery in interface QueryProducer

Parameters:

queryName - the name of a predefined named query

Returns:

The Query instance for manipulation and execution

createQuery

@Deprecated
QueryImplementor createQuery(String queryString)

Deprecated.

Description copied from interface: QueryProducer

Create a Query instance for the given HQL query, or HQL insert, update, or delete statement.

If a query has no explicit select list, the select list is inferred:

• if there is exactly one root entity in the from clause, and it has no non-fetch joins, then that root entity is the only element of the select list, or
• if there is an entity with the alias this, then that entity is the only element of the select list, or
• otherwise, the query is considered ambiguous, and this method throws a SemanticException.

The query must have an explicit from clause, which can never be inferred.

Specified by:

createQuery in interface QueryProducer

Parameters:

queryString - The HQL query

Returns:

The Query instance for manipulation and execution

See Also:

• EntityManager.createQuery(String)

createQuery

<R> QueryImplementor<R> createQuery(String queryString,
 Class<R> resultClass)

Description copied from interface: QueryProducer

Create a typed Query instance for the given HQL query string and given query result type.

• If the query has a single item in the select list, then the select item must be assignable to the given result type.
• Otherwise, if there are multiple select items, then the select items will be packaged into an instance of the result type. The result type must have an appropriate constructor with parameter types matching the select items, or it must be one of the types Object[], List, Map, or Tuple.

If a query has no explicit select list, the select list is inferred from the given query result type:

• if the result type is an entity type, the query must have exactly one root entity in the from clause, it must be assignable to the result type, and the inferred select list will contain just that entity, or
• otherwise, the select list contains every root entity and every non-fetch joined entity, and each query result will be packaged into an instance of the result type, just as specified above.

If a query has no explicit from clause, and the given result type is an entity type, the root entity is inferred to be the result type.

Passing Object.class as the query result type is not recommended. In this special case, this method has the same semantics as the overload QueryProducer.createQuery(String).

The returned Query may be executed by calling Query.getResultList() or Query.getSingleResult().

Specified by:

createQuery in interface QueryProducer

Parameters:

queryString - The HQL query

resultClass - The Class object representing the query result type, which should not be Object.class

Returns:

The Query instance for manipulation and execution

See Also:

• EntityManager.createQuery(String,Class)

createQuery

<R> QueryImplementor<R> createQuery(TypedQueryReference<R> typedQueryReference)

Description copied from interface: QueryProducer

Create a typed Query instance for the given typed query reference.

Specified by:

createQuery in interface QueryProducer

Parameters:

typedQueryReference - the type query reference

Returns:

The Query instance for execution

See Also:

• EntityManager.createQuery(TypedQueryReference)

createNamedQuery

@Deprecated
QueryImplementor createNamedQuery(String name)

Deprecated.

Description copied from interface: QueryProducer

Create a typed Query instance for the given named query. The named query might be defined in HQL or in native SQL.

Specified by:

createNamedQuery in interface QueryProducer

Parameters:

name - the name of a predefined named query

Returns:

The Query instance for manipulation and execution

See Also:

• EntityManager.createNamedQuery(String)

createNamedQuery

<R> QueryImplementor<R> createNamedQuery(String name,
 Class<R> resultClass)

Description copied from interface: QueryProducer

Create a typed Query instance for the given named query. The named query might be defined in HQL or in native SQL.

Specified by:

createNamedQuery in interface QueryProducer

Parameters:

name - the name of a query defined in metadata

resultClass - the type of the query result

Returns:

The Query instance for manipulation and execution

See Also:

• EntityManager.createNamedQuery(String,Class)

createNativeQuery

@Deprecated
NativeQueryImplementor createNativeQuery(String sqlString)

Deprecated.

Description copied from interface: QueryProducer

Create a NativeQuery instance for the given native SQL query.

Specified by:

createNativeQuery in interface QueryProducer

Parameters:

sqlString - a native SQL query string

Returns:

The NativeQuery instance for manipulation and execution

See Also:

• EntityManager.createNativeQuery(String)

createNativeQuery

<R> NativeQueryImplementor<R> createNativeQuery(String sqlString,
 Class<R> resultClass)

Description copied from interface: QueryProducer

Create a NativeQuery instance for the given native SQL query using an implicit mapping to the specified Java type.

• If the given class is an entity class, this method is equivalent to createNativeQuery(sqlString).addEntity(resultClass).
• If the given class has a registered JavaType, then the query must return a result set with a single column whose JdbcType is compatible with that JavaType.
• Otherwise, the select items will be packaged into an instance of the result type. The result type must have an appropriate constructor with parameter types matching the select items, or it must be one of the types Object[], List, Map, or Tuple.

Specified by:

createNativeQuery in interface QueryProducer

Parameters:

sqlString - The native (SQL) query string

resultClass - The Java type to map results to

Returns:

The NativeQuery instance for manipulation and execution

See Also:

• EntityManager.createNativeQuery(String,Class)

createNativeQuery

<R> NativeQueryImplementor<R> createNativeQuery(String sqlString,
 Class<R> resultClass,
 String tableAlias)

Description copied from interface: QueryProducer

Create a NativeQuery instance for the given native SQL query using an implicit mapping to the specified Java entity type.

The given class must be an entity class. This method is equivalent to createNativeQuery(sqlString).addEntity(tableAlias, resultClass).

Specified by:

createNativeQuery in interface QueryProducer

Parameters:

sqlString - Native (SQL) query string

resultClass - The Java entity class to map results to

tableAlias - The table alias for columns in the result set

Returns:

The NativeQuery instance for manipulation and execution

See Also:

• EntityManager.createNativeQuery(String,Class)

createNativeQuery

@Deprecated
NativeQueryImplementor createNativeQuery(String sqlString,
 String resultSetMappingName)

Deprecated.

Description copied from interface: QueryProducer

Create a NativeQuery instance for the given native SQL query using an explicit mapping to the specified Java type.

The given result set mapping name must identify a mapping defined by a SqlResultSetMapping annotation.

Specified by:

createNativeQuery in interface QueryProducer

Parameters:

sqlString - The native (SQL) query string

resultSetMappingName - The explicit result mapping name

Returns:

The NativeQuery instance for manipulation and execution

See Also:

• EntityManager.createNativeQuery(String,Class)
• SqlResultSetMapping

createNativeQuery

<R> NativeQueryImplementor<R> createNativeQuery(String sqlString,
 String resultSetMappingName,
 Class<R> resultClass)

Description copied from interface: QueryProducer

Create a NativeQuery instance for the given native SQL query using an explicit mapping to the specified Java type.

The given result set mapping name must identify a mapping defined by a SqlResultSetMapping annotation.

Specified by:

createNativeQuery in interface QueryProducer

Parameters:

sqlString - The native (SQL) query string

resultSetMappingName - The explicit result mapping name

Returns:

The NativeQuery instance for manipulation and execution

See Also:

• EntityManager.createNativeQuery(String,Class)
• SqlResultSetMapping

getNamedNativeQuery

@Deprecated
NativeQueryImplementor getNamedNativeQuery(String name)

Deprecated.

Description copied from interface: QueryProducer

Get a NativeQuery instance for a named native SQL query

Specified by:

getNamedNativeQuery in interface QueryProducer

Parameters:

name - The name of the predefined query

Returns:

The NativeQuery instance for manipulation and execution

getNamedNativeQuery

@Deprecated
NativeQueryImplementor getNamedNativeQuery(String name,
 String resultSetMapping)

Deprecated.

Description copied from interface: QueryProducer

Get a NativeQuery instance for a named native SQL query

Specified by:

getNamedNativeQuery in interface QueryProducer

Parameters:

name - The name of the predefined query

Returns:

The NativeQuery instance for manipulation and execution

createMutationQuery

MutationQuery createMutationQuery(String statementString)

Description copied from interface: QueryProducer

Create a MutationQuery reference for the given HQL insert, update, or delete statement.

Specified by:

createMutationQuery in interface QueryProducer

Parameters:

statementString - The HQL insert, update, or delete statement

createNamedMutationQuery

MutationQuery createNamedMutationQuery(String name)

Description copied from interface: QueryProducer

Create a MutationQuery instance for the given named insert, update, or delete HQL query. The named query might be defined as HQL) or native-SQL.

Specified by:

createNamedMutationQuery in interface QueryProducer

createNativeMutationQuery

MutationQuery createNativeMutationQuery(String sqlString)

Description copied from interface: QueryProducer

Create a NativeQuery instance for the given native SQL statement.

Specified by:

createNativeMutationQuery in interface QueryProducer

Parameters:

sqlString - a native SQL statement string

Returns:

The NativeQuery instance for manipulation and execution

createMutationQuery

MutationQuery createMutationQuery(CriteriaUpdate updateQuery)

Description copied from interface: QueryProducer

Create a MutationQuery from the given update criteria tree

Specified by:

createMutationQuery in interface QueryProducer

createMutationQuery

MutationQuery createMutationQuery(CriteriaDelete deleteQuery)

Description copied from interface: QueryProducer

Create a MutationQuery from the given delete criteria tree

Specified by:

createMutationQuery in interface QueryProducer

createQuery

<R> QueryImplementor<R> createQuery(CriteriaQuery<R> criteriaQuery)

Description copied from interface: QueryProducer

Create a Query for the given JPA CriteriaQuery.

Specified by:

createQuery in interface QueryProducer

createQuery

@Deprecated
QueryImplementor createQuery(CriteriaUpdate updateQuery)

Deprecated.

Description copied from interface: QueryProducer

Create a MutationQuery for the given JPA CriteriaUpdate

Specified by:

createQuery in interface QueryProducer

createQuery

@Deprecated
QueryImplementor createQuery(CriteriaDelete deleteQuery)

Deprecated.

Description copied from interface: QueryProducer

Create a MutationQuery for the given JPA CriteriaDelete

Specified by:

createQuery in interface QueryProducer