前提条件

このドキュメントは、次のテクノロジについて基本的な知識またはプログラミング経験を持つ読者を想定して書かれています。

• Java プログラミング
• NetBeans IDE

このチュートリアルに必要なソフトウェア

このチュートリアルでは、コンピュータに次のソフトウェアをインストールしておく必要があります。

• NetBeans IDE 5.5 (ダウンロード)
• Java Standard Development Kit (JDK) バージョン 5.0 またはバージョン 6.0 (ダウンロード)
• Sun Java System Application Server Platform Edition 9 (ダウンロード)

このチュートリアルでは、Sun Java System Application Server のローカルインスタンスを IDE に登録する必要があります。

チュートリアルの課題

• Web アプリケーションプロジェクトの設定
• 持続性ユニットの作成
• エンティティークラスの作成
• Web インタフェースの作成
• プロジェクトの実行
• トラブルシューティング

1. 「ファイル」>「新規プロジェクト」(Ctrl-Shift-N) を選択します。 「Web」カテゴリから「Web アプリケーション」を選択し、「次へ」をクリックします。
2. このプロジェクトに「ZooApp」という名前を付け、サーバーを「Sun Java System Application Server」に、「Java EE バージョン」を「Java EE 5」にそれぞれ設定して、「次へ」をクリックします。
3. 「JavaServer Faces」チェックボックスを選択して「完了」をクリックします。

まとめ

この課題では、エンティティークラスを含める Java EE 5 Web アプリケーションを作成しました。

持続性ユニットの作成

1. 「プロジェクト」ウィンドウの ZooApp Web アプリケーションノードを右クリックし、「新規」>「ファイル/フォルダ」を選択して「新規ファイル」ウィザードを開きます。
2. 「持続性」カテゴリから「持続性ユニット」を選択し、「次へ」をクリックします。
3. 持続性ユニットの名前はデフォルトのままにしておきます。
4. 「持続性プロバイダ」には TopLink (デフォルト) を使用します。

   デフォルトのプロバイダは TopLink Essential.jar です。 TopLink Essential.jar には Java Persistence 用のライブラリが含まれています。 エンティティーマネージャーは TopLink Essential.jar に置かれています。

5. 「データソース」には、デフォルトのデータソース jdbc/sample を使用します。

   デフォルトのデータソース jdbc/sample は、Sun Java System Application Server にバンドルされている Java DB データベースへの接続に使用されます。

6. 持続性ユニットが Java Transaction API を使用していること、アプリケーション配備時にエンティティークラスに基づいた表が作成されるように「Table Generation Strategy」が「作成」に設定されていることを確認します。
7. 「完了」をクリックします。

「完了」をクリックすると、IDE によって persistence.xml が作成され、ソースエディタの「デザイン」ビューに表示されます。 ソースエディタのツールバーにある「XML」をクリックすると、persistence.xml の XML を確認できます。 このファイルには、アプリケーションのエンティティーおよび持続性を管理するために Java EE 5 コンテナが必要とする情報がすべて含まれています。

まとめ

この課題では、データソース、持続させるエンティティークラス、およびエンティティーのライフサイクル管理のためにコンテナが使用するエンティティーマネージャーを指定するための、持続性ユニットを作成しました。

Animal エンティティークラスの作成

まず、Animal というエンティティークラスを作成します。 このクラスは、データベース内の ANIMAL という表を表します。 このエンティティークラスを作成すると、クラスをエンティティークラスとして定義するための @Entity という注釈が IDE によって追加されます。 このクラスを作成したあとで、表で表示するデータを表すフィールドをクラス内に作成し、注釈を使用してこれらのフィールドの一部についての追加情報を与えることになります。

各エンティティークラスは主キーを持つ必要があります。 エンティティークラスを作成すると、IDE によって、どのフィールドを主キーとして使用するかを宣言するための @Id という注釈が追加されます。 また、主 ID のキー生成方法を指定するための @Generated という注釈も IDE によって追加されます。

Animal クラスを作成するには、次の手順を実行します。

1. ZooApp プロジェクトノードを右クリックし、「新規」>「ファイル/フォルダ」を選択します。
2. 「持続性」カテゴリから「エンティティークラス」を選択し、「次へ」をクリックします。
3. クラス名に「Animal」を、パッケージに「entity」をそれぞれ入力し、「主キーの型」は Long のままにしておきます。 「完了」をクリックします。

「完了」をクリックすると、エンティティークラス Animal.java がソースエディタに表示されます。 ソースエディタで次の手順を実行します。

1. このクラスに次のフィールド宣言を追加します。

     String name;
     String kind;
     String weight;
     Pavilion pavilion;
                       

2. ソースエディタ内で右クリックし、「リファクタリング」>「フィールドをカプセル化」を選択して、各フィールドの取得メソッドおよび設定メソッドを生成します。 「フィールドをカプセル化」ダイアログで、すべてのフィールドについて取得メソッドおよび設定メソッドのチェックボックスが選択されていることを確認します。
3. 「フィールドをカプセル化」ダイアログの「次へ」をクリックし、「出力」ウィンドウの「リファクタリング」タブで「リファクタリングを実行」をクリックします。
4. 続いて、Animal 表内に作成される列の 1 つの名前を変更することにします。 この列の名前を name ではなく animalName とします。 name フィールドの宣言の上に次の注釈を追加すると、生成される列の名前を指定できます。

       @Column(name="animalName")

5. また、Animal 表の pavilion という列に多対 1 の関係を持たせることにします。 pavilion の宣言の上に次の注釈を追加すると、この操作を行うことができます。

       @ManyToOne

6. Alt-Shift-F キーを押し、このクラスに必要なインポート文を生成します。
7. 変更を保存します。

次の手順では、Pavilion エンティティークラスを作成します。

Pavilion エンティティークラスの作成

今度は、データベース内の PAVILION という表を表す Pavilion エンティティークラスを作成します。 ふたたびクラス内で注釈を使用し、一部のフィールドのオブジェクトリレーショナルマッピングを指定します。 Pavilion クラスを作成するには、次の手順を実行します。

1. ZooApp プロジェクトノードを右クリックし、「新規」>「ファイル/フォルダ」を選択します。
2. 「持続性」カテゴリから「エンティティークラス」を選択し、「次へ」をクリックします。
3. クラス名に「Pavilion」を、パッケージに「entity」をそれぞれ入力し、「主キーの型」は Long のままにしておきます。 「完了」をクリックします。

「完了」をクリックすると新しいエンティティークラス Pavilion.java がソースエディタに表示されます。 ソースエディタで次の手順を実行します。

1. このクラスに次のフィールド宣言を追加します。

     String name;
     String address;
     Collection <Animal> animals;

2. 「リファクタリング」>「フィールドをカプセル化」を選択し、これらのフィールドの取得メソッドおよび設定メソッドを生成します。
3. 次の注釈を name の宣言の上に追加し、生成される列の名前を変更します。

       @Column(name="pavilionName")

4. 次の注釈を animals コレクションの上に追加し、このエンティティーに「1 対多」の関係を指定します。

       @OneToMany(mappedBy="pavilion")

5. Alt-Shift-F キーを押して、足りないインポート文を生成します。
6. 変更を保存します。

まとめ

この課題では、2 つのエンティティークラスを作成し、フィールドを定義しました。 また、注釈を使用して、アプリケーションの配備時に生成される表の列の一部に対してプロパティーを定義しました。

「エンティティークラス」ウィザードの「新規 JSF ページ」に関する問題

ウィザードを使用してエンティティークラスから JSF ページを作成しようとすると、ウィザードに次のエラーメッセージが現れることがあります。

このウィザードは、JSF をサポートしている Web プロジェクトでしか使用できません。

このメッセージが出た場合、Java Server Faces フレームワークがプロジェクトプロパティーに追加されていることを確認する必要があります。 次の手順を実行することによって、Web プロジェクトに Java Server Faces サポートを追加できます。

1. 「プロジェクト」ウィンドウで対象の Web アプリケーションノードを右クリックし、「プロパティー」を選択します。
2. 「プロジェクトプロパティー」ダイアログの「カテゴリ」区画で「フレームワーク」を選択し、「追加」をクリックします。
3. 「Select Frameworks」ダイアログで「Java Server Faces」を選択して「了解」をクリックします。
4. 「プロジェクトプロパティー」ダイアログの「了解」をクリックして、ウィンドウを閉じます。

プロジェクトプロパティーに「JSF フレームワーク」を追加したあとは、ウィザードを使用して JSF ページを作成できるはずです。