3. クラス詳細

3.1 CatpApiクラス

public class CatpApi extends Object

3.1.1 クラス階層図

java.lang.Object
   |
   +----CatpApi

3.1.2 クラス概要

　CATP/1.0のクライアント機能を実装したクラス（HTTP/1.0に対応）。

3.1.3 メソッド

  1. CatpApli　
  2. finalize　
  3. open　
  4. close　
  5. drop　
  6. search　
  7. scan　
  8. indexList　
  9. retrieveBrowse　
  10. retrieveDetail　
  11. insert　
  12. update　
  13. delete　
  14. changeResultSetName　

3.1.3.1 CatpApi

public CatpApi(Applet applet)
　(1) 概要
コンストラクタ
　(2) 引数
　(a) applet
Java Appletオブジェクトを引数に指定
　(3) 戻り値
なし
　(4) 例外時処理
なし
　(5) オーバライド
なし
　(6) 特記事項
なし

[メソッド一覧]

3.1.3.2 finalize

public void finalize()
　(1) 概要
CatpApiオブジェクト消滅時に呼ばれる後処理メソッド。
　(2) 引数
なし
　(3) 戻り値
なし
　(4) 例外時処理
なし
　(5) オーバライド
finalize in class Object
　(6) 特記事項
なし

[メソッド一覧]

3.1.3.3 open

public void open(String uid,String passwd) throws CatpException
　(1) 概要
サーバに対してアクセス開始を要求する。すなわち、CATPのGETHANDLEリクエストを発行しハンドルを確保する。
　(2) 引数
　(a) uid
CATPサーバに登録されているユーザＩＤを指定
　(b) password
CATPサーバに登録されているパスワードを指定
　(3) 戻り値
なし
　(4) 例外時処理
CATPサーバよりエラーレスポンス受信時CatpException（CatpExceptionクラス参照）を発行する。本メソッド発行側はtry-catch文により本メソッドの成功/失敗を判定する。
　(5) オーバライド
なし
　(6) 特記事項
本クラス使用時本クラス内の他のメソッドに先立って本メソッドを発行する必要がある。

[メソッド一覧]

3.1.3.4 close

public void close() throws CatpException
　(1) 概要
サーバに対してアクセス終了を要求する。すなわち、CATPのRELEASEHANDLEリクエストを発行しハンドルを解放する。
　(2) 引数
なし
　(3) 戻り値
なし
　(4) 例外時処理
CATPサーバよりエラーレスポンス受信時CatpException（CatpExceptionクラス参照）を発行する。本メソッド発行側はtry-catch文により本メソッドの成功/失敗を判定する。
　(5) オーバライド
なし
　(6) 特記事項
CATPサーバとのアクセスを終了する場合、必ず本メソッドを発行する必要がある。

[メソッド一覧]

3.1.3.5 drop

public void drop(String resultSetName) throws CatpException
　(1) 概要
サーバに対して検索結果集合の解放を要求する。すなわち、CATPのRELEASEFRAMEリクエストを発行しフレームを解放する。
　(2) 引数
　(a) resultSetName
searchまたはscanにより以前生成した検索結果集合名を指定する。本メソッドは指定された検索結果集合名を対応するフレーム番号に変換する。
　(3) 戻り値
なし
　(4) 例外時処理
CATPサーバよりエラーレスポンス受信時CatpException（CatpExceptionクラス参照）を発行する。本メソッド発行側はtry-catch文により本メソッドの成功/失敗を判定する。
　(5) オーバライド
なし
　(6) 特記事項
検索結果集合が不要になった場合に本メソッドを発行する。

[メソッド一覧]

3.1.3.6 search

public ResultSet search(String resultSetName, String databaseName,
                        String searchCondition)
                 throws CatpException
　(1) 概要
サーバに対してデータベースの検索を要求する。すなわち、CATPのSEARCHリクエストを発行し指定された検索条件による検索を要求する。
　(2) 引数
　(a) resultSetName
検索結果集合名を指定する。以前作成した検索結果集合を上書きする場合はその検索結果集合名を指定する。新規に検索結果集合名を割り当てる場合は新しい検索結果集合名を指定する。本メソッドは指定された検索結果集合名をフレーム番号に変換する。
　(b) databaseName
検索対象のデータベース名を指定する。
　(c) searchCondition
検索条件を指定する。
　(3) 戻り値
検索結果集合情報（ResultSetクラス参照）
　(4) 例外時処理
CATPサーバよりエラーレスポンス受信時CatpException（CatpExceptionクラス参照）を発行する。本メソッド発行側はtry-catch文により本メソッドの成功/失敗を判定する。
　(5) オーバライド
なし
　(6) 特記事項
本メソッドはCATPのSEARCHメソッドのSmall-set-upper-bound、Large-set-lower-boundを利用し、ヒットしたデータベースレコードを取得しキャッシングする。

[メソッド一覧]

3.1.3.7 scan

public ResultSet search(String oldResultSetName, String newResultSetName,
                        String databaseName, String searchCondition) 
                 throws CatpException
　(1) 概要
サーバに対して検索結果集合の絞り込みを要求する。すなわち、CATPのSCANリクエストを発行し指定された検索条件による検索結果集合を絞り込む。
　(2) 引数
　(a) oldResultSetName
scan対象の検索結果集合名を指定する。本メソッドは指定された検索結果集合名をフレーム番号に変換する。
　(b) newResultSetName
scanの結果生成する検索結果集合名を指定するoldResultSetNameと同一名称を指定した場合は以前の検索結果集合を上書きする。本メソッドは指定された検索結果集合名をフレーム番号に変換する。
　(c) databaseName
scan対象のデータベース名を指定する。
　(d) searchCondition
検索条件を指定する。
　(3) 戻り値
検索結果集合情報（ResultSetオブジェクト：ResultSetクラス参照）
　(4) 例外時処理
CATPサーバよりエラーレスポンス受信時CatpException（CatpExceptionクラス参照）を発行する。本メソッド発行側はtry-catch文により本メソッドの成功/失敗を判定する。
　(5) オーバライド
なし
　(6) 特記事項
本メソッドはCATPのSCANメソッドのSmall-set-upper-bound、Large-set-lower-boundを利用し、ヒットしたデータベースレコードを取得しキャッシングする。

[メソッド一覧]

3.1.3.8 indexList

public IndexResult indexList(String databaseName, String fieldName,
                             String keyword, int entries) 
                   throws CatpException
　(1) 概要
サーバに対してデータベースのインデックス一覧情報の検索を要求する。すなわち、CATPのINDEXLISTリクエストを発行する。
　(2) 引数
　(a) databaseName
対象のデータベース名を指定する。
　(b) fieldName
対象のフィールド名を指定する。
　(c) keyword
対象のキーワードを指定する。
　(d) entries
取得するインデックス数を指定する。
　(3) 戻り値
インデックス一覧（IndexResultクラス参照）
　(4) 例外時処理
CATPサーバよりエラーレスポンス受信時CatpException（CatpExceptionクラス参照）を発行する。本メソッド発行側はtry-catch文により本メソッドの成功/失敗を判定する。
　(5) オーバライド
なし
　(6) 特記事項
なし

[メソッド一覧]

3.1.3.9 retrieveBrowse

public RecordList retrieveBrowse(String resultSetName, int offset, int count) 
                  throws CatpException
　(1) 概要
サーバに対してsearchまたはscanの結果ヒットしたレコードを複数件要求する。すなわち、CATPのRETREIVEリクエストを発行し指定された件数分のデータベースレコードを要求する。
　(2) 引数
　(a) resultSetName
searchまたはscanで生成した検索結果集合名を指定する。本メソッドは指定された検索結果集合名をフレーム番号に変換する。
　(b) offset
検索結果集合内の開始相対位置を指定する。
　(c) count
相対位置からの要求件数を指定する。
　(3) 戻り値
サーバより取得したレコード群（RecordListクラス参照）
　(4) 例外時処理
CATPサーバよりエラーレスポンス受信時CatpException（CatpExceptionクラス参照）を発行する。本メソッド発行側はtry-catch文により本メソッドの成功/失敗を判定する。
　(5) オーバライド
なし
　(6) 特記事項
本メソッドはキャッシュ上に該当データベースレコードが存在すればそれを戻り値として返す。キャッシュ上に存在しない場合はサーバにRETREIVEリクエストを発行する。

[メソッド一覧]

3.1.3.10 retrieveDetail

public Record retrieveDetail(String resultSetName, int offset) 
              throws CatpException
　(1) 概要
サーバに対してsearchまたはscanの結果ヒットしたレコードを1件要求する。すなわち、CATPのRETREIVEリクエストを発行し指定された1件分のデータベースレコードを要求する。
　(2) 引数
　(a) resultSetName
searchまたはscanで生成した検索結果集合名を指定する。本メソッドは指定された検索結果集合名をフレーム番号に変換する。
　(b) offset
検索結果集合内の相対位置を指定する。
　(3) 戻り値
サーバより取得したレコード（Recordクラス参照）
　(4) 例外時処理
CATPサーバよりエラーレスポンス受信時CatpException（CatpExceptionクラス参照）を発行する。本メソッド発行側はtry-catch文により本メソッドの成功/失敗を判定する。
　(5) オーバライド
なし
　(6) 特記事項
本メソッドはキャッシュ上に該当データベースレコードが存在すればそれを戻り値として返す。キャッシュ上に存在しない場合はサーバにRETREIVEリクエストを発行する。

[メソッド一覧]

3.1.3.11 insert

public Record insert(String databaseName, Record rec) 
              throws CatpException
　(1) 概要
サーバにデータベースレコードの新規登録を要求する。すなわち、CATPのINSERTリクエストを発行し指定されたデータベースレコードの登録を要求する。
　(2) 引数
　(a) databaseName
登録対象のデータベース名
　(b) rec
登録レコード（RRecordクラス参照）
　(3) 戻り値
サーバから返ってきた登録済みレコード（Recordクラス参照）
　(4) 例外時処理
CATPサーバよりエラーレスポンス受信時CatpException（CatpExceptionクラス参照）を発行する。本メソッド発行側はtry-catch文により本メソッドの成功/失敗を判定する。
　(5) オーバライド
なし
　(6) 特記事項
本メソッドは指定されたRecordオブジェクトより各フィールドを取り出し、サーバに送信する。

[メソッド一覧]

3.1.3.12 update

public Record update(String databaseName, Record rec) 
              throws CatpException
　(1) 概要
サーバにデータベースレコードの更新を要求する。すなわち、CATPのUPDATEリクエストを発行し指定されたデータベースレコードの更新を要求する。
　(2) 引数
　(a) databaseName
更新対象のデータベース名
　(b) rec
更新レコード（Recordクラス参照）
　(3) 戻り値
サーバから返ってきた更新済みレコード（Recordクラス参照）
　(4) 例外時処理
CATPサーバよりエラーレスポンス受信時CatpException（CatpExceptionクラス参照）を発行する。本メソッド発行側はtry-catch文により本メソッドの成功/失敗を判定する。
　(5) オーバライド
なし
　(6) 特記事項
本メソッドは指定されたRecordオブジェクトより各フィールドを取り出し、サーバに送信する。

[メソッド一覧]

3.1.3.13 delete

public void delete(String databaseName, Record rec) throws CatpException
　(1) 概要
サーバにデータベースレコードの削除を要求する。すなわち、CATPのDELETEリクエストを発行し指定されたデータベースレコードの削除を要求する。
　(2) 引数
　(a) databaseName
削除対象のデータベース名
　(b) rec
削除レコード（Recordクラス参照）
　(3) 戻り値
なし
　(4) 例外時処理
CATPサーバよりエラーレスポンス受信時CatpException（CatpExceptionクラス参照）を発行する。本メソッド発行側はtry-catch文により本メソッドの成功/失敗を判定する。
　(5) オーバライド
なし
　(6) 特記事項
本メソッドは指定されたRecordオブジェクトよりIDフィールドを取り出し、サーバに送信する。

[メソッド一覧]

3.1.3.14 changeResultSetName

public boolean changeResultSetName(String oldname, String newname)
　(1) 概要
指定された検索結果集合名を指定された名前に置き換える。
　(2) 引数
　(a) oldname
置換前の検索結果集合名
　(b) newname
置換後の検索結果集合名
　(3) 戻り値
成功（true）／失敗（false）
　(4) 例外時処理
なし
　(5) オーバライド
なし
　(6) 特記事項
なし

[メソッド一覧]