AbstractParameterRegistrationImpl (Red Hat JBoss Enterprise Application Platform 7.1.0.GA public API)

java.lang.Object
- org.hibernate.procedure.internal.AbstractParameterRegistrationImpl<T>

All Implemented Interfaces:

ParameterRegistration<T>, ParameterRegistrationImplementor<T>

Direct Known Subclasses:

NamedParameterRegistration, PositionalParameterRegistration
```
public abstract class AbstractParameterRegistrationImpl<T>
extends Object
implements ParameterRegistrationImplementor<T>
```
Abstract implementation of ParameterRegistration/ParameterRegistrationImplementor

Author:

Steve Ebersole

Constructor Summary

Constructors
Modifier	Constructor and Description
`protected`	`AbstractParameterRegistrationImpl(ProcedureCallImpl procedureCall, Integer position, ParameterMode mode, Class<T> type, boolean initialPassNullsSetting)`
`protected`	`AbstractParameterRegistrationImpl(ProcedureCallImpl procedureCall, Integer position, ParameterMode mode, Class<T> type, Type hibernateType, boolean initialPassNullsSetting)`
`protected`	`AbstractParameterRegistrationImpl(ProcedureCallImpl procedureCall, String name, ParameterMode mode, Class<T> type, boolean initialPassNullsSetting)`
`protected`	`AbstractParameterRegistrationImpl(ProcedureCallImpl procedureCall, String name, ParameterMode mode, Class<T> type, Type hibernateType, boolean initialPassNullsSetting)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`bindValue(T value)` Bind a value to the parameter.
`void`	`bindValue(T 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.
`Type`	`getHibernateType()` Access to the Hibernate type for this parameter registration
`ParameterMode`	`getMode()` Retrieves the parameter "mode" which describes how the parameter is defined in the actual database procedure definition (is it an INPUT parameter? An OUTPUT parameter? etc).
`String`	`getName()` The name under which this parameter was registered.
`Integer`	`getPosition()` The position at which this parameter was registered.
`int[]`	`getSqlTypes()` Access to the SQL type(s) for this parameter
`Class<T>`	`getType()` Obtain the Java type of parameter.
`boolean`	`isPassNullsEnabled()` If no value is bound for this parameter registration, is the passing of NULL to the JDBC CallableStatement for that parameter enabled? This effectively controls whether default values for the argument as defined in the database are applied or not.
`void`	`prepare(CallableStatement statement, int startIndex)` Prepare for execution.
`protected SessionImplementor`	`session()`
`void`	`setHibernateType(Type type)` Set the Hibernate mapping type for this parameter.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - AbstractParameterRegistrationImpl
```
protected AbstractParameterRegistrationImpl(ProcedureCallImpl procedureCall,
                                            Integer position,
                                            ParameterMode mode,
                                            Class<T> type,
                                            boolean initialPassNullsSetting)
```
  - AbstractParameterRegistrationImpl
```
protected AbstractParameterRegistrationImpl(ProcedureCallImpl procedureCall,
                                            Integer position,
                                            ParameterMode mode,
                                            Class<T> type,
                                            Type hibernateType,
                                            boolean initialPassNullsSetting)
```
  - AbstractParameterRegistrationImpl
```
protected AbstractParameterRegistrationImpl(ProcedureCallImpl procedureCall,
                                            String name,
                                            ParameterMode mode,
                                            Class<T> type,
                                            boolean initialPassNullsSetting)
```
  - AbstractParameterRegistrationImpl
```
protected AbstractParameterRegistrationImpl(ProcedureCallImpl procedureCall,
                                            String name,
                                            ParameterMode mode,
                                            Class<T> type,
                                            Type hibernateType,
                                            boolean initialPassNullsSetting)
```
- Method Detail
  - session
```
protected SessionImplementor session()
```
  - getName
```
public String getName()
```
    Description copied from interface: ParameterRegistration
    
    The name under which this parameter was registered. Can be null which should indicate that positional registration was used (and therefore ParameterRegistration.getPosition() should return non-null.
    
    Specified by:
    
    getName in interface ParameterRegistration<T>
    
    Returns:
    
    The name;
  - getPosition
```
public Integer getPosition()
```
    Description copied from interface: ParameterRegistration
    
    The position at which this parameter was registered. Can be null which should indicate that named registration was used (and therefore ParameterRegistration.getName() should return non-null.
    
    Specified by:
    
    getPosition in interface ParameterRegistration<T>
    
    Returns:
    
    The name;
  - getType
```
public Class<T> getType()
```
    Description copied from interface: ParameterRegistration
    
    Obtain the Java type of parameter. This is used to guess the Hibernate type (unless ParameterRegistration.setHibernateType(org.hibernate.type.Type) is called explicitly).
    
    Specified by:
    
    getType in interface ParameterRegistration<T>
    
    Returns:
    
    The parameter Java type.
  - getMode
```
public ParameterMode getMode()
```
    Description copied from interface: ParameterRegistration
    
    Retrieves the parameter "mode" which describes how the parameter is defined in the actual database procedure definition (is it an INPUT parameter? An OUTPUT parameter? etc).
    
    Specified by:
    
    getMode in interface ParameterRegistration<T>
    
    Returns:
    
    The parameter mode.
  - isPassNullsEnabled
```
public boolean isPassNullsEnabled()
```
    Description copied from interface: ParameterRegistrationImplementor
    
    If no value is bound for this parameter registration, is the passing of NULL to the JDBC CallableStatement for that parameter enabled? This effectively controls whether default values for the argument as defined in the database are applied or not.
    
    Specified by:
    
    isPassNullsEnabled in interface ParameterRegistrationImplementor<T>
    
    Returns:
    
    true indicates that NULL will be passed to the JDBC driver, effectively disabling the application of the default argument value defined in the database; false indicates that the parameter will simply be ignored, with the assumption that the corresponding argument defined a default value.
  - enablePassingNulls
```
public void enablePassingNulls(boolean enabled)
```
    Description copied from interface: ParameterRegistration
    Controls how unbound values for this IN/INOUT parameter registration will be handled prior to execution. There are 2 possible options to handle it:
    - bind the NULL to the parameter
    - do not bind the NULL to the parameter
    The reason for the distinction comes from default values defined on the corresponding database procedure/function argument. Any time a value (including NULL) is bound to the argument, its default value will not be used. So effectively this setting controls whether the NULL should be interpreted as "pass the NULL" or as "apply the argument default".
    The (global) default this setting is defined by AvailableSettings.PROCEDURE_NULL_PARAM_PASSING
    Specified by:
    
    enablePassingNulls in interface ParameterRegistration<T>
    
    Parameters:
    
    enabled - true indicates that the NULL should be passed; false indicates it should not.
  - getHibernateType
```
public Type getHibernateType()
```
    Description copied from interface: ParameterRegistrationImplementor
    
    Access to the Hibernate type for this parameter registration
    
    Specified by:
    
    getHibernateType in interface ParameterRegistrationImplementor<T>
    
    Returns:
    
    The Hibernate Type
  - setHibernateType
```
public void setHibernateType(Type type)
```
    Description copied from interface: ParameterRegistration
    
    Set the Hibernate mapping type for this parameter.
    
    Specified by:
    
    setHibernateType in interface ParameterRegistration<T>
    
    Parameters:
    
    type - The Hibernate mapping type.
  - 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(T 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(T 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

Class AbstractParameterRegistrationImpl<T>

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

AbstractParameterRegistrationImpl

AbstractParameterRegistrationImpl

AbstractParameterRegistrationImpl

AbstractParameterRegistrationImpl

Method Detail

session

getName

getPosition

getType

getMode

isPassNullsEnabled

enablePassingNulls

getHibernateType

setHibernateType

getBind

bindValue

bindValue

prepare

getSqlTypes

extract