Java プラットフォーム 1.2

java.sql
インタフェース SQLInput

public abstract interface SQLInput

JDBC 2.0

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

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

メソッドの概要
 Array readArray()
          ストリームから配列を読み出します。
 InputStream readAsciiStream()
          ストリーム内の次の属性を ASCII 文字のストリームとして返します。
 BigDecimal readBigDecimal()
          ストリーム内の次の属性を java.math.BigDecimal オブジェクトとして読み取ります。
 InputStream readBinaryStream()
          ストリーム内の次の属性を未解釈のバイトストリームとして返します。
 Blob readBlob()
          ストリームから BLOB を読み出します。
 boolean readBoolean()
          ストリーム内の次の属性を Java の boolean として読み取ります。
 byte readByte()
          ストリーム内の次の属性を Java の byte として読み取ります。
 byte[] readBytes()
          ストリーム内の次の属性をバイトの配列として読み取ります。
 Reader readCharacterStream()
          ストリーム内の次の属性を Unicode 文字のストリームとして返します。
 Clob readClob()
          ストリームから 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 オブジェクトとして返します。
 Ref readRef()
          ストリームから REF(<構造化型>) を読み出します。
 short readShort()
          ストリーム内の次の属性を Java の short として読み取ります。
 String readString()
          ストリーム内の次の属性を Java の String として読み取ります。
 Time readTime()
          ストリーム内の次の属性を java.sql.Time オブジェクトとして読み取ります。
 Timestamp readTimestamp()
          ストリーム内の次の属性を java.sql.Timestamp オブジェクトとして読み取ります。
 boolean wasNull()
          最後に読み出された値が null であったかどうかを判定します。
 

メソッドの詳細

readString

public String readString()
                  throws SQLException
ストリーム内の次の属性を Java の String として読み取ります。
戻り値:
属性。値が SQL NULL の場合は null
例外:
SQLException - データベースアクセスエラーが発生した場合

readBoolean

public boolean readBoolean()
                    throws SQLException
ストリーム内の次の属性を Java の boolean として読み取ります。
戻り値:
属性。値が SQL NULL の場合は null
例外:
SQLException - データベースアクセスエラーが発生した場合

readByte

public byte readByte()
              throws SQLException
ストリーム内の次の属性を Java の byte として読み取ります。
戻り値:
属性。値が SQL NULL の場合は null
例外:
SQLException - データベースアクセスエラーが発生した場合

readShort

public short readShort()
                throws SQLException
ストリーム内の次の属性を Java の short として読み取ります。
戻り値:
属性。値が SQL NULL の場合は null
例外:
SQLException - データベースアクセスエラーが発生した場合

readInt

public int readInt()
            throws SQLException
ストリーム内の次の属性を Java の int として読み取ります。
戻り値:
属性。値が SQL NULL の場合は null
例外:
SQLException - データベースアクセスエラーが発生した場合

readLong

public long readLong()
              throws SQLException
ストリーム内の次の属性を Java の long として読み取ります。
戻り値:
属性。値が SQL NULL の場合は null
例外:
SQLException - データベースアクセスエラーが発生した場合

readFloat

public float readFloat()
                throws SQLException
ストリーム内の次の属性を Java の float として読み取ります。
戻り値:
属性。値が SQL NULL の場合は null
例外:
SQLException - データベースアクセスエラーが発生した場合

readDouble

public double readDouble()
                  throws SQLException
ストリーム内の次の属性を Java の double として読み取ります。
戻り値:
属性。値が SQL NULL の場合は null
例外:
SQLException - データベースアクセスエラーが発生した場合

readBigDecimal

public BigDecimal readBigDecimal()
                          throws SQLException
ストリーム内の次の属性を java.math.BigDecimal オブジェクトとして読み取ります。
戻り値:
属性。値が SQL NULL の場合は null
例外:
SQLException - データベースアクセスエラーが発生した場合

readBytes

public byte[] readBytes()
                 throws SQLException
ストリーム内の次の属性をバイトの配列として読み取ります。
戻り値:
属性。値が 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 オブジェクトとして返します。返されるオブジェクトの実際の型は、デフォルトの型マッピングおよびこのストリームの型マッピングに定義されているカスタマイズによって判定されます。

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

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

戻り値:
Java オブジェクトとして表された、ストリームの先頭にあるデータ。データが SQL NULL の場合は null
例外:
SQLException - データベースアクセスエラーが発生した場合

readRef

public Ref readRef()
            throws SQLException
ストリームから REF(<構造化型>) を読み出します。
戻り値:
ストリームの先頭にある SQL REF のデータを表すオブジェクト
例外:
SQLException - データベースアクセスエラーが発生した場合

readBlob

public Blob readBlob()
              throws SQLException
ストリームから BLOB を読み出します。
戻り値:
ストリームの先頭にある SQL BLOB を表すオブジェクト
例外:
SQLException - データベースアクセスエラーが発生した場合

readClob

public Clob readClob()
              throws SQLException
ストリームから CLOB を読み出します。
戻り値:
ストリームの先頭にある SQL CLOB を表すオブジェクト
例外:
SQLException - データベースアクセスエラーが発生した場合

readArray

public Array readArray()
                throws SQLException
ストリームから配列を読み出します。
戻り値:
ストリームの先頭にある SQL 配列を表すオブジェクト
例外:
SQLException - データベースアクセスエラーが発生した場合

wasNull

public boolean wasNull()
                throws SQLException
最後に読み出された値が null であったかどうかを判定します。
戻り値:
最後に取得した SQL 値が null の場合は true、そうでない場合は false
例外:
SQLException - データベースアクセスエラーが発生した場合
Java プラットフォーム 1.2
バグや機能要求の報告
新しい javadoc の表示についてのコメントやご提案
Java は、米国およびその他の国における米国 Sun Microsystems, Inc. の商標もしくは登録商標です。
Copyright 1993-1998 Sun Microsystems, Inc. 901 San Antonio Road,
Palo Alto, California, 94303, U.S.A. All Rights Reserved.