A.1 java.sql.CallableStatement

Symfoware(R) Server JDBCドライバユーザーズガイド - FUJITSU -

目次索引

付録A APIリファレンス

A.1 java.sql.CallableStatement

ストアドプロシジャを実行するために使用するインタフェースです。

■オブジェクトの作成

CallableStatementオブジェクトは、ConnectionインタフェースのprepareCallメソッドで作成します。

■INのパラメタ

ストアドプロシジャのINのパラメタに値を設定する場合には、PreparedStatementから継承したsetXXXメソッドを使用します。設定する値の型は、使用するsetXXXメソッドによって決まります（setFloatで設定する場合はJavaのfloat型、setIntで設定する場合にはJavaのInt型）。setXXXメソッドで指定するJavaの値をJDBCドライバがデータベースの型に対応したJDBC型の値に変換してデータベースに送信します。なお、各型の対応については“データ型”を参照してください。

■OUTのパラメタ

ストアドプロシジャのOUTのパラメタの値を取得する場合には、ストアドプロシジャを実行する前にregisterOutParameterメソッドを使用してJDBC型を登録する必要があります。その後、ストアドプロシジャを実行した後にgetXXXメソッドを使用して値を取得します。

■INOUTのパラメタ

ストアドプロシジャがINOUTのパラメタの場合には、値設定時はsetXXXメソッドを使用します。値取得時は、ストアドプロシジャ実行前にregisterOutParameterメソッドを使用してJDBC型を登録します。その後、ストアドプロシジャ実行後にgetXXXメソッドを使用して値を取得します。

なお、setXXXメソッドで指定するJDBC型と、registerOutParameterメソッドで指定するJDBC型は同一にする必要があります。

■parameterIndex

setXXXメソッド、registerOutParameterメソッド、getXXXメソッドで指定するparameterIndexの値は以下を参考に設定してください。

setXXXメソッド:: INのパラメタ、INOUTのパラメタを対象にして順番を設定してください。
registerOutParameterメソッド:: OUTのパラメタ、INOUTのパラメタを対象にして順番を設定してください。
getXXXメソッド:: OUTのパラメタ、INOUTのパラメタを対象にして順番を設定してください。

戻り値の型およびメソッドの詳細について以下に示します。

戻り値の型	メソッドの詳細
Array	getArray(int i) 本メソッドは使用できません。使用すると未サポートのエラーを返却します。
BigDecimal	getBigDecimal(int parameterIndex) ストアドプロシジャのOUTのパラメタの値を、その値と同じ小数点以下の桁数を持つjava.math.BigDecimalオブジェクトとして取得します。パラメタ parameterIndex 最初のパラメタは1、2番目のパラメタは2などとする。戻り値 java.math.BigDecimalオブジェクトとしてのパラメタ値(データベースに定義したスケール)。値がSQL NULLの場合はNULL。
BigDecimal	getBigDecimal(int parameterIndex, int scale) 推奨しない使用方法です。以下を使用してください。 getBigDecimal(int parameterIndex)
Blob	getBlob(int i) 本メソッドは使用できません。使用すると未サポートのエラーを返却します。ストアドプロシジャのOUTのパラメタがBLOBの場合には、以下を使用してください。 getBytes(int parameterIndex)
boolean	getBoolean(int parameterIndex) ストアドプロシジャのOUTのパラメタの値を、Java booleanとして取得します。パラメタ parameterIndex 最初のパラメタは1、2番目のパラメタは2などとする。戻り値 Java booleanとしてのパラメタ値。値がSQL NULLの場合はfalse。
byte	getByte(int parameterIndex) ストアドプロシジャのOUTのパラメタの値を、Java byteとして取得します。パラメタ parameterIndex 最初のパラメタは1、2番目のパラメタは2などとする。戻り値 Java byteとしてのパラメタ値。値がSQL NULLの場合は0。
byte[]	getBytes(int parameterIndex) ストアドプロシジャのOUTのパラメタの値をJava byte値の配列として取得します。パラメタ parameterIndex 最初のパラメタは1、2番目のパラメタは2などとする。戻り値 Java byte値の配列としてのパラメタ値。値がSQL NULLの場合はNULL。
Clob	getClob(int i) 本メソッドは使用できません。使用すると未サポートのエラーを返却します。
Date	getDate(int parameterIndex) ストアドプロシジャのOUTのパラメタの値をjava.sql.Dateオブジェクトとして取得します。パラメタ parameterIndex 最初のパラメタは1、2番目のパラメタは2などとする。戻り値 java.sql.Dateオブジェクトとしてのパラメタ値。値がSQL NULLの場合はNULL。
Date	getDate(int parameterIndex, Calendar cal) 本メソッドは使用できません。使用すると未サポートのエラーを返却します。
double	getDouble(int parameterIndex) ストアドプロシジャのOUTのパラメタの値をJava doubleとして取得します。パラメタ parameterIndex 最初のパラメタは1、2番目のパラメタは2などとする。戻り値 Java doubleとしてのパラメタ値。値がSQL NULLの場合は0。
float	getFloat(int parameterIndex) ストアドプロシジャのOUTのパラメタの値をJava floatとして取得します。パラメタ parameterIndex 最初のパラメタは1、2番目のパラメタは2などとする。戻り値 Java floatとしてのパラメタ値。値がSQL NULLの場合は0。
int	getInt(int parameterIndex) ストアドプロシジャのOUTのパラメタの値をJava intとして取得します。パラメタ parameterIndex 最初のパラメタは1、2番目のパラメタは2などとする。戻り値 Java intとしてのパラメタ値。値がSQL NULLの場合は0。
long	getLong(int parameterIndex) ストアドプロシジャのOUTのパラメタの値をJava longとして取得します。パラメタ parameterIndex 最初のパラメタは1、2番目のパラメタは2などとする。戻り値 Java longとしてのパラメタ値。値がSQL NULLの場合は0。
Object	getObject(int parameterIndex) 本メソッドは使用できません。使用すると未サポートのエラーを返却します。
Object	getObject(int i, Map map) 本メソッドは使用できません。使用すると未サポートのエラーを返却します。
Ref	getRef(int i) 本メソッドは使用できません。使用すると未サポートのエラーを返却します。
short	getShort(int parameterIndex) ストアドプロシジャのOUTのパラメタの値をJava shortとして取得します。パラメタ parameterIndex 最初のパラメタは1、2番目のパラメタは2などとする。戻り値 Java shortとしてのパラメタ値。値がSQL NULLの場合は0。
String	getString(int parameterIndex) ストアドプロシジャのOUTのパラメタの値をJava Stringとして取り出します。固定長JDBC CHAR型の場合、返却するStringオブジェクトはデータベースが持つ値と正確に同じ値(データベースが付加するパディングを含む)を持ちます。パラメタ parameterIndex 最初のパラメタは1、2番目のパラメタは2などとする。戻り値 Java Stringとしてのパラメタ値。値がSQL NULLの場合はNULL。
Time	getTime(int parameterIndex) ストアドプロシジャのOUTのパラメタの値をjava.sql.Timeオブジェクトとして取得します。パラメタ parameterIndex 最初のパラメタは1、2番目のパラメタは2などとする。戻り値 java.sql.Timeオブジェクトとしてのパラメタ値。値がSQL NULLの場合はNULL。
Time	getTime(int parameterIndex, Calendar cal) 本メソッドは使用できません。使用すると未サポートのエラーを返却します。
Timestamp	getTimestamp(int parameterIndex) ストアドプロシジャのOUTのパラメタの値をjava.sql.Timestampオブジェクトとして取得します。パラメタ parameterIndex 最初のパラメタは1、2番目のパラメタは2などとする。戻り値 java.sql.Timestampオブジェクトとしてのパラメタ値。値がSQL NULLの場合はNULL。
Timestamp	getTimestamp(int parameterIndex, Calendar cal) 本メソッドは使用できません。使用すると未サポートのエラーを返却します。
void	registerOutParameter(int parameterIndex, int sqlType) parameterIndexに指定した位置にあるOUTのパラメタをJDBC型のsqlTypeとして登録します。ストアドプロシジャを実行する前に、すべてのOUTのパラメタを登録する必要があります。 getXXXメソッドでOUTのパラメタの値を取得する際には、sqlTypeで指定したJDBC型に対応するJava型を使用する必要があります。なお、各型の対応については、“データ型”に詳細を記載しています。パラメタがJDBC型のNUMERICまたはDECIMAL以外の場合は、一般的にこのタイプのregisterOutParameterを使用します。パラメタ parameterIndex 最初のパラメタは1、2番目のパラメタは2などとする。 sqlType java.sql.Typesによって定義するJDBC型コード。パラメタがNUMERICまたはDECIMAL型の場合、スケールはデータベースに定義したスケールで取得します。 java.sql.Types.OTHERは未サポートです
void	registerOutParameter(int parameterIndex, int sqlType, int scale) parameterIndexに指定した位置にあるOUTのパラメタをJDBC型のsqlTypeとして登録します。ストアドプロシジャを実行する前に、すべてのOUTのパラメタを登録する必要があります。 getXXXメソッドでOUTのパラメタの値を取得する際には、sqlTypeで指定したJDBC型に対応するJava型を使用する必要があります。なお、各型の対応については、“ データ型”に詳細を記載しています。パラメタがJDBC型のNUMERICまたはDECIMALの場合は、一般的にこのタイプのregisterOutParameterを使用します。パラメタ parameterIndex 最初のパラメタは1、2番目のパラメタは2などとする。 sqlType java.sql.Typesによって定義するJDBC型コード。 scale 希望の小数点以下の桁数。 0以上の数値を指定する。 java.sql.Types.OTHERは未サポートです。
void	registerOutParameter(int paramIndex, int sqlType, String typeName) 本メソッドは使用できません。使用すると未サポートのエラーを返却します。
boolean	wasNull() 最後に読み込まれたOUTのパラメタの値がSQL NULLかどうかを示します。このメソッドを呼び出すのは、getxxxメソッドの呼び出しのあとでなければなりません。そうでない場合は、NULLかどうかを判別するために使用する値がありません。戻り値最後に読み込まれたパラメタがSQL NULLの場合はtrue、そうでない場合はfalse。

目次索引