org.hibernate.procedure.internal

Class ProcedureCallImpl

java.lang.Object

org.hibernate.internal.AbstractBasicQueryContractImpl

org.hibernate.procedure.internal.ProcedureCallImpl

All Implemented Interfaces:

BasicQueryContract, ProcedureCall, ResultContext, SynchronizeableQuery

public class ProcedureCallImpl
extends AbstractBasicQueryContractImpl
implements ProcedureCall, ResultContext

Standard implementation of ProcedureCall

Author:

Steve Ebersole

Constructor Summary

Constructors

Constructor and Description
ProcedureCallImpl(SessionImplementor session, String procedureName) The no-returns form.
ProcedureCallImpl(SessionImplementor session, String procedureName, Class... resultClasses) The result Class(es) return form
ProcedureCallImpl(SessionImplementor session, String procedureName, String... resultSetMappings) The result-set-mapping(s) return form

Method Summary

Modifier and Type	Method and Description
ProcedureCallImpl	addSynchronizedEntityClass(Class entityClass) Adds an entity for (a) auto-flush checking and (b) query result cache invalidation checking.
ProcedureCallImpl	addSynchronizedEntityName(String entityName) Adds an entity name for (a) auto-flush checking and (b) query result cache invalidation checking.
ProcedureCallImpl	addSynchronizedQuerySpace(String querySpace) Adds a query space.
protected void	addSynchronizedQuerySpaces(EntityPersister persister)
QueryParameters	buildQueryParametersObject()
ParameterRegistrationImplementor[]	collectRefCursorParameters() Collects any parameter registrations which indicate a REF_CURSOR parameter type/mode.
ProcedureCallMemento	extractMemento(Map<String,Object> hints) Extract the disconnected representation of this call.
ProcedureOutputs	getOutputs() Retrieves access to outputs of this procedure call.
ParameterRegistrationImplementor	getParameterRegistration(int position) Retrieve a previously registered parameter memento by the position under which it was registered.
ParameterRegistrationImplementor	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 to be called.
QueryParameters	getQueryParameters()
NativeSQLQueryReturn[]	getQueryReturns()
List<ParameterRegistration>	getRegisteredParameters() Retrieve all registered parameters.
Type[]	getReturnTypes() Return the Hibernate types of the query results.
SessionImplementor	getSession()
String	getSql()
Set<String>	getSynchronizedQuerySpaces() Obtain the list of query spaces the query is synchronized on.
<T> ParameterRegistration<T>	registerParameter(int position, Class<T> type, ParameterMode mode) Basic form for registering a positional parameter.
<T> ParameterRegistration<T>	registerParameter(String name, Class<T> type, ParameterMode mode) Basic form for registering a named parameter.
ProcedureCall	registerParameter0(int position, Class type, ParameterMode mode) Chained form of ProcedureCall.registerParameter(int, Class, javax.persistence.ParameterMode)
ProcedureCall	registerParameter0(String name, Class type, ParameterMode mode) Chained form of ProcedureCall.registerParameter(String, Class, javax.persistence.ParameterMode)
protected Set<String>	synchronizedQuerySpaces() Use this form instead of getSynchronizedQuerySpaces() when you want to make sure the underlying Set is instantiated (aka, on add)

Methods inherited from class org.hibernate.internal.AbstractBasicQueryContractImpl

getCacheMode, getCacheRegion, getFetchSize, getFlushMode, getTimeout, isCacheable, isReadOnly, session, setCacheable, setCacheMode, setCacheRegion, setFetchSize, setFlushMode, setReadOnly, setTimeout

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.hibernate.BasicQueryContract

getCacheMode, getCacheRegion, getFetchSize, getFlushMode, getTimeout, isCacheable, isReadOnly, setCacheable, setCacheMode, setCacheRegion, setFetchSize, setFlushMode, setReadOnly, setTimeout

Constructor Detail

ProcedureCallImpl

public ProcedureCallImpl(SessionImplementor session,
                         String procedureName)

The no-returns form.

Parameters:

session - The session

procedureName - The name of the procedure to call

ProcedureCallImpl

public ProcedureCallImpl(SessionImplementor 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(SessionImplementor session,
                         String procedureName,
                         String... resultSetMappings)

The result-set-mapping(s) return form

Parameters:

session - The session

procedureName - The name of the procedure to call

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

Method Detail

getSession

public SessionImplementor getSession()

Specified by:

getSession in interface ResultContext

getParameterStrategy

public ParameterStrategy getParameterStrategy()

getProcedureName

public String getProcedureName()

Description copied from interface: ProcedureCall

Get the name of the stored procedure to be called.

Specified by:

getProcedureName in interface ProcedureCall

Returns:

The procedure name.

getSql

public String getSql()

Specified by:

getSql in interface ResultContext

getQueryReturns

public NativeSQLQueryReturn[] getQueryReturns()

Specified by:

getQueryReturns in interface ResultContext

registerParameter

public <T> ParameterRegistration<T> registerParameter(int position,
                                                      Class<T> type,
                                                      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

type - The Java type of the parameter

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

Returns:

The parameter registration memento

registerParameter0

public ProcedureCall registerParameter0(int position,
                                        Class type,
                                        ParameterMode mode)

Description copied from interface: ProcedureCall

Chained form of ProcedureCall.registerParameter(int, Class, javax.persistence.ParameterMode)

Specified by:

registerParameter0 in interface ProcedureCall

Parameters:

position - The position

type - The Java type of the parameter

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

Returns:

this, for method chaining

getParameterRegistration

public ParameterRegistrationImplementor 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> ParameterRegistration<T> registerParameter(String name,
                                                      Class<T> type,
                                                      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

type - The Java type of the parameter

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

Returns:

The parameter registration memento

registerParameter0

public ProcedureCall registerParameter0(String name,
                                        Class type,
                                        ParameterMode mode)

Description copied from interface: ProcedureCall

Chained form of ProcedureCall.registerParameter(String, Class, javax.persistence.ParameterMode)

Specified by:

registerParameter0 in interface ProcedureCall

Parameters:

name - The parameter name

type - The Java type of the parameter

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

Returns:

The parameter registration memento

getParameterRegistration

public ParameterRegistrationImplementor 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<ParameterRegistration> 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

getReturnTypes

public Type[] getReturnTypes()
                      throws HibernateException

Description copied from interface: BasicQueryContract

Return the Hibernate types of the query results.

Specified by:

getReturnTypes in interface BasicQueryContract

Returns:

an array of types

Throws:

HibernateException

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 the query is synchronized on.

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 ProcedureCallImpl addSynchronizedQuerySpace(String querySpace)

Description copied from interface: SynchronizeableQuery

Adds a query space.

Specified by:

addSynchronizedQuerySpace in interface ProcedureCall

Specified by:

addSynchronizedQuerySpace in interface SynchronizeableQuery

Parameters:

querySpace - The query space to be auto-flushed for this query.

Returns:

this, for method chaining

addSynchronizedEntityName

public ProcedureCallImpl addSynchronizedEntityName(String entityName)

Description copied from interface: SynchronizeableQuery

Adds an entity name for (a) auto-flush checking and (b) query result cache invalidation checking. Same as SynchronizeableQuery.addSynchronizedQuerySpace(java.lang.String) for all tables associated with the given entity.

Specified by:

addSynchronizedEntityName in interface ProcedureCall

Specified by:

addSynchronizedEntityName in interface SynchronizeableQuery

Parameters:

entityName - The name of the entity upon whose defined query spaces we should additionally synchronize.

Returns:

this, for method chaining

addSynchronizedQuerySpaces

protected void addSynchronizedQuerySpaces(EntityPersister persister)

addSynchronizedEntityClass

public ProcedureCallImpl addSynchronizedEntityClass(Class entityClass)

Description copied from interface: SynchronizeableQuery

Adds an entity for (a) auto-flush checking and (b) query result cache invalidation checking. Same as SynchronizeableQuery.addSynchronizedQuerySpace(java.lang.String) for all tables associated with the given entity.

Specified by:

addSynchronizedEntityClass in interface ProcedureCall

Specified by:

addSynchronizedEntityClass in interface SynchronizeableQuery

Parameters:

entityClass - The class of the entity upon whose defined query spaces we should additionally synchronize.

Returns:

this, for method chaining

getQueryParameters

public QueryParameters getQueryParameters()

Specified by:

getQueryParameters in interface ResultContext

buildQueryParametersObject

public QueryParameters buildQueryParametersObject()

Overrides:

buildQueryParametersObject in class AbstractBasicQueryContractImpl

collectRefCursorParameters

public ParameterRegistrationImplementor[] collectRefCursorParameters()

Collects any parameter registrations which indicate a REF_CURSOR parameter type/mode.

Returns:

The collected REF_CURSOR type parameters.

extractMemento

public ProcedureCallMemento extractMemento(Map<String,Object> hints)

Description copied from interface: ProcedureCall

Extract the disconnected representation of this call. Used in HEM to allow redefining a named query

Specified by:

extractMemento in interface ProcedureCall

Parameters:

hints - The hints to incorporate into the memento

Returns:

The memento