javax.sql.rowset.serial
クラス SQLInputImpl

java.lang.Object
  javax.sql.rowset.serial.SQLInputImpl

すべての実装されたインタフェース:

SQLInput

public class SQLInputImpl
extends Object
implements SQLInput

ユーザー定義型 (UDT) のカスタムマッピング用入力ストリームです。SQLInputImpl オブジェクトは、UDT の属性に相当する値のストリームを格納する入力ストリームです。

このクラスは、カスタムマッピングを持つ SQL 構造型または SQL 個別型で getObject メソッドが呼び出されるとき、背後でドライバによって使用されます。 プログラマが直接 SQLInputImpl メソッドを呼び出すことはありません。これらは、RowSet 実装を書き込む手段として提供されています。

SQLInputImpl クラスは、ResultSet 取得メソッドと類似した一連のリーダーメソッドセットを提供します。これらのメソッドには、SQLInputImpl オブジェクト内の値の読み取りを可能にする機能があります。

最終値が SQL NULL であったかどうかの確認には、wasNull メソッドが使用されます。

getObject メソッドが SQLData インタフェースを実装するクラスのオブジェクトで呼び出されると、JDBC ドライバはカスタムマッピングされる UDT の SQL 型を判別するために SQLData.getSQLType メソッドを呼び出します。ドライバは、SQLInputImpl のインスタンスを作成し、UDT の属性を移植します。次に、入力ストリームを SQLData.readSQL メソッドに渡します。 すると、このメソッドは、SQLInputImpl reader メソッドを呼び出して、入力ストリームから属性を読み取ります。

関連項目:

SQLData

コンストラクタの概要

SQLInputImpl(Object[] attributes, Map<String,Class<?>> map)
指定された属性の配列と型マップで初期化された SQLInputImpl オブジェクトを作成します。

メソッドの概要

Array	readArray() ストリームから SQL ARRAY 値を読み込み、その値を Java プログラミング言語の Array オブジェクトとして返します。
InputStream	readAsciiStream() この SQLInputImpl オブジェクト内の次の属性を ASCII 文字ストリームとして取得します。
BigDecimal	readBigDecimal() この SQLInputImpl オブジェクト内の次の属性を java.math.BigDecimal として取得します。
InputStream	readBinaryStream() この SQLInputImpl オブジェクト内の次の属性を未解釈のバイトストリームとして取得します。
Blob	readBlob() この SQLInputImpl オブジェクトの先頭の BLOB 値を Java プログラミング言語の Blob オブジェクトとして取得します。
boolean	readBoolean() この SQLInputImpl オブジェクト内の次の属性を Java プログラミング言語の boolean として取得します。
byte	readByte() この SQLInputImpl オブジェクト内の次の属性を Java プログラミング言語の byte として取得します。
byte[]	readBytes() この SQLInputImpl オブジェクト内の次の属性をバイト配列として取得します。
Reader	readCharacterStream() この SQLInputImpl オブジェクト内の次の属性を Unicode 文字ストリームとして取得します。
Clob	readClob() この SQLInputImpl オブジェクトの先頭の CLOB 値を Java プログラミング言語の Clob オブジェクトとして取得します。
Date	readDate() この SQLInputImpl 内の次の属性を java.sql.Date オブジェクトとして取得します。
double	readDouble() この SQLInputImpl オブジェクト内の次の属性を Java プログラミング言語の double として取得します。
float	readFloat() この SQLInputImpl オブジェクト内の次の属性を Java プログラミング言語の float として取得します。
int	readInt() この SQLInputImpl オブジェクト内の次の属性を Java プログラミング言語の int として取得します。
long	readLong() この SQLInputImpl オブジェクト内の次の属性を Java プログラミング言語の long として取得します。
NClob	readNClob() ストリームから SQL NCLOB 値を読み込み、その値を Java プログラミング言語の Clob オブジェクトとして返します。
String	readNString() ストリーム内の次の属性を読み込み、それを Java プログラミング言語の String として返します。
Object	readObject() この SQLInputImpl オブジェクトの先頭の値を Java プログラミング言語の Object として取得します。
Ref	readRef() この SQLInputImpl オブジェクトの先頭の値を Java プログラミング言語の Ref オブジェクトとして取得します。
RowId	readRowId() ストリームから SQL ROWID 値を読み込み、その値を Java プログラミング言語の RowId オブジェクトとして返します。
short	readShort() この SQLInputImpl オブジェクト内の次の属性を Java プログラミング言語の short として取得します。
SQLXML	readSQLXML() ストリームから SQL XML 値を読み込み、その値を Java プログラミング言語の SQLXML オブジェクトとして返します。
String	readString() この SQLInputImpl オブジェクト内の次の属性を Java プログラミング言語の String として取得します。
Time	readTime() この SQLInputImpl オブジェクト内の次の属性を java.sql.Time オブジェクトとして取得します。
Timestamp	readTimestamp() この SQLInputImpl オブジェクト内の次の属性を java.sql.Timestamp オブジェクトとして取得します。
URL	readURL() ストリームから SQL DATALINK 値を読み込み、その値を Java プログラミング言語の URL オブジェクトとして返します。
boolean	wasNull() この SQLInputImpl オブジェクトから最後に読み込まれた値が SQL NULL かどうかを確認します。

クラス java.lang.Object から継承されたメソッド

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

コンストラクタの詳細

SQLInputImpl

public SQLInputImpl(Object[] attributes,
                    Map<String,Class<?>> map)
             throws SQLException

指定された属性の配列と型マップで初期化された SQLInputImpl オブジェクトを作成します。指定された属性の中に UDT 属性があり、その名前のエントリが型マップ内に存在する場合、この属性は対応する SQLData 実装に従ってマップされます。

パラメータ:

attributes - Object インスタンスの配列。各要素は UDT の属性。配列内の 属性の順序は、UDT 定義で属性が定義された順序と同じ

map - 0 個以上のエントリを持つ java.util.Map オブジェクト。 各エントリは、(1) UDT の完全修飾名を指定する String オブジェクトと、 (2) UDT のマッピング方法を定義する SQLData 実装の Class オブジェクトで 構成される

例外:

SQLException - attributes または map が null 値の場合

メソッドの詳細

readString

public String readString()
                  throws SQLException

この SQLInputImpl オブジェクト内の次の属性を Java プログラミング言語の String として取得します。

このメソッドは、期待どおりの型が返されるかどうかを判定する型保証 (type-safe) されたチェックを行いません。 このチェックは、SQLData 実装に定義されているとおり、UDT マッピングに委譲されます。

定義:

インタフェース SQLInput 内の readString

戻り値:

この SQLInputImpl オブジェクトの次の属性。 値が SQL NULL の場合は null

例外:

SQLException - 読み取り位置が無効である場合、 またはストリーム内にこれ以上値がない場合

readBoolean

public boolean readBoolean()
                    throws SQLException

この SQLInputImpl オブジェクト内の次の属性を Java プログラミング言語の boolean として取得します。

このメソッドは、期待どおりの型が返されるかどうかを判定する型保証 (type-safe) されたチェックを行いません。 このチェックは、SQLData 実装に定義されているとおり、UDT マッピングに委譲されます。

定義:

インタフェース SQLInput 内の readBoolean

戻り値:

この SQLInputImpl オブジェクトの次の属性。 値が SQL NULL の場合は null

例外:

SQLException - 読み取り位置が無効である場合、 またはストリーム内にこれ以上値がない場合

readByte

public byte readByte()
              throws SQLException

この SQLInputImpl オブジェクト内の次の属性を Java プログラミング言語の byte として取得します。

このメソッドは、期待どおりの型が返されるかどうかを判定する型保証 (type-safe) されたチェックを行いません。 このチェックは、SQLData 実装に定義されているとおり、UDT マッピングに委譲されます。

定義:

インタフェース SQLInput 内の readByte

戻り値:

この SQLInputImpl オブジェクトの次の属性。 値が SQL NULL の場合は null

例外:

SQLException - 読み取り位置が無効である場合、 またはストリーム内にこれ以上値がない場合

readShort

public short readShort()
                throws SQLException

この SQLInputImpl オブジェクト内の次の属性を Java プログラミング言語の short として取得します。

このメソッドは、期待どおりの型が返されるかどうかを判定する型保証 (type-safe) されたチェックを行いません。 このチェックは、SQLData 実装に定義されているとおり、UDT マッピングに委譲されます。

定義:

インタフェース SQLInput 内の readShort

戻り値:

この SQLInputImpl オブジェクトの次の属性。 値が SQL NULL の場合は null

例外:

SQLException - 読み取り位置が無効である場合、 またはストリーム内にこれ以上値がない場合

readInt

public int readInt()
            throws SQLException

この SQLInputImpl オブジェクト内の次の属性を Java プログラミング言語の int として取得します。

このメソッドは、期待どおりの型が返されるかどうかを判定する型保証 (type-safe) されたチェックを行いません。 このチェックは、SQLData 実装に定義されているとおり、UDT マッピングに委譲されます。

定義:

インタフェース SQLInput 内の readInt

戻り値:

この SQLInputImpl オブジェクトの次の属性。 値が SQL NULL の場合は null

例外:

SQLException - 読み取り位置が無効である場合、 またはストリーム内にこれ以上値がない場合

readLong

public long readLong()
              throws SQLException

この SQLInputImpl オブジェクト内の次の属性を Java プログラミング言語の long として取得します。

このメソッドは、期待どおりの型が返されるかどうかを判定する型保証 (type-safe) されたチェックを行いません。 このチェックは、SQLData 実装に定義されているとおり、UDT マッピングに委譲されます。

定義:

インタフェース SQLInput 内の readLong

戻り値:

この SQLInputImpl オブジェクトの次の属性。 値が SQL NULL の場合は null

例外:

SQLException - 読み取り位置が無効である場合、 またはストリーム内にこれ以上値がない場合

readFloat

public float readFloat()
                throws SQLException

この SQLInputImpl オブジェクト内の次の属性を Java プログラミング言語の float として取得します。

このメソッドは、期待どおりの型が返されるかどうかを判定する型保証 (type-safe) されたチェックを行いません。 このチェックは、SQLData 実装に定義されているとおり、UDT マッピングに委譲されます。

定義:

インタフェース SQLInput 内の readFloat

戻り値:

この SQLInputImpl オブジェクトの次の属性。 値が SQL NULL の場合は null

例外:

SQLException - 読み取り位置が無効である場合、 またはストリーム内にこれ以上値がない場合

readDouble

public double readDouble()
                  throws SQLException

この SQLInputImpl オブジェクト内の次の属性を Java プログラミング言語の double として取得します。

このメソッドは、期待どおりの型が返されるかどうかを判定する型保証 (type-safe) されたチェックを行いません。 このチェックは、SQLData 実装に定義されているとおり、UDT マッピングに委譲されます。

定義:

インタフェース SQLInput 内の readDouble

戻り値:

この SQLInputImpl オブジェクトの次の属性。 値が SQL NULL の場合は null

例外:

SQLException - 読み取り位置が無効である場合、 またはストリーム内にこれ以上値がない場合

readBigDecimal

public BigDecimal readBigDecimal()
                          throws SQLException

この SQLInputImpl オブジェクト内の次の属性を java.math.BigDecimal として取得します。

このメソッドは、期待どおりの型が返されるかどうかを判定する型保証 (type-safe) されたチェックを行いません。 このチェックは、SQLData 実装に定義されているとおり、UDT マッピングに委譲されます。

定義:

インタフェース SQLInput 内の readBigDecimal

戻り値:

この SQLInputImpl オブジェクトの次の属性。 値が SQL NULL の場合は null

例外:

SQLException - 読み取り位置が無効である場合、 またはストリーム内にこれ以上値がない場合

readBytes

public byte[] readBytes()
                 throws SQLException

この SQLInputImpl オブジェクト内の次の属性をバイト配列として取得します。

このメソッドは、期待どおりの型が返されるかどうかを判定する型保証 (type-safe) されたチェックを行いません。 このチェックは、SQLData 実装に定義されているとおり、UDT マッピングに委譲されます。

定義:

インタフェース SQLInput 内の readBytes

戻り値:

この SQLInputImpl オブジェクトの次の属性。 値が SQL NULL の場合は null

例外:

SQLException - 読み取り位置が無効である場合、 またはストリーム内にこれ以上値がない場合

readDate

public Date readDate()
              throws SQLException

この SQLInputImpl 内の次の属性を java.sql.Date オブジェクトとして取得します。

このメソッドは、期待どおりの型が返されるかどうかを判定する型保証 (type-safe) されたチェックを行いません。 このチェックは、SQLData 実装に定義されているとおり、UDT マッピングに委譲されます。

定義:

インタフェース SQLInput 内の readDate

戻り値:

この SQLInputImpl オブジェクトの次の属性。 値が SQL NULL の場合は null

例外:

SQLException - 読み取り位置が無効である場合、 またはストリーム内にこれ以上値がない場合

readTime

public Time readTime()
              throws SQLException

この SQLInputImpl オブジェクト内の次の属性を java.sql.Time オブジェクトとして取得します。

このメソッドは、期待どおりの型が返されるかどうかを判定する型保証 (type-safe) されたチェックを行いません。 このチェックは、SQLData 実装のとおり、UDT マッピングに委譲されます。

定義:

インタフェース SQLInput 内の readTime

戻り値:

属性。 値が SQL NULL の場合は null

例外:

SQLException - 読み取り位置が無効である場合、 またはストリーム内にこれ以上値がない場合

readTimestamp

public Timestamp readTimestamp()
                        throws SQLException

この SQLInputImpl オブジェクト内の次の属性を java.sql.Timestamp オブジェクトとして取得します。

定義:

インタフェース SQLInput 内の readTimestamp

戻り値:

属性。 値が SQL NULL の場合は null

例外:

SQLException - 読み取り位置が無効である場合、 またはストリーム内にこれ以上値がない場合

readCharacterStream

public Reader readCharacterStream()
                           throws SQLException

この SQLInputImpl オブジェクト内の次の属性を Unicode 文字ストリームとして取得します。

このメソッドは、期待どおりの型が返されるかどうかを判定する型保証 (type-safe) されたチェックを行いません。 このチェックは、SQLData 実装のとおり、UDT マッピングに委譲されます。

定義:

インタフェース SQLInput 内の readCharacterStream

戻り値:

属性。 値が SQL NULL の場合は null

例外:

SQLException - 読み取り位置が無効である場合、 またはストリーム内にこれ以上値がない場合

readAsciiStream

public InputStream readAsciiStream()
                            throws SQLException

この SQLInputImpl オブジェクト内の次の属性を ASCII 文字ストリームとして取得します。

このメソッドは、期待どおりの型が返されるかどうかを判定する型保証 (type-safe) されたチェックを行いません。 このチェックは、SQLData 実装のとおり、UDT マッピングに委譲されます。

定義:

インタフェース SQLInput 内の readAsciiStream

戻り値:

属性。 値が SQL NULL の場合は null

例外:

SQLException - 読み取り位置が無効である場合、 またはストリーム内にこれ以上値がない場合

readBinaryStream

public InputStream readBinaryStream()
                             throws SQLException

この SQLInputImpl オブジェクト内の次の属性を未解釈のバイトストリームとして取得します。

このメソッドは、期待どおりの型が返されるかどうかを判定する型保証 (type-safe) されたチェックを行いません。 このチェックは、SQLData 実装のとおり、UDT マッピングに委譲されます。

定義:

インタフェース SQLInput 内の readBinaryStream

戻り値:

属性。 値が SQL NULL の場合は null

例外:

SQLException - 読み取り位置が無効である場合、 またはストリーム内にこれ以上値がない場合

readObject

public Object readObject()
                  throws SQLException

この SQLInputImpl オブジェクトの先頭の値を Java プログラミング言語の Object として取得します。実際に返されるオブジェクトの型は、SQL 型と Java プログラミング言語の型のデフォルトマッピングによって決定されます。 ただし、カスタムマッピングが存在する場合、返されるオブジェクトの型はこのストリームの型マップによって決定されます。

JDBC テクノロジ対応のドライバは、アプリケーションにストリームを渡す前に、このストリームに型マップを登録します。

このメソッドは、ストリームの先頭のデータが SQL NULL である場合、null を返します。データがカスタムマッピングを持つ SQL 構造型または個別型である場合、ストリームの先頭のデータの SQL 型を判別し、適切なクラスのオブジェクトを構築して、このオブジェクト上で SQLData.readSQL メソッドを呼び出します。すると、readSQL メソッドにより、適切な SQLInputImpl.readXXX メソッドが呼び出され、ストリームから属性値が取り出されます。

定義:

インタフェース SQLInput 内の readObject

戻り値:

Java プログラミング言語の Object として表される ストリームの先頭の値。 値が SQL NULL の場合は null

例外:

SQLException - 読み取り位置が無効である場合、 またはストリーム内にこれ以上値がない場合

readRef

public Ref readRef()
            throws SQLException

この SQLInputImpl オブジェクトの先頭の値を Java プログラミング言語の Ref オブジェクトとして取得します。

定義:

インタフェース SQLInput 内の readRef

戻り値:

ストリームの先頭にある SQL REF 値を 表す Ref オブジェクト。 値が SQL NULL の場合は null

例外:

SQLException - 読み取り位置が無効である場合、 またはストリーム内にこれ以上値がない場合

readBlob

public Blob readBlob()
              throws SQLException

この SQLInputImpl オブジェクトの先頭の BLOB 値を Java プログラミング言語の Blob オブジェクトとして取得します。

このメソッドは、期待どおりの型が返されるかどうかを判定する型保証 (type-safe) されたチェックを行いません。 このチェックは、SQLData 実装のとおり、UDT マッピングに委譲されます。

定義:

インタフェース SQLInput 内の readBlob

戻り値:

ストリームの先頭の SQL BLOB 値を 表す Blob オブジェクト。 値が SQL NULL の場合は null

例外:

SQLException - 読み取り位置が無効である場合、 またはストリーム内にこれ以上値がない場合

readClob

public Clob readClob()
              throws SQLException

この SQLInputImpl オブジェクトの先頭の CLOB 値を Java プログラミング言語の Clob オブジェクトとして取得します。

このメソッドは、期待どおりの型が返されるかどうかを判定する型保証 (type-safe) されたチェックを行いません。 このチェックは、SQLData 実装のとおり、UDT マッピングに委譲されます。

定義:

インタフェース SQLInput 内の readClob

戻り値:

ストリームの先頭の SQL CLOB 値を 表す Clob オブジェクト。 値が SQL NULL の場合は null

例外:

SQLException - 読み取り位置が無効である場合、 またはストリーム内にこれ以上値がない場合

readArray

public Array readArray()
                throws SQLException

ストリームから SQL ARRAY 値を読み込み、その値を Java プログラミング言語の Array オブジェクトとして返します。

このメソッドは、期待どおりの型が返されるかどうかを判定する型保証 (type-safe) されたチェックを行いません。 このチェックは、SQLData 実装のとおり、UDT マッピングに委譲されます。

定義:

インタフェース SQLInput 内の readArray

戻り値:

ストリームの先頭にある SQL ARRAY 値を 表す Array オブジェクト。* 値が SQL NULL の場合は null

例外:

SQLException - 読み取り位置が無効である場合、 またはストリーム内にこれ以上値がない場合

wasNull

public boolean wasNull()
                throws SQLException

この SQLInputImpl オブジェクトから最後に読み込まれた値が SQL NULL かどうかを確認します。

定義:

インタフェース SQLInput 内の wasNull

戻り値:

最後に読み込まれた SQL 値が null の場合は true、そうでない場合は false。 デフォルトの戻り値は false

例外:

SQLException - 最後に読み込まれた値が null かどうかを確認中に エラーが発生した場合

readURL

public URL readURL()
            throws SQLException

ストリームから SQL DATALINK 値を読み込み、その値を Java プログラミング言語の URL オブジェクトとして返します。

このメソッドは、期待どおりの型が返されるかどうかを判定する型保証 (type-safe) されたチェックを行いません。 このチェックは、SQLData 実装のとおり、UDT マッピングに委譲されます。

定義:

インタフェース SQLInput 内の readURL

戻り値:

ストリームの先頭にある SQL DATALINK 値を 表す URL オブジェクト。* 値が SQL NULL の場合は null

例外:

SQLException - 読み取り位置が無効である場合、 またはストリーム内にこれ以上値がない場合

readNClob

public NClob readNClob()
                throws SQLException

ストリームから SQL NCLOB 値を読み込み、その値を Java プログラミング言語の Clob オブジェクトとして返します。

定義:

インタフェース SQLInput 内の readNClob

戻り値:

ストリームの先頭にある SQL NCLOB 値のデータを表す NClob オブジェクト。読み込まれた値が SQL NULL の場合は null

例外:

SQLException - データベースアクセスエラーが発生した場合

readNString

public String readNString()
                   throws SQLException

ストリーム内の次の属性を読み込み、それを Java プログラミング言語の String として返します。NCHAR、NVARCHAR、および LONGNVARCHAR 列にアクセスするときに使用します。

定義:

インタフェース SQLInput 内の readNString

戻り値:

属性。値が SQL NULL の場合は null

例外:

SQLException - データベースアクセスエラーが発生した場合

readSQLXML

public SQLXML readSQLXML()
                  throws SQLException

ストリームから SQL XML 値を読み込み、その値を Java プログラミング言語の SQLXML オブジェクトとして返します。

定義:

インタフェース SQLInput 内の readSQLXML

戻り値:

ストリームの先頭にある SQL XML 値のデータを表す SQLXML オブジェクト。読み込まれた値が SQL NULL の場合は null

例外:

SQLException - データベースアクセスエラーが発生した場合

readRowId

public RowId readRowId()
                throws SQLException

ストリームから SQL ROWID 値を読み込み、その値を Java プログラミング言語の RowId オブジェクトとして返します。

定義:

インタフェース SQLInput 内の readRowId

戻り値:

ストリームの先頭にある SQL ROWID 値のデータを表す RowId オブジェクト。読み込まれた値が SQL NULL の場合は null

例外:

SQLException - データベースアクセスエラーが発生した場合