6.3.11 PctoSQLXMLクラス
- 説明
-
Javaプログラミング言語でSQL XML型を表現するクラスです。XMLは、XML値をデータベース表の行内に列の値として格納する組み込みの型です。デフォルトでは、JDBC DriverはSQLXMLオブジェクトをデータそのものではなく、XMLデータへの論理ポインタとして格納します。SQLXMLオブジェクトは、それが生成されたトランザクションの期間中に有効です。
PctoResultSetまたはPctoCallableStatementの各クラスのメソッド（getSQLXMLなど）を使用すると、XML値にアクセスできます。
- メソッド
-
PctoSQLXMLクラスのメソッドの一覧を次の表に示します。
表6‒21 PctoSQLXMLクラスのメソッドの一覧 メソッド
説明
free()
このメソッドは、このオブジェクトをクローズし、このオブジェクトが保持していたリソースを解放します。
getString()
このSQLXMLインスタンスによって指定されたXML値の文字列表現を返します。
setString(java.lang.String value)
このSQLXMLインスタンスによって指定されたXML値を、指定されたString表現に設定します。
- パッケージ名称
jp.co.Hitachi.soft.hmppcto.jdbc.client
(1) free()
- 説明
-
このメソッドは、このオブジェクトをクローズし、このオブジェクトが保持していたリソースを解放します。このメソッドが呼び出されると、SQL XMLオブジェクトは無効になり、読み込み可能にも書き込み可能にもなりません。
なお、freeメソッドを呼び出した場合に、free以外のメソッドを呼び出すと、SQLExceptionがスローされます。
また、freeメソッドを複数回呼び出した場合、2回目以降のfreeメソッドの呼び出しでは何も行われません。
- 形式
public void free() throws java.sql.SQLException
- 引数
-
なし。
- 戻り値
-
なし。
- 例外
-
PctoCommunicationFailureException例外とPctoInternalContradictionException例外以外は、ParticipantでJDBC Driverが送出した例外を送出します。
- java.sql.SQLException：
-
XML値を解放するときにエラーが発生した場合に送出します。
- java.sql.SQLFeatureNotSupportedException：
-
ParticipantのJDBC Driverがこのメソッドをサポートしない場合に送出します。
- PctoCommunicationFailureException：
-
Entity-ServiceとParticipant間の通信に失敗した場合に送出します。
- PctoInternalContradictionException：
-
Participantの内部で障害が発生した場合に送出します。
- PctoTransactionStartException：
-
トランザクションの範囲外で実行されたためトランザクションブランチの開始に失敗した場合に送出します。
(2) getString()
- 説明
-
このSQLXMLインスタンスによって指定されたXML値の文字列表現を返します。StringのエンコーディングはUnicodeです。ResultSetの指定された列がjava.sql.Types型のSQLXMLである場合、このメソッドの動作はResultSet.getString()と同じになります。
このメソッドが呼び出されると、SQL XMLオブジェクトは読み込みができなくなります。実装によっては、書き込みができなくなることもあります。
- 形式
public java.lang.String getString() throws java.sql.SQLException
- 引数
-
なし。
- 戻り値
-
このSQLXMLインスタンスによって指定されたXML値の文字列表現を返します。
- 例外
-
PctoCommunicationFailureException例外とPctoInternalContradictionException例外以外は、ParticipantでJDBC Driverが送出した例外を送出します。
- java.sql.SQLException：
-
次の場合に例外を送出します。
-
XML値を処理するときにエラーが発生した場合
-
状態が読み込み不可能である場合
-
- java.sql.SQLFeatureNotSupportedException：
-
ParticipantのJDBC Driverがこのメソッドをサポートしない場合に送出します。
- PctoCommunicationFailureException：
-
Entity-ServiceとParticipant間の通信に失敗した場合に送出します。
- PctoInternalContradictionException：
-
Participantの内部で障害が発生した場合に送出します。
- PctoTransactionStartException：
-
トランザクションの範囲外で実行されたためトランザクションブランチの開始に失敗した場合に送出します。
(3) setString(java.lang.String value)
- 説明
-
このSQLXMLインスタンスによって指定されたXML値を、指定されたString表現に設定します。StringのエンコーディングはUnicodeです。このメソッドが呼び出されると、SQL XMLオブジェクトは書き込みができなくなります。実装によっては、読み込みができなくなることもあります。
- 形式
public void setString(java.lang.String value) throws java.sql.SQLException
- 引数
-
- java.lang.String value：
-
XML値を指定します。
- 戻り値
-
なし。
- 例外
-
PctoCommunicationFailureException例外とPctoInternalContradictionException例外以外は、ParticipantでJDBC Driverが送出した例外を送出します。
- java.sql.SQLException：
-
次の場合に例外を送出します。
-
XML値を処理するときにエラーが発生した場合
-
状態が書き込み不可能である場合
-
- java.sql.SQLFeatureNotSupportedException：
-
ParticipantのJDBC Driverがこのメソッドをサポートしない場合に送出します。
- PctoCommunicationFailureException：
-
Entity-ServiceとParticipant間の通信に失敗した場合に送出します。
- PctoInternalContradictionException：
-
Participantの内部で障害が発生した場合に送出します。
- PctoTransactionStartException：
-
トランザクションの範囲外で実行されたためトランザクションブランチの開始に失敗した場合に送出します。