spring-framework / org.springframework.jdbc.core.metadata / CallMetaDataContext

CallMetaDataContext

open class CallMetaDataContext

Class to manage context metadata used for the configuration and execution of the call.

Author
Thomas Risberg

Author
Juergen Hoeller

Author
Kiril Nugmanov

Since
2.5

Constructors

<init>

CallMetaDataContext()

Class to manage context metadata used for the configuration and execution of the call.

Functions

createCallString

open fun createCallString(): String

Build the call string based on configuration and metadata information.

createReturnResultSetParameter

open fun createReturnResultSetParameter(parameterName: String, rowMapper: RowMapper<*>): SqlParameter

Create a ReturnResultSetParameter/SqlOutParameter depending on the support provided by the JDBC driver used for the database in use.

getCallParameters

open fun getCallParameters(): MutableList<SqlParameter>

Get the List of SqlParameter objects to be used in call execution.

getCatalogName

open fun getCatalogName(): String

Get the name of the catalog.

getFunctionReturnName

open fun getFunctionReturnName(): String

Get the name used for the return value of the function.

getLimitedInParameterNames

open fun getLimitedInParameterNames(): MutableSet<String>

Get a limited set of in parameters to be used.

getOutParameterNames

open fun getOutParameterNames(): MutableList<String>

Get a list of the out parameter names.

getProcedureName

open fun getProcedureName(): String

Get the name of the procedure.

getScalarOutParameterName

open fun getScalarOutParameterName(): String

Get the name of the single out parameter for this call. If there are multiple parameters, the name of the first one will be returned.

getSchemaName

open fun getSchemaName(): String

Get the name of the schema.

initializeMetaData

open fun initializeMetaData(dataSource: DataSource): Unit

Initialize this class with metadata from the database.

isAccessCallParameterMetaData

open fun isAccessCallParameterMetaData(): Boolean

Check whether call parameter metadata should be accessed.

isFunction

open fun isFunction(): Boolean

Check whether this call is a function call.

isNamedBinding

open fun isNamedBinding(): Boolean

Check whether parameters should be bound by name.

isReturnValueRequired

open fun isReturnValueRequired(): Boolean

Check whether a return value is required.

matchInParameterValuesWithCallParameters

open fun matchInParameterValuesWithCallParameters(parameterSource: SqlParameterSource): MutableMap<String, Any>
open fun matchInParameterValuesWithCallParameters(inParameters: MutableMap<String, *>): MutableMap<String, *>

Match input parameter values with the parameters declared to be used in the call.

open fun matchInParameterValuesWithCallParameters(parameterValues: Array<Any>): MutableMap<String, *>

processParameters

open fun processParameters(parameters: MutableList<SqlParameter>): Unit

Process the list of parameters provided, and if procedure column metadata is used, the parameters will be matched against the metadata information and any missing ones will be automatically included.

setAccessCallParameterMetaData

open fun setAccessCallParameterMetaData(accessCallParameterMetaData: Boolean): Unit

Specify whether call parameter metadata should be accessed.

setCatalogName

open fun setCatalogName(catalogName: String): Unit

Specify the name of the catalog.

setFunction

open fun setFunction(function: Boolean): Unit

Specify whether this call is a function call.

setFunctionReturnName

open fun setFunctionReturnName(functionReturnName: String): Unit

Specify the name used for the return value of the function.

setLimitedInParameterNames

open fun setLimitedInParameterNames(limitedInParameterNames: MutableSet<String>): Unit

Specify a limited set of in parameters to be used.

setNamedBinding

open fun setNamedBinding(namedBinding: Boolean): Unit

Specify whether parameters should be bound by name.

setOutParameterNames

open fun setOutParameterNames(outParameterNames: MutableList<String>): Unit

Specify the names of the out parameters.

setProcedureName

open fun setProcedureName(procedureName: String): Unit

Specify the name of the procedure.

setReturnValueRequired

open fun setReturnValueRequired(returnValueRequired: Boolean): Unit

Specify whether a return value is required.

setSchemaName

open fun setSchemaName(schemaName: String): Unit

Secify the name of the schema.