JavaTM Platform
Standard Ed. 6

java.sql
インタフェース CallableStatement

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

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 メソッド経由で取り出されます。

ACallableStatement は、1 つの ResultSet オブジェクトまたは複数の 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 parameterIndex)
          指定された 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 parameterIndex)
          指定された JDBC BLOB パラメータの値を、Java プログラミング言語の Blob オブジェクトとして取り出します。
 Blob getBlob(String parameterName)
          JDBC BLOB パラメータの値を、Java プログラミング言語の Blob オブジェクトとして取り出します。
 boolean getBoolean(int parameterIndex)
          指定された JDBC BIT または BOOLEAN パラメータの値を Java プログラミング言語の boolean として取り出します。
 boolean getBoolean(String parameterName)
          JDBC BIT または BOOLEAN パラメータの値を 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 値の配列として取り出します。
 Reader getCharacterStream(int parameterIndex)
          指定されたパラメータの値を Java プログラミング言語の java.io.Reader オブジェクトとして取り出します。
 Reader getCharacterStream(String parameterName)
          指定されたパラメータの値を Java プログラミング言語の java.io.Reader オブジェクトとして取り出します。
 Clob getClob(int parameterIndex)
          指定された JDBC CLOB パラメータの値を Java プログラミング言語の java.sql.Clob オブジェクトとして取り出します。
 Clob getClob(String parameterName)
          JDBC CLOB パラメータの値を Java プログラミング言語の java.sql.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 として取り出します。
 Reader getNCharacterStream(int parameterIndex)
          指定されたパラメータの値を Java プログラミング言語の java.io.Reader オブジェクトとして取り出します。
 Reader getNCharacterStream(String parameterName)
          指定されたパラメータの値を Java プログラミング言語の java.io.Reader オブジェクトとして取り出します。
 NClob getNClob(int parameterIndex)
          指定された JDBC NCLOB パラメータの値を Java プログラミング言語の java.sql.NClob オブジェクトとして取り出します。
 NClob getNClob(String parameterName)
          JDBC NCLOB パラメータの値を Java プログラミング言語の java.sql.NClob オブジェクトとして取り出します。
 String getNString(int parameterIndex)
          指定された NCHARNVARCHAR、または LONGNVARCHAR パラメータの値を Java プログラミング言語の String として取り出します。
 String getNString(String parameterName)
          指定された NCHARNVARCHAR、または LONGNVARCHAR パラメータの値を Java プログラミング言語の String として取り出します。
 Object getObject(int parameterIndex)
          指定されたパラメータの値を Java プログラミング言語の Object として取り出します。
 Object getObject(int parameterIndex, Map<String,Class<?>> map)
          OUT パラメータ parameterIndex の値を表すオブジェクトを返し、map を使用してそのパラメータ値のカスタムマッピングを行います。
 Object getObject(String parameterName)
          パラメータの値を Java プログラミング言語の Object として取り出します。
 Object getObject(String parameterName, Map<String,Class<?>> map)
          OUT パラメータ parameterName の値を表すオブジェクトを返し、map を使用してそのパラメータ値のカスタムマッピングを行います。
 Ref getRef(int parameterIndex)
          指定された JDBC REF(<structured-type>) パラメータの値を、Java プログラミング言語の Ref オブジェクトとして取り出します。
 Ref getRef(String parameterName)
          JDBC REF(<structured-type>) パラメータの値を、Java プログラミング言語の Ref オブジェクトとして取り出します。
 RowId getRowId(int parameterIndex)
          指定された JDBC ROWID パラメータの値を java.sql.RowId オブジェクトとして取り出します。
 RowId getRowId(String parameterName)
          指定された JDBC ROWID パラメータの値を java.sql.RowId オブジェクトとして取り出します。
 short getShort(int parameterIndex)
          指定された JDBC SMALLINT パラメータの値を Java プログラミング言語の short として取り出します。
 short getShort(String parameterName)
          JDBC SMALLINT パラメータの値を Java プログラミング言語の short として取り出します。
 SQLXML getSQLXML(int parameterIndex)
          指定された SQL XML パラメータの値を Java プログラミング言語の java.sql.SQLXML オブジェクトとして取り出します。
 SQLXML getSQLXML(String parameterName)
          指定された SQL XML パラメータの値を Java プログラミング言語の java.sql.SQLXML オブジェクトとして取り出します。
 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 parameterIndex, 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)
          指定されたパラメータを指定された入力ストリームに設定します。
 void setAsciiStream(String parameterName, InputStream x, int length)
          指定されたパラメータを、指定されたバイト数を持つ指定された入力ストリームに設定します。
 void setAsciiStream(String parameterName, InputStream x, long length)
          指定されたパラメータを、指定されたバイト数を持つ指定された入力ストリームに設定します。
 void setBigDecimal(String parameterName, BigDecimal x)
          指定されたパラメータを指定された java.math.BigDecimal 値に設定します。
 void setBinaryStream(String parameterName, InputStream x)
          指定されたパラメータを指定された入力ストリームに設定します。
 void setBinaryStream(String parameterName, InputStream x, int length)
          指定されたパラメータを、指定されたバイト数を持つ指定された入力ストリームに設定します。
 void setBinaryStream(String parameterName, InputStream x, long length)
          指定されたパラメータを、指定されたバイト数を持つ指定された入力ストリームに設定します。
 void setBlob(String parameterName, Blob x)
          指定されたパラメータを指定された java.sql.Blob オブジェクトに設定します。
 void setBlob(String parameterName, InputStream inputStream)
          指定されたパラメータを InputStream オブジェクトに設定します。
 void setBlob(String parameterName, InputStream inputStream, long length)
          指定されたパラメータを InputStream オブジェクトに設定します。
 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)
          指定されたパラメータを、指定された Java の Reader オブジェクトに設定します。
 void setCharacterStream(String parameterName, Reader reader, int length)
          指定されたパラメータを、指定された文字数である指定された Reader オブジェクトに設定します。
 void setCharacterStream(String parameterName, Reader reader, long length)
          指定されたパラメータを、指定された文字数である指定された Reader オブジェクトに設定します。
 void setClob(String parameterName, Clob x)
          指定されたパラメータを指定された java.sql.Clob オブジェクトに設定します。
 void setClob(String parameterName, Reader reader)
          指定されたパラメータを Reader オブジェクトに設定します。
 void setClob(String parameterName, Reader reader, long 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 setNCharacterStream(String parameterName, Reader value)
          指定されたパラメータを Reader オブジェクトに設定します。
 void setNCharacterStream(String parameterName, Reader value, long length)
          指定されたパラメータを Reader オブジェクトに設定します。
 void setNClob(String parameterName, NClob value)
          指定されたパラメータを java.sql.NClob オブジェクトに設定します。
 void setNClob(String parameterName, Reader reader)
          指定されたパラメータを Reader オブジェクトに設定します。
 void setNClob(String parameterName, Reader reader, long length)
          指定されたパラメータを Reader オブジェクトに設定します。
 void setNString(String parameterName, String value)
          指定されたパラメータを指定された String オブジェクトに設定します。
 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 setRowId(String parameterName, RowId x)
          指定されたパラメータを指定された java.sql.RowId オブジェクトに設定します。
 void setShort(String parameterName, short x)
          指定されたパラメータを指定された Java の short 値に設定します。
 void setSQLXML(String parameterName, SQLXML xmlObject)
          指定されたパラメータを指定された java.sql.SQLXML オブジェクトに設定します。
 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, setAsciiStream, setAsciiStream, setBigDecimal, setBinaryStream, setBinaryStream, setBinaryStream, setBlob, setBlob, setBlob, setBoolean, setByte, setBytes, setCharacterStream, setCharacterStream, setCharacterStream, setClob, setClob, setClob, setDate, setDate, setDouble, setFloat, setInt, setLong, setNCharacterStream, setNCharacterStream, setNClob, setNClob, setNClob, setNString, setNull, setNull, setObject, setObject, setObject, setRef, setRowId, setShort, setSQLXML, 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, isClosed, isPoolable, setCursorName, setEscapeProcessing, setFetchDirection, setFetchSize, setMaxFieldSize, setMaxRows, setPoolable, setQueryTimeout
 
インタフェース java.sql.Wrapper から継承されたメソッド
isWrapperFor, unwrap
 

メソッドの詳細

registerOutParameter

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 - parameterIndex が無効な場合、データベースアクセスエラーが発生した場合、またはこのメソッドがクローズされた CallableStatement で呼び出された場合
SQLFeatureNotSupportedException - sqlType のデータ型が、ARRAYBLOBCLOBDATALINKJAVA_OBJECTNCHARNCLOBNVARCHARLONGNVARCHARREFROWIDSQLXML、または STRUCT で、JDBC ドライバがこのデータ型をサポートしていない場合
関連項目:
Types

registerOutParameter

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

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

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

パラメータ:
parameterIndex - 最初のパラメータは 1、2 番目のパラメータは 2、などとする
sqlType - java.sql.Types によって定義される SQL の型コード
scale - 希望の小数点以下の桁数。0 以上の数値を指定する
例外:
SQLException - parameterIndex が無効な場合、データベースアクセスエラーが発生した場合、またはこのメソッドがクローズされた CallableStatement で呼び出された場合
SQLFeatureNotSupportedException - sqlType のデータ型が、ARRAYBLOBCLOBDATALINKJAVA_OBJECTNCHARNCLOBNVARCHARLONGNVARCHARREFROWIDSQLXML、または STRUCT で、JDBC ドライバがこのデータ型をサポートしていない場合
関連項目:
Types

wasNull

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

戻り値:
最後に読み込まれたパラメータが SQL NULL の場合は true、そうでない場合は false
例外:
SQLException - データベースアクセスエラーが発生した場合、またはこのメソッドがクローズされた CallableStatement について呼び出された場合

getString

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

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

パラメータ:
parameterIndex - 最初のパラメータは 1、2 番目のパラメータは 2、などとする
戻り値:
パラメータ値値が SQL NULL の場合は null
例外:
SQLException - parameterIndex が無効な場合、データベースアクセスエラーが発生した場合、またはこのメソッドがクローズされた CallableStatement で呼び出された場合
関連項目:
setString(java.lang.String, java.lang.String)

getBoolean

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

パラメータ:
parameterIndex - 最初のパラメータは 1、2 番目のパラメータは 2、などとする
戻り値:
パラメータ値値が SQL NULL の場合は false
例外:
SQLException - parameterIndex が無効な場合、データベースアクセスエラーが発生した場合、またはこのメソッドがクローズされた CallableStatement で呼び出された場合
関連項目:
setBoolean(java.lang.String, boolean)

getByte

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

パラメータ:
parameterIndex - 最初のパラメータは 1、2 番目のパラメータは 2、などとする
戻り値:
パラメータ値値が SQL NULL の場合は 0
例外:
SQLException - parameterIndex が無効な場合、データベースアクセスエラーが発生した場合、またはこのメソッドがクローズされた CallableStatement で呼び出された場合
関連項目:
setByte(java.lang.String, byte)

getShort

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

パラメータ:
parameterIndex - 最初のパラメータは 1、2 番目のパラメータは 2、などとする
戻り値:
パラメータ値値が SQL NULL の場合は 0
例外:
SQLException - parameterIndex が無効な場合、データベースアクセスエラーが発生した場合、またはこのメソッドがクローズされた CallableStatement で呼び出された場合
関連項目:
setShort(java.lang.String, short)

getInt

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

パラメータ:
parameterIndex - 最初のパラメータは 1、2 番目のパラメータは 2、などとする
戻り値:
パラメータ値値が SQL NULL の場合は 0
例外:
SQLException - parameterIndex が無効な場合、データベースアクセスエラーが発生した場合、またはこのメソッドがクローズされた CallableStatement で呼び出された場合
関連項目:
setInt(java.lang.String, int)

getLong

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

パラメータ:
parameterIndex - 最初のパラメータは 1、2 番目のパラメータは 2、などとする
戻り値:
パラメータ値値が SQL NULL の場合は 0
例外:
SQLException - parameterIndex が無効な場合、データベースアクセスエラーが発生した場合、またはこのメソッドがクローズされた CallableStatement で呼び出された場合
関連項目:
setLong(java.lang.String, long)

getFloat

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

パラメータ:
parameterIndex - 最初のパラメータは 1、2 番目のパラメータは 2、などとする
戻り値:
パラメータ値値が SQL NULL の場合は 0
例外:
SQLException - parameterIndex が無効な場合、データベースアクセスエラーが発生した場合、またはこのメソッドがクローズされた CallableStatement で呼び出された場合
関連項目:
setFloat(java.lang.String, float)

getDouble

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

パラメータ:
parameterIndex - 最初のパラメータは 1、2 番目のパラメータは 2、などとする
戻り値:
パラメータ値値が SQL NULL の場合は 0
例外:
SQLException - parameterIndex が無効な場合、データベースアクセスエラーが発生した場合、またはこのメソッドがクローズされた CallableStatement で呼び出された場合
関連項目:
setDouble(java.lang.String, double)

getBigDecimal

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 - parameterIndex が無効な場合、データベースアクセスエラーが発生した場合、またはこのメソッドがクローズされた CallableStatement で呼び出された場合
SQLFeatureNotSupportedException - JDBC ドライバがこのメソッドをサポートしない場合
関連項目:
setBigDecimal(java.lang.String, java.math.BigDecimal)

getBytes

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

パラメータ:
parameterIndex - 最初のパラメータは 1、2 番目のパラメータは 2、などとする
戻り値:
パラメータ値値が SQL NULL の場合は null
例外:
SQLException - parameterIndex が無効な場合、データベースアクセスエラーが発生した場合、またはこのメソッドがクローズされた CallableStatement で呼び出された場合
関連項目:
setBytes(java.lang.String, byte[])

getDate

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

パラメータ:
parameterIndex - 最初のパラメータは 1、2 番目のパラメータは 2、などとする
戻り値:
パラメータ値値が SQL NULL の場合は null
例外:
SQLException - parameterIndex が無効な場合、データベースアクセスエラーが発生した場合、またはこのメソッドがクローズされた CallableStatement で呼び出された場合
関連項目:
setDate(java.lang.String, java.sql.Date)

getTime

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

パラメータ:
parameterIndex - 最初のパラメータは 1、2 番目のパラメータは 2、などとする
戻り値:
パラメータ値値が SQL NULL の場合は null
例外:
SQLException - parameterIndex が無効な場合、データベースアクセスエラーが発生した場合、またはこのメソッドがクローズされた CallableStatement で呼び出された場合
関連項目:
setTime(java.lang.String, java.sql.Time)

getTimestamp

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

パラメータ:
parameterIndex - 最初のパラメータは 1、2 番目のパラメータは 2、などとする
戻り値:
パラメータ値値が SQL NULL の場合は null
例外:
SQLException - parameterIndex が無効な場合、データベースアクセスエラーが発生した場合、またはこのメソッドがクローズされた CallableStatement で呼び出された場合
関連項目:
setTimestamp(java.lang.String, java.sql.Timestamp)

getObject

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 - parameterIndex が無効な場合、データベースアクセスエラーが発生した場合、またはこのメソッドがクローズされた CallableStatement で呼び出された場合
関連項目:
Types, setObject(java.lang.String, java.lang.Object, int, int)

getBigDecimal

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

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

getObject

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

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

パラメータ:
parameterIndex - 最初のパラメータは 1、2 番目のパラメータは 2、などとする
map - SQL の型名から Java クラスへのマッピング
戻り値:
OUT パラメータ値を保持する java.lang.Object
例外:
SQLException - parameterIndex が無効な場合、データベースアクセスエラーが発生した場合、またはこのメソッドがクローズされた CallableStatement で呼び出された場合
SQLFeatureNotSupportedException - JDBC ドライバがこのメソッドをサポートしない場合
導入されたバージョン:
1.2
関連項目:
setObject(java.lang.String, java.lang.Object, int, int)

getRef

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

パラメータ:
parameterIndex - 最初のパラメータは 1、2 番目のパラメータは 2、などとする
戻り値:
Java プログラミング言語の Ref オブジェクトとして表されたパラメータ値。値が SQL NULL の場合は null
例外:
SQLException - parameterIndex が無効な場合、データベースアクセスエラーが発生した場合、またはこのメソッドがクローズされた CallableStatement で呼び出された場合
SQLFeatureNotSupportedException - JDBC ドライバがこのメソッドをサポートしない場合
導入されたバージョン:
1.2

getBlob

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

パラメータ:
parameterIndex - 最初のパラメータは 1、2 番目のパラメータは 2、などとする
戻り値:
Java プログラミング言語の Blob オブジェクトとして表されたパラメータ値。値が SQL NULL の場合は null
例外:
SQLException - parameterIndex が無効な場合、データベースアクセスエラーが発生した場合、またはこのメソッドがクローズされた CallableStatement で呼び出された場合
SQLFeatureNotSupportedException - JDBC ドライバがこのメソッドをサポートしない場合
導入されたバージョン:
1.2

getClob

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

パラメータ:
parameterIndex - 最初のパラメータは 1、2 番目のパラメータは 2、などとする
戻り値:
Java プログラミング言語の Clob オブジェクトとして表されたパラメータ値。値が SQL NULL の場合は null
例外:
SQLException - parameterIndex が無効な場合、データベースアクセスエラーが発生した場合、またはこのメソッドがクローズされた CallableStatement で呼び出された場合
SQLFeatureNotSupportedException - JDBC ドライバがこのメソッドをサポートしない場合
導入されたバージョン:
1.2

getArray

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

パラメータ:
parameterIndex - 最初のパラメータは 1、2 番目のパラメータは 2、などとする
戻り値:
Java プログラミング言語の Array オブジェクトとして表されたパラメータ値。値が SQL NULL の場合は null
例外:
SQLException - parameterIndex が無効な場合、データベースアクセスエラーが発生した場合、またはこのメソッドがクローズされた CallableStatement で呼び出された場合
SQLFeatureNotSupportedException - JDBC ドライバがこのメソッドをサポートしない場合
導入されたバージョン:
1.2

getDate

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 - parameterIndex が無効な場合、データベースアクセスエラーが発生した場合、またはこのメソッドがクローズされた CallableStatement で呼び出された場合
導入されたバージョン:
1.2
関連項目:
setDate(java.lang.String, java.sql.Date)

getTime

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 - parameterIndex が無効な場合、データベースアクセスエラーが発生した場合、またはこのメソッドがクローズされた CallableStatement で呼び出された場合
導入されたバージョン:
1.2
関連項目:
setTime(java.lang.String, java.sql.Time)

getTimestamp

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 - parameterIndex が無効な場合、データベースアクセスエラーが発生した場合、またはこのメソッドがクローズされた CallableStatement で呼び出された場合
導入されたバージョン:
1.2
関連項目:
setTimestamp(java.lang.String, java.sql.Timestamp)

registerOutParameter

void registerOutParameter(int parameterIndex,
                          int sqlType,
                          String typeName)
                          throws SQLException
指定された出力パラメータを登録します。ユーザー定義出力パラメータまたは REF 出力パラメータには、このバージョンの registerOutParameter メソッドを使用します。ユーザー定義型の例としては、STRUCTDISTINCTJAVA_OBJECT、名前付き配列などが挙げられます。

ストアドプロシージャーが実行される前に、すべての OUT パラメータを登録する必要があります。 

ユーザー定義パラメータの場合は、そのパラメータの完全指定 SQL 型名も指定する必要があります。 一方、REF パラメータの場合は、参照する型の完全指定型名を指定する必要があります。型コードや型名の情報を必要としない JDBC ドライバはそれを無視します。ただし、移植性を高めるには、アプリケーションはユーザー定義パラメータおよび REF パラメータに対し、これらの値を提供する必要があります。 このメソッドは、ユーザー定義パラメータと REFパラメータを対象としていますが、任意の JDBC 型のパラメータを登録するために使用することもできます。パラメータの型がユーザー定義型、REF 型のいずれでもない場合、typeName パラメータは無視されます。  

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

パラメータ:
parameterIndex - 最初のパラメータは 1、2 番目のパラメータは 2、... となる
sqlType - Types に定義されている値
typeName - SQL 構造化型の完全指定された名前
例外:
SQLException - parameterIndex が無効な場合、データベースアクセスエラーが発生した場合、またはこのメソッドがクローズされた CallableStatement で呼び出された場合
SQLFeatureNotSupportedException - sqlType のデータ型が、ARRAYBLOBCLOBDATALINKJAVA_OBJECTNCHARNCLOBNVARCHARLONGNVARCHARREFROWIDSQLXML、または STRUCT で、JDBC ドライバがこのデータ型をサポートしていない場合
導入されたバージョン:
1.2
関連項目:
Types

registerOutParameter

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 - parameterName が指定されたパラメータに対応しない場合、データベースアクセスエラーが発生した場合、またはこのメソッドがクローズされた CallableStatement で呼び出された場合
SQLFeatureNotSupportedException - sqlType のデータ型が、ARRAYBLOBCLOBDATALINKJAVA_OBJECTNCHARNCLOBNVARCHARLONGNVARCHARREFROWIDSQLXML、または STRUCT で、JDBC ドライバがこのデータ型をサポートしていない場合。または JDBC ドライバがこのメソッドをサポートしていない場合
導入されたバージョン:
1.4
関連項目:
Types

registerOutParameter

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

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

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

パラメータ:
parameterName - パラメータの名前
sqlType - java.sql.Types によって定義される SQL の型コード
scale - 希望の小数点以下の桁数。0 以上の数値を指定する
例外:
SQLException - parameterName が指定されたパラメータに対応しない場合、データベースアクセスエラーが発生した場合、またはこのメソッドがクローズされた CallableStatement で呼び出された場合
SQLFeatureNotSupportedException - sqlType のデータ型が、ARRAYBLOBCLOBDATALINKJAVA_OBJECTNCHARNCLOBNVARCHARLONGNVARCHARREFROWIDSQLXML、または STRUCT で、JDBC ドライバがこのデータ型をサポートしていない場合。または JDBC ドライバがこのメソッドをサポートしていない場合
導入されたバージョン:
1.4
関連項目:
Types

registerOutParameter

void registerOutParameter(String parameterName,
                          int sqlType,
                          String typeName)
                          throws SQLException
指定された出力パラメータを登録します。ユーザー定義出力パラメータまたは REF 出力パラメータには、このバージョンの registerOutParameter メソッドを使用します。ユーザー定義型の例としては、STRUCT、DISTINCT、JAVA_OBJECT、名前付き配列などが挙げられます。

ストアドプロシージャーが実行される前に、すべての OUT パラメータを登録する必要があります。

ユーザー定義パラメータの場合は、そのパラメータの完全指定 SQL 型名も指定する必要があります。 REF パラメータの場合は、参照する型の完全指定型名を指定する必要があります。型コードや型名の情報を必要としない JDBC ドライバはそれを無視します。ただし、移植性を高めるには、アプリケーションはユーザー定義パラメータおよび REF パラメータに対し、これらの値を提供する必要があります。 このメソッドは、ユーザー定義パラメータおよび REF パラメータを対象としていますが、任意の JDBC 型のパラメータを登録するために使用することもできます。パラメータの型がユーザー定義型、REF 型のいずれでもない場合、typeName パラメータは無視されます。  

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

パラメータ:
parameterName - パラメータの名前
sqlType - Types に定義されている値
typeName - SQL 構造化型の完全指定された名前
例外:
SQLException - parameterName が指定されたパラメータに対応しない場合、データベースアクセスエラーが発生した場合、またはこのメソッドがクローズされた CallableStatement で呼び出された場合
SQLFeatureNotSupportedException - sqlType のデータ型が、ARRAYBLOBCLOBDATALINKJAVA_OBJECTNCHARNCLOBNVARCHARLONGNVARCHARREFROWIDSQLXML、または STRUCT で、JDBC ドライバがこのデータ型をサポートしていない場合。または JDBC ドライバがこのメソッドをサポートしていない場合
導入されたバージョン:
1.4
関連項目:
Types

getURL

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

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

setURL

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

パラメータ:
parameterName - パラメータの名前
val - パラメータ値
例外:
SQLException - parameterName が指定されたパラメータに対応しない場合、データベースアクセスエラーが発生した場合、このメソッドがクローズされた CallableStatement で呼び出された場合、または URL が無効の場合
SQLFeatureNotSupportedException - JDBC ドライバがこのメソッドをサポートしない場合
導入されたバージョン:
1.4
関連項目:
getURL(int)

setNull

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

注: パラメータの SQL の型を指定する必要があります。

パラメータ:
parameterName - パラメータの名前
sqlType - java.sql.Types で定義される SQL 型コード
例外:
SQLException - parameterName が指定されたパラメータに対応しない場合、データベースアクセスエラーが発生した場合、またはこのメソッドがクローズされた CallableStatement で呼び出された場合
SQLFeatureNotSupportedException - JDBC ドライバがこのメソッドをサポートしない場合
導入されたバージョン:
1.4

setBoolean

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

パラメータ:
parameterName - パラメータの名前
x - パラメータ値
例外:
SQLException - parameterName が指定されたパラメータに対応しない場合、データベースアクセスエラーが発生した場合、またはこのメソッドがクローズされた CallableStatement で呼び出された場合
SQLFeatureNotSupportedException - JDBC ドライバがこのメソッドをサポートしない場合
導入されたバージョン:
1.4
関連項目:
getBoolean(int)

setByte

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

パラメータ:
parameterName - パラメータの名前
x - パラメータ値
例外:
SQLException - parameterName が指定されたパラメータに対応しない場合、データベースアクセスエラーが発生した場合、またはこのメソッドがクローズされた CallableStatement で呼び出された場合
SQLFeatureNotSupportedException - JDBC ドライバがこのメソッドをサポートしない場合
導入されたバージョン:
1.4
関連項目:
getByte(int)

setShort

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

パラメータ:
parameterName - パラメータの名前
x - パラメータ値
例外:
SQLException - parameterName が指定されたパラメータに対応しない場合、データベースアクセスエラーが発生した場合、またはこのメソッドがクローズされた CallableStatement で呼び出された場合
SQLFeatureNotSupportedException - JDBC ドライバがこのメソッドをサポートしない場合
導入されたバージョン:
1.4
関連項目:
getShort(int)

setInt

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

パラメータ:
parameterName - パラメータの名前
x - パラメータ値
例外:
SQLException - parameterName が指定されたパラメータに対応しない場合、データベースアクセスエラーが発生した場合、またはこのメソッドがクローズされた CallableStatement で呼び出された場合
SQLFeatureNotSupportedException - JDBC ドライバがこのメソッドをサポートしない場合
導入されたバージョン:
1.4
関連項目:
getInt(int)

setLong

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

パラメータ:
parameterName - パラメータの名前
x - パラメータ値
例外:
SQLException - parameterName が指定されたパラメータに対応しない場合、データベースアクセスエラーが発生した場合、またはこのメソッドがクローズされた CallableStatement で呼び出された場合
SQLFeatureNotSupportedException - JDBC ドライバがこのメソッドをサポートしない場合
導入されたバージョン:
1.4
関連項目:
getLong(int)

setFloat

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

パラメータ:
parameterName - パラメータの名前
x - パラメータ値
例外:
SQLException - parameterName が指定されたパラメータに対応しない場合、データベースアクセスエラーが発生した場合、またはこのメソッドがクローズされた CallableStatement で呼び出された場合
SQLFeatureNotSupportedException - JDBC ドライバがこのメソッドをサポートしない場合
導入されたバージョン:
1.4
関連項目:
getFloat(int)

setDouble

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

パラメータ:
parameterName - パラメータの名前
x - パラメータ値
例外:
SQLException - parameterName が指定されたパラメータに対応しない場合、データベースアクセスエラーが発生した場合、またはこのメソッドがクローズされた CallableStatement で呼び出された場合
SQLFeatureNotSupportedException - JDBC ドライバがこのメソッドをサポートしない場合
導入されたバージョン:
1.4
関連項目:
getDouble(int)

setBigDecimal

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

パラメータ:
parameterName - パラメータの名前
x - パラメータ値
例外:
SQLException - parameterName が指定されたパラメータに対応しない場合、データベースアクセスエラーが発生した場合、またはこのメソッドがクローズされた CallableStatement で呼び出された場合
SQLFeatureNotSupportedException - JDBC ドライバがこのメソッドをサポートしない場合
導入されたバージョン:
1.4
関連項目:
getBigDecimal(int, int)

setString

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

パラメータ:
parameterName - パラメータの名前
x - パラメータ値
例外:
SQLException - parameterName が指定されたパラメータに対応しない場合、データベースアクセスエラーが発生した場合、またはこのメソッドがクローズされた CallableStatement で呼び出された場合
SQLFeatureNotSupportedException - JDBC ドライバがこのメソッドをサポートしない場合
導入されたバージョン:
1.4
関連項目:
getString(int)

setBytes

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

パラメータ:
parameterName - パラメータの名前
x - パラメータ値
例外:
SQLException - parameterName が指定されたパラメータに対応しない場合、データベースアクセスエラーが発生した場合、またはこのメソッドがクローズされた CallableStatement で呼び出された場合
SQLFeatureNotSupportedException - JDBC ドライバがこのメソッドをサポートしない場合
導入されたバージョン:
1.4
関連項目:
getBytes(int)

setDate

void setDate(String parameterName,
             Date x)
             throws SQLException
アプリケーションを実行している仮想マシンのデフォルトのタイムゾーンを使用して、指定されたパラメータを指定された java.sql.Date 値に設定します。データベースに送るときに、ドライバはこれを SQL DATE 値に変換します。

パラメータ:
parameterName - パラメータの名前
x - パラメータ値
例外:
SQLException - parameterName が指定されたパラメータに対応しない場合、データベースアクセスエラーが発生した場合、またはこのメソッドがクローズされた CallableStatement で呼び出された場合
SQLFeatureNotSupportedException - JDBC ドライバがこのメソッドをサポートしない場合
導入されたバージョン:
1.4
関連項目:
getDate(int)

setTime

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

パラメータ:
parameterName - パラメータの名前
x - パラメータ値
例外:
SQLException - parameterName が指定されたパラメータに対応しない場合、データベースアクセスエラーが発生した場合、またはこのメソッドがクローズされた CallableStatement で呼び出された場合
SQLFeatureNotSupportedException - JDBC ドライバがこのメソッドをサポートしない場合
導入されたバージョン:
1.4
関連項目:
getTime(int)

setTimestamp

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

パラメータ:
parameterName - パラメータの名前
x - パラメータ値
例外:
SQLException - parameterName が指定されたパラメータに対応しない場合、データベースアクセスエラーが発生した場合、またはこのメソッドがクローズされた CallableStatement で呼び出された場合
SQLFeatureNotSupportedException - JDBC ドライバがこのメソッドをサポートしない場合
導入されたバージョン:
1.4
関連項目:
getTimestamp(int)

setAsciiStream

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 - parameterName が指定されたパラメータに対応しない場合、データベースアクセスエラーが発生した場合、またはこのメソッドがクローズされた CallableStatement で呼び出された場合
SQLFeatureNotSupportedException - JDBC ドライバがこのメソッドをサポートしない場合
導入されたバージョン:
1.4

setBinaryStream

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

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

パラメータ:
parameterName - パラメータの名前
x - バイナリパラメータ値を含む Java 入力ストリーム
length - ストリームのバイト数
例外:
SQLException - parameterName が指定されたパラメータに対応しない場合、データベースアクセスエラーが発生した場合、またはこのメソッドがクローズされた CallableStatement で呼び出された場合
SQLFeatureNotSupportedException - JDBC ドライバがこのメソッドをサポートしない場合
導入されたバージョン:
1.4

setObject

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

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

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

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

setObject

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

パラメータ:
parameterName - パラメータの名前
x - 入力パラメータ値を含むオブジェクト
targetSqlType - データベースに送られる (java.sql.Types で定義される) SQL 型
例外:
SQLException - parameterName が指定されたパラメータに対応しない場合、データベースアクセスエラーが発生した場合、またはこのメソッドがクローズされた CallableStatement で呼び出された場合
SQLFeatureNotSupportedException - targetSqlType のデータ型が、ARRAYBLOBCLOBDATALINKJAVA_OBJECTNCHARNCLOBNVARCHARLONGNVARCHARREFROWIDSQLXML、または STRUCT で、JDBC ドライバがこのデータ型をサポートしていない場合
導入されたバージョン:
1.4
関連項目:
getObject(int)

setObject

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

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

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

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

注: すべてのデータベースで、バックエンドに対する型のない Null の送信が許可されるわけではありません。移植性を最大限にするには、setObject(String parameterName, Object x) の代わりに setNull メソッドまたは setObject(String parameterName, Object x, int sqlType) メソッドを使用しなければいけません。

パラメータ:
parameterName - パラメータの名前
x - 入力パラメータ値を含むオブジェクト
例外:
SQLException - parameterName が指定されたパラメータに対応しない場合、データベースアクセスエラーが発生した場合、このメソッドがクローズされた CallableStatement で呼び出された場合、または指定された Object パラメータがあいまいな場合
SQLFeatureNotSupportedException - JDBC ドライバがこのメソッドをサポートしない場合
導入されたバージョン:
1.4
関連項目:
getObject(int)

setCharacterStream

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 - parameterName が指定されたパラメータに対応しない場合、データベースアクセスエラーが発生した場合、またはこのメソッドがクローズされた CallableStatement で呼び出された場合
SQLFeatureNotSupportedException - JDBC ドライバがこのメソッドをサポートしない場合
導入されたバージョン:
1.4

setDate

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

パラメータ:
parameterName - パラメータの名前
x - パラメータ値
cal - ドライバが日付を作成するために使用する Calendar オブジェクト
例外:
SQLException - parameterName が指定されたパラメータに対応しない場合、データベースアクセスエラーが発生した場合、またはこのメソッドがクローズされた CallableStatement で呼び出された場合
SQLFeatureNotSupportedException - JDBC ドライバがこのメソッドをサポートしない場合
導入されたバージョン:
1.4
関連項目:
getDate(int)

setTime

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

パラメータ:
parameterName - パラメータの名前
x - パラメータ値
cal - ドライバが時刻を作成するために使用する Calendar オブジェクト
例外:
SQLException - parameterName が指定されたパラメータに対応しない場合、データベースアクセスエラーが発生した場合、またはこのメソッドがクローズされた CallableStatement で呼び出された場合
SQLFeatureNotSupportedException - JDBC ドライバがこのメソッドをサポートしない場合
導入されたバージョン:
1.4
関連項目:
getTime(int)

setTimestamp

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

パラメータ:
parameterName - パラメータの名前
x - パラメータ値
cal - ドライバがタイムスタンプを作成するために使用する Calendar オブジェクト
例外:
SQLException - parameterName が指定されたパラメータに対応しない場合、データベースアクセスエラーが発生した場合、またはこのメソッドがクローズされた CallableStatement で呼び出された場合
SQLFeatureNotSupportedException - JDBC ドライバがこのメソッドをサポートしない場合
導入されたバージョン:
1.4
関連項目:
getTimestamp(int)

setNull

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

注: 移植性を実現するためには、アプリケーションは NULL のユーザー定義パラメータまたは REF パラメータを指定するときに SQL 型コードおよび完全指定の SQL 型名を指定しなければいけません。ユーザー定義型の場合、名前はパラメータ自体の型名です。REF パラメータの場合、名前は参照される型の型名です。

ユーザー定義パラメータおよび REF パラメータを対象としていますが、このメソッドは任意の JDBC 型の null パラメータを設定するために使用できます。パラメータがユーザー定義の型または REF 型を持たない場合、指定された typeName は無視されます。

パラメータ:
parameterName - パラメータの名前
sqlType - java.sql.Types からの値
typeName - SQL ユーザー定義型の完全指定された名前。パラメータがユーザー定義型でも SQL REF 値でもない場合は無視される
例外:
SQLException - parameterName が指定されたパラメータに対応しない場合、データベースアクセスエラーが発生した場合、またはこのメソッドがクローズされた CallableStatement で呼び出された場合
SQLFeatureNotSupportedException - JDBC ドライバがこのメソッドをサポートしない場合
導入されたバージョン:
1.4

getString

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

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

パラメータ:
parameterName - パラメータの名前
戻り値:
パラメータ値値が SQL NULL の場合は null
例外:
SQLException - parameterName が指定されたパラメータに対応しない場合、データベースアクセスエラーが発生した場合、またはこのメソッドがクローズされた CallableStatement で呼び出された場合
SQLFeatureNotSupportedException - JDBC ドライバがこのメソッドをサポートしない場合
導入されたバージョン:
1.4
関連項目:
setString(java.lang.String, java.lang.String)

getBoolean

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

パラメータ:
parameterName - パラメータの名前
戻り値:
パラメータ値値が SQL NULL の場合は false
例外:
SQLException - parameterName が指定されたパラメータに対応しない場合、データベースアクセスエラーが発生した場合、またはこのメソッドがクローズされた CallableStatement で呼び出された場合
SQLFeatureNotSupportedException - JDBC ドライバがこのメソッドをサポートしない場合
導入されたバージョン:
1.4
関連項目:
setBoolean(java.lang.String, boolean)

getByte

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

パラメータ:
parameterName - パラメータの名前
戻り値:
パラメータ値値が SQL NULL の場合は 0
例外:
SQLException - parameterName が指定されたパラメータに対応しない場合、データベースアクセスエラーが発生した場合、またはこのメソッドがクローズされた CallableStatement で呼び出された場合
SQLFeatureNotSupportedException - JDBC ドライバがこのメソッドをサポートしない場合
導入されたバージョン:
1.4
関連項目:
setByte(java.lang.String, byte)

getShort

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

パラメータ:
parameterName - パラメータの名前
戻り値:
パラメータ値値が SQL NULL の場合は 0
例外:
SQLException - parameterName が指定されたパラメータに対応しない場合、データベースアクセスエラーが発生した場合、またはこのメソッドがクローズされた CallableStatement で呼び出された場合
SQLFeatureNotSupportedException - JDBC ドライバがこのメソッドをサポートしない場合
導入されたバージョン:
1.4
関連項目:
setShort(java.lang.String, short)

getInt

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

パラメータ:
parameterName - パラメータの名前
戻り値:
パラメータ値値が SQL NULL の場合は 0
例外:
SQLException - parameterName が指定されたパラメータに対応しない場合、データベースアクセスエラーが発生した場合、またはこのメソッドがクローズされた CallableStatement で呼び出された場合
SQLFeatureNotSupportedException - JDBC ドライバがこのメソッドをサポートしない場合
導入されたバージョン:
1.4
関連項目:
setInt(java.lang.String, int)

getLong

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

パラメータ:
parameterName - パラメータの名前
戻り値:
パラメータ値値が SQL NULL の場合は 0
例外:
SQLException - parameterName が指定されたパラメータに対応しない場合、データベースアクセスエラーが発生した場合、またはこのメソッドがクローズされた CallableStatement で呼び出された場合
SQLFeatureNotSupportedException - JDBC ドライバがこのメソッドをサポートしない場合
導入されたバージョン:
1.4
関連項目:
setLong(java.lang.String, long)

getFloat

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

パラメータ:
parameterName - パラメータの名前
戻り値:
パラメータ値値が SQL NULL の場合は 0
例外:
SQLException - parameterName が指定されたパラメータに対応しない場合、データベースアクセスエラーが発生した場合、またはこのメソッドがクローズされた CallableStatement で呼び出された場合
SQLFeatureNotSupportedException - JDBC ドライバがこのメソッドをサポートしない場合
導入されたバージョン:
1.4
関連項目:
setFloat(java.lang.String, float)

getDouble

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

パラメータ:
parameterName - パラメータの名前
戻り値:
パラメータ値値が SQL NULL の場合は 0
例外:
SQLException - parameterName が指定されたパラメータに対応しない場合、データベースアクセスエラーが発生した場合、またはこのメソッドがクローズされた CallableStatement で呼び出された場合
SQLFeatureNotSupportedException - JDBC ドライバがこのメソッドをサポートしない場合
導入されたバージョン:
1.4
関連項目:
setDouble(java.lang.String, double)

getBytes

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

パラメータ:
parameterName - パラメータの名前
戻り値:
パラメータ値値が SQL NULL の場合は null
例外:
SQLException - parameterName が指定されたパラメータに対応しない場合、データベースアクセスエラーが発生した場合、またはこのメソッドがクローズされた CallableStatement で呼び出された場合
SQLFeatureNotSupportedException - JDBC ドライバがこのメソッドをサポートしない場合
導入されたバージョン:
1.4
関連項目:
setBytes(java.lang.String, byte[])

getDate

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

パラメータ:
parameterName - パラメータの名前
戻り値:
パラメータ値値が SQL NULL の場合は null
例外:
SQLException - parameterName が指定されたパラメータに対応しない場合、データベースアクセスエラーが発生した場合、またはこのメソッドがクローズされた CallableStatement で呼び出された場合
SQLFeatureNotSupportedException - JDBC ドライバがこのメソッドをサポートしない場合
導入されたバージョン:
1.4
関連項目:
setDate(java.lang.String, java.sql.Date)

getTime

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

パラメータ:
parameterName - パラメータの名前
戻り値:
パラメータ値値が SQL NULL の場合は null
例外:
SQLException - parameterName が指定されたパラメータに対応しない場合、データベースアクセスエラーが発生した場合、またはこのメソッドがクローズされた CallableStatement で呼び出された場合
SQLFeatureNotSupportedException - JDBC ドライバがこのメソッドをサポートしない場合
導入されたバージョン:
1.4
関連項目:
setTime(java.lang.String, java.sql.Time)

getTimestamp

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

パラメータ:
parameterName - パラメータの名前
戻り値:
パラメータ値値が SQL NULL の場合は null
例外:
SQLException - parameterName が指定されたパラメータに対応しない場合、データベースアクセスエラーが発生した場合、またはこのメソッドがクローズされた CallableStatement で呼び出された場合
SQLFeatureNotSupportedException - JDBC ドライバがこのメソッドをサポートしない場合
導入されたバージョン:
1.4
関連項目:
setTimestamp(java.lang.String, java.sql.Timestamp)

getObject

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 - parameterName が指定されたパラメータに対応しない場合、データベースアクセスエラーが発生した場合、またはこのメソッドがクローズされた CallableStatement で呼び出された場合
SQLFeatureNotSupportedException - JDBC ドライバがこのメソッドをサポートしない場合
導入されたバージョン:
1.4
関連項目:
Types, setObject(java.lang.String, java.lang.Object, int, int)

getBigDecimal

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

パラメータ:
parameterName - パラメータの名前
戻り値:
パラメータ値 (全精度)。値が SQL NULL の場合は null
例外:
SQLExceptionif - parameterName が指定されたパラメータに対応しない場合、データベースアクセスエラーが発生した場合、またはこのメソッドがクローズされた CallableStatement で呼び出された場合
SQLFeatureNotSupportedException - JDBC ドライバがこのメソッドをサポートしない場合
SQLException
導入されたバージョン:
1.4
関連項目:
setBigDecimal(java.lang.String, java.math.BigDecimal)

getObject

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

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

パラメータ:
parameterName - パラメータの名前
map - SQL の型名から Java クラスへのマッピング
戻り値:
OUT パラメータ値を保持する java.lang.Object
例外:
SQLException - parameterName が指定されたパラメータに対応しない場合、データベースアクセスエラーが発生した場合、またはこのメソッドがクローズされた CallableStatement で呼び出された場合
SQLFeatureNotSupportedException - JDBC ドライバがこのメソッドをサポートしない場合
導入されたバージョン:
1.4
関連項目:
setObject(java.lang.String, java.lang.Object, int, int)

getRef

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

パラメータ:
parameterName - パラメータの名前
戻り値:
Java プログラミング言語の Ref オブジェクトとして表されたパラメータ値。値が SQL NULL の場合は null
例外:
SQLException - parameterName が指定されたパラメータに対応しない場合、データベースアクセスエラーが発生した場合、またはこのメソッドがクローズされた CallableStatement で呼び出された場合
SQLFeatureNotSupportedException - JDBC ドライバがこのメソッドをサポートしない場合
導入されたバージョン:
1.4

getBlob

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

パラメータ:
parameterName - パラメータの名前
戻り値:
Java プログラミング言語の Blob オブジェクトとして表されたパラメータ値。値が SQL NULL の場合は null
例外:
SQLException - parameterName が指定されたパラメータに対応しない場合、データベースアクセスエラーが発生した場合、またはこのメソッドがクローズされた CallableStatement で呼び出された場合
SQLFeatureNotSupportedException - JDBC ドライバがこのメソッドをサポートしない場合
導入されたバージョン:
1.4

getClob

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

パラメータ:
parameterName - パラメータの名前
戻り値:
Java プログラミング言語の Clob オブジェクトとして表されたパラメータ値。値が SQL NULL の場合は null
例外:
SQLException - parameterName が指定されたパラメータに対応しない場合、データベースアクセスエラーが発生した場合、またはこのメソッドがクローズされた CallableStatement で呼び出された場合
SQLFeatureNotSupportedException - JDBC ドライバがこのメソッドをサポートしない場合
導入されたバージョン:
1.4

getArray

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

パラメータ:
parameterName - パラメータの名前
戻り値:
Java プログラミング言語の Array オブジェクトとして表されたパラメータ値。値が SQL NULL の場合は null
例外:
SQLException - parameterName が指定されたパラメータに対応しない場合、データベースアクセスエラーが発生した場合、またはこのメソッドがクローズされた CallableStatement で呼び出された場合
SQLFeatureNotSupportedException - JDBC ドライバがこのメソッドをサポートしない場合
導入されたバージョン:
1.4

getDate

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

パラメータ:
parameterName - パラメータの名前
cal - ドライバが日付を作成するために使用する Calendar オブジェクト
戻り値:
パラメータ値値が SQL NULL の場合は null
例外:
SQLException - parameterName が指定されたパラメータに対応しない場合、データベースアクセスエラーが発生した場合、またはこのメソッドがクローズされた CallableStatement で呼び出された場合
SQLFeatureNotSupportedException - JDBC ドライバがこのメソッドをサポートしない場合
導入されたバージョン:
1.4
関連項目:
setDate(java.lang.String, java.sql.Date)

getTime

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

パラメータ:
parameterName - パラメータの名前
cal - ドライバが時刻を作成するために使用する Calendar オブジェクト
戻り値:
パラメータ値。値が SQL NULL の場合は null
例外:
SQLException - parameterName が指定されたパラメータに対応しない場合、データベースアクセスエラーが発生した場合、またはこのメソッドがクローズされた CallableStatement で呼び出された場合
SQLFeatureNotSupportedException - JDBC ドライバがこのメソッドをサポートしない場合
導入されたバージョン:
1.4
関連項目:
setTime(java.lang.String, java.sql.Time)

getTimestamp

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

パラメータ:
parameterName - パラメータの名前
cal - ドライバがタイムスタンプを作成するために使用する Calendar オブジェクト
戻り値:
パラメータ値値が SQL NULL の場合は null
例外:
SQLException - parameterName が指定されたパラメータに対応しない場合、データベースアクセスエラーが発生した場合、またはこのメソッドがクローズされた CallableStatement で呼び出された場合
SQLFeatureNotSupportedException - JDBC ドライバがこのメソッドをサポートしない場合
導入されたバージョン:
1.4
関連項目:
setTimestamp(java.lang.String, java.sql.Timestamp)

getURL

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

パラメータ:
parameterName - パラメータの名前
戻り値:
Java プログラミング言語の java.net.URL オブジェクトとして表されたパラメータ値。値が SQL NULL の場合は null
例外:
SQLException - parameterName が指定されたパラメータに対応しない場合、データベースアクセスエラーが発生した場合、このメソッドがクローズされた CallableStatement で呼び出された場合、または URL に問題がある場合
SQLFeatureNotSupportedException - JDBC ドライバがこのメソッドをサポートしない場合
導入されたバージョン:
1.4
関連項目:
setURL(java.lang.String, java.net.URL)

getRowId

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

パラメータ:
parameterIndex - 最初のパラメータは 1、2 番目のパラメータは 2、... となる
戻り値:
指定されたパラメータとして使用される JDBC ROWID 値を表す RowId オブジェクト。パラメータに SQL NULL を含む場合、null 値が返される
例外:
SQLException - parameterIndex が無効な場合、データベースアクセスエラーが発生した場合、またはこのメソッドがクローズされた CallableStatement で呼び出された場合
SQLFeatureNotSupportedException - JDBC ドライバがこのメソッドをサポートしない場合
導入されたバージョン:
1.6

getRowId

RowId getRowId(String parameterName)
               throws SQLException
指定された JDBC ROWID パラメータの値を java.sql.RowId オブジェクトとして取り出します。

パラメータ:
parameterName - パラメータの名前
戻り値:
指定されたパラメータとして使用される JDBC ROWID 値を表す RowId オブジェクト。パラメータに SQL NULL を含む場合、null 値が返される
例外:
SQLException - parameterName が指定されたパラメータに対応しない場合、データベースアクセスエラーが発生した場合、またはこのメソッドがクローズされた CallableStatement で呼び出された場合
SQLFeatureNotSupportedException - JDBC ドライバがこのメソッドをサポートしない場合
導入されたバージョン:
1.6

setRowId

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

パラメータ:
parameterName - パラメータの名前
x - パラメータ値
例外:
SQLException - parameterName が指定されたパラメータに対応しない場合、データベースアクセスエラーが発生した場合、またはこのメソッドがクローズされた CallableStatement で呼び出された場合
SQLFeatureNotSupportedException - JDBC ドライバがこのメソッドをサポートしない場合
導入されたバージョン:
1.6

setNString

void setNString(String parameterName,
                String value)
                throws SQLException
指定されたパラメータを指定された String オブジェクトに設定します。ドライバはこれを SQL NCHARNVARCHAR、または LONGNVARCHAR に変換します。

パラメータ:
parameterName - 設定されるパラメータの名前。
value - パラメータ値
例外:
SQLException - parameterName が指定されたパラメータに対応しない場合、ドライバが各国の文字セットをサポートしない場合、ドライバがデータ変換エラーが発生したことを検出できる場合、データベースアクセスエラーが発生した場合、またはこのメソッドがクローズされた CallableStatement で呼び出された場合
SQLFeatureNotSupportedException - JDBC ドライバがこのメソッドをサポートしない場合
導入されたバージョン:
1.6

setNCharacterStream

void setNCharacterStream(String parameterName,
                         Reader value,
                         long length)
                         throws SQLException
指定されたパラメータを Reader オブジェクトに設定します。Reader は、ファイルの終わりに達するまでデータを読み込みます。ドライバは、必要に応じて、Java の文字表現をデータベース内の各国文字セットに変換します。

パラメータ:
parameterName - 設定されるパラメータの名前。
value - パラメータ値
length - パラメータデータ内の文字数
例外:
SQLException - parameterName が指定されたパラメータに対応しない場合、ドライバが各国の文字セットをサポートしない場合、ドライバがデータ変換エラーが発生したことを検出できる場合、データベースアクセスエラーが発生した場合、またはこのメソッドがクローズされた CallableStatement で呼び出された場合
SQLFeatureNotSupportedException - JDBC ドライバがこのメソッドをサポートしない場合
導入されたバージョン:
1.6

setNClob

void setNClob(String parameterName,
              NClob value)
              throws SQLException
指定されたパラメータを java.sql.NClob オブジェクトに設定します。このオブジェクトは、java.sql.NClob インタフェースを実装します。この NClob オブジェクトは、SQL NCLOB にマッピングされます。

パラメータ:
parameterName - 設定されるパラメータの名前。
value - パラメータ値
例外:
SQLException - parameterName が指定されたパラメータに対応しない場合、ドライバが各国の文字セットをサポートしない場合、ドライバがデータ変換エラーが発生したことを検出できる場合、データベースアクセスエラーが発生した場合、またはこのメソッドがクローズされた CallableStatement で呼び出された場合
SQLFeatureNotSupportedException - JDBC ドライバがこのメソッドをサポートしない場合
導入されたバージョン:
1.6

setClob

void setClob(String parameterName,
             Reader reader,
             long length)
             throws SQLException
指定されたパラメータを Reader オブジェクトに設定します。reader には、length で指定される文字数が含まれる必要があります。そうでない場合、CallableStatement の実行時に SQLException が生成されます。このメソッドは、setCharacterStream (int, Reader, int) メソッドと異なり、パラメータ値を CLOB としてサーバーに送信しなければならないことをドライバに通知します。setCharacterStream メソッドを使用すると、ドライバは、パラメータデータを LONGVARCHARCLOB のどちらとしてサーバーに送信するかを判断するために余計な作業を行う必要がある可能性があります。

パラメータ:
parameterName - 設定されるパラメータの名前。
reader - パラメータ値に設定されるデータを含むオブジェクト
length - パラメータデータ内の文字数
例外:
SQLException - parameterName が指定されたパラメータに対応しない場合、指定された length が 0 より小さい場合、データベースアクセスエラーが発生した場合、またはこのメソッドがクローズされた CallableStatement で呼び出された場合
SQLFeatureNotSupportedException - JDBC ドライバがこのメソッドをサポートしない場合
導入されたバージョン:
1.6

setBlob

void setBlob(String parameterName,
             InputStream inputStream,
             long length)
             throws SQLException
指定されたパラメータを InputStream オブジェクトに設定します。inputstream には、length で指定される文字数が含まれる必要があります。そうでない場合、CallableStatement の実行時に SQLException が生成されます。このメソッドは、setBinaryStream (int, InputStream, int) メソッドと異なり、パラメータ値を BLOB としてサーバーに送信しなければならないことをドライバに通知します。setBinaryStream メソッドを使用すると、ドライバは、パラメータデータを LONGVARBINARYBLOB のどちらとしてサーバーに送信するかを判断するために余計な作業を行う必要がある可能性があります。

パラメータ:
parameterName - 2 番目は 2 に設定されるパラメータの名前
inputStream - パラメータ値に設定されるデータを含むオブジェクト
length - パラメータデータ内のバイト数
例外:
SQLException - parameterName が指定されたパラメータに対応しない場合、指定された length が 0 より小さい場合、inputStream 内のバイト数が指定された length に一致しない場合、データベースアクセスエラーが発生した場合、またはこのメソッドがクローズされた CallableStatement で呼び出された場合
SQLFeatureNotSupportedException - JDBC ドライバがこのメソッドをサポートしない場合
導入されたバージョン:
1.6

setNClob

void setNClob(String parameterName,
              Reader reader,
              long length)
              throws SQLException
指定されたパラメータを Reader オブジェクトに設定します。reader には、length で指定される文字数が含まれる必要があります。そうでない場合、CallableStatement の実行時に SQLException が生成されます。このメソッドは、setCharacterStream (int, Reader, int) メソッドと異なり、パラメータ値を NCLOB としてサーバーに送信しなければならないことをドライバに通知します。setCharacterStream メソッドを使用すると、ドライバは、パラメータデータを LONGNVARCHARNCLOB のどちらとしてサーバーに送信するかを判断するために余計な作業を行う必要がある可能性があります。

パラメータ:
parameterName - 設定されるパラメータの名前。
reader - パラメータ値に設定されるデータを含むオブジェクト
length - パラメータデータ内の文字数
例外:
SQLException - parameterName が指定されたパラメータに対応しない場合、指定された length が 0 より小さい場合、ドライバが各国の文字セットをサポートしない場合、ドライバがデータ変換エラーが発生したことを検出できる場合、データベースアクセスエラーが発生した場合、またはこのメソッドがクローズされた CallableStatement で呼び出された場合
SQLFeatureNotSupportedException - JDBC ドライバがこのメソッドをサポートしない場合
導入されたバージョン:
1.6

getNClob

NClob getNClob(int parameterIndex)
               throws SQLException
指定された JDBC NCLOB パラメータの値を Java プログラミング言語の java.sql.NClob オブジェクトとして取り出します。

パラメータ:
parameterIndex - 最初のパラメータは 1、2 番目のパラメータは 2、などとする
戻り値:
Java プログラミング言語の NClob オブジェクトとして表されたパラメータ値。値が SQL NULL の場合は null
例外:
SQLException - parameterIndex が有効でない場合、ドライバが各国の文字セットをサポートしない場合、ドライバがデータ変換エラーが発生したことを検出できる場合、データベースアクセスエラーが発生した場合、またはこのメソッドがクローズされた CallableStatement で呼び出された場合
SQLFeatureNotSupportedException - JDBC ドライバがこのメソッドをサポートしない場合
導入されたバージョン:
1.6

getNClob

NClob getNClob(String parameterName)
               throws SQLException
JDBC NCLOB パラメータの値を Java プログラミング言語の java.sql.NClob オブジェクトとして取り出します。

パラメータ:
parameterName - パラメータの名前
戻り値:
Java プログラミング言語の NClob オブジェクトとして表されたパラメータ値。値が SQL NULL の場合は null
例外:
SQLException - parameterName が指定されたパラメータに対応しない場合、ドライバが各国の文字セットをサポートしない場合、ドライバがデータ変換エラーが発生したことを検出できる場合、データベースアクセスエラーが発生した場合、またはこのメソッドがクローズされた CallableStatement で呼び出された場合
SQLFeatureNotSupportedException - JDBC ドライバがこのメソッドをサポートしない場合
導入されたバージョン:
1.6

setSQLXML

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

パラメータ:
parameterName - パラメータの名前
xmlObject - SQL XML 値をマッピングする SQLXML オブジェクト
例外:
SQLException - parameterName が指定されたパラメータに対応しない場合、データベースアクセスエラーが発生した場合、このメソッドがクローズされた CallableStatement または java.xml.transform.Result で呼び出された場合、Writer または OutputStreamSQLXML オブジェクトに対してクローズされていない場合
SQLFeatureNotSupportedException - JDBC ドライバがこのメソッドをサポートしない場合
導入されたバージョン:
1.6

getSQLXML

SQLXML getSQLXML(int parameterIndex)
                 throws SQLException
指定された SQL XML パラメータの値を Java プログラミング言語の java.sql.SQLXML オブジェクトとして取り出します。

パラメータ:
parameterIndex - 最初のパラメータのインデックスは 1、2 番目のパラメータのインデックスは 2、... となる
戻り値:
SQL XML 値をマッピングする SQLXML オブジェクト
例外:
SQLException - parameterIndex が無効な場合、データベースアクセスエラーが発生した場合、またはこのメソッドがクローズされた CallableStatement で呼び出された場合
SQLFeatureNotSupportedException - JDBC ドライバがこのメソッドをサポートしない場合
導入されたバージョン:
1.6

getSQLXML

SQLXML getSQLXML(String parameterName)
                 throws SQLException
指定された SQL XML パラメータの値を Java プログラミング言語の java.sql.SQLXML オブジェクトとして取り出します。

パラメータ:
parameterName - パラメータの名前
戻り値:
SQL XML 値をマッピングする SQLXML オブジェクト
例外:
SQLException - parameterName が指定されたパラメータに対応しない場合、データベースアクセスエラーが発生した場合、またはこのメソッドがクローズされた CallableStatement で呼び出された場合
SQLFeatureNotSupportedException - JDBC ドライバがこのメソッドをサポートしない場合
導入されたバージョン:
1.6

getNString

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

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

パラメータ:
parameterIndex - 最初のパラメータのインデックスは 1、2 番目のパラメータのインデックスは 2、... となる
戻り値:
NCHARNVARCHAR、または LONGNVARCHAR 値をマッピングする String オブジェクト
例外:
SQLException - parameterIndex が無効な場合、データベースアクセスエラーが発生した場合、またはこのメソッドがクローズされた CallableStatement で呼び出された場合
SQLFeatureNotSupportedException - JDBC ドライバがこのメソッドをサポートしない場合
導入されたバージョン:
1.6
関連項目:
setNString(java.lang.String, java.lang.String)

getNString

String getNString(String parameterName)
                  throws SQLException
指定された NCHARNVARCHAR、または LONGNVARCHAR パラメータの値を Java プログラミング言語の String として取り出します。

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

パラメータ:
parameterName - パラメータの名前
戻り値:
NCHARNVARCHAR、または LONGNVARCHAR 値をマッピングする String オブジェクト
例外:
SQLException - parameterName が指定されたパラメータに対応しない場合、データベースアクセスエラーが発生した場合、またはこのメソッドがクローズされた CallableStatement で呼び出された場合
SQLFeatureNotSupportedException - JDBC ドライバがこのメソッドをサポートしない場合
導入されたバージョン:
1.6
関連項目:
setNString(java.lang.String, java.lang.String)

getNCharacterStream

Reader getNCharacterStream(int parameterIndex)
                           throws SQLException
指定されたパラメータの値を Java プログラミング言語の java.io.Reader オブジェクトとして取り出します。NCHARNVARCHAR、および LONGNVARCHAR パラメータにアクセスするときに使用します。

パラメータ:
parameterIndex - 最初のパラメータは 1、2 番目のパラメータは 2、... となる
戻り値:
パラメータ値を格納する java.io.Reader オブジェクト。値が SQL NULL の場合、返される値は Java プログラミング言語の null
例外:
SQLException - parameterIndex が無効な場合、データベースアクセスエラーが発生した場合、またはこのメソッドがクローズされた CallableStatement で呼び出された場合
SQLFeatureNotSupportedException - JDBC ドライバがこのメソッドをサポートしない場合
導入されたバージョン:
1.6

getNCharacterStream

Reader getNCharacterStream(String parameterName)
                           throws SQLException
指定されたパラメータの値を Java プログラミング言語の java.io.Reader オブジェクトとして取り出します。NCHARNVARCHAR、および LONGNVARCHAR パラメータにアクセスするときに使用します。

パラメータ:
parameterName - パラメータの名前
戻り値:
パラメータ値を格納する java.io.Reader オブジェクト。値が SQL NULL の場合、返される値は Java プログラミング言語の null
例外:
SQLException - parameterName が指定されたパラメータに対応しない場合、データベースアクセスエラーが発生した場合、またはこのメソッドがクローズされた CallableStatement で呼び出された場合
SQLFeatureNotSupportedException - JDBC ドライバがこのメソッドをサポートしない場合
導入されたバージョン:
1.6

getCharacterStream

Reader getCharacterStream(int parameterIndex)
                          throws SQLException
指定されたパラメータの値を Java プログラミング言語の java.io.Reader オブジェクトとして取り出します。

パラメータ:
parameterIndex - 最初のパラメータは 1、2 番目のパラメータは 2、... となる
戻り値:
パラメータ値を格納する java.io.Reader オブジェクト。値が SQL NULL の場合、返される値は Java プログラミング言語の null
例外:
SQLException - parameterIndex が無効な場合、データベースアクセスエラーが発生した場合、またはこのメソッドがクローズされた CallableStatement で呼び出された場合
導入されたバージョン:
1.6

getCharacterStream

Reader getCharacterStream(String parameterName)
                          throws SQLException
指定されたパラメータの値を Java プログラミング言語の java.io.Reader オブジェクトとして取り出します。

パラメータ:
parameterName - パラメータの名前
戻り値:
パラメータ値を格納する java.io.Reader オブジェクト。値が SQL NULL の場合、返される値は Java プログラミング言語の null
例外:
SQLException - parameterName が指定されたパラメータに対応しない場合、データベースアクセスエラーが発生した場合、またはこのメソッドがクローズされた CallableStatement で呼び出された場合
SQLFeatureNotSupportedException - JDBC ドライバがこのメソッドをサポートしない場合
導入されたバージョン:
1.6

setBlob

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

パラメータ:
parameterName - パラメータの名前
x - SQL BLOB 値をマッピングする Blob オブジェクト
例外:
SQLException - parameterName が指定されたパラメータに対応しない場合、データベースアクセスエラーが発生した場合、またはこのメソッドがクローズされた CallableStatement で呼び出された場合
SQLFeatureNotSupportedException - JDBC ドライバがこのメソッドをサポートしない場合
導入されたバージョン:
1.6

setClob

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

パラメータ:
parameterName - パラメータの名前
x - SQL CLOB 値をマッピングする Clob オブジェクト
例外:
SQLException - parameterName が指定されたパラメータに対応しない場合、データベースアクセスエラーが発生した場合、またはこのメソッドがクローズされた CallableStatement で呼び出された場合
SQLFeatureNotSupportedException - JDBC ドライバがこのメソッドをサポートしない場合
導入されたバージョン:
1.6

setAsciiStream

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

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

パラメータ:
parameterName - パラメータの名前
x - ASCII パラメータ値を含む Java 入力ストリーム
length - ストリームのバイト数
例外:
SQLException - parameterName が指定されたパラメータに対応しない場合、データベースアクセスエラーが発生した場合、またはこのメソッドがクローズされた CallableStatement で呼び出された場合
SQLFeatureNotSupportedException - JDBC ドライバがこのメソッドをサポートしない場合
導入されたバージョン:
1.6

setBinaryStream

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

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

パラメータ:
parameterName - パラメータの名前
x - バイナリパラメータ値を含む Java 入力ストリーム
length - ストリームのバイト数
例外:
SQLException - parameterName が指定されたパラメータに対応しない場合、データベースアクセスエラーが発生した場合、またはこのメソッドがクローズされた CallableStatement で呼び出された場合
SQLFeatureNotSupportedException - JDBC ドライバがこのメソッドをサポートしない場合
導入されたバージョン:
1.6

setCharacterStream

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

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

パラメータ:
parameterName - パラメータの名前
reader - 指定されたパラメータとして使用される UNICODE データを含む java.io.Reader オブジェクト
length - ストリーム内の文字数
例外:
SQLException - parameterName が指定されたパラメータに対応しない場合、データベースアクセスエラーが発生した場合、またはこのメソッドがクローズされた CallableStatement で呼び出された場合
SQLFeatureNotSupportedException - JDBC ドライバがこのメソッドをサポートしない場合
導入されたバージョン:
1.6

setAsciiStream

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

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

注: length パラメータを使用するバージョンの setAsciiStream を使用する方が効率的かどうかを判断するには、JDBC ドライバのドキュメントを参照してください。

パラメータ:
parameterName - パラメータの名前
x - ASCII パラメータ値を含む Java 入力ストリーム
例外:
SQLException - parameterName が指定されたパラメータに対応しない場合、データベースアクセスエラーが発生した場合、またはこのメソッドがクローズされた CallableStatement で呼び出された場合
SQLFeatureNotSupportedException - JDBC ドライバがこのメソッドをサポートしない場合
導入されたバージョン:
1.6

setBinaryStream

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

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

注: length パラメータを使用するバージョンの setBinaryStream を使用する方が効率的かどうかを判断するには、JDBC ドライバのドキュメントを参照してください。

パラメータ:
parameterName - パラメータの名前
x - バイナリパラメータ値を含む Java 入力ストリーム
例外:
SQLException - parameterName が指定されたパラメータに対応しない場合、データベースアクセスエラーが発生した場合、またはこのメソッドがクローズされた CallableStatement で呼び出された場合
SQLFeatureNotSupportedException - JDBC ドライバがこのメソッドをサポートしない場合
導入されたバージョン:
1.6

setCharacterStream

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

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

注: length パラメータを使用するバージョンの setCharacterStream を使用する方が効率的かどうかを判断するには、JDBC ドライバのドキュメントを参照してください。

パラメータ:
parameterName - パラメータの名前
reader - Unicode データを格納する java.io.Reader オブジェクト
例外:
SQLException - parameterName が指定されたパラメータに対応しない場合、データベースアクセスエラーが発生した場合、またはこのメソッドがクローズされた CallableStatement で呼び出された場合
SQLFeatureNotSupportedException - JDBC ドライバがこのメソッドをサポートしない場合
導入されたバージョン:
1.6

setNCharacterStream

void setNCharacterStream(String parameterName,
                         Reader value)
                         throws SQLException
指定されたパラメータを Reader オブジェクトに設定します。Reader は、ファイルの終わりに達するまでデータを読み込みます。ドライバは、必要に応じて、Java の文字表現をデータベース内の各国文字セットに変換します。  

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

注: length パラメータを使用するバージョンの setNCharacterStream を使用する方が効率的かどうかを判断するには、JDBC ドライバのドキュメントを参照してください。

パラメータ:
parameterName - パラメータの名前
value - パラメータ値
例外:
SQLException - parameterName が指定されたパラメータに対応しない場合、ドライバが各国の文字セットをサポートしない場合、ドライバがデータ変換エラーが発生したことを検出できる場合、データベースアクセスエラーが発生した場合、またはこのメソッドがクローズされた CallableStatement で呼び出された場合
SQLFeatureNotSupportedException - JDBC ドライバがこのメソッドをサポートしない場合
導入されたバージョン:
1.6

setClob

void setClob(String parameterName,
             Reader reader)
             throws SQLException
指定されたパラメータを Reader オブジェクトに設定します。このメソッドは、setCharacterStream (int, Reader) メソッドと異なり、パラメータ値を CLOB としてサーバーに送信しなければならないことをドライバに通知します。setCharacterStream メソッドを使用すると、ドライバは、パラメータデータを LONGVARCHARCLOB のどちらとしてサーバーに送信するかを判断するために余計な作業を行う必要がある可能性があります。  

注: length パラメータを使用するバージョンの setClob を使用する方が効率的かどうかを判断するには、JDBC ドライバのドキュメントを参照してください。

パラメータ:
parameterName - パラメータの名前
reader - パラメータ値に設定されるデータを含むオブジェクト
例外:
SQLException - parameterName が指定されたパラメータに対応しない場合、データベースアクセスエラーが発生した場合、またはこのメソッドがクローズされた CallableStatement で呼び出された場合
SQLFeatureNotSupportedException - JDBC ドライバがこのメソッドをサポートしない場合
導入されたバージョン:
1.6

setBlob

void setBlob(String parameterName,
             InputStream inputStream)
             throws SQLException
指定されたパラメータを InputStream オブジェクトに設定します。このメソッドは、setBinaryStream (int, InputStream) メソッドと異なり、パラメータ値を BLOB としてサーバーに送信しなければならないことをドライバに通知します。setBinaryStream メソッドを使用すると、ドライバは、パラメータデータを LONGVARBINARYBLOB のどちらとしてサーバーに送信するかを判断するために余計な作業を行う必要がある可能性があります。  

注: length パラメータを使用するバージョンの setBlob を使用する方が効率的かどうかを判断するには、JDBC ドライバのドキュメントを参照してください。

パラメータ:
parameterName - パラメータの名前
inputStream - パラメータ値に設定されるデータを含むオブジェクト
例外:
SQLException - parameterName が指定されたパラメータに対応しない場合、データベースアクセスエラーが発生した場合、またはこのメソッドがクローズされた CallableStatement で呼び出された場合
SQLFeatureNotSupportedException - JDBC ドライバがこのメソッドをサポートしない場合
導入されたバージョン:
1.6

setNClob

void setNClob(String parameterName,
              Reader reader)
              throws SQLException
指定されたパラメータを Reader オブジェクトに設定します。このメソッドは、setCharacterStream (int, Reader) メソッドと異なり、パラメータ値を NCLOB としてサーバーに送信しなければならないことをドライバに通知します。setCharacterStream メソッドを使用した場合、ドライバは、パラメータデータがサーバーに LONGNVARCHAR または NCLOB のどちらの形式で送信されるのかを特定する追加処理を行わなければならないことがあります。

注: length パラメータを使用するバージョンの setNClob を使用する方が効率的かどうかを判断するには、JDBC ドライバのドキュメントを参照してください。

パラメータ:
parameterName - パラメータの名前
reader - パラメータ値に設定されるデータを含むオブジェクト
例外:
SQLException - parameterName が指定されたパラメータに対応しない場合、ドライバが各国の文字セットをサポートしない場合、ドライバがデータ変換エラーが発生したことを検出できる場合、データベースアクセスエラーが発生した場合、またはこのメソッドがクローズされた CallableStatement で呼び出された場合
SQLFeatureNotSupportedException - JDBC ドライバがこのメソッドをサポートしない場合
導入されたバージョン:
1.6

JavaTM Platform
Standard Ed. 6

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

Copyright 2009 Sun Microsystems, Inc. All rights reserved. Use is subject to license terms. Documentation Redistribution Policy も参照してください。