org.hibernate.query.procedure.internal

Class ProcedureParameterImpl<T>

java.lang.Object

org.hibernate.query.internal.QueryParameterImpl<T>

org.hibernate.query.procedure.internal.ProcedureParameterImpl<T>

All Implemented Interfaces:

Parameter<T>, ParameterRegistration<T>, ParameterRegistrationImplementor<T>, ProcedureParameter<T>, ProcedureParameterImplementor<T>, QueryParameter<T>

public class ProcedureParameterImpl<T>
extends QueryParameterImpl<T>
implements ProcedureParameterImplementor<T>, ParameterRegistration<T>

Author:

Steve Ebersole

Constructor Summary

Constructors

Constructor and Description
ProcedureParameterImpl(ProcedureCallImpl procedureCall, Integer position, ParameterMode mode, Class<T> javaType, Type hibernateType, boolean initialPassNullsSetting)
ProcedureParameterImpl(ProcedureCallImpl procedureCall, String name, ParameterMode mode, Class<T> javaType, Type hibernateType, boolean initialPassNullsSetting)

Method Summary

Modifier and Type	Method and Description
void	bindValue(Object value) Bind a value to the parameter.
void	bindValue(Object value, TemporalType explicitTemporalType) Bind a value to the parameter, using just a specified portion of the DATE/TIME value.
void	enablePassingNulls(boolean enabled) Controls how unbound values for this IN/INOUT parameter registration will be handled prior to execution.
T	extract(CallableStatement statement) Extract value from the statement after execution (used for OUT/INOUT parameters).
ParameterBind<T>	getBind() Retrieve the binding associated with this parameter.
ParameterMode	getMode() Retrieves the parameter "mode".
String	getName() Return the parameter name, or null if the parameter is not a named parameter or no name has been assigned.
Class<T>	getParameterType() Return the Java type of the parameter.
Integer	getPosition() Return the parameter position, or null if the parameter is not a positional parameter.
int[]	getSourceLocations()
int[]	getSqlTypes() Access to the SQL type(s) for this parameter
boolean	isPassNullsEnabled() How will an unbound value be handled in terms of the JDBC parameter?
void	prepare(CallableStatement statement, int startIndex) Prepare for execution.
void	setHibernateType(Type expectedType) Set the Hibernate mapping type for this parameter.

Methods inherited from class org.hibernate.query.internal.QueryParameterImpl

getHibernateType

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.hibernate.procedure.spi.ParameterRegistrationImplementor

getHibernateType

Methods inherited from interface org.hibernate.procedure.ParameterRegistration

getType

Constructor Detail

ProcedureParameterImpl

public ProcedureParameterImpl(ProcedureCallImpl procedureCall,
                              String name,
                              ParameterMode mode,
                              Class<T> javaType,
                              Type hibernateType,
                              boolean initialPassNullsSetting)

ProcedureParameterImpl

public ProcedureParameterImpl(ProcedureCallImpl procedureCall,
                              Integer position,
                              ParameterMode mode,
                              Class<T> javaType,
                              Type hibernateType,
                              boolean initialPassNullsSetting)

Method Detail

getMode

public ParameterMode getMode()

Description copied from interface: ProcedureParameter

Retrieves the parameter "mode". Only really pertinent in regards to procedure/function calls. In all other cases the mode would be ParameterMode.IN

Specified by:

getMode in interface ParameterRegistration<T>

Specified by:

getMode in interface ProcedureParameter<T>

Returns:

The parameter mode.

isPassNullsEnabled

public boolean isPassNullsEnabled()

Description copied from interface: ProcedureParameter

How will an unbound value be handled in terms of the JDBC parameter?

Specified by:

isPassNullsEnabled in interface ParameterRegistrationImplementor<T>

Specified by:

isPassNullsEnabled in interface ProcedureParameter<T>

Returns:

true here indicates that NULL should be passed; false indicates that it is ignored.

See Also:

ParameterRegistrationImplementor.isPassNullsEnabled()

enablePassingNulls

public void enablePassingNulls(boolean enabled)

Description copied from interface: ProcedureParameter

Controls how unbound values for this IN/INOUT parameter registration will be handled prior to execution. For details see ParameterRegistration.enablePassingNulls(boolean)

Specified by:

enablePassingNulls in interface ParameterRegistration<T>

Specified by:

enablePassingNulls in interface ProcedureParameter<T>

Parameters:

enabled - true indicates that the NULL should be passed; false indicates it should not.

See Also:

ParameterRegistration.enablePassingNulls(boolean)

getSourceLocations

public int[] getSourceLocations()

Specified by:

getSourceLocations in interface QueryParameter<T>

getName

public String getName()

Description copied from interface: Parameter

Return the parameter name, or null if the parameter is not a named parameter or no name has been assigned.

Specified by:

getName in interface Parameter<T>

Specified by:

getName in interface ParameterRegistration<T>

Returns:

parameter name

getPosition

public Integer getPosition()

Description copied from interface: Parameter

Return the parameter position, or null if the parameter is not a positional parameter.

Specified by:

getPosition in interface Parameter<T>

Specified by:

getPosition in interface ParameterRegistration<T>

Returns:

position of parameter

setHibernateType

public void setHibernateType(Type expectedType)

Description copied from interface: ParameterRegistration

Set the Hibernate mapping type for this parameter.

Specified by:

setHibernateType in interface ParameterRegistration<T>

Overrides:

setHibernateType in class QueryParameterImpl<T>

Parameters:

expectedType - The Hibernate mapping type.

getParameterType

public Class<T> getParameterType()

Description copied from interface: Parameter

Return the Java type of the parameter. Values bound to the parameter must be assignable to this type. This method is required to be supported for criteria queries only. Applications that use this method for Java Persistence query language queries and native queries will not be portable.

Specified by:

getParameterType in interface Parameter<T>

Overrides:

getParameterType in class QueryParameterImpl<T>

Returns:

the Java type of the parameter

getBind

public ParameterBind<T> getBind()

Description copied from interface: ParameterRegistration

Retrieve the binding associated with this parameter. The binding is only relevant for INPUT parameters. Can return null if nothing has been bound yet. To bind a value to the parameter use one of the ParameterRegistration.bindValue(T) methods.

Specified by:

getBind in interface ParameterRegistration<T>

Returns:

The parameter binding

bindValue

public void bindValue(Object value)

Description copied from interface: ParameterRegistration

Bind a value to the parameter. How this value is bound to the underlying JDBC CallableStatement is totally dependent on the Hibernate type.

Specified by:

bindValue in interface ParameterRegistration<T>

Parameters:

value - The value to bind.

bindValue

public void bindValue(Object value,
                      TemporalType explicitTemporalType)

Description copied from interface: ParameterRegistration

Bind a value to the parameter, using just a specified portion of the DATE/TIME value. It is illegal to call this form if the parameter is not DATE/TIME type. The Hibernate type is circumvented in this case and an appropriate "precision" Type is used instead.

Specified by:

bindValue in interface ParameterRegistration<T>

Parameters:

value - The value to bind

explicitTemporalType - An explicitly supplied TemporalType.

prepare

public void prepare(CallableStatement statement,
                    int startIndex)
             throws SQLException

Description copied from interface: ParameterRegistrationImplementor

Prepare for execution.

Specified by:

prepare in interface ParameterRegistrationImplementor<T>

Parameters:

statement - The statement about to be executed

startIndex - The parameter index for this registration (used for positional)

Throws:

SQLException - Indicates a problem accessing the statement object

getSqlTypes

public int[] getSqlTypes()

Description copied from interface: ParameterRegistrationImplementor

Access to the SQL type(s) for this parameter

Specified by:

getSqlTypes in interface ParameterRegistrationImplementor<T>

Returns:

The SQL types (JDBC type codes)

extract

public T extract(CallableStatement statement)

Description copied from interface: ParameterRegistrationImplementor

Extract value from the statement after execution (used for OUT/INOUT parameters).

Specified by:

extract in interface ParameterRegistrationImplementor<T>

Parameters:

statement - The callable statement

Returns:

The extracted value