Hibernate オブジェクト リレーショナル マッピングの生成

Workshop Studio ORM Workbench は、Hibernate のような一般的な永続性サービスを利用するための、多彩で柔軟性のあるオブジェクト リレーショナル マッピング インタフェースを備えています。

OR マッピングは、開発手法に応じて以下の異なるメカニズムで生成できます。

Hibernate OR マッピングをスキーマから作成する

Hibernate マッピングをオブジェクト モデルから生成する

Hibernate OR マッピングをスキーマから作成する

Workshop Studio は、データベース スキーマをリバース エンジニアリングすることで、関連付けられているオブジェクト モデルとマッピングを自動的に生成するシンプルなメカニズムを提供します。

注意 : まだ DbXplorer を開いていない場合は、[ウィンドウ] メニューから [ビューの表示｜その他] を選択します。[Workshop] ブランチを展開し、[DbXplorer] を選択して [OK] をクリックします。

1. [DbXplorer] で、データベース アーティファクトを右クリックして [Hibernate マッピングの生成] を選択します。



2. Hibernate マッピング ファイルとデータ オブジェクトを格納する Web アプリケーション プロジェクトを選択して [OK] をクリックします。Hibernate Web アプリケーションがないと、マッピングを生成することはできません。

   注意 : 現時点の Workshop Studio で Hibernate アプリケーションと見なされるのは、Eclipse ソース フォルダのルート レベルにコンフィグレーション ファイル hibernate.cfg.xml が格納されており、アプリケーションのクラスパスに hibernate.jar ファイルが含まれている Web アプリケーションです。



3. [データベース テーブル] ダイアログで、リバース エンジニアリングによってマッピングする適切なデータベースの接続、スキーマ、およびテーブルを選択して [次へ] をクリックします。



4. [テーブルの関連付け] ダイアログに、外部キー定義に基づいてデータベース スキーマから抽出された現在のエンティティ関係が表示されます (緑のボックス)。関連を選び、その関連を有効にしてマッピングすべきかどうかを選択します。マッピングする場合は、その関連のプロパティを指定します。



5. マッピングすべきでない関連がある場合は、その関連を選択して [この関連付けの生成] のチェックをはずします。無効にした関連は、[テーブルの関連付け] ではグレーで表示されます。



6. Workshop Studio では、新しい関連を作成することもできます。その場合は、[新しい関連付けの作成] オプションをクリックし、新しい関連のプロパティを指定します。Workshop Studio では、2 つのテーブル間の [Simple Associations] (一対一、一対多、多対一) と、中間テーブルを介した [Many to Many Associations] を作成できます。[次へ] をクリックすると、テーブル行の結合に使用するカラムが関連付けられます。

   この機能は、外部キーが定義されていないデータベース テーブルで Hibernate マッピングを作成する場合や、多対多関係を作成する場合に便利です。



7. 新しい関連 (黄色のボックス) はデータベース スキーマから抽出されたものではないため、Hibernate マッピング ファイルおよびオブジェクト モデル内にプログラム的に作成されます。エンティティの関連のコンフィグレーションが完了したら [次へ] をクリックします。



8. [デフォルト テーブルの生成] ダイアログでは、必要に応じて省略可能なプロパティを入力して [次へ] をクリックします。

   注意 : オブジェクト モデル クラスを生成するには Java パッケージが必要です。



9. [テーブルとカラム] ダイアログで、生成されるマッピング ファイルと Bean クラスのテーブル マッピング名およびカラム マッピング名を定義します。デフォルトでは、Hibernate マッピング ファイルと JavaBean に、スキーマのテーブル名およびカラム名が使用されます。ツールチップに表示されているのは、データベース スキーマに定義されているテーブルおよびカラムのプロパティです。[次へ] をクリックします。



10. [マッピングの生成] ダイアログでは、どのアーティファクトを生成し、生成されるファイルに XDoclet メタ タグを追加するかどうかを決定します。[完了] をクリックすると、Hibernate マッピング ファイルとドメイン Java クラスが作成されます。

ORM Generation ウィザードで指定したプロパティに基づいて、すべての Hibernate マッピング ファイルと Java Bean が生成されます。生成が完了したら、そのプロジェクトの [Hibernate コンフィグレーション] ブランチにある AppXplorer を使用してエンティティにアクセスできます。

なお、このウィザードで指定したすべての設定は記録されており、次回同じデータベース接続でこのウィザードを使用するときに再利用できます。

Hibernate OR マッピングをオブジェクト モデルから作成する

Workshop Studio では、Hibernate マッピング ファイルを Java オブジェクト モデルから生成する、トップダウンの開発手法もサポートされています。すべてのエンティティ関係が定義されていれば、Hibernate マッピングに基づいて DDL 経由でスキーマを定義することも可能です。

1. [ファイル] メニューから [新規｜その他] を選択します。[Hibernate] を展開します。[Java クラスからの Hibernate マッピング] を選択して [次へ] をクリックします。



2. [参照] ボタンを使用してマッピングするオブジェクトを選択し、自動的に生成されるマッピング ファイルの名前を選択して [次へ] をクリックします。



3. [クラス マッピングのプロパティ] ダイアログでは、指定できるデータベース情報と主キー プロパティがあれば指定して [次へ] をクリックします。開発手法によってはデータベースがまだ定義されていない場合もあるので、[データベース スキーマ] オプションと [データベース テーブル] オプションは必須ではありません。



4. [Bean プロパティのマッピング] ダイアログで、どの Bean プロパティをマッピングするかを選択します。プロパティを強調表示にして [削除] ボタンをクリックすると、そのプロパティのマッピングを Hibernate マッピング ファイルから削除できます。プロパティをマッピングする場合は、そのプロパティを選択して [編集] をクリックし、カラムのマッピング情報を指定します。



5. Bean プロパティのマッピングをコンフィグレーションするには、適切な情報を入力して [OK] をクリックします。データベース スキーマを利用できる場合は、[参照] をクリックすると、そのテーブルで使用できる [カラム名] の一覧が表示されます。



6. 単純なデータ型でなく、コレクションとして設定されている Bean プロパティもあります。コレクションのマッピング プロパティを定義するには、項目を強調表示にして [編集] をクリックします。[コレクション型]、[要素型]、および [カーディナリティ] を指定して [次へ] をクリックします。



7. 選択した [カーディナリティ] に基づき、[Collection Entity] と [Set Properties] を指定して [完了] をクリックします。次の例では、orderDetails コレクションを外部キー ProductId で OrderDetail にマッピングしています。



8. すべての Bean プロパティの選択とカラム マッピング情報の追加が完了したら、[完了] をクリックして Hibernate マッピングを生成します。

DbXplorer によるデータベースの操作

Hibernate エンティティの関係の管理

Hibernate プロパティのコンフィグレーション