モジュール java.sql.rowset
パッケージ 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メソッドを呼び出して、入力ストリームから属性を読み取ります。

    導入されたバージョン:
    1.5
    関連項目:
    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オブジェクトから最後に読み込まれた値がnullかどうかを確認します。
    • コンストラクタの詳細

      • 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またはmapnull値の場合
    • メソッドの詳細

      • readString

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

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

        定義:
        readString、インタフェース: SQLInput
        戻り値:
        このSQLInputImplオブジェクトの次の属性。値がSQL NULLの場合はnull
        例外:
        SQLException - 読取り位置が無効である場合、またはストリーム内にこれ以上値がない場合。
      • readBoolean

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

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

        定義:
        readBoolean、インタフェース: SQLInput
        戻り値:
        このSQLInputImplオブジェクトの次の属性。値がSQL NULLの場合はnull
        例外:
        SQLException - 読取り位置が無効である場合、またはストリーム内にこれ以上値がない場合。
      • readByte

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

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

        定義:
        readByte、インタフェース: SQLInput
        戻り値:
        このSQLInputImplオブジェクトの次の属性。値がSQL NULLの場合はnull
        例外:
        SQLException - 読取り位置が無効である場合、またはストリーム内にこれ以上値がない場合
      • readShort

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

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

        定義:
        readShort、インタフェース: SQLInput
        戻り値:
        このSQLInputImplオブジェクトの次の属性。値がSQL NULLの場合はnull
        例外:
        SQLException - 読取り位置が無効である場合、またはストリーム内にこれ以上値がない場合
      • readInt

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

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

        定義:
        readInt、インタフェース: SQLInput
        戻り値:
        このSQLInputImplオブジェクトの次の属性。値がSQL NULLの場合はnull
        例外:
        SQLException - 読取り位置が無効である場合、またはストリーム内にこれ以上値がない場合
      • readLong

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

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

        定義:
        readLong、インタフェース: SQLInput
        戻り値:
        このSQLInputImplオブジェクトの次の属性。値がSQL NULLの場合はnull
        例外:
        SQLException - 読取り位置が無効である場合、またはストリーム内にこれ以上値がない場合
      • readFloat

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

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

        定義:
        readFloat、インタフェース: SQLInput
        戻り値:
        このSQLInputImplオブジェクトの次の属性。値がSQL NULLの場合はnull
        例外:
        SQLException - 読取り位置が無効である場合、またはストリーム内にこれ以上値がない場合
      • readDouble

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

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

        定義:
        readDouble、インタフェース: SQLInput
        戻り値:
        このSQLInputImplオブジェクトの次の属性。値がSQL NULLの場合はnull
        例外:
        SQLException - 読取り位置が無効である場合、またはストリーム内にこれ以上値がない場合
      • readBigDecimal

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

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

        定義:
        readBigDecimal、インタフェース: SQLInput
        戻り値:
        このSQLInputImplオブジェクトの次の属性。値がSQL NULLの場合はnull
        例外:
        SQLException - 読取り位置が無効である場合、またはストリーム内にこれ以上値がない場合
      • readBytes

        public byte[] readBytes()
                         throws SQLException
        このSQLInputImplオブジェクト内の次の属性をバイト配列として取得します。

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

        定義:
        readBytes、インタフェース: SQLInput
        戻り値:
        このSQLInputImplオブジェクトの次の属性。値がSQL NULLの場合はnull
        例外:
        SQLException - 読取り位置が無効である場合、またはストリーム内にこれ以上値がない場合
      • readDate

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

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

        定義:
        readDate、インタフェース: SQLInput
        戻り値:
        このSQLInputImplオブジェクトの次の属性。値がSQL NULLの場合はnull
        例外:
        SQLException - 読取り位置が無効である場合、またはストリーム内にこれ以上値がない場合
      • readTime

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

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

        定義:
        readTime、インタフェース: SQLInput
        戻り値:
        属性。値がSQL NULLの場合はnull
        例外:
        SQLException - 読取り位置が無効である場合、またはストリーム内にこれ以上値がない場合。
      • readTimestamp

        public Timestamp readTimestamp()
                                throws SQLException
        このSQLInputImplオブジェクト内の次の属性をjava.sql.Timestampオブジェクトとして取得します。
        定義:
        readTimestamp、インタフェース: SQLInput
        戻り値:
        属性。値がSQL NULLの場合はnull
        例外:
        SQLException - 読取り位置が無効である場合、またはストリーム内にこれ以上値がない場合。
      • readCharacterStream

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

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

        定義:
        readCharacterStream、インタフェース: SQLInput
        戻り値:
        属性。値がSQL NULLの場合はnull
        例外:
        SQLException - 読取り位置が無効である場合、またはストリーム内にこれ以上値がない場合。
      • readAsciiStream

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

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

        定義:
        readAsciiStream、インタフェース: SQLInput
        戻り値:
        属性。値がSQL NULLの場合はnull
        例外:
        SQLException - 読取り位置が無効である場合、またはストリーム内にこれ以上値がない場合。
      • readBinaryStream

        public InputStream readBinaryStream()
                                     throws SQLException
        このSQLInputImplオブジェクト内の次の属性を未解釈のバイト・ストリームとして取得します。

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

        定義:
        readBinaryStream、インタフェース: SQLInput
        戻り値:
        属性。値が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メソッドが呼び出され、ストリームから属性値が取り出されます。

        定義:
        readObject、インタフェース: SQLInput
        戻り値:
        ストリームの先頭にあるJavaプログラミング言語のObjectとしての値。値がSQL NULLの場合はnull
        例外:
        SQLException - 読取り位置が無効である場合、またはストリーム内にこれ以上値がない場合。
      • readRef

        public Ref readRef()
                    throws SQLException
        このSQLInputImplオブジェクトの先頭の値をJavaプログラミング言語のRefオブジェクトとして取得します。
        定義:
        readRef、インタフェース: SQLInput
        戻り値:
        ストリームの先頭にあるSQL REF値を表すRefオブジェクト。値がSQL NULLの場合はnull
        例外:
        SQLException - 読取り位置が無効である場合、またはストリーム内にこれ以上値がない場合。
      • readBlob

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

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

        定義:
        readBlob、インタフェース: SQLInput
        戻り値:
        このストリームの先頭にあるSQL BLOB値を表すBlobオブジェクト。値がSQL NULLの場合はnull
        例外:
        SQLException - 読取り位置が無効である場合、またはストリーム内にこれ以上値がない場合。
      • readClob

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

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

        定義:
        readClob、インタフェース: SQLInput
        戻り値:
        ストリームの先頭にあるSQL CLOB値を表すClobオブジェクト。値がSQL NULLの場合はnull
        例外:
        SQLException - 読取り位置が無効である場合、またはストリーム内にこれ以上値がない場合。
      • readArray

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

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

        定義:
        readArray、インタフェース: SQLInput
        戻り値:
        ストリームの先頭にあるSQL ARRAY値を表すArrayオブジェクト。*値がSQL NULLの場合はnull
        例外:
        SQLException - 読取り位置が無効である場合、またはストリーム内にこれ以上値がない場合。
      • wasNull

        public boolean wasNull()
                        throws SQLException
        このSQLInputImplオブジェクトから最後に読み込まれた値がnullかどうかを確認します。
        定義:
        wasNull、インタフェース: SQLInput
        戻り値:
        最後に読み込まれたSQL値がnullの場合はtrue、そうでない場合はfalse。デフォルトの戻り値はfalse
        例外:
        SQLException - 最後に読み込まれた値がnullかどうかを確認中にエラーが発生した場合
      • readURL

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

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

        定義:
        readURL、インタフェース: SQLInput
        戻り値:
        ストリームの先頭にあるSQL DATALINK値を表すURLオブジェクト。*値がSQL NULLの場合はnull
        例外:
        SQLException - 読取り位置が無効である場合、またはストリーム内にこれ以上値がない場合。
      • readNClob

        public NClob readNClob()
                        throws SQLException
        ストリームからSQL NCLOB値を読み込み、その値をJavaプログラミング言語のClobオブジェクトとして返します。
        定義:
        readNClob、インタフェース: SQLInput
        戻り値:
        ストリームの先頭にあるSQL NCLOB値のデータを表すNClobオブジェクト。読み込まれた値がSQL NULLの場合はnull
        例外:
        SQLException - データベース・アクセス・エラーが発生した場合
        導入されたバージョン:
        1.6
      • readNString

        public String readNString()
                           throws SQLException
        ストリーム内の次の属性を読み込み、それをJavaプログラミング言語のStringとして返します。 NCHARNVARCHAR、およびLONGNVARCHAR列にアクセスするときに使用します。
        定義:
        readNString、インタフェース: SQLInput
        戻り値:
        属性。値がSQL NULLの場合はnullを返す
        例外:
        SQLException - データベース・アクセス・エラーが発生した場合
        導入されたバージョン:
        1.6
      • readSQLXML

        public SQLXML readSQLXML()
                          throws SQLException
        ストリームからSQL XML値を読み込み、その値をJavaプログラミング言語のSQLXMLオブジェクトとして返します。
        定義:
        readSQLXML、インタフェース: SQLInput
        戻り値:
        ストリームの先頭にあるSQL XML値のデータを表すSQLXMLオブジェクト。読み込まれた値がSQL NULLの場合はnull
        例外:
        SQLException - データベース・アクセス・エラーが発生した場合
        導入されたバージョン:
        1.6
      • readRowId

        public RowId readRowId()
                        throws SQLException
        ストリームからSQL ROWID値を読み込み、その値をJavaプログラミング言語のRowIdオブジェクトとして返します。
        定義:
        readRowId、インタフェース: SQLInput
        戻り値:
        ストリームの先頭にあるSQL ROWID値のデータを表すRowIdオブジェクト。読み込まれた値がSQL NULLの場合はnull
        例外:
        SQLException - データベース・アクセス・エラーが発生した場合
        導入されたバージョン:
        1.6