CallMetaDataProvider (Spring Framework API)

すべての既知の実装クラス:
Db2CallMetaDataProvider, DerbyCallMetaDataProvider, GenericCallMetaDataProvider, HanaCallMetaDataProvider, OracleCallMetaDataProvider, PostgresCallMetaDataProvider, SqlServerCallMetaDataProvider, SybaseCallMetaDataProvider
```
public interface CallMetaDataProvider
```
呼び出しメタデータを提供するクラスによって実装される API を指定するインターフェース。
これは、Spring の SimpleJdbcCall による内部使用を目的としています。
導入:
2.5
作成者:
Thomas Risberg

メソッドのサマリー

すべてのメソッドインスタンスメソッド抽象メソッド
修飾子と型	メソッドと説明
`boolean`	`byPassReturnParameter(StringSE parameterName)` 指定した名前の戻りパラメーターをバイパスする必要があります。
`StringSE`	`catalogNameToUse(StringSE catalogName)` 現在使用されているメタデータと一致するように、渡されたカタログ名の変更を提供します。
`SqlParameter`	`createDefaultInOutParameter(StringSE parameterName, CallParameterMetaData meta)` 提供されたメタデータに基づいて、デフォルトの入出力パラメーターを作成します。
`SqlParameter`	`createDefaultInParameter(StringSE parameterName, CallParameterMetaData meta)` 提供されたメタデータに基づいて、デフォルトのパラメーターを作成します。
`SqlParameter`	`createDefaultOutParameter(StringSE parameterName, CallParameterMetaData meta)` 提供されたメタデータに基づいてデフォルトの出力パラメーターを作成します。
`ListSE<CallParameterMetaData>`	`getCallParameterMetaData()` 現在使用されている呼び出しパラメーターのメタデータを取得します。
`int`	`getRefCursorSqlType()` この機能がサポートされている場合、参照カーソルとして ResultSets を返す列の `Types`SE 型を取得します。
`StringSE`	`getUserName()` 現在のユーザーの名前を取得します。
`void`	`initializeWithMetaData(DatabaseMetaDataSE databaseMetaData)` 提供された DatabaseMetData を使用して初期化します。
`void`	`initializeWithProcedureColumnMetaData(DatabaseMetaDataSE databaseMetaData, StringSE catalogName, StringSE schemaName, StringSE procedureName)` プロシージャ列のメタデータのデータベース固有の管理を初期化します。
`boolean`	`isProcedureColumnMetaDataUsed()` プロシージャ列にメタデータを使用していますか？
`boolean`	`isRefCursorSupported()` このデータベースは、指定された列の `CallableStatement.getObject(int)`SE で取得される参照カーソルとして ResultSets を返すことをサポートしていますか？
`boolean`	`isReturnResultSetSupported()` このデータベースは、JDBC 呼び出し `Statement.getResultSet()`SE で取得する必要がある ResultSets を返すことをサポートしていますか？
`boolean`	`isSupportsCatalogsInProcedureCalls()` データベースは、プロシージャコールでのカタログ名の使用をサポートしていますか？
`boolean`	`isSupportsSchemasInProcedureCalls()` データベースは、プロシージャコールでのスキーマ名の使用をサポートしていますか？
`StringSE`	`metaDataCatalogNameToUse(StringSE catalogName)` 現在使用されているメタデータと一致するように、渡されたカタログ名の変更を提供します。
`StringSE`	`metaDataSchemaNameToUse(StringSE schemaName)` 現在使用されているメタデータと一致するように、渡されたスキーマ名の変更を提供します。
`StringSE`	`parameterNameToUse(StringSE parameterName)` 現在使用されているメタデータに一致するように、渡された列名の変更を提供します。
`StringSE`	`procedureNameToUse(StringSE procedureName)` 現在使用されているメタデータに一致するように、渡されたプロシージャ名の変更を提供します。
`StringSE`	`schemaNameToUse(StringSE schemaName)` 現在使用されているメタデータと一致するように、渡されたスキーマ名の変更を提供します。

- メソッドの詳細
  - initializeWithMetaData
```
void initializeWithMetaData(DatabaseMetaDataSE databaseMetaData)
                     throws SQLExceptionSE
```
    提供された DatabaseMetData を使用して初期化します。
    パラメーター:
    databaseMetaData - データベース固有の情報を取得するために使用されます
    例外:
    SQLExceptionSE - 初期化に失敗した場合
  - initializeWithProcedureColumnMetaData
```
void initializeWithProcedureColumnMetaData(DatabaseMetaDataSE databaseMetaData,
                                           @Nullable
                                           StringSE catalogName,
                                           @Nullable
                                           StringSE schemaName,
                                           @Nullable
                                           StringSE procedureName)
                                    throws SQLExceptionSE
```
    プロシージャ列のメタデータのデータベース固有の管理を初期化します。これは、サポートされているデータベースに対してのみ呼び出されます。この初期化は、列のメタデータを使用しないように指定することでオフにできます。
    パラメーター:
    databaseMetaData - データベース固有の情報を取得するために使用されます
    catalogName - 使用するカタログの名前 (または、存在しない場合は null )
    schemaName - 使用するスキーマ名の名前 (または、存在しない場合は null )
    procedureName - ストアドプロシージャの名前
    例外:
    SQLExceptionSE - 初期化に失敗した場合
    関連事項:
    SimpleJdbcCall.withoutProcedureColumnMetaDataAccess()
  - procedureNameToUse
```
@Nullable
StringSE procedureNameToUse(@Nullable
                                    StringSE procedureName)
```
    現在使用されているメタデータと一致するように、渡されたプロシージャ名の変更を提供します。これには、ケースの変更が含まれる場合があります。
  - catalogNameToUse
```
@Nullable
StringSE catalogNameToUse(@Nullable
                                  StringSE catalogName)
```
    現在使用されているメタデータと一致するように、渡されたカタログ名の変更を提供します。これには、ケースの変更が含まれる場合があります。
  - schemaNameToUse
```
@Nullable
StringSE schemaNameToUse(@Nullable
                                 StringSE schemaName)
```
    現在使用されているメタデータと一致するように、渡されたスキーマ名の変更を提供します。これには、ケースの変更が含まれる場合があります。
  - metaDataCatalogNameToUse
```
@Nullable
StringSE metaDataCatalogNameToUse(@Nullable
                                          StringSE catalogName)
```
    現在使用されているメタデータと一致するように、渡されたカタログ名の変更を提供します。戻り値は、メタデータ検索に使用されます。これには、使用されているケースの変更や、提供されていない場合は基本カタログの提供が含まれます。
  - metaDataSchemaNameToUse
```
@Nullable
StringSE metaDataSchemaNameToUse(@Nullable
                                         StringSE schemaName)
```
    現在使用されているメタデータと一致するように、渡されたスキーマ名の変更を提供します。戻り値は、メタデータ検索に使用されます。これには、使用されるケースの変更や、提供されていない場合は基本スキーマの提供が含まれます。
  - parameterNameToUse
```
@Nullable
StringSE parameterNameToUse(@Nullable
                                    StringSE parameterName)
```
    現在使用されているメタデータと一致するように、渡された列名の変更を提供します。これには、ケースの変更が含まれる場合があります。
    パラメーター:
    parameterName - 列のパラメーターの名前
  - createDefaultOutParameter
```
SqlParameter createDefaultOutParameter(StringSE parameterName,
                                       CallParameterMetaData meta)
```
    提供されたメタデータに基づいて、デフォルトの出力パラメーターを作成します。これは、明示的なパラメーター宣言が行われていない場合に使用されます。
    パラメーター:
    parameterName - パラメーターの名前
    meta - この呼び出しに使用されるメタデータ
    戻り値:
    設定された SqlOutParameter
  - createDefaultInOutParameter
```
SqlParameter createDefaultInOutParameter(StringSE parameterName,
                                         CallParameterMetaData meta)
```
    提供されたメタデータに基づいて、デフォルトの入出力パラメーターを作成します。これは、明示的なパラメーター宣言が行われていない場合に使用されます。
    パラメーター:
    parameterName - パラメーターの名前
    meta - この呼び出しに使用されるメタデータ
    戻り値:
    設定された SqlInOutParameter
  - createDefaultInParameter
```
SqlParameter createDefaultInParameter(StringSE parameterName,
                                      CallParameterMetaData meta)
```
    提供されたメタデータに基づいて、デフォルトのパラメーターを作成します。これは、明示的なパラメーター宣言が行われていない場合に使用されます。
    パラメーター:
    parameterName - パラメーターの名前
    meta - この呼び出しに使用されるメタデータ
    戻り値:
    設定された SqlParameter
  - getUserName
```
@Nullable
StringSE getUserName()
```
    現在のユーザーの名前を取得します。メタデータ検索などに役立ちます。
    戻り値:
    データベース接続からの現在のユーザー名
  - isReturnResultSetSupported
```
boolean isReturnResultSetSupported()
```
    このデータベースは、JDBC 呼び出し Statement.getResultSet()SE で取得する必要がある ResultSets を返すことをサポートしていますか？
  - isRefCursorSupported
```
boolean isRefCursorSupported()
```
    このデータベースは、指定された列の CallableStatement.getObject(int)SE で取得される参照カーソルとして ResultSets を返すことをサポートしていますか？
  - getRefCursorSqlType
```
int getRefCursorSqlType()
```
    この機能がサポートされている場合、参照カーソルとして ResultSets を返す列の TypesSE 型を取得します。
  - isProcedureColumnMetaDataUsed
```
boolean isProcedureColumnMetaDataUsed()
```
    プロシージャ列にメタデータを使用していますか？
  - byPassReturnParameter
```
boolean byPassReturnParameter(StringSE parameterName)
```
    指定した名前の戻りパラメーターをバイパスする必要があります。これにより、データベース固有の実装は、データベース呼び出しによって返された特定の結果の処理をスキップできます。
  - getCallParameterMetaData
```
ListSE<CallParameterMetaData> getCallParameterMetaData()
```
    現在使用されている呼び出しパラメーターのメタデータを取得します。
    戻り値:
    CallParameterMetaData のリスト
  - isSupportsCatalogsInProcedureCalls
```
boolean isSupportsCatalogsInProcedureCalls()
```
    データベースは、プロシージャコールでのカタログ名の使用をサポートしていますか？
  - isSupportsSchemasInProcedureCalls
```
boolean isSupportsSchemasInProcedureCalls()
```
    データベースは、プロシージャコールでのスキーマ名の使用をサポートしていますか？

インターフェース CallMetaDataProvider

メソッドのサマリー

メソッドの詳細

initializeWithMetaData

initializeWithProcedureColumnMetaData

procedureNameToUse

catalogNameToUse

schemaNameToUse

metaDataCatalogNameToUse

metaDataSchemaNameToUse

parameterNameToUse

createDefaultOutParameter

createDefaultInOutParameter

createDefaultInParameter

getUserName

isReturnResultSetSupported

isRefCursorSupported

getRefCursorSqlType

isProcedureColumnMetaDataUsed

byPassReturnParameter

getCallParameterMetaData

isSupportsCatalogsInProcedureCalls

isSupportsSchemasInProcedureCalls