Hibernate リバースエンジニアリングファイルの作成

「データベースからの Hibernate のマッピングファイルと POJO」ウィザードを使用する場合、最初に hibernate.reveng.xml リバースエンジニアリングファイルを作成する必要があります。「データベースからの Hibernate のマッピングファイルと POJO」ウィザードには、hibernate.reveng.xml および hibernate.cfg.xml が必要です。

リバースエンジニアリングファイルを使用すると、データベースマッピング方法をより詳細に制御できます。Hibernate リバースエンジニアリングウィザードでは、XML エディタで編集できるデフォルト構成を持つリバースエンジニアリングファイルが作成されます。

Hibernate リバースエンジニアリングファイルを作成するには、次の手順に従います。

1. 「プロジェクト」ウィンドウで「ソースパッケージ」ノードを右クリックし、「新規」>「その他」を選択して「新規ファイル」ウィザードを開きます。
2. 「Hibernate」カテゴリで「Hibernate リバースエンジニアリングウィザード」を選択します。「次へ」をクリックします。
3. ファイル名に hibernate.reveng を指定し、フォルダに src/java を指定します。「次へ」をクリックします。
4. 選択されていない場合、hibernate.cfg.xml を「構成ファイル」ドロップダウンリストから選択します。
5. 「使用可能な表」から次の表を選択し、「追加」をクリックして「選択した表」に追加します。
   • actor
   • category
   • film
   • film_actor
   • film_category
   • language

   「完了」をクリックします。

   

このウィザードでは、hibernate.reveng.xml リバースエンジニアリングファイルが生成され、ファイルはエディタに表示されます。リバースエンジニアリングファイルは、編集する必要がないため閉じてかまいません。

hibernate.reveng.xml ファイルの操作の詳細については、「第 5 章: リバースエンジニアリングの制御」(Hibernate Tools リファレンスガイド) を参照してください。

Hibernate マッピングファイルと POJO の作成

「データベースからの Hibernate のマッピングファイルと POJO」ウィザードを使用して、ファイルを生成できます。このウィザードでは、ウィザードで選択した表ごとに、POJO および対応するマッピングファイルを生成できます。マッピングファイルは XML ファイルで、表の列を POJO のフィールドにマップする方法に関するデータが含まれています。ウィザードを使用するには、hibernate.reveng.xml ファイルと hibernate.cfg.xml ファイルが必要です。

ウィザードを使用して POJO とマッピングファイルを作成するには、次の手順に従います。

1. 「プロジェクト」ウィンドウで「ソースパッケージ」ノードを右クリックし、「新規」>「その他」を選択して「新規ファイル」ウィザードを開きます。
2. 「データベースからの Hibernate のマッピングファイルと POJO」を「Hibernate」カテゴリから選択します。「次へ」をクリックします。
3. ドロップダウンリストで、hibernate.cfg.xml ファイルと hibernate.reveng.xml ファイルが選択されていることを確認します。
4. 「一般的な設定」で「JDK 5 言語機能」を選択します。
5. 「ドメインコード」および「Hibernate XML のマッピング」オプションが選択されていることを確認します。
6. パッケージ名に「dvdrental」を選択します。「完了」をクリックします。
   

「完了」をクリックすると、POJO と Hibernate のマッピングファイルが生成され、hibernate.reveng.xml で指定した列にフィールドがマップされます。また、hibernate.cfg.xml にマッピングエントリが追加されます。dvdrental パッケージを展開すると、ウィザードによって生成されたファイルを確認できます。

特定の表を特定のクラスにマップする Hibernate マッピングファイルを作成する場合、Hibernate マッピングウィザードを使用できます。

hibernate.reveng.xml ファイルの操作の詳細については、「第 5 章: 基本的な O/R マッピング」(Hibernate Reference Documentation) を参照してください。

クラスの作成

この節では、「新規ファイル」ウィザードを使用して、ヘルパークラス FilmHelper.java を dvdrental パッケージ内に作成します。HibernateUtil.java 内の getSessionFactory を呼び出して Hibernate セッションを作成し、データベースからデータを取り出すクエリーを作成するヘルパーメソッドをいくつか作成します。ヘルパーメソッドは JSP ページから呼び出します。

1. 「dvdrental」ソースパッケージノードを右クリックし、「新規」>「Java クラス」を選択して、「新規ファイル」ウィザードを開きます。
2. クラス名に「FilmHelper」と入力します。
3. パッケージが「dvdrental」であることを確認します。「完了」をクリックします。
4. 次のコード (ボールド部分) を追加して、Hibernate セッションを作成します。

   public class FilmHelper {
   
       Session session = null;
   
       public FilmHelper() {
           this.session = HibernateUtil.getSessionFactory().getCurrentSession();
       }
   
   }

5. インポートを修正して (org.hibernate.Session) 変更内容を保存します。

ここで FilmHelper.java を変更して、データベースに対してクエリーを実行するメソッドを追加します。

HQL クエリーを使用した映画タイトルの列挙と俳優の取得

この課題では、データベースをクエリーして Film 表から映画のタイトルのリストを取り出す、Hibernate クエリー言語 (HQL) クエリー作成します。次に、特定の映画に含まれる俳優を取得するため、Actor 表および Film_actor 表の両方にクエリーを実行するメソッドを追加します。

Film 表には 1,000 件のレコードがあるため、映画のリストを取得するメソッドは、filmId 主キーに基づいてレコードを取得できる必要があります。HQL クエリーの構成とテストには、HQL エディタを使用します。正しいクエリーを作成したあと、適切なクエリーを生成できるクラスにメソッドを追加します。

1. 「プロジェクト」ウィンドウで「hibernate.cfg.xml」を右クリックし、「HQL クエリーを実行」を選択して、HQL クエリーエディタを開きます。
2. ツールバーのドロップダウンリストから「hibernate.cfg」を選択します。
3. 接続をテストするには、エディタで次のように入力し、ツールバーの「HQL クエリーを実行」ボタン () をクリックします。

   from Film

   「HQL クエリーを実行」をクリックすると、HQL クエリーエディタの下部ウィンドウにクエリーの結果が表示されます。

   「SQL」ボタンをクリックすると、対応する SQL クエリーを見ることができます。

   select film0_.film_id as col_0_0_ from sakila.film film0_

4. 次のクエリーを入力して、filmid が 100 から 200 の間に含まれるレコードを Film 表から取り出します。

   from Film as film where film.filmId between 100 and 200

   結果ウィンドウにレコードのリストが表示されます。クエリーが適切な結果を返すことをテストできたので、このクエリーをヘルパークラスで使用できます。

5. FilmHelper.java に次のメソッド getFilmTitles を追加して、filmid が、変数 startID と endID で指定する範囲内にある映画を取り出します。

   public List getFilmTitles(int startID, int endID) {
       List<Film> filmList = null;
       try {
           org.hibernate.Transaction tx = session.beginTransaction();
           Query q = session.createQuery ("from Film as film where film.filmId between '"+startID+"' and '"+endID+"'");
           filmList = (List<Film>) q.list();
       } catch (Exception e) {
           e.printStackTrace();
       }
       return filmList;
   }

6. 特定の映画から俳優を取得する次のメソッド getActorsByID を追加します。メソッドは、入力変数として filmId を使用し、クエリーを構成します。

   public List getActorsByID(int filmId){
       List<Actor> actorList = null;
       try {
           org.hibernate.Transaction tx = session.beginTransaction();
           Query q = session.createQuery ("from Actor as actor where actor.actorId in (select filmActor.actor.actorId from FilmActor as filmActor where filmActor.film.filmId='" + filmId + "')");
           actorList = (List<Actor>) q.list();
   
       } catch (Exception e) {
           e.printStackTrace();
       }
   
       return actorList;
   }

7. インポートを修正して変更内容を保存します。

   インポートを修正するときは、java.util.List と org.hibernate.Query を選択します。

ヘルパーメソッドの追加

ここでは、入力変数に基づいてクエリーを作成するヘルパーメソッドを追加します。クエリーは HQL クエリーエディタで確認できます。

1. filmId に基づいてカテゴリのリストを取り出す次のメソッドを追加します。

   public Category getCategoryByID(int filmId){
       List<Category> categoryList = null;
       try {
           org.hibernate.Transaction tx = session.beginTransaction();
           Query q = session.createQuery("from Category as category where category.categoryId in (select filmCat.category.categoryId from FilmCategory as filmCat where filmCat.film.filmId='" + filmId + "')");
           categoryList = (List<Category>) q.list();
   
       } catch (Exception e) {
           e.printStackTrace();
       }
   
       return categoryList.get(0);
   }

2. filmId に基づいて 1 つの映画を取り出す次のメソッドを追加します。

   public Film getFilmByID(int filmId){
   
       Film film = null;
   
       try {
           org.hibernate.Transaction tx = session.beginTransaction();
           Query q = session.createQuery("from Film as film where film.filmId=" + filmId);
           film = (Film) q.uniqueResult();
       } catch (Exception e) {
           e.printStackTrace();
       }
   
       return film;
   }

3. langId に基づいて映画の言語を取り出す次のメソッドを追加します。

   public String getLangByID(int langId){
   
       Language language = null;
   
       try {
           org.hibernate.Transaction tx = session.beginTransaction();
           Query q = session.createQuery("from Language as lang where lang.languageId=" + langId);
           language = (Language) q.uniqueResult();
       } catch (Exception e) {
           e.printStackTrace();
       }
   
       return language.getName();
   }

template.xhtml の作成

最初に、index.xhtml ページと browse.xhtml ページの構成に使用する、JSF Facelets テンプレート template.xhtml を作成します。

1. 「プロジェクト」ウィンドウで「DVDStore」を右クリックし、「新規」>「その他」を選択します。
2. 「JavaServer Faces」カテゴリで「Facelets テンプレート」を選択します。「次へ」をクリックします。
3. 「ファイル名」に「template」と入力し、1 つ目の CSS レイアウトスタイルを選択します。
4. 「完了」をクリックします。

   「完了」をクリックすると、エディタで template.xhtml ファイルが開きます。テンプレートには次のデフォルトコードが含まれています。

   <h:body>
   
       <div id="top" class="top">
           <ui:insert name="top">Top</ui:insert>
       </div>
   
       <div id="content" class="center_content">
           <ui:insert name="content">Content</ui:insert>
       </div>
   
   </h:body>

5. <ui:insert> 要素を変更して、デフォルトで生成される名前を「body」に変えます。

   <div id="content" class="center_content">
           <ui:insert name="body">Content</ui:insert>
   </div>

6. 変更を保存します。

index.xhtml および browse.xhtml の <ui:define name="body"> 要素内の内容は、テンプレートの <ui:insert name="body">Content</ui:insert> で指定された場所に挿入されます。

index.xhtml の変更

Web アプリケーションを作成すると、IDE が自動的にページの index.xhtml を生成します。この課題では、ページを変更して映画のタイトルのリストを表示するようにします。JSF ページは JSF 管理対象 Bean の FilmController のメソッドを呼び出し、映画のリストを取り出して、映画のタイトルと説明の表を表示します。

1. 「プロジェクト」ウィンドウで「Web ページ」フォルダを展開し、index.xhtml をエディタで開きます。

   新規プロジェクトウィザードで、次に示すデフォルトの index.xhtml を生成します。

   <html xmlns="http://www.w3.org/1999/xhtml"
         xmlns:h="http://java.sun.com/jsf/html">
   <h:head>
           <title>Facelet Title</title>
       </h:head>
       <h:body>
           Hello from Facelets
       </h:body>
   </html>

2. ページを変更し、JSF <ui:composition> 要素および <ui:define> 要素を使用するようにして、<h:form> 要素を追加します。

   <html xmlns="http://www.w3.org/1999/xhtml"
     xmlns:h="http://java.sun.com/jsf/html"
     xmlns:ui="http://java.sun.com/jsf/facelets">
       <ui:composition template="./template.xhtml">
           <ui:define name="body">
               <h:form>
   
               </h:form>
           </ui:define>
       </ui:composition>
   </html>

   タグの入力を開始すると、IDE は xmlns:ui="http://java.sun.com/jsf/facelets" タグライブラリ宣言を追加します。

   <ui:composition> 要素と <ui:define> 要素は、作成するページテンプレートと組み合わせて使用されます。<ui:composition> 要素は、このページによって使用されるテンプレートの場所を参照します。<ui:define> 要素は、含まれているコードが占有するテンプレート内での位置を参照します。

3. JSF 管理対象 Bean で previous メソッドおよび next メソッドを呼び出す、次のナビゲーションリンクを追加します。

       <ui:define name="body">
               <h:form>
                   <h:commandLink action="#{filmController.previous}" value="Previous #{filmController.pageSize}" rendered="#{filmController.hasPreviousPage}"/> 
                   <h:commandLink action="#{filmController.next}" value="Next #{filmController.pageSize}" rendered="#{filmController.hasNextPage}"/> 
               </h:form>
       </ui:define>

4. 取り出された項目を表示する表を生成する次の dataTable 要素 (ボールド部分) を追加します。

               <h:form styleClass="jsfcrud_list_form">
                   <h:commandLink action="#{filmController.previous}" value="Previous #{filmController.pageSize}" rendered="#{filmController.hasPreviousPage}"/> 
                   <h:commandLink action="#{filmController.next}" value="Next #{filmController.pageSize}" rendered="#{filmController.hasNextPage}"/> 
                   <h:dataTable value="#{filmController.filmTitles}" var="item" border="0" cellpadding="2" cellspacing="0" rowClasses="jsfcrud_odd_row,jsfcrud_even_row" rules="all" style="border:solid 1px">
                       <h:column>
                           <f:facet name="header">
                               <h:outputText value="Title"/>
                           </f:facet>
                           <h:outputText value="#{item.title}"/>
                       </h:column>
                       <h:column>
                           <f:facet name="header">
                               <h:outputText value="Description"/>
                           </f:facet>
                           <h:outputText value="#{item.description}"/>
                       </h:column>
                       <h:column>
                           <f:facet name="header">
                               <h:outputText value=" "/>
                           </f:facet>
                           <h:commandLink action="#{filmController.prepareView}" value="View"/>
                       </h:column>
                   </h:dataTable>
                   <br/>
               </h:form>
   

5. 変更を保存します。

これで、索引ページにデータベース内の映画のタイトルリストが表示されます。表の各行に、管理対象 Bean の prepareView メソッドを呼び出す「View」リンクがあります。prepareView メソッドは「browse」を返し、browse.xhtml を開きます。

<f:facet> タグを入力すると、IDE は xmlns:f="http://java.sun.com/jsf/core タグライブラリ宣言を追加します。

browse.xhtml の作成

ここでは、選択した映画の詳細を表示する browse.xhtml ページを作成します。「Facelets テンプレートクライアント」ウィザードを使用すると、作成した JSF Facelets テンプレート template.xhtml に基づいて、ページを作成できます。

1. 「プロジェクト」ウィンドウで「DVDStore」を右クリックし、「新規」>「その他」を選択します。
2. 「JavaServer Faces」カテゴリで「Facelets テンプレートクライアント」を選択します。「次へ」をクリックします。
   
3. 「ファイル名」に「browse」と入力します。
4. 「参照」ボタンをクリックして「ファイルを参照」ダイアログを開き、ページのテンプレートを検索します。
5. Web ページフォルダを展開し、template.xhtml を選択します。「ファイルを選択」をクリックします。
   
6. 生成したルートタグに <ui:composition> を選択します。「完了」をクリックします。

   「完了」をクリックすると、browse.xhtml ファイルがエディタで開き、次のコードが表示されます。

   <ui:composition xmlns:ui="http://java.sun.com/jsf/facelets"
       template="./template.xhtml">
   
       <ui:define name="top">
           top
       </ui:define>
   
       <ui:define name="body">
           body
       </ui:define>
   
   </ui:composition>

   新しいファイルが template.xhtml ファイルを指定し、<ui:define> タグに name="body" プロパティーがあることが確認できます。

7. <ui:define> タグの間に次のボールドのコードを追加してフォームを作成し、管理対象 Bean の FilmController でメソッドを呼び出して、データを取り出し、フォームを生成します。

   <ui:composition xmlns:ui="http://java.sun.com/jsf/facelets"
       template="./template.xhtml"
       xmlns:h="http://java.sun.com/jsf/html"
       xmlns:f="http://java.sun.com/jsf/core">
   
           <ui:define name="top">
               top
           </ui:define>
   
           <ui:define name="body">
           
               <h:form>
                   <h:panelGrid columns="2">
                       <h:outputText value="Title:"/>
                       <h:outputText value="#{filmController.selected.title}" title="Title"/>
                       <h:outputText value="Description"/>
                       <h:outputText value="#{filmController.selected.description}" title="Description"/>
                       <h:outputText value="Genre"/>
                       <h:outputText value="#{filmController.category}"/>
   
                       <h:outputText value="Cast"/>
                       <h:outputText value="#{filmController.actors}"/>
   
   
                       <h:outputText value="Film Length"/>
                       <h:outputText value="#{filmController.selected.length} min" title="Film Length"/>
   
                       <h:outputText value="Language"/>
                       <h:outputText value="#{filmController.language}" title="Film Length"/>
   
                       <h:outputText value="Release Year"/>
                       <h:outputText value="#{filmController.selected.releaseYear}" title="Release Year">
                           <f:convertDateTime pattern="MM/dd/yyyy" />
                       </h:outputText>
                       <h:outputText value="Rental Duration"/>
                       <h:outputText value="#{filmController.selected.rentalDuration}" title="Rental DUration"/>
                       <h:outputText value="Rental Rate"/>
                       <h:outputText value="#{filmController.selected.rentalRate}" title="Rental Rate"/>
                       <h:outputText value="Replacement Cost"/>
                       <h:outputText value="#{filmController.selected.replacementCost}" title="Replacement Cost"/>
                       <h:outputText value="Rating"/>
                       <h:outputText value="#{filmController.selected.rating}" title="Rating"/>
                       <h:outputText value="Special Features"/>
                       <h:outputText value="#{filmController.selected.specialFeatures}" title="Special Features"/>
                       <h:outputText value="Last Update"/>
                       <h:outputText value="#{filmController.selected.lastUpdate}" title="Last Update">
                           <f:convertDateTime pattern="MM/dd/yyyy HH:mm:ss" />
                       </h:outputText>
                   </h:panelGrid>
                   <br/>
                   <br/>
                   <h:commandLink action="#{filmController.prepareList}" value="View All List"/>
                   <br/>
               </h:form>
   
           </ui:define>
       </ui:composition>
   </html>

   browse.xhtml と index.xhtml が同じページテンプレートを使用していることが確認できます。

8. 変更を保存します。