GenericCallMetaDataProvider

Overview

Package

Class

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

org.springframework.jdbc.core.metadata
Class GenericCallMetaDataProvider

java.lang.Object
  org.springframework.jdbc.core.metadata.GenericCallMetaDataProvider

All Implemented Interfaces:: CallMetaDataProvider

Direct Known Subclasses:: Db2CallMetaDataProvider, DerbyCallMetaDataProvider, OracleCallMetaDataProvider, PostgresCallMetaDataProvider, SqlServerCallMetaDataProvider, SybaseCallMetaDataProvider

public class GenericCallMetaDataProvider
extends Object
implements CallMetaDataProvider
extends Object
implements CallMetaDataProvider

Generic implementation for the CallMetaDataProvider interface. This class can be extended to provide database specific behavior.

Since:: 2.5
Author:: Thomas Risberg

Field Summary
`protected static Log`	`logger` Logger available to subclasses

Constructor Summary
`protected`	`GenericCallMetaDataProvider(DatabaseMetaData databaseMetaData)` Constructor used to initialize with provided database meta data.

Method Summary
`boolean`	`byPassReturnParameter(String parameterName)` Should we bypass the return parameter with the specified name.
`String`	`catalogNameToUse(String catalogName)` Provide any modification of the catalog name passed in to match the meta data currently used.
`SqlParameter`	`createDefaultInOutParameter(String parameterName, CallParameterMetaData meta)` Create a default inout parameter based on the provided meta data.
`SqlParameter`	`createDefaultInParameter(String parameterName, CallParameterMetaData meta)` Create a default in parameter based on the provided meta data.
`SqlParameter`	`createDefaultOutParameter(String parameterName, CallParameterMetaData meta)` Create a default out parameter based on the provided meta data.
`List<CallParameterMetaData>`	`getCallParameterMetaData()` Get the call parameter metadata that is currently used.
`int`	`getRefCursorSqlType()` Get the `Types` type for columns that return resultsets as ref cursors if this feature is supported.
`String`	`getUserName()` Get the name of the current user.
`void`	`initializeWithMetaData(DatabaseMetaData databaseMetaData)` Initialize using the provided DatabaseMetData.
`void`	`initializeWithProcedureColumnMetaData(DatabaseMetaData databaseMetaData, String catalogName, String schemaName, String procedureName)` Initialize the database specific management of procedure column meta data.
`boolean`	`isProcedureColumnMetaDataUsed()` Are we using the meta data for the procedure columns?
`boolean`	`isRefCursorSupported()` Does this database support returning resultsets as ref cursors to be retrieved with `CallableStatement.getObject(int)` for the specified column.
`boolean`	`isReturnResultSetSupported()` Does this database support returning resultsets that should be retrieved with the JDBC call `Statement.getResultSet()`
`protected boolean`	`isStoresLowerCaseIdentifiers()` Does the database use lower case for identifiers
`protected boolean`	`isStoresUpperCaseIdentifiers()` Does the database use upper case for identifiers
`boolean`	`isSupportsCatalogsInProcedureCalls()` Does the database support the use of catalog name in procedure calls
`boolean`	`isSupportsSchemasInProcedureCalls()` Does the database support the use of schema name in procedure calls
`String`	`metaDataCatalogNameToUse(String catalogName)` Provide any modification of the catalog name passed in to match the meta data currently used.
`String`	`metaDataSchemaNameToUse(String schemaName)` Provide any modification of the schema name passed in to match the meta data currently used.
`String`	`parameterNameToUse(String parameterName)` Provide any modification of the column name passed in to match the meta data currently used.
`String`	`procedureNameToUse(String procedureName)` Provide any modification of the procedure name passed in to match the meta data currently used.
`String`	`schemaNameToUse(String schemaName)` Provide any modification of the schema name passed in to match the meta data currently used.
`protected void`	`setStoresLowerCaseIdentifiers(boolean storesLowerCaseIdentifiers)` Specify whether the database uses lower case for identifiers
`protected void`	`setStoresUpperCaseIdentifiers(boolean storesUpperCaseIdentifiers)` Specify whether the database uses upper case for identifiers
`protected void`	`setSupportsCatalogsInProcedureCalls(boolean supportsCatalogsInProcedureCalls)` Specify whether the database supports the use of catalog name in procedure calls
`protected void`	`setSupportsSchemasInProcedureCalls(boolean supportsSchemasInProcedureCalls)` Specify whether the database supports the use of schema name in procedure calls

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

Field Detail

logger

protected static final Log logger

Logger available to subclasses

Constructor Detail

GenericCallMetaDataProvider

protected GenericCallMetaDataProvider(DatabaseMetaData databaseMetaData)
                               throws SQLException

Constructor used to initialize with provided database meta data.

Parameters:: databaseMetaData - meta data to be used
Throws:: SQLException

Method Detail