PSQL_JCL_Guide.book

Transcription

1 PSQL v12 Java Class Library Guide Developing Applications Using the PSQL Java Class Library

2 免責事項 Actian Corporation は 本ソフトウェアおよびドキュメントの使用を 利用者またはその会社に対して 現状のまま で かつ同梱の使用許諾契約書に記載の契約条件によってのみ許諾するものです Actian Corporation は いかなる場合にも本ソフトウェアおよび本マニュアルに記載された内容に関するその他の一切の保証を 明示的にも黙示的にも行いません Actian Corporation は 市場性 権利 特定の目的に対する適合性 あるいは一連の取引業務や職業的な使用に関する問題などに対し 一切の保証を行わないことを明示するとともに 利用者およびその会社がこれに同意したものとします 商標 Btrieve Client/Server in a Box および Pervasive は Actian Corporation の登録商標です Built on Pervasive Software DataExchange MicroKernel Database Engine MicroKernel Database Architecture Pervasive.SQL Pervasive PSQL Solution Network Ultralight ZDBA は Actian Corporation の商標です Apple Macintosh Mac および OS X は Apple Inc の登録商標です Microsoft MS-DOS Windows Windows 95 Windows 98 Windows NT Windows Me Windows 2000 Windows 2003 Windows 2008 Windows 7 Windows 8 Windows 10 Windows Server 2003 Windows Server 2008 Windows Server 2012 Windows XP Win32 Win32s および Visual Basic は Microsoft Corporation の登録商標です NetWare および Novell は Novell, Inc の登録商標です NetWare Loadable Module NLM Novell DOS Transaction Tracking System および TTS は Novell, Inc の商標です Oracle Java および Oracle または Java を含むすべての商標やロゴは Oracle Corporation の商標または登録商標です すべての会社名および製品名は各社の商標または登録商標です Copyright 2016 Actian Corporation.All rights reserved. このマニュアルの全文 一部に関わりなく複製 複写 配布をすることは 前もって発行者の書面による同意がない限り禁止します 本製品には Powerdog Industries により開発されたソフトウェアが含まれています Copyright 1994 Powerdog Industries.All rights reserved. 本製品には KeyWorks Software により開発されたソフトウェアが含まれています Copyright 2002 KeyWorks Software.All rights reserved. 本製品には DUNDAS SOFTWARE により開発されたソフトウェアが含まれています Copyright DUNDAS SOFTWARE LTD. All rights reserved. 本製品には Apache Software Foundation Foundation( により開発されたソフトウェアが含まれています 本製品ではフリーソフトウェアの unixodbc Driver Manager を使用しています これは Peter Harvey (pharvey@codebydesign.com) によって作成され Nick Gorham (nick@easysoft.com) により変更および拡張されたものに Actian Corporation が一部修正を加えたものです Actian Corporation は unixodbc Driver Manager プロジェクトの LGPL 使用許諾契約書に従って このプロジェクトの現在の保守管理者にそのコード変更を提供します unixodbc Driver Manager の Web ページは にあります このプロジェクトに関する詳細については 現在の保守管理者である Nick Gorham (nick@easysoft.com) にお問い合せください GNU Lesser General Public License (LGPL) は本製品の配布メディアに含まれています LGPL は でも見ることができます Java Class Library Guide 2016 年 7 月

3 目次 このマニュアルについて v このマニュアルの読者 vi 表記上の規則 vii 1 PSQL Java インターフェイスの概要 PSQL Java インターフェイス Java クラスライブラリと MicroKernel エンジン データベースコンセプト 環境設定の方法 JDK のサポート CLASSPATH 環境変数 PVideo Java サンプルアプリケーションの実行 PVideo アプリケーションのソースの表示 PSQL の開発者用リソース Web サイトリソース Javadoc 形式のリファレンス 次に行うこと Java クラスライブラリを使ったプログラミング PSQL Java インターフェイスのクラス階層 一般クラス Rowset ファミリクラス Cursor ファミリクラス 主要なクラスとメソッドの概要 Java アプリケーションにおける一連の手順 Java クラスライブラリ使用時の最初の手順 環境が正しいかどうかの確認 データベースとテーブルの作成 PSQL データベースへの接続 テーブルの取得と行セットの作成 行セット内での行間の移動 データの制限またはフィルター処理 行の挿入 更新または削除 複数のオペレーションによるトランザクションへの結合 バイナリラージオブジェクト (BLOB) の格納と取得 Java データ型の問題点 サンプルデータベースファイル 追加の Java サンプル iii

4 目次 iv

5 このマニュアルについて このマニュアルでは Java クラスライブラリを使用して PSQL v12 アプリケーション開発を行う場合について説明します v

6 このマニュアルの読者 このマニュアルは PSQL に精通し Java クラスライブラリを使用してアプリケーションを開発したいユーザー向けにデザインされています 本ソフトウェアの全般的な使用手順やほかのデータベースアクセス方法については説明していません vi

7 表記上の規則 特段の記述がない限り コマンド構文 コード およびコード例では 以下の表記が使用されます 大文字小文字の区別 太字 固定幅フォント 通常 コマンドと予約語は 大文字で表記されます 本書で別途記述がない限り これらの項目は大文字 小文字 あるいはその両方を使って入力できます たとえば MYPROG myprog または MYprog と入力することができます 太字で表示される単語には次のようなものがあります メニュー名 ダイアログボックス名 コマンド オプション ボタン ステートメントなど 固定幅フォントは コマンド構文など ユーザーが入力するテキストに使われます [ ] 省略可能な情報には [log_name] のように 角かっこが使用されます 角かっこで囲まれていない情報は必ず指定する必要があります 縦棒は [file name] のように 入力する情報の選択肢を表します < > <> は /D=<5 6 7> のように 必須項目に対する選択肢を表します 変数 file name のように斜体で表されている語は 適切な値に置き換える必要のある変数です... [parameter...] のように 情報の後に省略記号が続く場合は その情報を繰り返し使用できます ::= 記号 ::= は ある項目が別の項目用語で定義されていることを意味します たとえば a::=b は 項目 a が b で定義されていることを意味します vii

8 viii

9 PSQL Java インターフェイスの概要 1 PSQL Java インターフェイスは 標準の Btrieve API に追加されるオブジェクト指向のインターフェイスです この章では 以下の項目について説明します PSQL Java インターフェイス 環境設定の方法 PVideo Java サンプルアプリケーションの実行 PVideo アプリケーションのソースの表示 PSQL の開発者用リソース 次に行うこと 1

10 PSQL Java インターフェイスの概要 PSQL Java インターフェイス PSQL Java クラスは MicroKernel エンジンへのインターフェイスです Java クラスライブラリと MicroKernel エンジン PSQL リレーショナルエンジンでは 列レベルでのデータベースへのアクセスが可能です 一方 MicroKernel エンジンでは ファイル レコードおよびインデックスによるアクセスのみが可能で アプリケーションプログラム自体では Btrieve API 呼び出しにより返されたデータバッファー内でフィールドレベルのアクセスを行う必要があります SQL データベースでは データ辞書ファイルに格納されているデータ辞書で 各列レベルの情報にアクセスできます メモ Btrieve は ファイル レコード フィールド の用語を使用しています ただし このセクションでは PSQL 辞書を持つデータベースと併用できるクラスについて説明する場合は 代わりに テーブル 行 列 という用語を使用します この API の目的は 単に Java や C++ のようなオブジェクト指向言語へのインターフェイスを提供するということだけでなく オブジェクト指向アプリケーションに適する論理構造を提供することにあります オブジェクト指向 API の設計では 次の目標に取り組んでいます Btrieve アプリケーション開発者に一連の抽象化を提供する 使いやすさを保証する プラットフォームに依存するバイトオーダーを隠す 開発者が Btrieve システムのすべての機能を使用できるようにする MicroKernel エンジンのパフォーマンスを損なわないようにする Java の登場後まもなく データベースインターフェイスとして Java Database Connectivity (JDBC) が導入されました JDBC は データベース開発者の間にますます普及しつつあります 新しい PSQL Java API の設計では モデルとして JDBC API を使用し JDBC で使用されているアイデアと手法の多くを利用しています ただし JDBC は SQL と一般的にリレーショナルモデルをサポートするよう設計されているため いくつかの新しい概念を導入する必要がありました その一方で この API セットはトランザクショナル Btrieve もサポートします 既に述べたように Btrieve アプリケーションが SQL データベースに属するデータファイルにアクセスする場合 新しい API 呼び出しはデータベースの辞書に格納されている列の記述を使用できます SQL データベースの一部ではない Btrieve データファイルの場合 新しい API はこれらのファイルにアクセスするための別の手段を提供します データベースコンセプト SQL データベースに属さない一連の Btrieve データファイルは これまでどおり アプリケーションプログラムが論理的な意味でそれらのファイルを 1 つに結合する場合にデータベースを構成します そのようなデータベースを 疎結合型 データベースと呼びます 疎結合型データベースには データベース辞書がありません それに対して SQL データベースを 密結合型 データベースと呼びます 密結合型データベースには 永続的なデータベース辞書があります PSQL Java インターフェイスは 使用するクラスに応じて 高レベルでも低レベルでも動作可能です 密結合型データベース Java インターフェイスの高レベルの部分は Btrieve のプログラマが以前扱っていたポジションブロックおよびデータバッファーなど 実装の詳細部分を隠します 2

11 PSQL Java インターフェイス 疎結合型データベース 疎結合型データベースを現在持っており 新しい API の列レベルのサポートを活用したいと考えているユーザーは 以下のオプションのうちの 1 つを選択する必要があります 1 PSQL Control Center を使用して 疎結合型データベースのデータベース辞書を作成します 実際には 新しい API を使用する前にデータベースが密結合型データベースに切り替えられます 2 新しい永続的な辞書を作成し 新しい API を使用してアプリケーションプログラム内で Btrieve ファイルごとにテーブル 列などを定義します この場合 データベースはプログラムによって密結合型データベースに切り替えられます 3

12 PSQL Java インターフェイスの概要 環境設定の方法 このセクションでは PSQL Java インターフェイスを使用する場合の適切な設定について説明します JDK のサポート CLASSPATH 環境変数 JDK のサポート PSQL Java インターフェイスは JDK 1.4 以降のバージョンをサポートしています CLASSPATH 環境変数 PSQL SDK では PSQL クラスを指すように CLASSPATH 変数を設定する必要があります サンプル CLASSPATH は PSQL が file_path\psql にインストールされており Java Class Library SDK が file_path\ PSQL\SDK\JCL にインストールされていることを前提とします PSQL ファイルのデフォルトの保存場所については Getting Started With PSQL の PSQL ファイルはどこにインストールされますか? を参照してください CLASSPATH 環境変数を以下のように変更する必要があります SET CLASSPATH=.; file_path\psql\bin\psql.jar; file_path\psql\sdk\jcl\samples\pvideo\pvideoj.jar; file_path\psql\sdk\jcl\samples\pvideo; file_path は PSQL のインストール場所です Windows CLASSPATH ある PSQL クラスファイルが見つからないというエラーが発生した場合 コントロールパネルで設定されているユーザー CLASSPATH 変数が PSQL パスが設定されているシステム CLASSPATH 変数を上書きしている可能性があります 以下の手順で Windows の設定を確認し 必要に応じて修正してください 1 [ スタート ] メニューから [ コントロールパネル ] にアクセスします 2 [ システム ] をダブルクリックします 3 [ 詳細 ] タブまたは [ 詳細設定 ] タブを選択し [ 環境変数 ] をクリックします 4 PSQL パスは システム変数に含まれています ユーザー環境変数で CLASSPATH が存在するかどうかを確認します 存在しない場合 何もする必要はありません 存在する場合 ユーザー変数の先頭に %CLASSPATH%; を付けます 4

13 PVideo Java サンプルアプリケーションの実行 PVideo Java サンプルアプリケーションの実行 PVideo サンプルアプリケーションは PSQL Java インターフェイスの機能を利用して作成されています サンプルアプリケーションを実行するには 1 PSQL SDK Java Pvideo フォルダーを開きます デフォルトの場所にインストールする場合 この場所は file_path\psql\sdk\jcl\samples\pvideo です PSQL ファイルのデフォルトの保存場所については Getting Started With PSQL の PSQL ファイルはどこにインストールされますか? を参照してください 2 PVIDEOJ.BAT アイコンをダブルクリックします 以下のアプリケーションウィンドウが表示されます 図 1 PSQL PVideo サンプルアプリケーションのメインウィンドウ - Java 5

14 PSQL Java インターフェイスの概要 PVideo アプリケーションのソースの表示 PSQL ビデオ店サンプルアプリケーションの Java ソースファイルは Java Archive ファイルに格納されています これらのファイルを抽出して Btrieve テーブルに接続する PSQL Java インターフェイスの実例を得ることができます 以下の手順では JDK がインストールされ その BIN ディレクトリがパスに設定されていることを仮定しています Java ソースファイルを解凍するには 1 コマンドプロンプトで 以下のように入力します cd \psql\sdk\jcl\samples\pvideo 2 次に JAR コマンドを入力します jar -xvf source.zip ソースファイルが 現在のディレクトリと PSQL\SDK\JCL\samples\pvideo 内のサブディレクトリに展開されます PSQL ファイルのデフォルトの保存場所については Getting Started With PSQL の PSQL ファイルはどこにインストールされますか? を参照してください Java Archive ファイルの詳細については を参照してください 6

15 PSQL の開発者用リソース PSQL の開発者用リソース Java インターフェイスを使用してアプリケーションを開発する際の情報は 以下の Web サイトで得ることができます Web サイトリソース リソース PSQL Developer Zone Oracle Java Web サイト Oracle Java チュートリアル オンラインの場所 Actian PSQL Web サイトをご覧ください Javadoc 形式のリファレンス Java クラスライブラリに付属の Javadoc 形式のドキュメントでは JCL ベースのアプリケーションで使用されるクラスとメソッドのリファレンスを提供します Java クラスライブラリ用の Javadoc リファレンスを開くには 1 JCL.zip をインストールしたフォルダーを指定します たとえば この JCL.zip を C:\SDK に解凍した場合は C:\SDK\JCL\doc\jajp\javadoc フォルダーを開きます 2 Web ブラウザーを使用して index.html を開きます 7

16 PSQL Java インターフェイスの概要 次に行うこと これまでの説明で PSQL Java インターフェイスの内容について理解し 適切な環境設定に関して十分な知識を得ました 次の章では Java インターフェイスを使用してデータベースアプリケーションを作成する方法について説明します 8

17 Java クラスライブラリを使ったプログラミング 2 この章では 以下の項目について説明します PSQL Java インターフェイスのクラス階層 主要なクラスとメソッドの概要 Java アプリケーションにおける一連の手順 Java クラスライブラリ使用時の最初の手順 Java データ型の問題点 サンプルデータベースファイル 追加の Java サンプル 9

18 Java クラスライブラリを使ったプログラミング PSQL Java インターフェイスのクラス階層 ここでは 新しい PSQL Java インターフェイスのクラスについて説明します ファクトリ パターンを適用することにより Driver Timestamp FieldDef および PsqlException を除く ほとんどすべてのクラスは ( 単一または複数の ) ほかのクラスのメソッドを通してのみ作成できます クラスの説明で パブリックコンストラクターが使用できない場合 ラベル Constructors の下にコンストラクターのリストは表示されません PSQL Java インターフェイスには API のメソッドを呼び出すときに発生するエラー状態を処理する特別なクラス PsqlException があります PsqlException は java.lang.exception を拡張します PSQL Java クラスの個々のメソッドは PsqlException を返しますが 簡潔にするために以下の節はメソッド定義から省略されています throws PsqlException 図 2 に すべてのクラスとクラス間の関係を示します 図 2 Java API のクラス階層 10

19 PSQL Java インターフェイスのクラス階層 PSQL Java インターフェイスのクラスは 以下の 3 つのグループに分類できます 一般クラス Rowset ファミリクラス Cursor ファミリクラス 一般クラス 以下のクラスは 一般クラスのグループに属します Driver Session Database Timestamp PsqlException これらのクラスは 密結合型データベースと疎結合型データベースの両方に使用できます Rowset ファミリクラス 以下のクラスは Rowset ファミリクラスグループに属します Table Rowset Buffer Row Index DBMetaData TableMetaData RowSetMetaData ColumnDef IndexMetaData これらのクラスは PSQL データベースの辞書に見られるメタデータを使用するので 密結合型データベースにのみ適用できます Cursor ファミリクラス これは PSQL Java インターフェイスの低レベル部分です このインターフェイス部分を使用する場合 ポジションブロック データバッファーやその他 Btrieve API 特有のプログラミング要素を処理する必要があります メモ Btrieve ファイルに DDF がない場合は Java インターフェイスのこれらのクラスを使用しなければなりません データ用の DDF ファイルは PSQL Control Center ユーティリティを使用して作成できます 詳細については PSQL User's Guide を参照してください 以下のクラスは Cursor ファミリクラスグループに属します SCursor XCursor FieldDef これらのクラスはメタデータを使用せず 従来の Btrieve オペレーション (BTRV メッセージなど ) を直接サポートします したがって これらのクラスは一般に疎結合型データベースに適用されます ただし これらのクラスを使用して DDF とデータとの密結合型データベースのテーブルを格納するデータファイルにアクセスすることもできます ( しかし 後者では Rowset ファミリ を使用する方が便利です ) 11

20 Java クラスライブラリを使ったプログラミング 主要なクラスとメソッドの概要 以下に 基本的な Java アプリケーションに関連する主なクラスとメソッドを示します 主なクラスとメソッド Driver establishsession killallsessions Session connecttodatabase starttransaction committransaction aborttransaction Database gettable gettablenames createxcursor 使用目的 1 つまたは複数のセッションの確立 すべてのセッションの停止 データベースへの接続 トランザクションの処理 テーブル名とテーブルの取得 xcursor を作成し 必要に応じて低レベルのオペレーションを実行 Table gettablemetadata createrowset TableMetaData getindexnames テーブルデータへのビューである RowSet の作成 テーブルに関するメタデータ情報の取得 テーブルからのインデックスの取得 RowSet createrow insertrow deleterow updaterow getnext getbyindex reset RowSetMetaData AddColumns DropColumns AddFirstTerm SetAccessPath SetDirection Row getstring setstring getfloat setfloat テーブルの一部の取得 行情報の更新 列の追加または削除 WHERE 句の機能の実行 ナビゲーションの方向の変更 RowSet により取得したデータを実際に更新 PSQL Java Class Library リファレンス (Javadoc) に表示されるクラスとメソッドはほかにもありますが これらはアプリケーションで最も頻繁に使用するクラスです Java インターフェイスクラスの構造はフラットです これらのクラス間に継承関係はありません 12

21 主要なクラスとメソッドの概要 DRIVER Driver は Session を確立します Driver を使用して 必要な個数の Session オブジェクトのインスタンスを作成できます KillallSessions メソッドはソケット接続 データベース接続 開いているファイル システムリソースをクリーンアップするので このメソッドを使用してアプリケーションを停止することもできます SESSION Sessions はドライバーとの接続を使用して URI によるデータベースへの接続およびトランザクションの開始と終了を行うことができます セッションごとに一意の Btrieve クライアント ID を取得します アプリケーションが 特に複数の Btrieve クライアント ID を必要としない限り 通常はアプリケーション全体に対して 1 つの Session を使用することができます Session および Btrieve クライアントは Session.close() を呼び出すことによってリセットできます PSQL User's Guide のクライアント ID および ライセンスモデル に関する詳しい情報は PSQL Programmer's Guide の Btrieve クライアント を参照してください DATABASE このクラスでインスタンスが作成されるオブジェクトは データベース自体です このクラスのメソッドを使用すれば 開発者は密結合型データベースの場合にテーブル名 テーブルなどを取得したりすることができます 疎結合型データベースの場合 開発者は Extended オペレーションなどの Btrieve に似た使い慣れた API でアクセスできます TABLE このクラスのインスタンスは テーブルをオブジェクトとして表します Table オブジェクトを使用して 行セットを作成し テーブルに関するメタデータ情報を取得できます ROWSET RowSet は 非常に重要なクラスです このクラスは 関連するテーブルの行にアクセスする場合に使用します また このクラスのメソッドから行を挿入 更新および削除できます このクラスのインスタンスは ベーステーブルから得られる一連の行を表します ベーステーブルを見るもう 1 つの方法である RowSet は 物理的に格納されたテーブルから作成された仮想テーブル ( ビュー ) です メモこのオブジェクトを作成できるのは Table の createrowset メソッドを使用した場合のみです 行セットには ベーステーブルのすべての行または行のサブセットを含めることができます addfirstterm addandterm などの RowSetMetaData 内の多数のメソッドは ベーステーブルからのどの行を行セットに組み込むかを決定する制限基準の条件を指定する場合に使用します 行セットには ベース行のすべての列を含めることも ベース行から任意の個数の列を選択して含めることもできます RowSet オブジェクトが Table.createRowSet で作成された場合 このオブジェクトは呼び出しで明示的または暗黙に指定された nocolumns の値に従って初期化されます nocolumns に True を指定すると 行セットに列が含まれません この場合 アプリケーションでは RowSetMetaData.addColumns を呼び出すことによって 選択した列を行セットに含めることができます nocolumns に False を指定したり 引数として含めない場合 作成された RowSet にはテーブルのすべての列が含まれます 通常 アプリケーションは行セットを開いたり閉じたりする必要はありません 関連するデータファイルは RowSet オブジェクトの作成時に開かれ また アプリケーションが RowSet.close を明示的に呼び出すか あるいは さらに高レベルの関連オブジェクト たとえば Table Database などを閉じた結果としてデータファイルが閉じられます 行セットの要素は Row オブジェクトを通じてアクセスできます 行を取得する複数のオプションがあります 行セットに関する重要な追加情報については PSQL Java Class Library リファレンス (Javadoc) を参照してください 13

22 Java クラスライブラリを使ったプログラミング ROW このクラスのインスタンスは RowSet 内の行の行バッファーを表します Row クラスによって 行 および行内の列の値にアクセスできます RowSet を使用して 行の取得 更新または削除を行ったり 挿入のための行を作成することができます このクラスには独自のメソッドがありませんが Buffer から継承されたメソッドを使用して行バッファー内で列の値を取得または設定することができます 14

23 Java アプリケーションにおける一連の手順 Java アプリケーションにおける一連の手順 以下の一連の手順は アプリケーションまたはアプレットで通常使用されます 最初の 2 つの手順は 密結合型データベースでも 疎結合型データベースでも同じです 1 実行環境として使用される Session のインスタンスを設定します (Driver は静的クラスなので インスタンス化する必要はありません ) また アプリケーションまたはアプレットで複数のセッションを作成することもできます 2 URI を指定する Session.connectToDatabase() を呼び出して データベースの Database オブジェクトを取得します データベース URI の詳細については PSQL Programmer's Guide を参照してください また アクセスする個々のデータベースごとに 1 つのセッション内で複数の Database オブジェクトを取得することもできます ここで ケース 1 : アプリケーションが密結合型データベースのテーブルにアクセスする (Btrieve データベースは DDF を使用 ) または ケース 2 : 疎結合型データベースのデータファイル または密結合型データベースのテーブルを標準的な方法で格納するデータファイルにアプリケーションがアクセスする を選択してください ケース 1 : アプリケーションが密結合型データベースのテーブルにアクセスする 3 オプションとして アプリケーションがデータベースのテーブル名を認識していない場合は Database.getTableNames を呼び出してテーブル名を取得します 4 Database.getTable を呼び出して 作業するテーブルごとに Table オブジェクトを取得します 5 オプションとして アプリケーションが辞書から列の名前またはインデックスの名前を取得する必要がある場合は テーブルごとに TableMetaData オブジェクトを取得します 6 アプリケーションで処理するテーブルごとに 少なくとも 1 つの RowSet オブジェクトを作成します RowSet オブジェクトは データの取得と変更に使用します テーブルのすべての列を含むか まったく含まない行セットを作成できます 手順 7 の詳細を参照してください テーブル内をナビゲートする際に 複数のカレンシー ( 位置 ) を保持しながら同時にテーブルを処理したい場合 アプリケーションでは 1 つのテーブルに対して複数の RowSet を作成します 所定のテーブルの RowSet オブジェクトは アプリケーションの実行中いつでも使用できます つまり 異なるインデックス 異なる条件などによる取得に使用できます 7 所定の行セットに対して a. 行セットの RowSetMetaData オブジェクトを取得します b. 行セットが列を含めずに作成された場合は 必要な列を定義に追加します c. 必要であれば 行のデフォルトの特性 たとえば 方向 アクセスパスなどを変更します d. ベーステーブル内の選択した行のみを 1 つの行セットに含める場合は 選択条件 たとえば addfirstterm addandterm などを定義します e. Row オブジェクトを取得するための RowSet.getNext メソッドを呼び出します オプションとして RowSet のほかのメソッド たとえば getbyindex getbypercent insertrow updaterow などを呼び出します f. 行で列の値を取得または設定するには Row のメソッド たとえば getstring setstring getint などを呼び出します メモ手順 a ~ d はオプションであり また アプリケーションにもよりますが 行セットによっては必要でない場合があります 15

24 Java クラスライブラリを使ったプログラミング ケース 2 : 疎結合型データベースのデータファイル または密結合型データベースのテーブルを標準的な方法で格納するデータファイルにアプリケーションがアクセスする 3. アプリケーションが動作する個々のデータファイルに対して SCursor オブジェクトまたは XCursor オブジェクトを作成します XCursor は このファイルに対して Extended get オペレーションまたは Extended step オペレーションが実行される場合のみ必要です オプションとして 複数の位置を同時に保持しながら 並行してファイルを処理したい場合 アプリケーションで同一ファイルに対して複数の Cursor オブジェクトを取得することができます 4 SCursor.BTRV を使用して 従来の Btrieve オペレーション たとえば open get step insert などを実行します メモ XCursor は SCursor の拡張なので XCursor 上で BTRV メソッドを使用できます 5 オプションとして データフィールドにいくつかの FieldDef オブジェクトを定義したり これらのフィールドオブジェクトを使用して選択基準 たとえば XCursor.addFirstTerm などを設定して抽象リストを定義したり getnextextended のようなメソッドを使用してオペレーションを実行します 6 SCursor (XCursor) オブジェクトのプライベートデータおよびキーバッファーでフィールドの値を取得または設定するには getdstring setkstring getdint4 などのメソッドを呼び出します 以降では これらの概要手順についてさらに詳しく説明します 16

25 Java クラスライブラリ使用時の最初の手順 Java クラスライブラリ使用時の最初の手順 Java Btrieve アプリケーションを作成するには まず以下の手順に従います 1 環境が正しいかどうかの確認 2 データベースとテーブルの作成 3 PSQL データベースへの接続 4 テーブルの取得と行セットの作成 5 行セット内での行間の移動 6 データの制限またはフィルター処理 7 行の挿入 更新または削除 8 複数のオペレーションによるトランザクションへの結合 9 バイナリラージオブジェクト (BLOB) の格納と取得 環境が正しいかどうかの確認 環境が 環境設定の方法 で説明しているように正しくセットアップされているかどうかを確認する必要があります また psql.jar が CLASSPATH 環境変数内にあるかどうかを確認します この手順は インストール手順で既に実行しているはずです PSQL Java インターフェイスクラスライブラリ内のクラスにアクセスするには Java ソースファイルにパッケージをインポートする必要があります import PSQL.database.*; データベースとテーブルの作成 現在 PSQL Java インターフェイスのクラスライブラリは データベースとデータベーステーブルの作成をサポートしていません これらの作業を実行するには PSQL Control Center を使用します データベースのデータ辞書ファイル (DDF) およびデータファイルを作成したら Java API クラスを使用してテーブルを追加してアクセスすることができます PSQL Control Center とテーブルの作成の詳細については PSQL User's Guide を参照してください PSQL データベースへの接続 PSQL データベースに接続するには エンジンに直接接続します URI を使用してデータベースに接続するには 1 Driver から Session オブジェクトを取得します Session session = Driver.establishSession(); 2 Session オブジェクトを使用してデータベースに接続します URI を指定してデータベースに接続します 少なくとも この URI には btrv:///dbname を含めてください Database db = session.connecttodatabase("btrv:///demodata"); または Database db = session.connecttodatabase("btrv://user@host/ demodata?pwd=password"); データベースセキュリティおよび URI の詳細については Advanced Operations Guide を参照してください 17

26 Java クラスライブラリを使ったプログラミング テーブルの取得と行セットの作成 データベースからのテーブルの検索 Table table = db.gettable("mytable"); ここで MyTable はデータベーステーブルの名前です テーブル名では大文字と小文字を区別します また データベースのテーブル名のリストを取得することもできます String [] names = db.gettablenames(); Table オブジェクトのプロパティにアクセスするには Table オブジェクトがあれば TableMetaData オブジェクトからの列とインデックスに関する情報が得られます TableMetaData tmd = table.gettablemetadata(); いくつかの例を以下に示します // 列数を取得する int num_columns = tmd.getcolumncount(); // 列 0 のデータ型を取得する int data_type = tmd.getcolumndef(0).gettype()); // 列 0 の列の長さを文字数で取得する int col_length = tmd.getcolumndef(0).getoffset(); Table オブジェクトの行にアクセスするには Table の行にアクセスするには Table オブジェクトでしか作成できない RowSet オブジェクトが必要です RowSet rowset = table.createrowset(); 同じテーブルから複数の RowSet オブジェクトを作成できます RowSet オブジェクトは テーブルの行を取得したり 新しい行を挿入したり 既存の行を削除および更新する場合に使用します すべてのテーブルの行を繰り返し取得するには RowSet オブジェクトを作成し PsqlEOFException が発生するまで getnext() を呼び出します try { while(true) Row row = rowset.getnext(); } catch(psqleofexception ex) { // もう行は残っていない } Rowset オブジェクトのプロパティにアクセスするには RowSet オブジェクトがあれば RowSetMetaData から RowSet に関する情報を得ることができます RowSetMetaData rsmd = rowset.getrowsetmetadata(); 詳細については PSQL Java Class Library リファレンス (Javadoc) の RowSetMetaData クラスのメソッドを参照してください 行セット内での行間の移動 前に示したように getnext メソッドを繰り返し呼び出し 行セットのすべての行を取得することができます 行セットの RowSetMetaData オブジェクトの direction プロパティを変更すれば 後方へ繰り返すことができます rsmd.setdirection(const.btr_backwards); このプロパティを設定した後 getnext メソッドの動作は getprevious になります 18

27 Java クラスライブラリ使用時の最初の手順 メモ以下の手順に示すように 行セットのカレンシーは いつでもリセットして 最初の行の前または最後の行の後になるようにすることができます これは 行セット全体を繰り返さなくても 最初の行または最後の行を取得できる効率的な方法です 行セット内の最初の行を取得するには 1 方向を前方に設定します これはデフォルトです rsmd.setdirection(const.btr_forwards); 2 最初の行の前に行セットのカレンシーを設定します rowset.reset(); 3 最初の行を検索します Row first = rowset.getnext(); 行セット内の最後の行を取得するには 1 方向を後方に設定します rsmd.setdirection(const.btr_backwards); 2 最後の行の後に行セットのカレンシーを設定します rowset.reset(); 3 最後の行を検索します Row last = rowset.getnext(); Row オブジェクトの列データにアクセスするには Row オブジェクトは Buffer クラスから多数の accessor メソッドまたは mutator メソッドを継承します これらのメソッドで Row オブジェクトのバッファーに対して列データを設定または取得できます 1 たとえば String として列 0 でデータを取得するには 以下のうちの 1 つを実行します String str = row.getstring(0); または String str = row.getstring("columnname"); ここで ColumnName は列 0 に対してデータ辞書で定義されている名前です 列名は大文字と小文字を区別します 2 次に 列 0 に対してデータを設定するには setstring メソッドのうちの 1 つを使用します row.setstring(0, "MyColumnData"); または row.setstring("columnname", "MyColumnData"); 3 詳細については PSQL Java Class Library リファレンス (Javadoc) の Buffer クラスのメソッドを参照してください データの制限またはフィルター処理 行セット内の行を制限またはフィルター処理するには 行セットの行を制限またはフィルター処理するには RowSetMetaData の addfirstterm addorterm および addandterm を使用する必要があります たとえば テーブルの最初の列に整数データが入っていて その最初の列の値が 23 より大きい行をすべて取得する場合は 以下の手順に従います 19

28 Java クラスライブラリを使ったプログラミング 1 行セットの RowSetMetaData を取得します RowSetMetaData rsmd = rowset.getrowsetmetadata(); 2 最初の列 つまり列番号 0 に対して ColumnDef を取得します ColumnDef cmd = rsmd.getcolumndef(0); 3 行セットのカレンシーを先頭位置にリセットします rowset.reset(); 4 最初の条件を追加します rowset.addfirstterm(cmd, Const.BTR_GR, "23"); 5 getnext を呼び出して列 0 が 23 よりも大きい最初の行を取得します Row row = rowset.getnext(); RowSetMetaData の addorterm および addandterm を使用して項目を追加することができます これらのメソッドを使用すれば SQL の WHERE 句と同じように さらに複雑なフィルター処理を設定できます 行セットから列を選択するには RowSetMetaData のメソッド addcolumns および dropcolumns を使用すれば SQL の SELECT ステートメントと同じように 取得する列のサブセットを指定できます nocolumns パラメーターを True に設定して行が作成されていない限り デフォルトでは 行セットはすべての列データを取得します RowSet rowset = table.createrowset(true); この場合 列は取得されません その代わり 行セットを作成後 行の一部または全部を削除できます RowSetMetaData rsmd = rowset.getrowsetmetadata(); rsmd.dropallcolumns(); 次に 対象の列のセットを行セットに追加できます rsmd.addcolumns("lastname", "FirstName"); 行セットに列を追加するには 列名または列番号を使用できます 詳細については PSQL Java Class Library リファレンス (Javadoc) の RowSetMetaData クラスの addcolumns メソッドと dropcolumns メソッドの項を参照してください 列番号で行内の列データにアクセスする場合 列番号は addcolumns メソッドと dropcolumns メソッドによって生成される新しい順序の影響を受けるので 注意してください たとえば FirstName は最初は行セットの列番号 3 であった場合 すべての列を削除した後に LastName と FirstName を追加すると FirstName の列番号は 1 になります インデックスで行を取得するには定義されたインデックスを比較演算子と共に使用すれば 行を取得できます たとえば インデックス Last_Name が仮想テーブルの LastName 列で作成されている場合 以下のことを実行して Smith という LastName を持つ行を検索することができます 1 行セットの RowSetMetaData オブジェクトを使用して インデックス Last_Name を使用するようにアクセスパスを設定します rsmd.setaccesspath("last_name"); 2 インデックス名を使用してインデックスオブジェクトを作成します 名前の代わりにインデックス番号を使用できます Index index = rowset.createindex("last_name"); 3 インデックスに対して LastName 列のデータを設定します index.setstring("lastname", "Smith"); 20

29 Java クラスライブラリ使用時の最初の手順 4 LastName = = Smith の最初の行を取得します try { Row row = rowset.getbyindex(const.btr_eq, index); } 5 発生する例外を把握します catch(psqloperationexception ex) { // エラーコード == 4 である場合 // LastName == Smith を持つ行は存在しません // これは正常なオペレーションと見なすことができます // ステータスコードが 4 でない場合は 見つからない // 以外の何らかの理由でオペレーションが失敗しています if (ex.geterrorcode()!= 4) throw(ex); } インデックスが重複キー値を許可する場合は 比較演算子に適合する最初の行が返されます 返された行は現在の行になるので インデックスに基づいて 行セットの getnext メソッドで次の論理行を取得できます テーブルの TableMetaData オブジェクトからインデックス名のリストを取得できます String [] index_names = table.gettablemetadata().getindexnames(); インデックスに名前を付けなくてもよいことに注意してください その場合 代わりにインデックス番号を使用してください インデックス番号はゼロから始まります 行の挿入 更新または削除 新しい行を挿入するには 1 まず 新しい Row オブジェクトを作成します Row row = rowset.createrow(); 2 行の列データを設定します // 列 0 のデータを設定する row.setstring(0, "Column0String"); // 列 1 のデータを設定する row.setint(1, 45); // 列 2 のデータを更新する row.setdouble(2, 99.99); 3 次に行を挿入します rowset.insertrow(row); この新たに挿入された行は 行セットの現在の行になります 行セットのカレンシーを挿入により変更したくない場合は オーバーロード版の insertrow を使用できます これは カレンシー変更なし (NCC) を示すブール引数をとります rowset.insertrow(row, true); 行セットの現在の行は変更されません 21

30 Java クラスライブラリを使ったプログラミング 行またはレコードを更新するには 1 まず 行セットの行取得メソッド getnext getbyindex などの 1 つを呼び出して 行を取得します Row row = rowset.getnext(); 2 行の列データを変更します // 列 1 を更新する row.setint(1, 45); 3 次に行を更新します rowset.updaterow(row); 次に示すように NCC (No-currency-change : カレンシー変更なし ) が示されていない場合は insertrow のように 新しく更新された行が行セットの現在の行になります rowset.updaterow(row, true); 行またはレコードを削除するには 1 まず 行セットの行取得メソッド getnext getbyindex などの 1 つを呼び出して 行を取得します Row row = rowset.getnext(); 2 次に行を削除します rowset.deleterow(row); 削除する行は 現在の行 つまり 最終取得オペレーションから返された行である必要はありません 削除する行が現在の行でない場合 deleterow メソッドはその行を現在の行にした後削除します 削除後 getnext を呼び出すと その削除された行の後の行が返されます 複数のオペレーションによるトランザクションへの結合 トランザクションを使用すると 一連のオペレーションを 1 つのオペレーションに結合し これをコミットまたは中止することができます 一連のオペレーションをトランザクションにするには Session クラスのトランザクションメソッドを使用して 一連のオペレーションをトランザクションにすることができます 次に トランザクションの例を示します 1 トランザクションを開始します try { session.starttransaction(btr_concurrent_trans); 2 障害が発生するとロールバックする いくつかのオペレーションを実行します // ここに 1 つまたは複数のオペレーションを追加する 3 トランザクションのコミットを試行します session.committransaction(); } catch(psqlexception ex) 4 エラーが検出されたら トランザクションを中止します { // エラーが発生 session.aborttransaction(); } トランザクションは 排他的 にすることも 並列 にすることもできます トランザクションの詳細については PSQL Programmer's Guide を参照してください 22

31 Java クラスライブラリ使用時の最初の手順 バイナリラージオブジェクト (BLOB) の格納と取得 setobject () および getobject () メソッドは java io Serializable インターフェイスを実装する Java オブジェクト を格納および取得するのに使用できます setbinarystream() および getbinarystream() メソッドは Java InputStreams を使用したバイナリデータの格納および取得に使用できます 次のインターフェイスを持つ 単純な Employee オブジェクトがあるとします public class Employee implements java.io.serializable public int getid(); // Employee の ID を取得する public void setid(int ID); // Employee の ID を設定する public String getname(); // Employee の名前を取得する public void setname(string name); // Employee の名前を設定する public String getmanagername(); // Manager の名前を取得する public void setmanagername(); // Manager の名前を設定する また C:\Employees\Java Duke\report.txt というファイルが存在し 読み込めるとします この場合 Employee オ ブジェクトのインスタンスを作成し さまざまなメソッドを使用して設定を行い データベースの Employee_Data 列に格納することができます さらに そのファイルを Manager_Report 列に格納することもできます // 通常のセットアップ (Driver.establishSession など ) および // employeeobject という名前の Employee オブジェクトの // インスタンスの作成は完了済み employeeobject.setname("java Duke"); employeeobject.setid( ); employeeobject.setmanagername("big Boss"); FileInputStream managerreport = null; try { managerreport = new FileInputStream(C:\Employees\Java Duke\report.txt); } catch(ioexception ioe) { // 例外処理 } // その行の列値を設定する // RowSet オブジェクト ( 行セット ) が既に // 作成されているものとする Row employeerow = rowset.createrow(); // データベースの ID 列を設定する employeerow.setint("id", employeeobject.getid()); // Employee オブジェクトを行に設定する try { employeerow.setobject("employee_data", employeeobject); } catch(psqlioexception pioe) { // 例外処理 } // マネージャーのレポートを行に設定する employeerow.setbinarystream("manager_report", managerreport); 23

32 Java クラスライブラリを使ったプログラミング // 行を挿入する rowset.insertrow(employeerow); // これで データベースからこの行を取得することができる RowSetMetaData rsmd = rowset.getrowsetmetadata(); ColumnDef cdef = rsmd.getcolumndef("id"); rsmd.addfirstterm(cdef, Const.BTR_EQ, " "); Row rowretrieved = rowset.getnext(); // 行の取得後 その行に getobject および getbinarystream // メソッドを使用して目的のデータを取得することができる try { Employee employeeretrieved = (Employee)rowRetrieved.getObject("Employee_Data"); } catch(psqlexception pe) // このメソッドは PsqlIOException および { // PsqlClassNotFoundException の両方をスローする // 例外処理 } InputStream reportretrieved = rowretrieved.getbinarystream("manager_report"); // これらのオブジェクトはこれで再構成された // オブジェクト自体または親オブジェクトに定義されたメソッドを // 起動することができる String managername = employeeretrieved.getmanagername(); // 通常 ファイル全体を 1 つのチャンクで処理することは // あまりないが リソースがあれば可能 byte file[] = new byte[reportretrieved.available()]; reportretrieved.read(file); 詳細については バイナリラージオブジェクトのサポート を参照してください 24

33 Java データ型の問題点 Java データ型の問題点 ここでは PSQL Java プログラマに役立つと思われる情報を示します バイナリラージオブジェクトのサポート Java クラスライブラリにバイナリラージオブジェクト (BLOB) 処理のサポートが追加されました BLOB は大きな ( 最大 4 ギガバイト ) バイナリデータを表し PSQL エンジンでは LONGVARBINARY データ型として示されます Java クラスライブラリは 次のメソッドでこれらのデータ型をサポートします これらは PSQL.database.Row クラスにあります public void setobject(int columnnumber, Serializable object), public void setobject(string columnname, Serializable object), public Serializable getobject(int columnnumber), public Serializable getobject(string columnname), public InputStream getbinarystream(int columnnumber), public InputStream getbinarystream(string columnname), public void setbinarystream(int columnnumber, InputStream instream), public void setbinarystream(string columnname, InputStream instream) ここで columnnumber は 行バッファー内の列のシーケンス番号です シーケンス番号はゼロから始まります columnname は行バッファー内の列の名前です object はデータベースに格納されるシリアル化可能な Java オブジェクトです instream は データベースにバイトをストリームとして書き込むのに使用します 上記のメソッドは 2 つのカテゴリに分割されます 1 つは Serialized Java オブジェクトで動作するもので もう 1 つは JavaInputStream オブジェクトで動作するものです これらのカテゴリは それぞれ次のセクションで詳しく説明します 次のセクションの例では 以下のスキーマで Employee という名前のテーブルが作成されていることを前提としてます メモ Employee_Data および Manager_Report には not null の指定があります これは PSQL 2000 以降のバージョンがサポートする 真のヌル を Java クラスライブラリがサポートしていないためです table Employees (SS_Num ubigint primary key, Employee_Data longvarbinary not null, Manager_Report longvarbinary not null) SQL インターフェイスで 1 バイト整数列 に挿入されたデータを Java インターフェイスで取得することはできない PSQL データベースエンジンでは 1 バイト整数は 0 ~ 255 の値を持つものと解釈されます 一方 Java では このバイト型は符号付きで -128 ~ 127 の値を持つものと解釈されます このような解釈の違いがあるので データが誤って解釈されないように コードから以下のプロシージャを実行する必要があります Java の解釈と PSQL データベースエンジンの解釈との間で 1 バイトの整数を変換するには int theonebyteint = 0; PSQL.database.Row row = _rowset.getnext(); theonebyteint = row.getbyte("onebyte") & 0x00FF; listcourses.add(theonebyteint + " "); 25

34 Java クラスライブラリを使ったプログラミング メモすべての Java データ型は符号付きです Java データ型の詳細について あるいはその他の Java 言語に関する情報は index.html を参照してください 26

35 サンプルデータベースファイル サンプルデータベースファイル 本 SDK コンポーネントに付属するサンプルデータベースファイルを使用して Java アプリケーションを作成することができます プログラミングの欠陥によりデータベースファイルを壊してしまった場合は SDK でインストールされたバックアップディレクトリからデータベースファイルを復元できます サンプルデータベースファイルを復元するには 1 復元する前に サンプルアプリケーションや開発環境など データベースファイルを開いているプログラムを閉じます 2 file_path\psql\sdk ( デフォルトの場所 ) にインストールしたという前提で 以下のフォルダーを開きます file_path\psql\sdk\jcl\samples\pvideo\pvideodb\dbbackup PSQL ファイルのデフォルトの保存場所については Getting Started With PSQL の PSQL ファイルはどこにインストールされますか? を参照してください 3 このディレクトリにあるファイルを 1 つ上のフォルダーにコピーしますが 手順 1 の場合は 以下のフォルダーになります file_path\psql\sdk\jcl\samples\pvideo\pvideodb\ 27

36 Java クラスライブラリを使ったプログラミング 追加の Java サンプル Java API に付属の追加サンプルがあります まず 本 SDK コンポーネントで提供する 2 つのテーブルの結合を実証するサンプル 次に DEMODATA データベースへ接続するサンプル 最後に オブジェクトのシリアル化を実証するサンプルです デフォルトの場所にインストールしたという前提で これらのサンプルは以下のディレクトリに置かれます file_path\psql\sdk\jcl\samples\join file_path\psql\sdk\jcl\samples\helloworld\ file_path\psql\sdk\jcl\samples\serialization PSQL ファイルのデフォルトの保存場所については Getting Started With PSQL の PSQL ファイルはどこにインストールされますか? を参照してください 28