JavaTM 2
Platform
Std. Ed. v1.4.0

java.sql
インタフェース CallableStatement

すべてのスーパーインタフェース:
PreparedStatement, Statement

public interface CallableStatement
extends PreparedStatement

SQL ストアドプロシージャを実行するのに使用されるインタフェースです。JDBC API は、ストアドプロシージャ SQL エスケープ構文を提供します。これにより、すべての RDBMS に対し標準の方法でストアドプロシージャを呼び出せます。このエスケープ構文には、結果パラメータを含めるものと含めないものとがあります。使用するには、結果パラメータは OUT パラメータとして登録しなければなりません。ほかのパラメータは入出力両方に使用できます。パラメータは、番号により順番に参照されます。最初のパラメータは 1 です。

   {?= call <procedure-name>[<arg1>,<arg2>, ...]}
   {call <procedure-name>[<arg1>,<arg2>, ...]}
 

IN パラメータ値は、PreparedStatement から継承した set メソッドを使用して設定されます。すべての OUT パラメータの型はストアドプロシージャの実行前に登録しなければなりません。それらの値は、ここで提供される get メソッドの実行後に取り出されます。

CallableStatement は、1 つまたは複数の ResultSet オブジェクトを返すことがあります。複数の ResultSet オブジェクトは Statement から継承した操作で処理されます。

移植性を最大限にするには、出力パラメータを得る前に、呼び出しの ResultSet オブジェクトと更新カウントを処理しなければなりません。

関連項目:
Connection.prepareCall(java.lang.String), ResultSet

フィールドの概要
 
インタフェース java.sql.Statement から継承したフィールド
CLOSE_ALL_RESULTS, CLOSE_CURRENT_RESULT, EXECUTE_FAILED, KEEP_CURRENT_RESULT, NO_GENERATED_KEYS, RETURN_GENERATED_KEYS, SUCCESS_NO_INFO
 
メソッドの概要
 Array getArray(int i)
          指定された JDBC ARRAY パラメータの値を Java プログラミング言語の Array オブジェクトとして取り出します。
 Array getArray(String parameterName)
          JDBC ARRAY パラメータの値を Java プログラミング言語の Array オブジェクトとして取り出します。
 BigDecimal getBigDecimal(int parameterIndex)
          指定された JDBC NUMERIC パラメータの値を、その値と同じ小数点以下の桁数を持つ java.math.BigDecimal オブジェクトとして取り出します。
 BigDecimal getBigDecimal(int parameterIndex, int scale)
          推奨されていません。 getBigDecimal(int parameterIndex) または getBigDecimal(String parameterName) を使用します。
 BigDecimal getBigDecimal(String parameterName)
          JDBC NUMERIC パラメータの値を、その値と同じ小数点以下の桁数を持つ java.math.BigDecimal オブジェクトとして取り出します。
 Blob getBlob(int i)
          指定された JDBC BLOB パラメータの値を Java プログラミング言語の Blob オブジェクトとして取り出します。
 Blob getBlob(String parameterName)
          JDBC BLOB パラメータの値を Java プログラミング言語の Blob オブジェクトとして取り出します。
 boolean getBoolean(int parameterIndex)
          指定された JDBC BIT パラメータの値を Java プログラミング言語の boolean として取り出します。
 boolean getBoolean(String parameterName)
          JDBC BIT パラメータの値を Java プログラミング言語の boolean として取り出します。
 byte getByte(int parameterIndex)
          指定された JDBC TINYINT パラメータの値を Java プログラミング言語の byte として取り出します。
 byte getByte(String parameterName)
          JDBC TINYINT パラメータの値を Java プログラミング言語の byte として取り出します。
 byte[] getBytes(int parameterIndex)
          指定された JDBC の BINARY パラメータまたは VARBINARY パラメータの値を Java プログラミング言語の byte 値の配列として取り出します。
 byte[] getBytes(String parameterName)
          JDBC の BINARY パラメータまたは VARBINARY パラメータの値を Java プログラミング言語の byte 値の配列として取り出します。
 Clob getClob(int i)
          指定された JDBC CLOB パラメータの値を Java プログラミング言語の Clob オブジェクトとして取り出します。
 Clob getClob(String parameterName)
          JDBC CLOB パラメータの値を Java プログラミング言語の Clob オブジェクトとして取り出します。
 Date getDate(int parameterIndex)
          指定された JDBC DATE パラメータの値を java.sql.Date オブジェクトとして取り出します。
 Date getDate(int parameterIndex, Calendar cal)
          指定された JDBC DATE パラメータの値を java.sql.Date オブジェクトとして取り出します。
 Date getDate(String parameterName)
          JDBC DATE パラメータの値を java.sql.Date オブジェクトとして取り出します。
 Date getDate(String parameterName, Calendar cal)
          JDBC DATE パラメータの値を java.sql.Date オブジェクトとして取り出します。
 double getDouble(int parameterIndex)
          指定された JDBC DOUBLE パラメータの値を Java プログラミング言語の double として取り出します。
 double getDouble(String parameterName)
          JDBC DOUBLE パラメータの値を Java プログラミング言語の double として取り出します。
 float getFloat(int parameterIndex)
          指定された JDBC FLOAT パラメータの値を Java プログラミング言語の float として取り出します。
 float getFloat(String parameterName)
          JDBC FLOAT パラメータの値を Java プログラミング言語の float として取り出します。
 int getInt(int parameterIndex)
          指定された JDBC INTEGER パラメータの値を Java プログラミング言語の int として取り出します。
 int getInt(String parameterName)
          JDBC INTEGER パラメータの値を Java プログラミング言語の int として取り出します。
 long getLong(int parameterIndex)
          指定された JDBC BIGINT パラメータの値を Java プログラミング言語の long として取り出します。
 long getLong(String parameterName)
          JDBC BIGINT パラメータの値を Java プログラミング言語の long として取り出します。
 Object getObject(int parameterIndex)
          指定されたパラメータの値を Java プログラミング言語の Object として取り出します。
 Object getObject(int i, Map map)
          OUT パラメータ i の値を表すオブジェクトを返し、map を使用してそのパラメータ値のカスタムマッピングを行います。
 Object getObject(String parameterName)
          パラメータの値を Java プログラミング言語の Object として取り出します。
 Object getObject(String parameterName, Map map)
          OUT パラメータ i の値を表すオブジェクトを返し、map を使用してそのパラメータ値のカスタムマッピングを行います。
 Ref getRef(int i)
          指定された JDBC REF(<structured-type>) パラメータの値を Java プログラミング言語の Ref オブジェクトとして取り出します。
 Ref getRef(String parameterName)
          JDBC REF(<structured-type>) パラメータの値を Java プログラミング言語の Ref オブジェクトとして取り出します。
 short getShort(int parameterIndex)
          指定された JDBC SMALLINT パラメータの値を Java プログラミング言語の short として取り出します。
 short getShort(String parameterName)
          JDBC SMALLINT パラメータの値を Java プログラミング言語の short として取り出します。
 String getString(int parameterIndex)
          指定された JDBC の CHARVARCHAR、または LONGVARCHAR パラメータの値を Java プログラミング言語の String として取り出します。
 String getString(String parameterName)
          JDBC の CHARVARCHAR、または LONGVARCHAR パラメータの値を Java プログラミング言語の String として取り出します。
 Time getTime(int parameterIndex)
          指定された JDBC TIME パラメータの値を java.sql.Time オブジェクトとして取り出します。
 Time getTime(int parameterIndex, Calendar cal)
          指定された JDBC TIME パラメータの値を java.sql.Time オブジェクトとして取り出します。
 Time getTime(String parameterName)
          JDBC TIME パラメータの値を java.sql.Time オブジェクトとして取り出します。
 Time getTime(String parameterName, Calendar cal)
          JDBC TIME パラメータの値を java.sql.Time オブジェクトとして取り出します。
 Timestamp getTimestamp(int parameterIndex)
          指定された JDBC TIMESTAMP パラメータの値を java.sql.Timestamp オブジェクトとして取り出します。
 Timestamp getTimestamp(int parameterIndex, Calendar cal)
          指定された JDBC TIMESTAMP パラメータの値を java.sql.Timestamp オブジェクトとして取り出します。
 Timestamp getTimestamp(String parameterName)
          JDBC TIMESTAMP パラメータの値を java.sql.Timestamp オブジェクトとして取り出します。
 Timestamp getTimestamp(String parameterName, Calendar cal)
          JDBC TIMESTAMP パラメータの値を java.sql.Timestamp オブジェクトとして取り出します。
 URL getURL(int parameterIndex)
          指定された JDBC DATALINK パラメータの値を java.net.URL オブジェクトとして取り出します。
 URL getURL(String parameterName)
          JDBC DATALINK パラメータの値を java.net.URL オブジェクトとして取り出します。
 void registerOutParameter(int parameterIndex, int sqlType)
          順番 parameterIndex の OUT パラメータを JDBC の型の sqlType に登録します。
 void registerOutParameter(int parameterIndex, int sqlType, int scale)
          順番 parameterIndex のパラメータを JDBC の型の sqlType に登録します。
 void registerOutParameter(int paramIndex, int sqlType, String typeName)
          指定された出力パラメータを登録します。
 void registerOutParameter(String parameterName, int sqlType)
          parameterName という名前の OUT パラメータを JDBC の型の sqlType に登録します。
 void registerOutParameter(String parameterName, int sqlType, int scale)
          parameterName という名前のパラメータを JDBC の型の sqlType に登録します。
 void registerOutParameter(String parameterName, int sqlType, String typeName)
          指定された出力パラメータを登録します。
 void setAsciiStream(String parameterName, InputStream x, int length)
          指定されたパラメータを、指定されたバイト数を持つ指定された入力ストリームに設定します。
 void setBigDecimal(String parameterName, BigDecimal x)
          指定されたパラメータを指定された java.math.BigDecimal 値に設定します。
 void setBinaryStream(String parameterName, InputStream x, int length)
          指定されたパラメータを、指定されたバイト数を持つ指定された入力ストリームに設定します。
 void setBoolean(String parameterName, boolean x)
          指定されたパラメータを指定された Java の boolean 値に設定します。
 void setByte(String parameterName, byte x)
          指定されたパラメータを指定された Java の byte 値に設定します。
 void setBytes(String parameterName, byte[] x)
          指定されたパラメータを指定された Java のバイト配列に設定します。
 void setCharacterStream(String parameterName, Reader reader, int length)
          指定されたパラメータを、指定された文字数である指定された Reader オブジェクトに設定します。
 void setDate(String parameterName, Date x)
          指定されたパラメータを指定された java.sql.Date 値に設定します。
 void setDate(String parameterName, Date x, Calendar cal)
          指定された Calendar オブジェクトを使用して、指定されたパラメータを指定された java.sql.Date 値に設定します。
 void setDouble(String parameterName, double x)
          指定されたパラメータを指定された Java の double 値に設定します。
 void setFloat(String parameterName, float x)
          指定されたパラメータを指定された Java の float 値に設定します。
 void setInt(String parameterName, int x)
          指定されたパラメータを指定された Java の int 値に設定します。
 void setLong(String parameterName, long x)
          指定されたパラメータを指定された Java の long 値に設定します。
 void setNull(String parameterName, int sqlType)
          指定されたパラメータを SQL NULL に設定します。
 void setNull(String parameterName, int sqlType, String typeName)
          指定されたパラメータを SQL NULL に設定します。
 void setObject(String parameterName, Object x)
          指定されたパラメータの値を、指定されたオブジェクトを使用して設定します。
 void setObject(String parameterName, Object x, int targetSqlType)
          指定されたパラメータの値を、指定されたオブジェクトで設定します。
 void setObject(String parameterName, Object x, int targetSqlType, int scale)
          指定されたパラメータの値を、指定されたオブジェクトを使用して設定します。
 void setShort(String parameterName, short x)
          指定されたパラメータを指定された Java の short 値に設定します。
 void setString(String parameterName, String x)
          指定されたパラメータを指定された Java の String 値に設定します。
 void setTime(String parameterName, Time x)
          指定されたパラメータを指定された java.sql.Time 値に設定します。
 void setTime(String parameterName, Time x, Calendar cal)
          指定された Calendar オブジェクトを使用して、指定されたパラメータを指定された java.sql.Time 値に設定します。
 void setTimestamp(String parameterName, Timestamp x)
          指定されたパラメータを指定された java.sql.Timestamp 値に設定します。
 void setTimestamp(String parameterName, Timestamp x, Calendar cal)
          指定された Calendar オブジェクトを使用して、指定されたパラメータを指定された java.sql.Timestamp 値に設定します。
 void setURL(String parameterName, URL val)
          指定されたパラメータを指定された java.net.URL オブジェクトに設定します。
 boolean wasNull()
          最後に読み込まれた OUT パラメータの値が SQL NULL かどうかを取得します。
 
インタフェース java.sql.PreparedStatement から継承したメソッド
addBatch, clearParameters, execute, executeQuery, executeUpdate, getMetaData, getParameterMetaData, setArray, setAsciiStream, setBigDecimal, setBinaryStream, setBlob, setBoolean, setByte, setBytes, setCharacterStream, setClob, setDate, setDate, setDouble, setFloat, setInt, setLong, setNull, setNull, setObject, setObject, setObject, setRef, setShort, setString, setTime, setTime, setTimestamp, setTimestamp, setUnicodeStream, setURL
 
インタフェース java.sql.Statement から継承したメソッド
addBatch, cancel, clearBatch, clearWarnings, close, execute, execute, execute, execute, executeBatch, executeQuery, executeUpdate, executeUpdate, executeUpdate, executeUpdate, getConnection, getFetchDirection, getFetchSize, getGeneratedKeys, getMaxFieldSize, getMaxRows, getMoreResults, getMoreResults, getQueryTimeout, getResultSet, getResultSetConcurrency, getResultSetHoldability, getResultSetType, getUpdateCount, getWarnings, setCursorName, setEscapeProcessing, setFetchDirection, setFetchSize, setMaxFieldSize, setMaxRows, setQueryTimeout
 

メソッドの詳細

registerOutParameter

public void registerOutParameter(int parameterIndex,
                                 int sqlType)
                          throws SQLException
順番 parameterIndex の OUT パラメータを JDBC の型の sqlType に登録します。ストアドプロシージャが実行される前に、すべての OUT パラメータを登録する必要があります。

OUT パラメータ用に sqlType によって指定された JDBC の型は、そのパラメータの値を読み込むために get メソッドで使用する必要のある Java の型を判定します。

この出力パラメータに返されることになっている JDBC の型がこの特定のデータベースに固有である場合、sqlTypejava.sql.Types.OTHER でなければなりません。getObject(int) メソッドは値を取り出します。

パラメータ:
parameterIndex - 最初のパラメータは 1、2 番目のパラメータは 2、などとする
sqlType - java.sql.Types によって定義される JDBC の型コード。パラメータが JDBC の型 NUMERIC または DECIMAL の場合、スケール値を受け入れるバージョンの registerOutParameter を使用する
例外:
SQLException - データベースアクセスエラーが発生した場合
関連項目:
Types

registerOutParameter

public void registerOutParameter(int parameterIndex,
                                 int sqlType,
                                 int scale)
                          throws SQLException
順番 parameterIndex のパラメータを JDBC の型の sqlType に登録します。このメソッドは、ストアドプロシージャが実行される前に呼び出さなければなりません。

OUT パラメータ用に sqlType によって指定された JDBC の型は、そのパラメータの値を読み込むために get メソッドで使用する必要のある Java の型を判定します。

パラメータが JDBC の型 NUMERIC または DECIMAL の場合は、このバージョンの registerOutParameter を使用しなければなりません。

パラメータ:
parameterIndex - 最初のパラメータは 1、2 番目のパラメータは 2、などとする
sqlType - java.sql.Types によって定義される SQL の型コード
scale - 希望の小数点以下の桁数。0 以上の数値を指定する
例外:
SQLException - データベースアクセスエラーが発生した場合
関連項目:
Types

wasNull

public boolean wasNull()
                throws SQLException
最後に読み込まれた OUT パラメータの値が SQL NULL かどうかを取得します。このメソッドを呼び出すのは、読み込み用メソッドの呼び出しのあとでなければなりません。そうでない場合は、null かどうかを判別するために使用する値がありません。

戻り値:
最後に読み込まれたパラメータが SQL NULL の場合は true、そうでない場合は false
例外:
SQLException - データベースアクセスエラーが発生した場合

getString

public String getString(int parameterIndex)
                 throws SQLException
指定された JDBC の CHARVARCHAR、または LONGVARCHAR パラメータの値を Java プログラミング言語の String として取り出します。

固定長 JDBC CHAR の型の場合、返される String オブジェクトはデータベースで JDBC CHAR が持つ値と正確に同じ値 (データベースが付加するパディングを含む) を持ちます。

パラメータ:
parameterIndex - 最初のパラメータは 1、2 番目のパラメータは 2、などとする
戻り値:
パラメータ値。値が SQL NULL の場合は null
例外:
SQLException - データベースアクセスエラーが発生した場合
関連項目:
setString(java.lang.String, java.lang.String)

getBoolean

public boolean getBoolean(int parameterIndex)
                   throws SQLException
指定された JDBC BIT パラメータの値を Java プログラミング言語の boolean として取り出します。

パラメータ:
parameterIndex - 最初のパラメータは 1、2 番目のパラメータは 2、などとする
戻り値:
パラメータ値。値が SQL NULL の場合は false
例外:
SQLException - データベースアクセスエラーが発生した場合
関連項目:
setBoolean(java.lang.String, boolean)

getByte

public byte getByte(int parameterIndex)
             throws SQLException
指定された JDBC TINYINT パラメータの値を Java プログラミング言語の byte として取り出します。

パラメータ:
parameterIndex - 最初のパラメータは 1、2 番目のパラメータは 2、などとする
戻り値:
パラメータ値。値が SQL NULL の場合は 0
例外:
SQLException - データベースアクセスエラーが発生した場合
関連項目:
setByte(java.lang.String, byte)

getShort

public short getShort(int parameterIndex)
               throws SQLException
指定された JDBC SMALLINT パラメータの値を Java プログラミング言語の short として取り出します。

パラメータ:
parameterIndex - 最初のパラメータは 1、2 番目のパラメータは 2、などとする
戻り値:
パラメータ値。値が SQL NULL の場合は 0
例外:
SQLException - データベースアクセスエラーが発生した場合
関連項目:
setShort(java.lang.String, short)

getInt

public int getInt(int parameterIndex)
           throws SQLException
指定された JDBC INTEGER パラメータの値を Java プログラミング言語の int として取り出します。

パラメータ:
parameterIndex - 最初のパラメータは 1、2 番目のパラメータは 2、などとする
戻り値:
パラメータ値。値が SQL NULL の場合は 0
例外:
SQLException - データベースアクセスエラーが発生した場合
関連項目:
setInt(java.lang.String, int)

getLong

public long getLong(int parameterIndex)
             throws SQLException
指定された JDBC BIGINT パラメータの値を Java プログラミング言語の long として取り出します。

パラメータ:
parameterIndex - 最初のパラメータは 1、2 番目のパラメータは 2、などとする
戻り値:
パラメータ値。値が SQL NULL の場合は 0
例外:
SQLException - データベースアクセスエラーが発生した場合
関連項目:
setLong(java.lang.String, long)

getFloat

public float getFloat(int parameterIndex)
               throws SQLException
指定された JDBC FLOAT パラメータの値を Java プログラミング言語の float として取り出します。

パラメータ:
parameterIndex - 最初のパラメータは 1、2 番目のパラメータは 2、などとする
戻り値:
パラメータ値。値が SQL NULL の場合は 0
例外:
SQLException - データベースアクセスエラーが発生した場合
関連項目:
setFloat(java.lang.String, float)

getDouble

public double getDouble(int parameterIndex)
                 throws SQLException
指定された JDBC DOUBLE パラメータの値を Java プログラミング言語の double として取り出します。

パラメータ:
parameterIndex - 最初のパラメータは 1、2 番目のパラメータは 2、などとする
戻り値:
パラメータ値。値が SQL NULL の場合は 0
例外:
SQLException - データベースアクセスエラーが発生した場合
関連項目:
setDouble(java.lang.String, double)

getBigDecimal

public BigDecimal getBigDecimal(int parameterIndex,
                                int scale)
                         throws SQLException
推奨されていません。 getBigDecimal(int parameterIndex) または getBigDecimal(String parameterName) を使用します。

指定された JDBC NUMERIC パラメータの値を、scale で指定された小数点以下の桁数を持つ java.math.BigDecimal オブジェクトとして取り出します。

パラメータ:
parameterIndex - 最初のパラメータは 1、2 番目のパラメータは 2、などとする
scale - 小数点以下の桁数
戻り値:
パラメータ値。値が SQL NULL の場合は null
例外:
SQLException - データベースアクセスエラーが発生した場合
関連項目:
setBigDecimal(java.lang.String, java.math.BigDecimal)

getBytes

public byte[] getBytes(int parameterIndex)
                throws SQLException
指定された JDBC の BINARY パラメータまたは VARBINARY パラメータの値を Java プログラミング言語の byte 値の配列として取り出します。

パラメータ:
parameterIndex - 最初のパラメータは 1、2 番目のパラメータは 2、などとする
戻り値:
パラメータ値。値が SQL NULL の場合は null
例外:
SQLException - データベースアクセスエラーが発生した場合
関連項目:
setBytes(java.lang.String, byte[])

getDate

public Date getDate(int parameterIndex)
             throws SQLException
指定された JDBC DATE パラメータの値を java.sql.Date オブジェクトとして取り出します。

パラメータ:
parameterIndex - 最初のパラメータは 1、2 番目のパラメータは 2、などとする
戻り値:
パラメータ値。値が SQL NULL の場合は null
例外:
SQLException - データベースアクセスエラーが発生した場合
関連項目:
setDate(java.lang.String, java.sql.Date)

getTime

public Time getTime(int parameterIndex)
             throws SQLException
指定された JDBC TIME パラメータの値を java.sql.Time オブジェクトとして取り出します。

パラメータ:
parameterIndex - 最初のパラメータは 1、2 番目のパラメータは 2、などとする
戻り値:
パラメータ値。値が SQL NULL の場合は null
例外:
SQLException - データベースアクセスエラーが発生した場合
関連項目:
setTime(java.lang.String, java.sql.Time)

getTimestamp

public Timestamp getTimestamp(int parameterIndex)
                       throws SQLException
指定された JDBC TIMESTAMP パラメータの値を java.sql.Timestamp オブジェクトとして取り出します。

パラメータ:
parameterIndex - 最初のパラメータは 1、2 番目のパラメータは 2、などとする
戻り値:
パラメータ値。値が SQL NULL の場合は null
例外:
SQLException - データベースアクセスエラーが発生した場合
関連項目:
setTimestamp(java.lang.String, java.sql.Timestamp)

getObject

public Object getObject(int parameterIndex)
                 throws SQLException
指定されたパラメータの値を Java プログラミング言語の Object として取り出します。値が SQL NULL の場合、ドライバは Java null を返します。

このメソッドは、Java オブジェクトを返します。そのオブジェクトの型は、registerOutParameter メソッドを使用して登録された JDBC の型に対応します。ターゲットの JDBC の型を java.sql.Types.OTHER として登録することで、このメソッドを使用してデータベース固有の抽象データの型を読み込むことができます。

パラメータ:
parameterIndex - 最初のパラメータは 1、2 番目のパラメータは 2、などとする
戻り値:
OUT パラメータ値を保持する java.lang.Object
例外:
SQLException - データベースアクセスエラーが発生した場合
関連項目:
Types, setObject(java.lang.String, java.lang.Object, int, int)

getBigDecimal

public BigDecimal getBigDecimal(int parameterIndex)
                         throws SQLException
指定された JDBC NUMERIC パラメータの値を、その値と同じ小数点以下の桁数を持つ java.math.BigDecimal オブジェクトとして取り出します。

パラメータ:
parameterIndex - 最初のパラメータは 1、2 番目のパラメータは 2、などとする
戻り値:
パラメータ値 (全精度)。値が SQL NULL の場合は null
例外:
SQLException - データベースアクセスエラーが発生した場合
導入されたバージョン:
1.2
関連項目:
setBigDecimal(java.lang.String, java.math.BigDecimal)

getObject

public Object getObject(int i,
                        Map map)
                 throws SQLException
OUT パラメータ i の値を表すオブジェクトを返し、map を使用してそのパラメータ値のカスタムマッピングを行います。

このメソッドは、Java オブジェクトを返します。そのオブジェクトの型は、registerOutParameter メソッドを使用して登録された JDBC の型に対応します。ターゲットの JDBC の型を java.sql.Types.OTHER として登録することで、このメソッドを使用してデータベース固有の抽象データの型を読み込むことができます。

パラメータ:
i - 最初のパラメータは 1、2 番目のパラメータは 2、などとする
map - SQL の型名から Java クラスへのマッピング
戻り値:
OUT パラメータ値を保持する java.lang.Object
例外:
SQLException - データベースアクセスエラーが発生した場合
導入されたバージョン:
1.2
関連項目:
setObject(java.lang.String, java.lang.Object, int, int)

getRef

public Ref getRef(int i)
           throws SQLException
指定された JDBC REF(<structured-type>) パラメータの値を Java プログラミング言語の Ref オブジェクトとして取り出します。

パラメータ:
i - 最初のパラメータは 1、2 番目のパラメータは 2、などとする
戻り値:
Java プログラミング言語の Ref オブジェクトとして表されたパラメータ値。値が SQL NULL の場合は null
例外:
SQLException - データベースアクセスエラーが発生した場合
導入されたバージョン:
1.2

getBlob

public Blob getBlob(int i)
             throws SQLException
指定された JDBC BLOB パラメータの値を Java プログラミング言語の Blob オブジェクトとして取り出します。

パラメータ:
i - 最初のパラメータは 1、2 番目のパラメータは 2、などとする
戻り値:
Java プログラミング言語の Blob オブジェクトとして表されたパラメータ値。値が SQL NULL の場合は null
例外:
SQLException - データベースアクセスエラーが発生した場合
導入されたバージョン:
1.2

getClob

public Clob getClob(int i)
             throws SQLException
指定された JDBC CLOB パラメータの値を Java プログラミング言語の Clob オブジェクトとして取り出します。

パラメータ:
i - 最初のパラメータは 1、2 番目のパラメータは 2、などとする
戻り値:
Java プログラミング言語の Clob オブジェクトとして表されたパラメータ値。値が SQL NULL の場合は null
例外:
SQLException - データベースアクセスエラーが発生した場合
導入されたバージョン:
1.2

getArray

public Array getArray(int i)
               throws SQLException
指定された JDBC ARRAY パラメータの値を Java プログラミング言語の Array オブジェクトとして取り出します。

パラメータ:
i - 最初のパラメータは 1、2 番目のパラメータは 2、などとする
戻り値:
Java プログラミング言語の Array オブジェクトとして表されたパラメータ値。値が SQL NULL の場合は null
例外:
SQLException - データベースアクセスエラーが発生した場合
導入されたバージョン:
1.2

getDate

public Date getDate(int parameterIndex,
                    Calendar cal)
             throws SQLException
指定された JDBC DATE パラメータの値を java.sql.Date オブジェクトとして取り出します。日付の作成には、指定された Calendar オブジェクトを使用します。Calendar オブジェクトを使用すると、ドライバはカスタムタイムゾーンおよびロケールを考慮して日付を計算できます。Calendar オブジェクトを指定しない場合、ドライバはデフォルトのタイムゾーンおよびロケールを使用します。

パラメータ:
parameterIndex - 最初のパラメータは 1、2 番目のパラメータは 2、などとする
cal - ドライバが日付を作成するために使用する Calendar オブジェクト
戻り値:
パラメータ値。値が SQL NULL の場合は null
例外:
SQLException - データベースアクセスエラーが発生した場合
導入されたバージョン:
1.2
関連項目:
setDate(java.lang.String, java.sql.Date)

getTime

public Time getTime(int parameterIndex,
                    Calendar cal)
             throws SQLException
指定された JDBC TIME パラメータの値を java.sql.Time オブジェクトとして取り出します。時刻の作成には、指定された Calendar オブジェクトを使用します。Calendar オブジェクトを使用すると、ドライバはカスタムタイムゾーンおよびロケールを考慮して時刻を計算できます。Calendar オブジェクトを指定しない場合、ドライバはデフォルトのタイムゾーンおよびロケールを使用します。

パラメータ:
parameterIndex - 最初のパラメータは 1、2 番目のパラメータは 2、などとする
cal - ドライバが時刻を作成するために使用する Calendar オブジェクト
戻り値:
パラメータ値。値が SQL NULL の場合は null
例外:
SQLException - データベースアクセスエラーが発生した場合
導入されたバージョン:
1.2
関連項目:
setTime(java.lang.String, java.sql.Time)

getTimestamp

public Timestamp getTimestamp(int parameterIndex,
                              Calendar cal)
                       throws SQLException
指定された JDBC TIMESTAMP パラメータの値を java.sql.Timestamp オブジェクトとして取り出します。Timestamp オブジェクトの作成には、指定された Calendar オブジェクトを使用します。Calendar オブジェクトを使用すると、ドライバはカスタムタイムゾーンおよびロケールを考慮してタイムスタンプを計算できます。Calendar オブジェクトを指定しない場合、ドライバはデフォルトのタイムゾーンおよびロケールを使用します。

パラメータ:
parameterIndex - 最初のパラメータは 1、2 番目のパラメータは 2、などとする
cal - ドライバがタイムスタンプを作成するために使用する Calendar オブジェクト
戻り値:
パラメータ値。値が SQL NULL の場合は null
例外:
SQLException - データベースアクセスエラーが発生した場合
導入されたバージョン:
1.2
関連項目:
setTimestamp(java.lang.String, java.sql.Timestamp)

registerOutParameter

public void registerOutParameter(int paramIndex,
                                 int sqlType,
                                 String typeName)
                          throws SQLException
指定された出力パラメータを登録します。ユーザ定義出力パラメータまたは REF 出力パラメータには、このバージョンの registerOutParameter メソッドを使用します。ユーザ定義の型の例には、STRUCTDISTINCTJAVA_OBJECT、および名前付き配列があります。ストアドプロシージャの呼び出しを実行する前に、registerOutParameter を明示的に呼び出して、各 OUT パラメータの型を java.sql.Types から登録する必要があります。ユーザ定義パラメータの場合は、そのパラメータの完全指定された SQL の型名も指定します。REF パラメータでは、参照される型の完全指定された型名を指定する必要があります。型コードや型名の情報を必要としない JDBC ドライバはそれを無視します。ただし、移植性を実現するには、アプリケーションはユーザ定義パラメータおよび REF パラメータのそれらの値を提供しなければなりません。ユーザ定義パラメータおよび REF パラメータを対象としていますが、このメソッドは任意の JDBC 型のパラメータを登録するために使用できます。パラメータがユーザ定義の型または REF 型を持たない場合、typeName パラメータは無視されます。

注: 出力パラメータの値を読み込むときには、Java の型がパラメータの登録されている SQL の型に対応する読み込み用メソッドを使用する必要があります。

パラメータ:
paramIndex - 最初のパラメータは 1、2 番目のパラメータは 2、などとする
sqlType - からの値
typeName - SQL 構造化型の完全指定された名前
例外:
SQLException - データベースアクセスエラーが発生した場合
導入されたバージョン:
1.2
関連項目:
Types

registerOutParameter

public void registerOutParameter(String parameterName,
                                 int sqlType)
                          throws SQLException
parameterName という名前の OUT パラメータを JDBC の型の sqlType に登録します。ストアドプロシージャが実行される前に、すべての OUT パラメータを登録する必要があります。

OUT パラメータ用に sqlType によって指定された JDBC の型は、そのパラメータの値を読み込むために get メソッドで使用する必要のある Java の型を判定します。

この出力パラメータに返されることになっている JDBC の型がこの特定のデータベースに固有である場合、sqlTypejava.sql.Types.OTHER でなければなりません。getObject(int) メソッドは値を取り出します。

パラメータ:
parameterName - パラメータの名前
sqlType - java.sql.Types によって定義される JDBC の型コード。パラメータが JDBC の型 NUMERIC または DECIMAL の場合、スケール値を受け入れるバージョンの registerOutParameter を使用する
例外:
SQLException - データベースアクセスエラーが発生した場合
導入されたバージョン:
1.4
関連項目:
Types

registerOutParameter

public void registerOutParameter(String parameterName,
                                 int sqlType,
                                 int scale)
                          throws SQLException
parameterName という名前のパラメータを JDBC の型の sqlType に登録します。このメソッドは、ストアドプロシージャが実行される前に呼び出さなければなりません。

OUT パラメータ用に sqlType によって指定された JDBC の型は、そのパラメータの値を読み込むために get メソッドで使用する必要のある Java の型を判定します。

パラメータが JDBC の型 NUMERIC または DECIMAL の場合は、このバージョンの registerOutParameter を使用しなければなりません。

パラメータ:
parameterName - パラメータの名前
sqlType - java.sql.Types によって定義される SQL の型コード
scale - 希望の小数点以下の桁数。0 以上の数値を指定する
例外:
SQLException - データベースアクセスエラーが発生した場合
導入されたバージョン:
1.4
関連項目:
Types

registerOutParameter

public void registerOutParameter(String parameterName,
                                 int sqlType,
                                 String typeName)
                          throws SQLException
指定された出力パラメータを登録します。ユーザ命名出力パラメータまたは REF 出力パラメータには、このバージョンの registerOutParameter メソッドを使用します。ユーザ命名型の例には、STRUCT、DISTINCT、JAVA_OBJECT、および名前付き配列があります。ストアドプロシージャの呼び出しを実行する前に、registerOutParameter を明示的に呼び出して、各 OUT パラメータの型を java.sql.Types から登録する必要があります。ユーザ命名パラメータの場合は、そのパラメータの完全指定された SQL の型名も指定します。REF パラメータでは、参照される型の完全指定された型名を指定する必要があります。型コードや型名の情報を必要としない JDBC ドライバはそれを無視します。ただし、移植性を実現するには、アプリケーションはユーザ命名パラメータおよび REF パラメータのそれらの値を提供しなければなりません。ユーザ命名パラメータおよび REF パラメータを対象としていますが、このメソッドは任意の JDBC 型のパラメータを登録するために使用できます。パラメータがユーザ命名の型または REF 型を持たない場合、typeName パラメータは無視されます。

注: 出力パラメータの値を読み込むときには、Java の型 XXX がパラメータの登録されている SQL の型に対応する getXXX メソッドを使用する必要があります。

パラメータ:
parameterName - パラメータの名前
sqlType - からの値
typeName - SQL 構造化型の完全指定された名前
例外:
SQLException - データベースアクセスエラーが発生した場合
導入されたバージョン:
1.4
関連項目:
Types

getURL

public URL getURL(int parameterIndex)
           throws SQLException
指定された JDBC DATALINK パラメータの値を java.net.URL オブジェクトとして取り出します。

パラメータ:
parameterIndex - 最初のパラメータは 1、2 番目のパラメータは 2、などとする
戻り値:
指定されたパラメータとして使用される JDBC DATALINK 値を表す java.net.URL オブジェクト
例外:
SQLException - データベースアクセスエラーが発生した場合、または返された URL が Java プラットフォームの有効な URL でない場合
導入されたバージョン:
1.4
関連項目:
setURL(java.lang.String, java.net.URL)

setURL

public void setURL(String parameterName,
                   URL val)
            throws SQLException
指定されたパラメータを指定された java.net.URL オブジェクトに設定します。データベースに送るときに、ドライバはこれを SQL DATALINK 値に変換します。

パラメータ:
parameterName - パラメータの名前
val - パラメータ値
例外:
SQLException - データベースアクセスエラーが発生した場合、または URL が無効の場合
導入されたバージョン:
1.4
関連項目:
getURL(int)

setNull

public void setNull(String parameterName,
                    int sqlType)
             throws SQLException
指定されたパラメータを SQL NULL に設定します。

注: パラメータの SQL 型を指定しなければなりません。

パラメータ:
parameterName - パラメータの名前
sqlType - java.sql.Types で定義される SQL 型コード
例外:
SQLException - データベースアクセスエラーが発生した場合
導入されたバージョン:
1.4

setBoolean

public void setBoolean(String parameterName,
                       boolean x)
                throws SQLException
指定されたパラメータを指定された Java の boolean 値に設定します。データベースに送るときに、ドライバはこれを SQL BIT 値に変換します。

パラメータ:
parameterName - パラメータの名前
x - パラメータ値
例外:
SQLException - データベースアクセスエラーが発生した場合
導入されたバージョン:
1.4
関連項目:
getBoolean(int)

setByte

public void setByte(String parameterName,
                    byte x)
             throws SQLException
指定されたパラメータを指定された Java の byte 値に設定します。データベースに送るときに、ドライバはこれを SQL TINYINT 値に変換します。

パラメータ:
parameterName - パラメータの名前
x - パラメータ値
例外:
SQLException - データベースアクセスエラーが発生した場合
導入されたバージョン:
1.4
関連項目:
getByte(int)

setShort

public void setShort(String parameterName,
                     short x)
              throws SQLException
指定されたパラメータを指定された Java の short 値に設定します。データベースに送るときに、ドライバはこれを SQL SMALLINT 値に変換します。

パラメータ:
parameterName - パラメータの名前
x - パラメータ値
例外:
SQLException - データベースアクセスエラーが発生した場合
導入されたバージョン:
1.4
関連項目:
getShort(int)

setInt

public void setInt(String parameterName,
                   int x)
            throws SQLException
指定されたパラメータを指定された Java の int 値に設定します。データベースに送るときに、ドライバはこれを SQL INTEGER 値に変換します。

パラメータ:
parameterName - パラメータの名前
x - パラメータ値
例外:
SQLException - データベースアクセスエラーが発生した場合
導入されたバージョン:
1.4
関連項目:
getInt(int)

setLong

public void setLong(String parameterName,
                    long x)
             throws SQLException
指定されたパラメータを指定された Java の long 値に設定します。データベースに送るときに、ドライバはこれを SQL BIGINT 値に変換します。

パラメータ:
parameterName - パラメータの名前
x - パラメータ値
例外:
SQLException - データベースアクセスエラーが発生した場合
導入されたバージョン:
1.4
関連項目:
getLong(int)

setFloat

public void setFloat(String parameterName,
                     float x)
              throws SQLException
指定されたパラメータを指定された Java の float 値に設定します。データベースに送るときに、ドライバはこれを SQL FLOAT 値に変換します。

パラメータ:
parameterName - パラメータの名前
x - パラメータ値
例外:
SQLException - データベースアクセスエラーが発生した場合
導入されたバージョン:
1.4
関連項目:
getFloat(int)

setDouble

public void setDouble(String parameterName,
                      double x)
               throws SQLException
指定されたパラメータを指定された Java の double 値に設定します。データベースに送るときに、ドライバはこれを SQL DOUBLE 値に変換します。

パラメータ:
parameterName - パラメータの名前
x - パラメータ値
例外:
SQLException - データベースアクセスエラーが発生した場合
導入されたバージョン:
1.4
関連項目:
getDouble(int)

setBigDecimal

public void setBigDecimal(String parameterName,
                          BigDecimal x)
                   throws SQLException
指定されたパラメータを指定された java.math.BigDecimal 値に設定します。データベースに送るときに、ドライバはこれを SQL NUMERIC 値に変換します。

パラメータ:
parameterName - パラメータの名前
x - パラメータ値
例外:
SQLException - データベースアクセスエラーが発生した場合
導入されたバージョン:
1.4
関連項目:
getBigDecimal(int, int)

setString

public void setString(String parameterName,
                      String x)
               throws SQLException
指定されたパラメータを指定された Java の String 値に設定します。データベースに送るときに、ドライバはこれを SQL VARCHAR または LONGVARCHAR 値 (ドライバの VARCHAR 値に関する制限に関する引数のサイズに依存) に変換します。

パラメータ:
parameterName - パラメータの名前
x - パラメータ値
例外:
SQLException - データベースアクセスエラーが発生した場合
導入されたバージョン:
1.4
関連項目:
getString(int)

setBytes

public void setBytes(String parameterName,
                     byte[] x)
              throws SQLException
指定されたパラメータを指定された Java のバイト配列に設定します。データベースに送るときに、ドライバはこれを SQL VARBINARY または LONGVARBINARY (ドライバの VARBINARY 値に関する制限に関する引数のサイズに依存) に変換します。

パラメータ:
parameterName - パラメータの名前
x - パラメータ値
例外:
SQLException - データベースアクセスエラーが発生した場合
導入されたバージョン:
1.4
関連項目:
getBytes(int)

setDate

public void setDate(String parameterName,
                    Date x)
             throws SQLException
指定されたパラメータを指定された java.sql.Date 値に設定します。データベースに送るときに、ドライバはこれを SQL DATE 値に変換します。

パラメータ:
parameterName - パラメータの名前
x - パラメータ値
例外:
SQLException - データベースアクセスエラーが発生した場合
導入されたバージョン:
1.4
関連項目:
getDate(int)

setTime

public void setTime(String parameterName,
                    Time x)
             throws SQLException
指定されたパラメータを指定された java.sql.Time 値に設定します。データベースに送るときに、ドライバはこれを SQL TIME 値に変換します。

パラメータ:
parameterName - パラメータの名前
x - パラメータ値
例外:
SQLException - データベースアクセスエラーが発生した場合
導入されたバージョン:
1.4
関連項目:
getTime(int)

setTimestamp

public void setTimestamp(String parameterName,
                         Timestamp x)
                  throws SQLException
指定されたパラメータを指定された java.sql.Timestamp 値に設定します。データベースに送るときに、ドライバはこれを SQL TIMESTAMP 値に変換します。

パラメータ:
parameterName - パラメータの名前
x - パラメータ値
例外:
SQLException - データベースアクセスエラーが発生した場合
導入されたバージョン:
1.4
関連項目:
getTimestamp(int)

setAsciiStream

public void setAsciiStream(String parameterName,
                           InputStream x,
                           int length)
                    throws SQLException
指定されたパラメータを、指定されたバイト数を持つ指定された入力ストリームに設定します。LONGVARCHAR パラメータに非常に大きな ASCII 値が入力されるときには、java.io.InputStream を介して送るのが現実的です。ファイルの終わりに達するまで必要に応じてストリームからデータが読み込まれます。JDBC ドライバは、データを ASCII からデータベースの char 形式に変換します。

注: このストリームオブジェクトは、標準の Java ストリームオブジェクト、または標準インタフェースを実装する独自のサブクラスのどちらでもかまいません。

パラメータ:
parameterName - パラメータの名前
x - ASCII パラメータ値を含む Java 入力ストリーム
length - ストリームのバイト数
例外:
SQLException - データベースアクセスエラーが発生した場合
導入されたバージョン:
1.4

setBinaryStream

public void setBinaryStream(String parameterName,
                            InputStream x,
                            int length)
                     throws SQLException
指定されたパラメータを、指定されたバイト数を持つ指定された入力ストリームに設定します。LONGVARBINARY パラメータに、非常に大きなバイナリ値が入力されるときには、java.io.InputStream オブジェクトを介して送るのが現実的です。ファイルの終わりに達するまで必要に応じてストリームからデータが読み込まれます。

注: このストリームオブジェクトは、標準の Java ストリームオブジェクト、または標準インタフェースを実装する独自のサブクラスのどちらでもかまいません。

パラメータ:
parameterName - パラメータの名前
x - バイナリパラメータ値を含む Java 入力ストリーム
length - ストリームのバイト数
例外:
SQLException - データベースアクセスエラーが発生した場合
導入されたバージョン:
1.4

setObject

public void setObject(String parameterName,
                      Object x,
                      int targetSqlType,
                      int scale)
               throws SQLException
指定されたパラメータの値を、指定されたオブジェクトを使用して設定します。2 番目の引数は、オブジェクトの型でなければなりません。必要となるすべての値に対して、等価な java.lang オブジェクトを使用する必要があります。

指定された Java オブジェクトは、データベースに送られる前に、指定された targetSqlType に変換されます。オブジェクトがインタフェース SQLData を実装するクラスのカスタムマッピングを持つ場合、JDBC ドライバは SQLData.writeSQL メソッドを呼び出して、そのオブジェクトを SQL データストリームへ書き込む必要があります。また、オブジェクトが RefBlobClobStruct、または Array を実装するクラスの場合、ドライバは対応する SQL 型の値としてオブジェクトをデータベースに渡さなければなりません。

このメソッドは、データベース固有の抽象データ型を渡すために使用することに注意してください。

パラメータ:
parameterName - パラメータの名前
x - 入力パラメータ値を含むオブジェクト
targetSqlType - データベースに送られる (java.sql.Types で定義される) SQL 型。スケール引数で、さらに型を限定できる
scale - java.sql.Types.DECIMAL や java.sql.Types.NUMERIC 型では、小数点以下の桁数。ほかのすべての型では、この値は無視される
例外:
SQLException - データベースアクセスエラーが発生した場合
導入されたバージョン:
1.4
関連項目:
Types, getObject(int)

setObject

public void setObject(String parameterName,
                      Object x,
                      int targetSqlType)
               throws SQLException
指定されたパラメータの値を、指定されたオブジェクトで設定します。このメソッドは、上記のメソッド setObject に似ていますが、スケールに 0 を仮定している点が異なります。

パラメータ:
parameterName - パラメータの名前
x - 入力パラメータ値を含むオブジェクト
targetSqlType - データベースに送られる (java.sql.Types で定義される) SQL 型
例外:
SQLException - データベースアクセスエラーが発生した場合
導入されたバージョン:
1.4
関連項目:
getObject(int)

setObject

public void setObject(String parameterName,
                      Object x)
               throws SQLException
指定されたパラメータの値を、指定されたオブジェクトを使用して設定します。2 番目のパラメータは、Object の型でなければなりません。したがって、組み込み型の場合、等価な java.lang オブジェクトを使用する必要があります。

JDBC は、Java の Object 型から SQL 型への標準マッピングを指定しています。指定された引数は、データベースに送られる前に、対応する SQL 型に変換されます。

このメソッドは、ドライバ固有の Java 型を使用して、データベース固有の抽象データ型を渡すために使用することに注意してください。オブジェクトがインタフェース SQLData を実装するクラスの場合、JDBC ドライバは SQLData.writeSQL メソッドを呼び出して、そのオブジェクトを SQL データストリームへ書き込む必要があります。また、オブジェクトが RefBlobClobStruct、または Array を実装するクラスの場合、ドライバは対応する SQL 型の値としてオブジェクトをデータベースに渡さなければなりません。

たとえば、オブジェクトが上記のインタフェースを複数実装するクラスであるなど、あいまいさがある場合、このメソッドは例外をスローします。

パラメータ:
parameterName - パラメータの名前
x - 入力パラメータ値を含むオブジェクト
例外:
SQLException - データベースアクセスエラーが発生した場合、または指定された Object パラメータがあいまいである場合
導入されたバージョン:
1.4
関連項目:
getObject(int)

setCharacterStream

public void setCharacterStream(String parameterName,
                               Reader reader,
                               int length)
                        throws SQLException
指定されたパラメータを、指定された文字数である指定された Reader オブジェクトに設定します。LONGVARCHAR パラメータに非常に大きな UNICODE 値を入力するときには、java.io.Reader オブジェクトを介して送るほうが現実的です。ファイルの終わりに達するまで必要に応じてストリームからデータが読み込まれます。JDBC ドライバは、データを UNICODE からデータベースの char 形式に変換します。

注: このストリームオブジェクトは、標準の Java ストリームオブジェクト、または標準インタフェースを実装する独自のサブクラスのどちらでもかまいません。

パラメータ:
parameterName - パラメータの名前
reader - 指定されたパラメータとして使用される UNICODE データを含む java.io.Reader オブジェクト
length - ストリーム内の文字数
例外:
SQLException - データベースアクセスエラーが発生した場合
導入されたバージョン:
1.4

setDate

public void setDate(String parameterName,
                    Date x,
                    Calendar cal)
             throws SQLException
指定された Calendar オブジェクトを使用して、指定されたパラメータを指定された java.sql.Date 値に設定します。ドライバは Calendar オブジェクトを使用して SQL DATE 値を作成し、続いてそれをデータベースに送ります。Calendar オブジェクトを使用すると、ドライバはカスタムタイムゾーンを考慮して日付を計算できます。Calendar オブジェクトを指定しない場合、ドライバは、アプリケーションで実行される仮想マシンのタイムゾーンであるデフォルトのタイムゾーンを使用します。

パラメータ:
parameterName - パラメータの名前
x - パラメータ値
cal - ドライバが日付を作成するために使用する Calendar オブジェクト
例外:
SQLException - データベースアクセスエラーが発生した場合
導入されたバージョン:
1.4
関連項目:
getDate(int)

setTime

public void setTime(String parameterName,
                    Time x,
                    Calendar cal)
             throws SQLException
指定された Calendar オブジェクトを使用して、指定されたパラメータを指定された java.sql.Time 値に設定します。ドライバは Calendar オブジェクトを使用して SQL TIME 値を作成し、続いてそれをデータベースに送ります。Calendar オブジェクトを使用すると、ドライバはカスタムタイムゾーンを考慮して時刻を計算できます。Calendar オブジェクトを指定しない場合、ドライバは、アプリケーションで実行される仮想マシンのタイムゾーンであるデフォルトのタイムゾーンを使用します。

パラメータ:
parameterName - パラメータの名前
x - パラメータ値
cal - ドライバが時刻を作成するために使用する Calendar オブジェクト
例外:
SQLException - データベースアクセスエラーが発生した場合
導入されたバージョン:
1.4
関連項目:
getTime(int)

setTimestamp

public void setTimestamp(String parameterName,
                         Timestamp x,
                         Calendar cal)
                  throws SQLException
指定された Calendar オブジェクトを使用して、指定されたパラメータを指定された java.sql.Timestamp 値に設定します。ドライバは Calendar オブジェクトを使用して SQL TIMESTAMP 値を作成し、続いてそれをデータベースに送ります。Calendar オブジェクトを使用すると、ドライバはカスタムタイムゾーンを考慮してタイムスタンプを計算できます。Calendar オブジェクトを指定しない場合、ドライバは、アプリケーションで実行される仮想マシンのタイムゾーンであるデフォルトのタイムゾーンを使用します。

パラメータ:
parameterName - パラメータの名前
x - パラメータ値
cal - ドライバがタイムスタンプを作成するために使用する Calendar オブジェクト
例外:
SQLException - データベースアクセスエラーが発生した場合
導入されたバージョン:
1.4
関連項目:
getTimestamp(int)

setNull

public void setNull(String parameterName,
                    int sqlType,
                    String typeName)
             throws SQLException
指定されたパラメータを SQL NULL に設定します。ユーザ定義型および REF 型のパラメータでは、このバージョンのメソッド setNull を使用しなければなりません。ユーザ定義型の例には、STRUCT、DISTINCT、JAVA_OBJECT、および名前付き配列があります。

注: 移植性を実現するためには、アプリケーションは NULL のユーザ定義パラメータまたは REF パラメータを指定するときに SQL 型コードおよび完全指定された SQL 型名を指定しなければなりません。ユーザ定義型の場合、名前はパラメータ自体の型名です。REF パラメータの場合、名前は参照される型の型名です。JDBC ドライバが型コードまたは型名の情報を必要としない場合、それは無視されます。ユーザ定義パラメータおよび REF パラメータを対象としていますが、このメソッドは任意の JDBC 型の null パラメータを設定するために使用できます。パラメータがユーザ定義の型または REF 型を持たない場合、指定された typeName は無視されます。

パラメータ:
sqlType - java.sql.Types からの値
typeName - SQL ユーザ定義型の完全指定された名前。パラメータがユーザ定義型でも SQL REF 値でもない場合は無視される
例外:
SQLException - データベースアクセスエラーが発生した場合
導入されたバージョン:
1.4

getString

public String getString(String parameterName)
                 throws SQLException
JDBC の CHARVARCHAR、または LONGVARCHAR パラメータの値を Java プログラミング言語の String として取り出します。

固定長 JDBC CHAR の型の場合、返される String オブジェクトはデータベースで JDBC CHAR が持つ値と正確に同じ値 (データベースが付加するパディングを含む) を持ちます。

パラメータ:
parameterName - パラメータの名前
戻り値:
パラメータ値。値が SQL NULL の場合は null
例外:
SQLException - データベースアクセスエラーが発生した場合
導入されたバージョン:
1.4
関連項目:
setString(java.lang.String, java.lang.String)

getBoolean

public boolean getBoolean(String parameterName)
                   throws SQLException
JDBC BIT パラメータの値を Java プログラミング言語の boolean として取り出します。

パラメータ:
parameterName - パラメータの名前
戻り値:
パラメータ値。値が SQL NULL の場合は false
例外:
SQLException - データベースアクセスエラーが発生した場合
導入されたバージョン:
1.4
関連項目:
setBoolean(java.lang.String, boolean)

getByte

public byte getByte(String parameterName)
             throws SQLException
JDBC TINYINT パラメータの値を Java プログラミング言語の byte として取り出します。

パラメータ:
parameterName - パラメータの名前
戻り値:
パラメータ値。値が SQL NULL の場合は 0
例外:
SQLException - データベースアクセスエラーが発生した場合
導入されたバージョン:
1.4
関連項目:
setByte(java.lang.String, byte)

getShort

public short getShort(String parameterName)
               throws SQLException
JDBC SMALLINT パラメータの値を Java プログラミング言語の short として取り出します。

パラメータ:
parameterName - パラメータの名前
戻り値:
パラメータ値。値が SQL NULL の場合は 0
例外:
SQLException - データベースアクセスエラーが発生した場合
導入されたバージョン:
1.4
関連項目:
setShort(java.lang.String, short)

getInt

public int getInt(String parameterName)
           throws SQLException
JDBC INTEGER パラメータの値を Java プログラミング言語の int として取り出します。

パラメータ:
parameterName - パラメータの名前
戻り値:
パラメータ値。値が SQL NULL の場合は 0
例外:
SQLException - データベースアクセスエラーが発生した場合
導入されたバージョン:
1.4
関連項目:
setInt(java.lang.String, int)

getLong

public long getLong(String parameterName)
             throws SQLException
JDBC BIGINT パラメータの値を Java プログラミング言語の long として取り出します。

パラメータ:
parameterName - パラメータの名前
戻り値:
パラメータ値。値が SQL NULL の場合は 0
例外:
SQLException - データベースアクセスエラーが発生した場合
導入されたバージョン:
1.4
関連項目:
setLong(java.lang.String, long)

getFloat

public float getFloat(String parameterName)
               throws SQLException
JDBC FLOAT パラメータの値を Java プログラミング言語の float として取り出します。

パラメータ:
parameterName - パラメータの名前
戻り値:
パラメータ値。値が SQL NULL の場合は 0
例外:
SQLException - データベースアクセスエラーが発生した場合
導入されたバージョン:
1.4
関連項目:
setFloat(java.lang.String, float)

getDouble

public double getDouble(String parameterName)
                 throws SQLException
JDBC DOUBLE パラメータの値を Java プログラミング言語の double として取り出します。

パラメータ:
parameterName - パラメータの名前
戻り値:
パラメータ値。値が SQL NULL の場合は 0
例外:
SQLException - データベースアクセスエラーが発生した場合
導入されたバージョン:
1.4
関連項目:
setDouble(java.lang.String, double)

getBytes

public byte[] getBytes(String parameterName)
                throws SQLException
JDBC の BINARY パラメータまたは VARBINARY パラメータの値を Java プログラミング言語の byte 値の配列として取り出します。

パラメータ:
parameterName - パラメータの名前
戻り値:
パラメータ値。値が SQL NULL の場合は null
例外:
SQLException - データベースアクセスエラーが発生した場合
導入されたバージョン:
1.4
関連項目:
setBytes(java.lang.String, byte[])

getDate

public Date getDate(String parameterName)
             throws SQLException
JDBC DATE パラメータの値を java.sql.Date オブジェクトとして取り出します。

パラメータ:
parameterName - パラメータの名前
戻り値:
パラメータ値。値が SQL NULL の場合は null
例外:
SQLException - データベースアクセスエラーが発生した場合
導入されたバージョン:
1.4
関連項目:
setDate(java.lang.String, java.sql.Date)

getTime

public Time getTime(String parameterName)
             throws SQLException
JDBC TIME パラメータの値を java.sql.Time オブジェクトとして取り出します。

パラメータ:
parameterName - パラメータの名前
戻り値:
パラメータ値。値が SQL NULL の場合は null
例外:
SQLException - データベースアクセスエラーが発生した場合
導入されたバージョン:
1.4
関連項目:
setTime(java.lang.String, java.sql.Time)

getTimestamp

public Timestamp getTimestamp(String parameterName)
                       throws SQLException
JDBC TIMESTAMP パラメータの値を java.sql.Timestamp オブジェクトとして取り出します。

パラメータ:
parameterName - パラメータの名前
戻り値:
パラメータ値。値が SQL NULL の場合は null
例外:
SQLException - データベースアクセスエラーが発生した場合
導入されたバージョン:
1.4
関連項目:
setTimestamp(java.lang.String, java.sql.Timestamp)

getObject

public Object getObject(String parameterName)
                 throws SQLException
パラメータの値を Java プログラミング言語の Object として取り出します。値が SQL NULL の場合、ドライバは Java null を返します。

このメソッドは、Java オブジェクトを返します。そのオブジェクトの型は、registerOutParameter メソッドを使用して登録された JDBC の型に対応します。ターゲットの JDBC の型を java.sql.Types.OTHER として登録することで、このメソッドを使用してデータベース固有の抽象データの型を読み込むことができます。

パラメータ:
parameterName - パラメータの名前
戻り値:
OUT パラメータ値を保持する java.lang.Object
例外:
SQLException - データベースアクセスエラーが発生した場合
導入されたバージョン:
1.4
関連項目:
Types, setObject(java.lang.String, java.lang.Object, int, int)

getBigDecimal

public BigDecimal getBigDecimal(String parameterName)
                         throws SQLException
JDBC NUMERIC パラメータの値を、その値と同じ小数点以下の桁数を持つ java.math.BigDecimal オブジェクトとして取り出します。

パラメータ:
parameterName - パラメータの名前
戻り値:
パラメータ値 (全精度)。値が SQL NULL の場合は null
例外:
SQLException - データベースアクセスエラーが発生した場合
導入されたバージョン:
1.4
関連項目:
setBigDecimal(java.lang.String, java.math.BigDecimal)

getObject

public Object getObject(String parameterName,
                        Map map)
                 throws SQLException
OUT パラメータ i の値を表すオブジェクトを返し、map を使用してそのパラメータ値のカスタムマッピングを行います。

このメソッドは、Java オブジェクトを返します。そのオブジェクトの型は、registerOutParameter メソッドを使用して登録された JDBC の型に対応します。ターゲットの JDBC の型を java.sql.Types.OTHER として登録することで、このメソッドを使用してデータベース固有の抽象データの型を読み込むことができます。

パラメータ:
parameterName - パラメータの名前
map - SQL の型名から Java クラスへのマッピング
戻り値:
OUT パラメータ値を保持する java.lang.Object
例外:
SQLException - データベースアクセスエラーが発生した場合
導入されたバージョン:
1.4
関連項目:
setObject(java.lang.String, java.lang.Object, int, int)

getRef

public Ref getRef(String parameterName)
           throws SQLException
JDBC REF(<structured-type>) パラメータの値を Java プログラミング言語の Ref オブジェクトとして取り出します。

パラメータ:
parameterName - パラメータの名前
戻り値:
Java プログラミング言語の Ref オブジェクトとして表されたパラメータ値。値が SQL NULL の場合は null
例外:
SQLException - データベースアクセスエラーが発生した場合
導入されたバージョン:
1.4

getBlob

public Blob getBlob(String parameterName)
             throws SQLException
JDBC BLOB パラメータの値を Java プログラミング言語の Blob オブジェクトとして取り出します。

パラメータ:
parameterName - パラメータの名前
戻り値:
Java プログラミング言語の Blob オブジェクトとして表されたパラメータ値。値が SQL NULL の場合は null
例外:
SQLException - データベースアクセスエラーが発生した場合
導入されたバージョン:
1.4

getClob

public Clob getClob(String parameterName)
             throws SQLException
JDBC CLOB パラメータの値を Java プログラミング言語の Clob オブジェクトとして取り出します。

パラメータ:
parameterName - パラメータの名前
戻り値:
Java プログラミング言語の Clob オブジェクトとして表されたパラメータ値。値が SQL NULL の場合は null
例外:
SQLException - データベースアクセスエラーが発生した場合
導入されたバージョン:
1.4

getArray

public Array getArray(String parameterName)
               throws SQLException
JDBC ARRAY パラメータの値を Java プログラミング言語の Array オブジェクトとして取り出します。

パラメータ:
parameterName - パラメータの名前
戻り値:
Java プログラミング言語の Array オブジェクトとして表されたパラメータ値。値が SQL NULL の場合は null
例外:
SQLException - データベースアクセスエラーが発生した場合
導入されたバージョン:
1.4

getDate

public Date getDate(String parameterName,
                    Calendar cal)
             throws SQLException
JDBC DATE パラメータの値を java.sql.Date オブジェクトとして取り出します。日付の作成には、指定された Calendar オブジェクトを使用します。Calendar オブジェクトを使用すると、ドライバはカスタムタイムゾーンおよびロケールを考慮して日付を計算できます。Calendar オブジェクトを指定しない場合、ドライバはデフォルトのタイムゾーンおよびロケールを使用します。

パラメータ:
parameterName - パラメータの名前
cal - ドライバが日付を作成するために使用する Calendar オブジェクト
戻り値:
パラメータ値。値が SQL NULL の場合は null
例外:
SQLException - データベースアクセスエラーが発生した場合
導入されたバージョン:
1.4
関連項目:
setDate(java.lang.String, java.sql.Date)

getTime

public Time getTime(String parameterName,
                    Calendar cal)
             throws SQLException
JDBC TIME パラメータの値を java.sql.Time オブジェクトとして取り出します。時刻の作成には、指定された Calendar オブジェクトを使用します。Calendar オブジェクトを使用すると、ドライバはカスタムタイムゾーンおよびロケールを考慮して時刻を計算できます。Calendar オブジェクトを指定しない場合、ドライバはデフォルトのタイムゾーンおよびロケールを使用します。

パラメータ:
parameterName - パラメータの名前
cal - ドライバが時刻を作成するために使用する Calendar オブジェクト
戻り値:
パラメータ値。値が SQL NULL の場合は null
例外:
SQLException - データベースアクセスエラーが発生した場合
導入されたバージョン:
1.4
関連項目:
setTime(java.lang.String, java.sql.Time)

getTimestamp

public Timestamp getTimestamp(String parameterName,
                              Calendar cal)
                       throws SQLException
JDBC TIMESTAMP パラメータの値を java.sql.Timestamp オブジェクトとして取り出します。Timestamp オブジェクトの作成には、指定された Calendar オブジェクトを使用します。Calendar オブジェクトを使用すると、ドライバはカスタムタイムゾーンおよびロケールを考慮してタイムスタンプを計算できます。Calendar オブジェクトを指定しない場合、ドライバはデフォルトのタイムゾーンおよびロケールを使用します。

パラメータ:
parameterName - パラメータの名前
cal - ドライバがタイムスタンプを作成するために使用する Calendar オブジェクト
戻り値:
パラメータ値。値が SQL NULL の場合は null
例外:
SQLException - データベースアクセスエラーが発生した場合
導入されたバージョン:
1.4
関連項目:
setTimestamp(java.lang.String, java.sql.Timestamp)

getURL

public URL getURL(String parameterName)
           throws SQLException
JDBC DATALINK パラメータの値を java.net.URL オブジェクトとして取り出します。

パラメータ:
parameterName - パラメータの名前
戻り値:
Java プログラミング言語の java.net.URL オブジェクトとして表されたパラメータ値。値が SQL NULL の場合は null
例外:
SQLException - データベースアクセスエラーが発生した場合、または URL に問題がある場合
導入されたバージョン:
1.4
関連項目:
setURL(java.lang.String, java.net.URL)

JavaTM 2
Platform
Std. Ed. v1.4.0

バグの報告と機能のリクエスト
これ以外の API リファレンスおよび開発者用ドキュメントについては、 Java 2 SDK SE 開発者用ドキュメントを参照してください。 開発者向けの詳細な解説、概念の概要、用語の定義、バグの回避策、 およびコード実例が含まれています。

Java、Java 2D、および JDBC は米国ならびにその他の国における米国 Sun Microsystems, Inc. の商標もしくは登録商標です。
Copyright 1993-2002 Sun Microsystems, Inc. 901 San Antonio Road
Palo Alto, California, 94303, U.S.A. All Rights Reserved.