1. 「ファイル」>「新規プロジェクト」(Ctrl-Shift-N) を選択します。「Web」カテゴリから「Web アプリケーション」を選択し、「次へ」をクリックします。
2. プロジェクト名として「ZooApp」と入力し、プロジェクトの場所を設定します。
3. 専用フォルダを使用するオプションが選択されている場合は選択を解除します。
   このチュートリアルでは、ライブラリをほかのユーザーと共有する必要がないので、プロジェクトライブラリを専用のフォルダにコピーする理由はほとんどありません。
   「次へ」をクリックします。
4. サーバーを GlassFish に設定し、Java EE バージョンを Java EE 5 に設定します。「次へ」をクリックします。
5. 「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 は、GlassFish アプリケーションサーバーにバンドルされている Java DB データベースに接続するようにすでに設定されています。データベースのデータソースを作成すれば、別のデータベースを使用できます。

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

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

まとめ

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

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

まず、Animal と Pavilion というエンティティークラスを作成します。これらのクラスは、データベース内の ANIMAL と PAVILION という表を表します。

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

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

エンティティークラスを作成するには、次の手順を実行します。

1. 「ZooApp」プロジェクトノードを右クリックし、「新規」>「その他」を選択します。
2. 「持続性」カテゴリから「エンティティークラス」を選択し、「次へ」をクリックします。
3. クラス名に「Animal」を、パッケージに「entity」をそれぞれ入力し、「主キーの型」は Long のままにしておきます。「完了」をクリックします。
4. 同じ手順で entity ソースパッケージに Pavilion クラスを作成します。

「完了」をクリックすると、新しいエンティティークラスがエディタに表示されます。「プロジェクト」ウィンドウで「ソースパッケージ」の下にある「entity」ノードを展開すると、エンティティークラス Animal と Pavilion が表示されます。

Animal クラスのフィールドの定義

Animal クラスをエディタで開き、次の手順に従います。

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

   public class Animal implements Serializable {
   
       private static final long serialVersionUID = 1L;
       private Long id;
       private String name;
       private String kind;
       private String weight;
       private Pavilion pavilion;

2. ソースエディタ内を右クリックして「コードを挿入」(Alt-Insert) を選択し、「取得メソッドおよび設定メソッド」を選択して「取得メソッドおよび設定メソッドの生成」ダイアログを開きます。
3. 「取得メソッドおよび設定メソッドの生成」ダイアログですべてのフィールドを選択し、「生成」をクリックします。
   

   「取得メソッドおよび設定メソッドの生成」ダイアログでは、キーボードの上矢印キーを使用して、選択した項目を Animal 項目まで移動してから、スペースバーを押して Animal 内のすべてのフィールドを選択できます。

4. 続いて、Animal 表内に作成される列の 1 つの名前を変更し、この列の名前を name ではなく animalName とします。name フィールドの宣言の上に次の注釈を追加すると、生成される列の名前を指定できます。

      @Column(name="animalName")
       private String name;

5. name フィールドに @Column 注釈を付けたとき、クラス識別子の横の左マージンに警告が表示されました。マージン内にある警告アイコンをクリックし、「フィールドアクセスの単一化」を選択します。
   

   「フィールドアクセスの単一化」をクリックすると、@Id と @GeneratedValue の各注釈が getId 取得メソッドから

   private Long id のすぐ上まで移動されます。
6. Animal 表の pavilion 列には多対 1 の関係が必要です。pavilion の宣言の上に次の注釈を追加すると、この操作を行うことができます。

      @ManyToOne
       private Pavilion pavilion;

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

次の手順では、Pavilion エンティティークラス内のフィールドを定義します。

Pavilion クラスのフィールドの定義

Pavilion クラスをエディタで開き、次の手順に従います。

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

   public class Pavilion implements Serializable {
   
       private static final long serialVersionUID = 1L;
       private Long id;
       private String name;
       private String address;
       private Collection <Animal> animals;

2. 次の注釈を name の宣言の上に追加し、生成される列の名前を変更します。

      @Column(name="pavilionName")
       private String name;

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

      @OneToMany(mappedBy="pavilion")
       private Collection <Animal> animals;

4. エディタ内を右クリックして「コードを挿入」(Alt-Insert) を選択し、「取得メソッドおよび設定メソッド」を選択します。
5. 「取得メソッドおよび設定メソッドの生成」ダイアログですべてのフィールドを選択し、「生成」をクリックします。
   
6. Animal クラスのときと同様に、マージンにある警告アイコンをクリックし、「フィールドアクセスの単一化」を選択します。
7. Alt-Shift-I キーを押して、足りないインポート文を生成します。
8. 変更を保存します。

まとめ

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

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

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

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

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

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

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

Pavilion データの変更時に IllegalArgumentException が発生する問題

次の例外が発生する場合があります。

java.lang.IllegalArgumentException: Expected a child component type of UISelectItem/UISelectItems for component type javax.faces.SelectMany(animals). Found null.

この場合、Pavilion クラスの Collection <Animal> の取得メソッドと設定メソッドが間違っている可能性があります。

Collection <Animal> の取得メソッドと設定メソッドが次のようになっていることを確認してください。

public Collection<Animal> getAnimals() {
    return animals;
}

public void setAnimals(Collection<Animal> animals) {
    this.animals = animals;
}

プロジェクトの取得メソッドと設定メソッドが正しくない場合は、次の手順に従います。

1. エンティティークラスのコントローラクラスとコンバータクラスを削除します。
2. 「プロジェクト」ウィンドウの「Web ページ」ノードの下にある animal と pavilion の各ディレクトリを削除します。
3. Pavilion エンティティークラスの取得メソッドと設定メソッドを修正します。
4. 「エンティティークラスからの JSF ページ」ウィザードを使用して、JSF ページ、およびコントローラクラスとコンバータクラスを再生成します。