java.sql
インタフェース SQLInput

public interface SQLInput

SQL 構造化型または個別の型のインスタンスを表す値のストリームを格納する入力ストリームです。カスタムマッピングだけに使用されるこのインタフェースは、背後にあるドライバによって使用されます。プログラマが SQLInput メソッドを直接呼び出すことはできません。readXXX メソッドを使用すると、SQLInput オブジェクトの値を読み込むことができます。メソッド wasNull は、最後に読み込まれた値が SQL NULL かどうかを判別するために使用されます。

getObject メソッドが SQLData インタフェースを実装するクラスのオブジェクトで呼び出されると、JDBC ドライバはカスタムマッピングされるユーザ定義型 (UDT) の SQL 型を判別するために SQLData.getSQLType メソッドを呼び出します。ドライバは、UDT の属性で設定された SQLInput のインスタンスを生成します。次に、ドライバは入力ストリームを SQLData.readSQL メソッドに渡し、SQLData.readSQL メソッドはその実装で入力ストリームから属性を読み込むための SQLInput.readXXX メソッドを呼び出します。

導入されたバージョン:

1.2

関連項目:

「JDBC 2.0 API に含まれるもの」

メソッドの概要

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

メソッドの詳細

readString

public String readString()
                  throws SQLException

ストリーム内の次の属性を Java プログラミング言語の String として読み込みます。

戻り値:

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

例外:

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

readBoolean

public boolean readBoolean()
                    throws SQLException

ストリーム内の次の属性を Java プログラミング言語の boolean として読み込みます。

戻り値:

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

例外:

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

readByte

public byte readByte()
              throws SQLException

ストリーム内の次の属性を Java プログラミング言語の byte として読み込みます。

戻り値:

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

例外:

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

readShort

public short readShort()
                throws SQLException

ストリーム内の次の属性を Java プログラミング言語の short として読み込みます。

戻り値:

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

例外:

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

readInt

public int readInt()
            throws SQLException

ストリーム内の次の属性を Java プログラミング言語の int として読み込みます。

戻り値:

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

例外:

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

readLong

public long readLong()
              throws SQLException

ストリーム内の次の属性を Java プログラミング言語の long として読み込みます。

戻り値:

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

例外:

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

readFloat

public float readFloat()
                throws SQLException

ストリーム内の次の属性を Java プログラミング言語の float として読み込みます。

戻り値:

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

例外:

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

readDouble

public double readDouble()
                  throws SQLException

ストリーム内の次の属性を Java プログラミング言語の double として読み込みます。

戻り値:

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

例外:

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

readBigDecimal

public BigDecimal readBigDecimal()
                          throws SQLException

ストリーム内の次の属性を Java プログラミング言語の java.math.BigDecimal オブジェクトとして読み込みます。

戻り値:

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

例外:

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

readBytes

public byte[] readBytes()
                 throws SQLException

ストリーム内の次の属性を Java プログラミング言語のバイトの配列として読み込みます。

戻り値:

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

例外:

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

readDate

public Date readDate()
              throws SQLException

ストリーム内の次の属性を java.sql.Date オブジェクトとして読み込みます。

戻り値:

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

例外:

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

readTime

public Time readTime()
              throws SQLException

ストリーム内の次の属性を java.sql.Time オブジェクトとして読み込みます。

戻り値:

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

例外:

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

readTimestamp

public Timestamp readTimestamp()
                        throws SQLException

ストリーム内の次の属性を java.sql.Timestamp オブジェクトとして読み込みます。

戻り値:

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

例外:

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

readCharacterStream

public Reader readCharacterStream()
                           throws SQLException

ストリーム内の次の属性を Unicode 文字のストリームとして返します。

戻り値:

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

例外:

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

readAsciiStream

public InputStream readAsciiStream()
                            throws SQLException

ストリーム内の次の属性を ASCII 文字のストリームとして返します。

戻り値:

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

例外:

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

readBinaryStream

public InputStream readBinaryStream()
                             throws SQLException

ストリーム内の次の属性を未解釈のバイトストリームとして返します。

戻り値:

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

例外:

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

readObject

public Object readObject()
                  throws SQLException

ストリームの先頭にあるデータを Java プログラミング言語の Object として返します。返されるオブジェクトの実際の型は、デフォルトの型マップおよびこのストリームのこのストリームの型マップに示されるカスタマイズによって判定されます。

型マップはストリームがアプリケーションに渡される前に JDBC ドライバによってストリームに登録されます。

ストリームの先頭にあるデータが SQL NULL の場合、このメソッドは null を返します。データが SQL 構造化型または個別の型の場合は、ストリームの先頭にあるデータの SQL 型を判定します。ストリームの型マップに SQL 型のエントリがある場合は、ドライバは適切なクラスのオブジェクトを構築してから、そのオブジェクトでメソッド SQLData.readSQL を呼び出します。SQLData.readSQL メソッドはそのメソッドのために記述されたプロトコルを使用して、ストリームから追加データを読み込みます。

戻り値:

ストリームの先頭にある Java プログラミング言語の Object としてのデータ。データが SQL NULL の場合は null

例外:

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

readRef

public Ref readRef()
            throws SQLException

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

戻り値:

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

例外:

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

readBlob

public Blob readBlob()
              throws SQLException

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

戻り値:

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

例外:

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

readClob

public Clob readClob()
              throws SQLException

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

戻り値:

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

例外:

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

readArray

public Array readArray()
                throws SQLException

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

戻り値:

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

例外:

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

wasNull

public boolean wasNull()
                throws SQLException

最後に読み込まれた値が SQL NULL かどうかを判定します。

戻り値:

最後に読み込まれた SQL 値が SQL NULL の場合は true、そうでない場合は false

例外:

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