6.3.16 PctoArrayクラス
- 説明
-
SQL型ARRAYのJavaプログラミング言語でのマッピングをするクラスです。デフォルトでは、ARRAY値はSQL ARRAY値へのトランザクション期間中の参照です。デフォルトでは、Arrayオブジェクトは内部的にSQL LOCATOR(array)を使って実装されます。したがって、Arrayオブジェクトは、ARRAY値のデータを含むのではなく、SQL ARRAY値のデータへの論理ポインタを含みます。
Arrayインタフェースは、SQL ARRAY値のデータを配列またはResultSetオブジェクトとしてクライアントに渡すメソッドを提供します。
基底型のエントリを持つ型マップが、getArrayメソッドおよびgetResultSetメソッドに提供されると、その型マップに含まれるマッピングは、ARRAY値の要素をマッピングするのに使用されます。通常、型マップは提供されません。その場合、接続の型マップがデフォルトで使用されます。接続の型マップまたはメソッドに提供された型マップが基底型のエントリを持っていない場合、要素は標準マップに従ってマッピングされます。
- メソッド
-
PctoArrayクラスのメソッドの一覧を次の表に示します。
表6‒26 PctoArrayクラスのメソッドの一覧 メソッド
説明
free()
このメソッドは、Arrayオブジェクトを解放し、保持されているリソースを解放します。
getArray()
このArrayオブジェクトによって指定されたSQL ARRAY値の内容を、Javaプログラミング言語の配列の形式で取り出します。
- パッケージ名称
jp.co.Hitachi.soft.hmppcto.jdbc.client
- 〈この項の構成〉
(1) free()
- 説明
-
このメソッドは、Arrayオブジェクトを解放し、保持されているリソースを解放します。freeメソッドが一度呼び出されたあとは、オブジェクトは無効になります。
freeメソッドが呼び出されると、freeメソッド以外のメソッドを呼び出そうとしても、SQLExceptionがスローされます。freeメソッドを複数回呼び出した場合、2回目以降のfreeメソッドの呼び出しでは何も行われません。
- 形式
public void free() throws java.sql.SQLException
- 引数
-
なし。
- 戻り値
-
なし。
- 例外
-
PctoCommunicationFailureException例外とPctoInternalContradictionException例外以外は、ParticipantでJDBC Driverが送出した例外を送出します。
- java.sql.SQLException：
-
Arrayのリソースの解放時にエラーが発生した場合に送出します。
- java.sql.SQLFeatureNotSupportedException：
-
ParticipantのJDBC Driverがこのメソッドをサポートしない場合に送出します。
- PctoCommunicationFailureException：
-
Entity-ServiceとParticipant間の通信に失敗した場合に送出します。
- PctoInternalContradictionException：
-
Participantの内部で障害が発生した場合に送出します。
- PctoTransactionStartException：
-
トランザクションの範囲外で実行されたためトランザクションブランチの開始に失敗した場合に送出します。
(2) getArray()
- 説明
-
このArrayオブジェクトによって指定されたSQL ARRAY値の内容を、Javaプログラミング言語の配列の形式で取り出します。このgetArrayメソッドは、型マップのカスタマイズのための接続に関連した型マップを使います。
なお、getArrayメソッドを使用してプリミティブデータ型にマッピングする基底型を生成する場合、返される配列がそのプリミティブデータ型の配列とjava.lang.Objectの配列のどちらであるかは、実装で定義されます。
- 形式
public java.lang.Object getArray() throws java.sql.SQLException
- 引数
-
なし。
- 戻り値
-
このArrayオブジェクトによって指定されたSQL ARRAY値の順序付き要素が格納されている、Javaプログラミング言語の配列を返します。
- 例外
-
PctoCommunicationFailureException例外とPctoInternalContradictionException例外以外は、ParticipantでJDBC Driverが送出した例外を送出します。
- java.sql.SQLException：
-
配列へのアクセス中にエラーが発生した場合に送出します。
- java.sql.SQLFeatureNotSupportedException：
-
ParticipantのJDBC Driverがこのメソッドをサポートしない場合に送出します。
- PctoCommunicationFailureException：
-
Entity-ServiceとParticipant間の通信に失敗した場合に送出します。
- PctoInternalContradictionException：
-
Participantの内部で障害が発生した場合に送出します。
- PctoTransactionStartException：
-
トランザクションの範囲外で実行されたためトランザクションブランチの開始に失敗した場合に送出します。