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:

javax.persistence.Parameter<T>, ProcedureParameter<T>, ProcedureParameterImplementor<T>, QueryParameter<T>

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

Constructor Summary

Constructors

Constructor and Description
ProcedureParameterImpl(ParameterRegistrationImplementor<T> nativeParamRegistration)

Method Summary

Modifier and Type	Method and Description
void	enablePassingNulls(boolean enabled) Controls how unbound values for this IN/INOUT parameter registration will be handled prior to execution.
javax.persistence.ParameterMode	getMode() Retrieves the parameter "mode".
java.lang.String	getName()
ParameterRegistrationImplementor<T>	getNativeParameterRegistration()
java.lang.Integer	getPosition()
boolean	isJpaPositionalParameter() JPA has a different definition of positional parameters than what legacy Hibernate HQL had.
boolean	isPassNullsEnabled() How will an unbound value be handled in terms of the JDBC parameter?

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

getParameterType, getType

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.QueryParameter

getType

Methods inherited from interface javax.persistence.Parameter

getParameterType

Constructor Detail

ProcedureParameterImpl

public ProcedureParameterImpl(ParameterRegistrationImplementor<T> nativeParamRegistration)

Method Detail

getMode

public javax.persistence.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 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 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 ProcedureParameter<T>

Parameters:

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

See Also:

ParameterRegistration.enablePassingNulls(boolean)

isJpaPositionalParameter

public boolean isJpaPositionalParameter()

Description copied from interface: QueryParameter

JPA has a different definition of positional parameters than what legacy Hibernate HQL had. In JPA, the parameter holders are labelled (named :/). At any rate the semantics are different and we often need to understand which we are dealing with (and applications might too).

Specified by:

isJpaPositionalParameter in interface QueryParameter<T>

Returns:

true if this is a JPA-style positional parameter; false would indicate we have either a named parameter (Parameter.getName() would return a non-null value) or a native Hibernate positional parameter.

getName

public java.lang.String getName()

Specified by:

getName in interface javax.persistence.Parameter<T>

getPosition

public java.lang.Integer getPosition()

Specified by:

getPosition in interface javax.persistence.Parameter<T>

getNativeParameterRegistration

public ParameterRegistrationImplementor<T> getNativeParameterRegistration()

Specified by:

getNativeParameterRegistration in interface ProcedureParameterImplementor<T>