Package org.hibernate.procedure.internal

Class ProcedureCallImpl<R>

java.lang.Object

org.hibernate.query.spi.AbstractCommonQueryContract

org.hibernate.query.spi.AbstractSelectionQuery<R>

org.hibernate.query.spi.AbstractQuery<R>

org.hibernate.procedure.internal.ProcedureCallImpl<R>

All Implemented Interfaces:

Query, StoredProcedureQuery, TypedQuery<R>, AutoCloseable, ProcedureCall, ProcedureCallImplementor<R>, CommonQueryContract, MutationQuery, NameableQuery, Query<R>, SelectionQuery<R>, DomainQueryExecutionContext, QueryImplementor<R>, SynchronizeableQuery, ResultContext

public class ProcedureCallImpl<R>
extends AbstractQuery<R>
implements ProcedureCallImplementor<R>, ResultContext

Standard implementation of ProcedureCall

Field Summary

Fields inherited from class org.hibernate.query.spi.AbstractSelectionQuery

CRITERIA_HQL_STRING

Fields inherited from interface org.hibernate.procedure.ProcedureCall

FUNCTION_RETURN_TYPE_HINT

Constructor Summary

Constructors

Constructor	Description
ProcedureCallImpl(SharedSessionContractImplementor session, String procedureName)	The no-returns form.
ProcedureCallImpl(SharedSessionContractImplementor session, String procedureName, Class<?>... resultClasses)	The result Class(es) return form
ProcedureCallImpl(SharedSessionContractImplementor session, String procedureName, String... resultSetMappingNames)	The result-set-mapping(s) return form
ProcedureCallImpl(SharedSessionContractImplementor session, NamedCallableQueryMementoImpl memento, String... resultSetMappingNames)

Method Summary

Modifier and Type	Method	Description
ProcedureCallImplementor<R>	addSynchronizedEntityClass(Class entityClass)	Add all query spaces associated with the entity with the given type.
ProcedureCallImplementor<R>	addSynchronizedEntityName(String entityName)	Add all query spaces associated with the entity with the given names.
ProcedureCallImplementor<R>	addSynchronizedQuerySpace(String querySpace)	Add a query space.
protected void	addSynchronizedQuerySpaces(EntityPersister persister)
Query<R>	applyGraph(RootGraph graph, GraphSemantic semantic)	Apply the given graph using the given semantic
protected void	applyGraph(RootGraphImplementor<?> entityGraph, GraphSemantic graphSemantic)
protected int	doExecuteUpdate()
protected List<R>	doList()
protected ScrollableResultsImplementor<R>	doScroll(ScrollMode scrollMode)
boolean	execute()
FunctionReturnImplementor<R>	getFunctionReturn()	The FunctionReturn describing the return value of the function, or null if this ProcedureCall is not a function call.
KeyedResultList<R>	getKeyedResultList(KeyedPage<R> page)	Execute the query and return the results for the given page, using key-based pagination.
LockModeType	getLockMode()	Get the root LockModeType for the query
Object	getOutputParameterValue(int position)
Object	getOutputParameterValue(String parameterName)
ProcedureOutputs	getOutputs()	Retrieves access to outputs of this procedure call.
QueryParameterBindings	getParameterBindings()
ProcedureParameterMetadataImpl	getParameterMetadata()	Get the ParameterMetadata object representing the parameters of this query, and providing access to the QueryParameters.
ProcedureParameterImplementor<?>	getParameterRegistration(int position)	Retrieve a previously registered parameter memento by the position under which it was registered.
ProcedureParameterImplementor<?>	getParameterRegistration(String name)	Retrieve a previously registered parameter memento by the name under which it was registered.
ParameterStrategy	getParameterStrategy()
String	getProcedureName()	Get the name of the stored procedure (or function) to be called.
MutableQueryOptions	getQueryOptions()	Get the execution options for this Query.
QueryParameterBindings	getQueryParameterBindings()	The domain parameter bindings
String	getQueryString()	The query as a string, or null in the case of a criteria query.
List<ProcedureParameter<?>>	getRegisteredParameters()	Retrieve all registered parameters.
long	getResultCount()	Determine the size of the query result list that would be returned by calling SelectionQuery.getResultList() with no offset or limit applied to the query.
List<R>	getResultList()	Execute the query and return the query results as a List.
ResultSetMapping	getResultSetMapping()
Stream<R>	getResultStream()	Execute the query and return the query results as a Stream.
R	getSingleResult()	Execute the query and return the single result of the query, throwing an exception if the query returns no results.
R	getSingleResultOrNull()	Execute the query and return the single result of the query, or null if the query returns no results.
Set<String>	getSynchronizedQuerySpaces()	Obtain the list of query spaces this query is synchronized with.
int	getUpdateCount()
boolean	hasMoreResults()
boolean	isFunctionCall()	Does this ProcedureCall represent a call to a database FUNCTION, as opposed to a PROCEDURE?
ProcedureCallImplementor<R>	markAsFunctionCall(int sqlType)	Mark this ProcedureCall as representing a call to a database function, rather than a database procedure.
ProcedureCall	markAsFunctionCall(Type<?> typeReference)	Mark this ProcedureCall as representing a call to a database function, rather than a database procedure.
ProcedureCallImpl<R>	markAsFunctionCall(Class<?> resultType)	Mark this ProcedureCall as representing a call to a database function, rather than a database procedure.
protected ProcedureOutputs	outputs()
<T> ProcedureParameter<T>	registerParameter(int position, Type<T> typeReference, ParameterMode mode)	Basic form for registering a positional parameter.
<T> ProcedureParameter<T>	registerParameter(int position, Class<T> javaType, ParameterMode mode)	Basic form for registering a positional parameter.
<T> ProcedureParameterImplementor<T>	registerParameter(String name, Type<T> typeReference, ParameterMode mode)	Basic form for registering a named parameter.
<T> ProcedureParameterImplementor<T>	registerParameter(String name, Class<T> javaType, ParameterMode mode)	Basic form for registering a named parameter.
ProcedureCallImplementor<R>	registerStoredProcedureParameter(int position, Type<?> type, ParameterMode mode)	Like ProcedureCall.registerStoredProcedureParameter(int, Class, ParameterMode) but a type reference is given instead of a class for the parameter type.
ProcedureCallImplementor<R>	registerStoredProcedureParameter(int position, Class<?> type, ParameterMode mode)
ProcedureCallImplementor<R>	registerStoredProcedureParameter(String parameterName, Type<?> type, ParameterMode mode)	Like ProcedureCall.registerStoredProcedureParameter(String, Class, ParameterMode) but a type reference is given instead of a class for the parameter type.
ProcedureCallImplementor<R>	registerStoredProcedureParameter(String parameterName, Class<?> type, ParameterMode mode)
ScrollableResultsImplementor<R>	scroll(ScrollMode scrollMode)	Returns scrollable access to the query results.
ProcedureCallImplementor<R>	setCacheRetrieveMode(CacheRetrieveMode cacheRetrieveMode)
ProcedureCallImplementor<R>	setCacheStoreMode(CacheStoreMode cacheStoreMode)
ProcedureCallImplementor<R>	setFlushMode(FlushModeType flushModeType)	Set the FlushMode to use for this query.
ProcedureCallImplementor<R>	setHint(String hintName, Object value)	Set a hint.
ProcedureCallImplementor<R>	setLockMode(LockModeType lockMode)	Specify the root LockModeType for the query
QueryImplementor<R>	setLockOptions(LockOptions lockOptions)	Deprecated.
ProcedureCallImplementor<R>	setParameter(int position, Object value)	Bind the given argument to an ordinal query parameter.
ProcedureCallImplementor<R>	setParameter(int position, Calendar value, TemporalType temporalPrecision)	Deprecated.
ProcedureCallImplementor<R>	setParameter(int position, Date value, TemporalType temporalPrecision)	Deprecated.
<P> ProcedureCallImplementor<R>	setParameter(int position, P value, Type<P> type)	Bind the given argument to an ordinal query parameter using the given Type.
ProcedureCallImplementor<R>	setParameter(Parameter<Calendar> parameter, Calendar value, TemporalType temporalPrecision)	Deprecated.
ProcedureCallImplementor<R>	setParameter(Parameter<Date> parameter, Date value, TemporalType temporalPrecision)	Deprecated.
<P> ProcedureCallImplementor<R>	setParameter(Parameter<P> parameter, P value)	Query override
ProcedureCallImplementor<R>	setParameter(String name, Object value)	Bind the given argument to a named query parameter.
ProcedureCallImplementor<R>	setParameter(String name, Calendar value, TemporalType temporalPrecision)	Deprecated.
ProcedureCallImplementor<R>	setParameter(String name, Date value, TemporalType temporalPrecision)	Deprecated.
<P> ProcedureCallImplementor<R>	setParameter(String name, P value, Type<P> type)	Bind the given argument to a named query parameter using the given Type.
<P> ProcedureCallImplementor<R>	setParameter(QueryParameter<P> parameter, P value)	Bind an argument to the query parameter represented by the given QueryParameter.
<P> ProcedureCallImplementor<R>	setParameter(QueryParameter<P> parameter, P value, Type<P> type)	Bind an argument to the query parameter represented by the given QueryParameter, using the given Type.
ProcedureCallImplementor<R>	setTimeout(Integer timeout)
Stream<R>	stream()	Execute the query and return the query results as a Stream.
protected Set<String>	synchronizedQuerySpaces()	Use this form instead of getSynchronizedQuerySpaces() when you want to make sure the underlying Set is instantiated (aka, on add)
NamedCallableQueryMemento	toMemento(String name)	Convert this query into the memento.
<T> T	unwrap(Class<T> type)

Methods inherited from class org.hibernate.query.spi.AbstractQuery

addQueryHint, applyOptions, collectHints, disableFetchProfile, enableFetchProfile, executeUpdate, getComment, getFirstResult, getLockOptions, getMaxResults, getParameters, getSupportedHints, isCacheable, prepareForExecution, resolveJdbcParameterTypeIfNecessary, setCacheable, setCacheMode, setCacheRegion, setComment, setEntityGraph, setFetchSize, setFirstResult, setHibernateFlushMode, setLockScope, setLockScope, setMaxResults, setParameter, setParameter, setParameter, setParameter, setParameter, setParameterList, setParameterList, setParameterList, setParameterList, setParameterList, setParameterList, setParameterList, setParameterList, setParameterList, setParameterList, setParameterList, setParameterList, setParameterList, setParameterList, setParameterList, setParameterList, setParameterList, setParameterList, setProperties, setProperties, setQueryFlushMode, setQueryPlanCacheable, setReadOnly, setResultListTransformer, setTimeout, setTimeout, setTupleTransformer

Methods inherited from class org.hibernate.query.spi.AbstractSelectionQuery

afterQuery, afterQuery, afterQueryHandlingFetchProfiles, beforeQuery, beforeQueryHandlingFetchProfiles, getCacheMode, getCacheRegion, getCacheRetrieveMode, getCacheStoreMode, getCallback, getFetchSize, getFlushMode, getHibernateLockMode, hasCallbackActions, isQueryPlanCacheable, isReadOnly, list, requiresTxn, resetCallback, scroll, setFollowOnLocking, setFollowOnStrategy, setHibernateLockMode, setLockMode, uniqueElement, uniqueResult, uniqueResultOptional

Methods inherited from class org.hibernate.query.spi.AbstractCommonQueryContract

applyCommentHint, applyDatabaseHint, applyEntityGraphHint, applyFlushModeHint, applyFollowOnLockingHint, applyFollowOnStrategyHint, applyGraph, applyHibernateLockMode, applyHint, applyLockModeHint, applyLockModeType, applyLockTimeoutHint, applyLockTimeoutHint, applySelectionHint, applySynchronizeSpacesHint, applyTimeoutHint, determineType, getExceptionConverter, getHibernateFlushMode, getHints, getIntegerLiteral, getMaxRows, getParameter, getParameter, getParameter, getParameter, getParameterValue, getParameterValue, getParameterValue, getQueryFlushMode, getSession, getSessionFactory, getTimeout, getTypeConfiguration, isBound, locateBinding, locateBinding, locateBinding, locateBinding, putIfNotNull, putIfNotNull

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.hibernate.query.CommonQueryContract

getFlushMode, getHibernateFlushMode, getQueryFlushMode, getTimeout

Methods inherited from interface org.hibernate.query.spi.DomainQueryExecutionContext

getResultType, getSession

Methods inherited from interface org.hibernate.procedure.ProcedureCall

close

Methods inherited from interface jakarta.persistence.Query

getCacheRetrieveMode, getCacheStoreMode, getFirstResult, getFlushMode, getHints, getMaxResults, getParameter, getParameter, getParameter, getParameter, getParameters, getParameterValue, getParameterValue, getParameterValue, getTimeout, isBound

Methods inherited from interface org.hibernate.query.Query

addQueryHint, applyFetchGraph, applyLoadGraph, disableFetchProfile, enableFetchProfile, executeUpdate, getComment, getLockOptions, list, setCacheable, setCacheMode, setCacheRegion, setComment, setEntityGraph, setFetchSize, setFirstResult, setHibernateFlushMode, setLockScope, setMaxResults, setPage, setQueryFlushMode, setReadOnly, setTimeout, setTimeout, uniqueResult, uniqueResultOptional

Methods inherited from interface org.hibernate.query.spi.QueryImplementor

getSession, scroll, setParameter, setParameter, setParameter, setParameter, setParameter, setParameterList, setParameterList, setParameterList, setParameterList, setParameterList, setParameterList, setParameterList, setParameterList, setParameterList, setParameterList, setParameterList, setParameterList, setParameterList, setParameterList, setParameterList, setParameterList, setParameterList, setParameterList, setProperties, setProperties, setResultListTransformer, setResultTransformer, setTupleTransformer

Methods inherited from interface org.hibernate.result.spi.ResultContext

getSession

Methods inherited from interface org.hibernate.query.SelectionQuery

getCacheMode, getCacheRegion, getCacheRetrieveMode, getCacheStoreMode, getFetchSize, getFirstResult, getHibernateLockMode, getMaxResults, isCacheable, isQueryPlanCacheable, isReadOnly, setFollowOnLocking, setFollowOnStrategy, setHibernateLockMode, setLockMode, setLockScope, setQueryPlanCacheable

Methods inherited from interface jakarta.persistence.StoredProcedureQuery

executeUpdate

Constructor Details

ProcedureCallImpl

public ProcedureCallImpl(SharedSessionContractImplementor session,
 String procedureName)

The no-returns form.

Parameters:

session - The session

procedureName - The name of the procedure to call

ProcedureCallImpl

public ProcedureCallImpl(SharedSessionContractImplementor session,
 String procedureName,
 Class<?>... resultClasses)

The result Class(es) return form

Parameters:

session - The session

procedureName - The name of the procedure to call

resultClasses - The classes making up the result

ProcedureCallImpl

public ProcedureCallImpl(SharedSessionContractImplementor session,
 String procedureName,
 String... resultSetMappingNames)

The result-set-mapping(s) return form

Parameters:

session - The session

procedureName - The name of the procedure to call

resultSetMappingNames - The names of the result set mappings making up the result

ProcedureCallImpl

public ProcedureCallImpl(SharedSessionContractImplementor session,
 NamedCallableQueryMementoImpl memento,
 String... resultSetMappingNames)

Method Details

getProcedureName

public String getProcedureName()

Description copied from interface: ProcedureCall

Get the name of the stored procedure (or function) to be called.

Specified by:

getProcedureName in interface ProcedureCall

Returns:

The procedure name.

getQueryOptions

public MutableQueryOptions getQueryOptions()

Description copied from interface: Query

Get the execution options for this Query. Many of the setters of this object update the state of the returned QueryOptions. This is useful because it gives access to s primitive value in its (nullable) wrapper form, rather than the primitive form as required by JPA. This allows us to distinguish whether a value has been explicitly set by the client.

Specified by:

getQueryOptions in interface DomainQueryExecutionContext

Specified by:

getQueryOptions in interface Query<R>

Specified by:

getQueryOptions in interface ResultContext

Overrides:

getQueryOptions in class AbstractQuery<R>

Returns:

Return the encapsulation of this query's options.

getParameterMetadata

public ProcedureParameterMetadataImpl getParameterMetadata()

Description copied from interface: CommonQueryContract

Get the ParameterMetadata object representing the parameters of this query, and providing access to the QueryParameters.

Specified by:

getParameterMetadata in interface CommonQueryContract

Specified by:

getParameterMetadata in interface ProcedureCallImplementor<R>

Specified by:

getParameterMetadata in class AbstractCommonQueryContract

getQueryParameterBindings

public QueryParameterBindings getQueryParameterBindings()

Description copied from interface: DomainQueryExecutionContext

The domain parameter bindings

Specified by:

getQueryParameterBindings in interface DomainQueryExecutionContext

Specified by:

getQueryParameterBindings in class AbstractCommonQueryContract

getParameterStrategy

public ParameterStrategy getParameterStrategy()

Specified by:

getParameterStrategy in interface ProcedureCallImplementor<R>

isFunctionCall

public boolean isFunctionCall()

Description copied from interface: ProcedureCall

Does this ProcedureCall represent a call to a database FUNCTION, as opposed to a PROCEDURE?

Specified by:

isFunctionCall in interface ProcedureCall

Returns:

true indicates that this ProcedureCall represents a function call; false indicates a procedure call.

getFunctionReturn

public FunctionReturnImplementor<R> getFunctionReturn()

Description copied from interface: ProcedureCall

The FunctionReturn describing the return value of the function, or null if this ProcedureCall is not a function call.

Specified by:

getFunctionReturn in interface ProcedureCall

Specified by:

getFunctionReturn in interface ProcedureCallImplementor<R>

markAsFunctionCall

public ProcedureCallImplementor<R> markAsFunctionCall(int sqlType)

Description copied from interface: ProcedureCall

Mark this ProcedureCall as representing a call to a database function, rather than a database procedure.

Specified by:

markAsFunctionCall in interface ProcedureCall

Parameters:

sqlType - The Types code for the function return

Returns:

this, for method chaining

markAsFunctionCall

public ProcedureCallImpl<R> markAsFunctionCall(Class<?> resultType)

Description copied from interface: ProcedureCall

Mark this ProcedureCall as representing a call to a database function, rather than a database procedure.

Specified by:

markAsFunctionCall in interface ProcedureCall

Parameters:

resultType - The result type for the function return

Returns:

this, for method chaining

markAsFunctionCall

public ProcedureCall markAsFunctionCall(Type<?> typeReference)

Description copied from interface: ProcedureCall

Mark this ProcedureCall as representing a call to a database function, rather than a database procedure.

Specified by:

markAsFunctionCall in interface ProcedureCall

Parameters:

typeReference - The result type for the function return

Returns:

this, for method chaining

getParameterBindings

public QueryParameterBindings getParameterBindings()

Specified by:

getParameterBindings in interface QueryImplementor<R>

registerStoredProcedureParameter

public ProcedureCallImplementor<R> registerStoredProcedureParameter(int position,
 Class<?> type,
 ParameterMode mode)

Specified by:

registerStoredProcedureParameter in interface ProcedureCall

Specified by:

registerStoredProcedureParameter in interface ProcedureCallImplementor<R>

Specified by:

registerStoredProcedureParameter in interface StoredProcedureQuery

registerStoredProcedureParameter

public ProcedureCallImplementor<R> registerStoredProcedureParameter(String parameterName,
 Class<?> type,
 ParameterMode mode)

Specified by:

registerStoredProcedureParameter in interface ProcedureCall

Specified by:

registerStoredProcedureParameter in interface ProcedureCallImplementor<R>

Specified by:

registerStoredProcedureParameter in interface StoredProcedureQuery

registerStoredProcedureParameter

public ProcedureCallImplementor<R> registerStoredProcedureParameter(int position,
 Type<?> type,
 ParameterMode mode)

Description copied from interface: ProcedureCall

Like ProcedureCall.registerStoredProcedureParameter(int, Class, ParameterMode) but a type reference is given instead of a class for the parameter type.

Specified by:

registerStoredProcedureParameter in interface ProcedureCall

Specified by:

registerStoredProcedureParameter in interface ProcedureCallImplementor<R>

registerStoredProcedureParameter

public ProcedureCallImplementor<R> registerStoredProcedureParameter(String parameterName,
 Type<?> type,
 ParameterMode mode)

Description copied from interface: ProcedureCall

Like ProcedureCall.registerStoredProcedureParameter(String, Class, ParameterMode) but a type reference is given instead of a class for the parameter type.

Specified by:

registerStoredProcedureParameter in interface ProcedureCall

Specified by:

registerStoredProcedureParameter in interface ProcedureCallImplementor<R>

registerParameter

public <T> ProcedureParameter<T> registerParameter(int position,
 Class<T> javaType,
 ParameterMode mode)

Description copied from interface: ProcedureCall

Basic form for registering a positional parameter.

Specified by:

registerParameter in interface ProcedureCall

Type Parameters:

T - The parameterized Java type of the parameter.

Parameters:

position - The position

javaType - The Java type of the parameter

mode - The parameter mode (in, out, inout)

Returns:

The parameter registration memento

registerParameter

public <T> ProcedureParameter<T> registerParameter(int position,
 Type<T> typeReference,
 ParameterMode mode)

Description copied from interface: ProcedureCall

Basic form for registering a positional parameter.

Specified by:

registerParameter in interface ProcedureCall

Type Parameters:

T - The parameterized Java type of the parameter.

Parameters:

position - The position

typeReference - The type reference of the parameter type

mode - The parameter mode (in, out, inout)

Returns:

The parameter registration memento

getParameterRegistration

public ProcedureParameterImplementor<?> getParameterRegistration(int position)

Description copied from interface: ProcedureCall

Retrieve a previously registered parameter memento by the position under which it was registered.

Specified by:

getParameterRegistration in interface ProcedureCall

Parameters:

position - The parameter position

Returns:

The parameter registration memento

registerParameter

public <T> ProcedureParameterImplementor<T> registerParameter(String name,
 Class<T> javaType,
 ParameterMode mode)

Description copied from interface: ProcedureCall

Basic form for registering a named parameter.

Specified by:

registerParameter in interface ProcedureCall

Type Parameters:

T - The parameterized Java type of the parameter.

Parameters:

name - The parameter name

javaType - The Java type of the parameter

mode - The parameter mode (in, out, inout)

Returns:

The parameter registration memento

registerParameter

public <T> ProcedureParameterImplementor<T> registerParameter(String name,
 Type<T> typeReference,
 ParameterMode mode)

Description copied from interface: ProcedureCall

Basic form for registering a named parameter.

Specified by:

registerParameter in interface ProcedureCall

Type Parameters:

T - The parameterized Java type of the parameter.

Parameters:

name - The parameter name

typeReference - The type reference of the parameter type

mode - The parameter mode (in, out, inout)

Returns:

The parameter registration memento

getParameterRegistration

public ProcedureParameterImplementor<?> getParameterRegistration(String name)

Description copied from interface: ProcedureCall

Retrieve a previously registered parameter memento by the name under which it was registered.

Specified by:

getParameterRegistration in interface ProcedureCall

Parameters:

name - The parameter name

Returns:

The parameter registration memento

getRegisteredParameters

public List<ProcedureParameter<?>> getRegisteredParameters()

Description copied from interface: ProcedureCall

Retrieve all registered parameters.

Specified by:

getRegisteredParameters in interface ProcedureCall

Returns:

The (immutable) list of all registered parameters.

getOutputs

public ProcedureOutputs getOutputs()

Description copied from interface: ProcedureCall

Retrieves access to outputs of this procedure call. Can be called multiple times, returning the same ProcedureOutputs instance each time.

If the procedure call has not actually be executed yet, it will be executed and then the ProcedureOutputs will be returned.

Specified by:

getOutputs in interface ProcedureCall

Returns:

The ProcedureOutputs representation

getQueryString

public String getQueryString()

Description copied from interface: Query

The query as a string, or null in the case of a criteria query.

Specified by:

getQueryString in interface Query<R>

Specified by:

getQueryString in class AbstractSelectionQuery<R>

synchronizedQuerySpaces

protected Set<String> synchronizedQuerySpaces()

Use this form instead of getSynchronizedQuerySpaces() when you want to make sure the underlying Set is instantiated (aka, on add)

Returns:

The spaces

getSynchronizedQuerySpaces

public Set<String> getSynchronizedQuerySpaces()

Description copied from interface: SynchronizeableQuery

Obtain the list of query spaces this query is synchronized with.

Specified by:

getSynchronizedQuerySpaces in interface ResultContext

Specified by:

getSynchronizedQuerySpaces in interface SynchronizeableQuery

Returns:

The list of query spaces upon which the query is synchronized.

addSynchronizedQuerySpace

public ProcedureCallImplementor<R> addSynchronizedQuerySpace(String querySpace)

Description copied from interface: SynchronizeableQuery

Add a query space. The effect of this call is to:

• force an auto-flush if any entity associated with the current session and mapped to the given query space has pending changes which have not yet been synchronized with the database, and
• if the result set of this query is cached, mark it for invalidation when any entity mapped to the given query space is synchronized with the database in any session.

Specified by:

addSynchronizedQuerySpace in interface ProcedureCall

Specified by:

addSynchronizedQuerySpace in interface SynchronizeableQuery

Parameters:

querySpace - The name of the query space, usually the name of a database table.

Returns:

this, for method chaining

addSynchronizedEntityName

public ProcedureCallImplementor<R> addSynchronizedEntityName(String entityName)

Description copied from interface: SynchronizeableQuery

Add all query spaces associated with the entity with the given names.

Same as SynchronizeableQuery.addSynchronizedQuerySpace(java.lang.String) for all tables mapped by the given entity.

Specified by:

addSynchronizedEntityName in interface ProcedureCall

Specified by:

addSynchronizedEntityName in interface SynchronizeableQuery

Parameters:

entityName - The name of an entity.

Returns:

this, for method chaining

addSynchronizedQuerySpaces

protected void addSynchronizedQuerySpaces(EntityPersister persister)

addSynchronizedEntityClass

public ProcedureCallImplementor<R> addSynchronizedEntityClass(Class entityClass)

Description copied from interface: SynchronizeableQuery

Add all query spaces associated with the entity with the given type.

Same as SynchronizeableQuery.addSynchronizedQuerySpace(java.lang.String) for all tables mapped by the given entity.

Specified by:

addSynchronizedEntityClass in interface ProcedureCall

Specified by:

addSynchronizedEntityClass in interface SynchronizeableQuery

Parameters:

entityClass - The class of the entity.

Returns:

this, for method chaining

toMemento

public NamedCallableQueryMemento toMemento(String name)

Description copied from interface: NameableQuery

Convert this query into the memento.

Specified by:

toMemento in interface NameableQuery

Specified by:

toMemento in interface ProcedureCallImplementor<R>

See Also:

• EntityManagerFactory.addNamedQuery(String, Query)
• NamedObjectRepository.registerNamedQuery(String, Query)

applyGraph

protected void applyGraph(RootGraphImplementor<?> entityGraph,
 GraphSemantic graphSemantic)

Overrides:

applyGraph in class AbstractCommonQueryContract

applyGraph

public Query<R> applyGraph(RootGraph graph,
 GraphSemantic semantic)

Description copied from interface: Query

Apply the given graph using the given semantic

Specified by:

applyGraph in interface Query<R>

Parameters:

graph - The graph to apply.

semantic - The semantic to use when applying the graph

execute

public boolean execute()

Specified by:

execute in interface StoredProcedureQuery

outputs

protected ProcedureOutputs outputs()

doExecuteUpdate

protected int doExecuteUpdate()

Specified by:

doExecuteUpdate in class AbstractQuery<R>

getOutputParameterValue

public Object getOutputParameterValue(int position)

Specified by:

getOutputParameterValue in interface StoredProcedureQuery

getOutputParameterValue

public Object getOutputParameterValue(String parameterName)

Specified by:

getOutputParameterValue in interface StoredProcedureQuery

hasMoreResults

public boolean hasMoreResults()

Specified by:

hasMoreResults in interface StoredProcedureQuery

getUpdateCount

public int getUpdateCount()

Specified by:

getUpdateCount in interface StoredProcedureQuery

doList

protected List<R> doList()

Specified by:

doList in class AbstractSelectionQuery<R>

getResultCount

public long getResultCount()

Description copied from interface: SelectionQuery

Determine the size of the query result list that would be returned by calling SelectionQuery.getResultList() with no offset or limit applied to the query.

Specified by:

getResultCount in interface SelectionQuery<R>

Returns:

the size of the list that would be returned

getKeyedResultList

public KeyedResultList<R> getKeyedResultList(KeyedPage<R> page)

Description copied from interface: SelectionQuery

Execute the query and return the results for the given page, using key-based pagination.

Specified by:

getKeyedResultList in interface SelectionQuery<R>

Overrides:

getKeyedResultList in class AbstractQuery<R>

Parameters:

page - the key-based specification of the page as an instance of KeyedPage

Returns:

the query results and the key of the next page as an instance of KeyedResultList

See Also:

• KeyedPage
• KeyedResultList

scroll

public ScrollableResultsImplementor<R> scroll(ScrollMode scrollMode)

Description copied from interface: SelectionQuery

Returns scrollable access to the query results. The capabilities of the returned ScrollableResults depend on the specified ScrollMode.

Specified by:

scroll in interface Query<R>

Specified by:

scroll in interface QueryImplementor<R>

Specified by:

scroll in interface SelectionQuery<R>

Overrides:

scroll in class AbstractSelectionQuery<R>

doScroll

protected ScrollableResultsImplementor<R> doScroll(ScrollMode scrollMode)

Specified by:

doScroll in class AbstractSelectionQuery<R>

getResultList

public List<R> getResultList()

Description copied from interface: Query

Execute the query and return the query results as a List. If the query contains multiple items in the selection list, then by default each result in the list is packaged in an array of type Object[].

Specified by:

getResultList in interface ProcedureCallImplementor<R>

Specified by:

getResultList in interface Query

Specified by:

getResultList in interface Query<R>

Specified by:

getResultList in interface SelectionQuery<R>

Specified by:

getResultList in interface StoredProcedureQuery

Specified by:

getResultList in interface TypedQuery<R>

Returns:

the results as a list

getSingleResult

public R getSingleResult()

Description copied from interface: SelectionQuery

Execute the query and return the single result of the query, throwing an exception if the query returns no results.

Specified by:

getSingleResult in interface ProcedureCallImplementor<R>

Specified by:

getSingleResult in interface Query

Specified by:

getSingleResult in interface Query<R>

Specified by:

getSingleResult in interface SelectionQuery<R>

Specified by:

getSingleResult in interface StoredProcedureQuery

Specified by:

getSingleResult in interface TypedQuery<R>

Overrides:

getSingleResult in class AbstractSelectionQuery<R>

Returns:

the single result, only if there is exactly one

getSingleResultOrNull

public R getSingleResultOrNull()

Description copied from interface: SelectionQuery

Execute the query and return the single result of the query, or null if the query returns no results.

Specified by:

getSingleResultOrNull in interface Query

Specified by:

getSingleResultOrNull in interface SelectionQuery<R>

Specified by:

getSingleResultOrNull in interface StoredProcedureQuery

Specified by:

getSingleResultOrNull in interface TypedQuery<R>

Overrides:

getSingleResultOrNull in class AbstractSelectionQuery<R>

Returns:

the single result or null if there is no result to return

unwrap

public <T> T unwrap(Class<T> type)

Specified by:

unwrap in interface Query

setLockMode

public ProcedureCallImplementor<R> setLockMode(LockModeType lockMode)

Description copied from class: AbstractSelectionQuery

Specify the root LockModeType for the query

Specified by:

setLockMode in interface Query

Specified by:

setLockMode in interface Query<R>

Specified by:

setLockMode in interface SelectionQuery<R>

Specified by:

setLockMode in interface TypedQuery<R>

Overrides:

setLockMode in class AbstractQuery<R>

See Also:

• AbstractSelectionQuery.setHibernateLockMode(org.hibernate.LockMode)

setTimeout

public ProcedureCallImplementor<R> setTimeout(Integer timeout)

Specified by:

setTimeout in interface ProcedureCallImplementor<R>

Specified by:

setTimeout in interface Query

Specified by:

setTimeout in interface StoredProcedureQuery

Specified by:

setTimeout in interface TypedQuery<R>

getLockMode

public LockModeType getLockMode()

Description copied from interface: SelectionQuery

Get the root LockModeType for the query

Specified by:

getLockMode in interface Query

Specified by:

getLockMode in interface SelectionQuery<R>

Overrides:

getLockMode in class AbstractQuery<R>

See Also:

• SelectionQuery.getHibernateLockMode()

setLockOptions

@Deprecated
public QueryImplementor<R> setLockOptions(LockOptions lockOptions)

Deprecated.

Description copied from interface: Query

Apply the given lock options to this query. Alias-specific lock modes in the given lock options are merged with any alias-specific lock mode which have already been set. If a lock mode has already been specified for an alias that is among the aliases in the given lock options, the lock mode specified in the given lock options overrides the lock mode that was already set.

Specified by:

setLockOptions in interface Query<R>

Overrides:

setLockOptions in class AbstractQuery<R>

Parameters:

lockOptions - The lock options to apply to the query.

Returns:

this, for method chaining

See Also:

• Query.getLockOptions()

setHint

public ProcedureCallImplementor<R> setHint(String hintName,
 Object value)

Description copied from interface: CommonQueryContract

Set a hint. The hints understood by Hibernate are enumerated by AvailableHints.

Specified by:

setHint in interface CommonQueryContract

Specified by:

setHint in interface MutationQuery

Specified by:

setHint in interface ProcedureCall

Specified by:

setHint in interface ProcedureCallImplementor<R>

Specified by:

setHint in interface Query

Specified by:

setHint in interface Query<R>

Specified by:

setHint in interface SelectionQuery<R>

Specified by:

setHint in interface StoredProcedureQuery

Specified by:

setHint in interface TypedQuery<R>

Overrides:

setHint in class AbstractQuery<R>

See Also:

• HibernateHints
• SpecHints

setFlushMode

public ProcedureCallImplementor<R> setFlushMode(FlushModeType flushModeType)

Description copied from interface: CommonQueryContract

Set the FlushMode to use for this query.

Setting this to null ultimately indicates to use the FlushMode of the session. Use CommonQueryContract.setHibernateFlushMode(org.hibernate.FlushMode) passing FlushMode.MANUAL instead to indicate that no automatic flushing should occur.

Specified by:

setFlushMode in interface CommonQueryContract

Specified by:

setFlushMode in interface MutationQuery

Specified by:

setFlushMode in interface ProcedureCall

Specified by:

setFlushMode in interface ProcedureCallImplementor<R>

Specified by:

setFlushMode in interface Query

Specified by:

setFlushMode in interface Query<R>

Specified by:

setFlushMode in interface SelectionQuery<R>

Specified by:

setFlushMode in interface StoredProcedureQuery

Specified by:

setFlushMode in interface TypedQuery<R>

Overrides:

setFlushMode in class AbstractQuery<R>

See Also:

• CommonQueryContract.getQueryFlushMode()
• CommonQueryContract.getHibernateFlushMode()
• Session.getHibernateFlushMode()

setParameter

public <P> ProcedureCallImplementor<R> setParameter(QueryParameter<P> parameter,
 P value)

Description copied from interface: CommonQueryContract

Bind an argument to the query parameter represented by the given QueryParameter.

If the type of the parameter cannot be inferred from the context in which it occurs, use one of the overloads which accepts a "type".

Specified by:

setParameter in interface CommonQueryContract

Specified by:

setParameter in interface MutationQuery

Specified by:

setParameter in interface Query<R>

Specified by:

setParameter in interface QueryImplementor<R>

Specified by:

setParameter in interface SelectionQuery<R>

Overrides:

setParameter in class AbstractQuery<R>

Parameters:

parameter - the query parameter memento

value - the argument, which might be null

Returns:

this, for method chaining

See Also:

• CommonQueryContract.setParameter(QueryParameter, Object, Type)

setParameter

public <P> ProcedureCallImplementor<R> setParameter(Parameter<P> parameter,
 P value)

Description copied from interface: Query

Query override

Specified by:

setParameter in interface CommonQueryContract

Specified by:

setParameter in interface MutationQuery

Specified by:

setParameter in interface ProcedureCall

Specified by:

setParameter in interface ProcedureCallImplementor<R>

Specified by:

setParameter in interface Query

Specified by:

setParameter in interface Query<R>

Specified by:

setParameter in interface QueryImplementor<R>

Specified by:

setParameter in interface SelectionQuery<R>

Specified by:

setParameter in interface StoredProcedureQuery

Specified by:

setParameter in interface TypedQuery<R>

Overrides:

setParameter in class AbstractQuery<R>

See Also:

• Query.setParameter(Parameter, Object)

setParameter

public ProcedureCallImplementor<R> setParameter(String name,
 Object value)

Description copied from interface: CommonQueryContract

Bind the given argument to a named query parameter.

If the type of the parameter cannot be inferred from the context in which it occurs, use one of the overloads which accepts a "type", or pass a TypedParameterValue.

Specified by:

setParameter in interface CommonQueryContract

Specified by:

setParameter in interface MutationQuery

Specified by:

setParameter in interface ProcedureCall

Specified by:

setParameter in interface ProcedureCallImplementor<R>

Specified by:

setParameter in interface Query

Specified by:

setParameter in interface Query<R>

Specified by:

setParameter in interface QueryImplementor<R>

Specified by:

setParameter in interface SelectionQuery<R>

Specified by:

setParameter in interface StoredProcedureQuery

Specified by:

setParameter in interface TypedQuery<R>

Overrides:

setParameter in class AbstractQuery<R>

See Also:

• CommonQueryContract.setParameter(String, Object, Class)
• CommonQueryContract.setParameter(String, Object, Type)
• TypedParameterValue

setParameter

public ProcedureCallImplementor<R> setParameter(int position,
 Object value)

Description copied from interface: CommonQueryContract

Bind the given argument to an ordinal query parameter.

If the type of the parameter cannot be inferred from the context in which it occurs, use one of the overloads which accepts a "type", or pass a TypedParameterValue.

Specified by:

setParameter in interface CommonQueryContract

Specified by:

setParameter in interface MutationQuery

Specified by:

setParameter in interface ProcedureCall

Specified by:

setParameter in interface ProcedureCallImplementor<R>

Specified by:

setParameter in interface Query

Specified by:

setParameter in interface Query<R>

Specified by:

setParameter in interface QueryImplementor<R>

Specified by:

setParameter in interface SelectionQuery<R>

Specified by:

setParameter in interface StoredProcedureQuery

Specified by:

setParameter in interface TypedQuery<R>

Overrides:

setParameter in class AbstractQuery<R>

See Also:

• CommonQueryContract.setParameter(int, Object, Class)
• CommonQueryContract.setParameter(int, Object, Type)
• TypedParameterValue

setParameter

public <P> ProcedureCallImplementor<R> setParameter(QueryParameter<P> parameter,
 P value,
 Type<P> type)

Description copied from interface: CommonQueryContract

Bind an argument to the query parameter represented by the given QueryParameter, using the given Type.

Specified by:

setParameter in interface CommonQueryContract

Specified by:

setParameter in interface MutationQuery

Specified by:

setParameter in interface Query<R>

Specified by:

setParameter in interface QueryImplementor<R>

Specified by:

setParameter in interface SelectionQuery<R>

Overrides:

setParameter in class AbstractQuery<R>

Parameters:

parameter - the query parameter memento

value - the argument, which might be null

type - a Type representing the type of the parameter

Returns:

this, for method chaining

setParameter

public <P> ProcedureCallImplementor<R> setParameter(String name,
 P value,
 Type<P> type)

Description copied from interface: CommonQueryContract

Bind the given argument to a named query parameter using the given Type.

Specified by:

setParameter in interface CommonQueryContract

Specified by:

setParameter in interface MutationQuery

Specified by:

setParameter in interface Query<R>

Specified by:

setParameter in interface QueryImplementor<R>

Specified by:

setParameter in interface SelectionQuery<R>

Overrides:

setParameter in class AbstractQuery<R>

setParameter

public <P> ProcedureCallImplementor<R> setParameter(int position,
 P value,
 Type<P> type)

Description copied from interface: CommonQueryContract

Bind the given argument to an ordinal query parameter using the given Type.

Specified by:

setParameter in interface CommonQueryContract

Specified by:

setParameter in interface MutationQuery

Specified by:

setParameter in interface Query<R>

Specified by:

setParameter in interface QueryImplementor<R>

Specified by:

setParameter in interface SelectionQuery<R>

Overrides:

setParameter in class AbstractQuery<R>

setParameter

@Deprecated
public ProcedureCallImplementor<R> setParameter(Parameter<Calendar> parameter,
 Calendar value,
 TemporalType temporalPrecision)

Deprecated.

Description copied from interface: Query

Query override

Specified by:

setParameter in interface CommonQueryContract

Specified by:

setParameter in interface MutationQuery

Specified by:

setParameter in interface ProcedureCall

Specified by:

setParameter in interface ProcedureCallImplementor<R>

Specified by:

setParameter in interface Query

Specified by:

setParameter in interface Query<R>

Specified by:

setParameter in interface QueryImplementor<R>

Specified by:

setParameter in interface SelectionQuery<R>

Specified by:

setParameter in interface StoredProcedureQuery

Specified by:

setParameter in interface TypedQuery<R>

Overrides:

setParameter in class AbstractQuery<R>

See Also:

• Query.setParameter(Parameter, Calendar, TemporalType)

setParameter

@Deprecated
public ProcedureCallImplementor<R> setParameter(Parameter<Date> parameter,
 Date value,
 TemporalType temporalPrecision)

Deprecated.

Description copied from interface: Query

Query override

Specified by:

setParameter in interface CommonQueryContract

Specified by:

setParameter in interface MutationQuery

Specified by:

setParameter in interface ProcedureCall

Specified by:

setParameter in interface ProcedureCallImplementor<R>

Specified by:

setParameter in interface Query

Specified by:

setParameter in interface Query<R>

Specified by:

setParameter in interface QueryImplementor<R>

Specified by:

setParameter in interface SelectionQuery<R>

Specified by:

setParameter in interface StoredProcedureQuery

Specified by:

setParameter in interface TypedQuery<R>

Overrides:

setParameter in class AbstractQuery<R>

See Also:

• Query.setParameter(Parameter, Date, TemporalType)

setParameter

@Deprecated
public ProcedureCallImplementor<R> setParameter(String name,
 Calendar value,
 TemporalType temporalPrecision)

Deprecated.

Description copied from interface: Query

Query override

Specified by:

setParameter in interface CommonQueryContract

Specified by:

setParameter in interface MutationQuery

Specified by:

setParameter in interface ProcedureCall

Specified by:

setParameter in interface ProcedureCallImplementor<R>

Specified by:

setParameter in interface Query

Specified by:

setParameter in interface Query<R>

Specified by:

setParameter in interface QueryImplementor<R>

Specified by:

setParameter in interface SelectionQuery<R>

Specified by:

setParameter in interface StoredProcedureQuery

Specified by:

setParameter in interface TypedQuery<R>

Overrides:

setParameter in class AbstractQuery<R>

See Also:

• Query.setParameter(String, Calendar, TemporalType)

setParameter

@Deprecated
public ProcedureCallImplementor<R> setParameter(String name,
 Date value,
 TemporalType temporalPrecision)

Deprecated.

Description copied from interface: Query

Query override

Specified by:

setParameter in interface CommonQueryContract

Specified by:

setParameter in interface MutationQuery

Specified by:

setParameter in interface ProcedureCall

Specified by:

setParameter in interface ProcedureCallImplementor<R>

Specified by:

setParameter in interface Query

Specified by:

setParameter in interface Query<R>

Specified by:

setParameter in interface QueryImplementor<R>

Specified by:

setParameter in interface SelectionQuery<R>

Specified by:

setParameter in interface StoredProcedureQuery

Specified by:

setParameter in interface TypedQuery<R>

Overrides:

setParameter in class AbstractQuery<R>

See Also:

• Query.setParameter(String, Date, TemporalType)

setParameter

@Deprecated
public ProcedureCallImplementor<R> setParameter(int position,
 Calendar value,
 TemporalType temporalPrecision)

Deprecated.

Description copied from interface: Query

Query override

Specified by:

setParameter in interface CommonQueryContract

Specified by:

setParameter in interface MutationQuery

Specified by:

setParameter in interface ProcedureCall

Specified by:

setParameter in interface ProcedureCallImplementor<R>

Specified by:

setParameter in interface Query

Specified by:

setParameter in interface Query<R>

Specified by:

setParameter in interface QueryImplementor<R>

Specified by:

setParameter in interface SelectionQuery<R>

Specified by:

setParameter in interface StoredProcedureQuery

Specified by:

setParameter in interface TypedQuery<R>

Overrides:

setParameter in class AbstractQuery<R>

See Also:

• Query.setParameter(int, Calendar, TemporalType)

setParameter

@Deprecated
public ProcedureCallImplementor<R> setParameter(int position,
 Date value,
 TemporalType temporalPrecision)

Deprecated.

Description copied from interface: Query

Query override

Specified by:

setParameter in interface CommonQueryContract

Specified by:

setParameter in interface MutationQuery

Specified by:

setParameter in interface ProcedureCall

Specified by:

setParameter in interface ProcedureCallImplementor<R>

Specified by:

setParameter in interface Query

Specified by:

setParameter in interface Query<R>

Specified by:

setParameter in interface QueryImplementor<R>

Specified by:

setParameter in interface SelectionQuery<R>

Specified by:

setParameter in interface StoredProcedureQuery

Specified by:

setParameter in interface TypedQuery<R>

Overrides:

setParameter in class AbstractQuery<R>

See Also:

• Query.setParameter(int, Date, TemporalType)

getResultStream

public Stream<R> getResultStream()

Description copied from interface: SelectionQuery

Execute the query and return the query results as a Stream. If the query contains multiple items in the selection list, then by default each result in the stream is packaged in an array of type Object[].

The client should call BaseStream.close() after processing the stream so that resources are freed as soon as possible.

Specified by:

getResultStream in interface Query

Specified by:

getResultStream in interface Query<R>

Specified by:

getResultStream in interface SelectionQuery<R>

Specified by:

getResultStream in interface TypedQuery<R>

Overrides:

getResultStream in class AbstractSelectionQuery<R>

Returns:

The results as a Stream

stream

public Stream<R> stream()

Description copied from interface: SelectionQuery

Execute the query and return the query results as a Stream. If the query contains multiple items in the selection list, then by default each result in the stream is packaged in an array of type Object[].

The client should call BaseStream.close() after processing the stream so that resources are freed as soon as possible.

Specified by:

stream in interface Query<R>

Specified by:

stream in interface SelectionQuery<R>

Overrides:

stream in class AbstractSelectionQuery<R>

Returns:

The results as a Stream

getResultSetMapping

public ResultSetMapping getResultSetMapping()

setCacheRetrieveMode

public ProcedureCallImplementor<R> setCacheRetrieveMode(CacheRetrieveMode cacheRetrieveMode)

Specified by:

setCacheRetrieveMode in interface ProcedureCallImplementor<R>

Specified by:

setCacheRetrieveMode in interface Query

Specified by:

setCacheRetrieveMode in interface Query<R>

Specified by:

setCacheRetrieveMode in interface SelectionQuery<R>

Specified by:

setCacheRetrieveMode in interface StoredProcedureQuery

Specified by:

setCacheRetrieveMode in interface TypedQuery<R>

Overrides:

setCacheRetrieveMode in class AbstractQuery<R>

See Also:

• SelectionQuery.setCacheMode(CacheMode)

setCacheStoreMode

public ProcedureCallImplementor<R> setCacheStoreMode(CacheStoreMode cacheStoreMode)

Specified by:

setCacheStoreMode in interface ProcedureCallImplementor<R>

Specified by:

setCacheStoreMode in interface Query

Specified by:

setCacheStoreMode in interface Query<R>

Specified by:

setCacheStoreMode in interface SelectionQuery<R>

Specified by:

setCacheStoreMode in interface StoredProcedureQuery

Specified by:

setCacheStoreMode in interface TypedQuery<R>

Overrides:

setCacheStoreMode in class AbstractQuery<R>

See Also:

• SelectionQuery.setCacheMode(CacheMode)