ADF ToyStore
- 4: サンプル・アプリケーションの分析 「ビュー層」 -

JSPページとJSTLを使用したビュー層の構築

図47: ToyStoreViewプロジェクトにおける表示に関連するリソースとページ

toystore.viewパッケージには、 ToyStoreResources.propertiesファイルと GlobalErrors.propertiesファイルが含まれています。これらのファイルには、ビュー層ページで使用される翻訳可能な文字列が、デフォルトの言語（英語）で保存されています。 名前に 「_it」および 「_de」が付いている、これらの2つのファイルの別のバージョンには、それぞれ同じ文字列のイタリア語とドイツ語の翻訳が含まれています。

DataBindings.cpxはADFのバインディング・コンテキスト・ファイルで、データ・コントロールに関する定義情報、およびバインディング・コンテナの名前が格納されています。 *UIModel.xmlファイルには、詳細なバインディング・コンテナの定義情報が含まれており、それぞれに含まれているバインディングについて詳しく記述しています。 JDeveloperのアプリケーション・ナビゲータで DataBindings.cpxをクリックし、構造ウィンドウで詳細を調べると、このサンプル・アプリケーションには、 ToyStoreServiceという名前のデータ・コントロールのみが定義されていることがわかります。

モデル・データへのアクセスと反復処理

JSTLおよびそのExpression Languageの概要

図48: EL式に対するコード・インサイト

次の項では、ADF ToyStoreサンプル・アプリケーションのすべてのJSPページで、ADFバインディング層によって公開されるデータを表現するために、JSTLとEL式を使用していることについて確認します。

買い物かご機能の確認

最初に、買い物かごがどのように機能するかを説明します。 /yourcart DataPageは、ビュー層のUI表示のために /WEB-INF/jsp/yourcart.jspページを使用するもので、次のように構成されています。

    <action path="/yourcart"
            className="oracle.adf.controller.struts.actions.DataActionMapping"
            type="toystore.controller.strutsactions.YourCartAction"
            name="DataForm"
            parameter="/WEB-INF/jsp/yourcart.jsp"
            unknown="false">
      <set-property property="modelReference"
                    value="WEB_INF_jsp_yourcartUIModel"/>
      <forward name="reviewcheckout" path="/reviewcheckout.do"/>
    </action>

図49: yourcart.jspのバインディング・コンテナ

実行時には、DataForwardActionのデフォルト動作により、UI表示のために、付随しているJSPページに制御がフォワードされます。 この例では、yourcart.jspページへフォワードするように ShowProductDetailsアクションが構成されています。

ページでは、次の4つのタグ・ライブラリを宣言することから始まっています。

1. Struts Beanタグ・ライブラリ - このタグには bean:という接頭辞が付きます。
2. Struts HTMLタグ・ライブラリ - このタグには html:という接頭辞が付きます。
3. JSTL Coreタグ・ライブラリ - このタグには c:という接頭辞が付きます。
4. ADFタグ・ライブラリ - このタグには adf:という接頭辞が付きます。

Struts Beanタグ・ライブラリを使用すると、便利な <bean:message>タグを利用できます。これを使用すると、 details.title、 cart.addItem、 images.buttons.addtocartなどの文字列キーに基づいて、翻訳テキスト文字列をページに簡単に組み込むすることができます。

Struts HTMLタグ・ライブラリを使用すると、 <html:errors>タグを利用できます。これを使用すると、実行時の処理で発生したすべてのエラーを、標準の方法でページの最上部に簡単に表示できます。

JSTL Coreタグ・ライブラリを使用すると、データ・コレクションを反復処理し、属性値をページに組み込むことができます。このページで使用しているJSTLタグには、次のものがあります。

• <c:choose>、 <c:when>、および <c:otherwise>。これらのものは、 if/ then / else 文のように機能して、買い物かごが空かどうかによって、条件に応じた表示を行います。

    <c:choose>
    <c:when test="${not empty bindings.ShoppingCart.rangeSet}">
     <form action="yourcart.do" method="post">
        <!-- etc. -->
     </form>
    </c:when>
    <c:otherwise>
      <br><br><bean:message key="cart.empty"/>    
    </c:otherwise>
  </c:choose>


• 買い物かご内の商品を反復処理する <c:forEach>、およびこれらの商品の属性を表示する <c:out>。

  <c:forEach var="Row" items="${bindings.ShoppingCart.rangeSet}" >
  <tr bgcolor="#f3f3f3">
    <td>
      <a href="yourcart.do?event=removeItem&id=<c:out value='${Row.Itemid}'/>"
      ><img src="<bean:message key='images.buttons.removefromcart'/>"
      border="0" alt="<bean:message key="cart.removeItem"/>"></a>
    </td>
    <td><c:out value="${Row.Itemid}"/></td>
    <!-- etc. -->
  </tr>
</c:forEach>

ADFタグ・ライブラリは、 <adf:render>タグを利用するために使用しています。このタグを利用すると、言語環境に応じた適切な書式マスクでフォーマットされた属性データを出力できます。ここで利用される書式マスクは、ビジネス・コンポーネントの定義情報の中で指定できます。

図50: 「Your Cart」ページ

買い物かごの中身は、一時的なビュー・オブジェクト行に保持されており、ユーザーが買い物かごに対して商品を追加および削除したときに、プログラムによって移入されることを思い出してください。 このため、前の項の /yourcartの例では、ページの表示処理にデータベース問合せが含まれていません。

バインド変数を使用して問合せの結果を表示するページ

次に、問合せされたデータベース情報を表す、 /showproductdetails DataPageなどのページについて説明します。 /showproductdetails DataPageは、ビュー層のUI表示のために showproductdetails.jspページを使用するもので、次のように構成されています。

<action path="/showproductdetails"
        className="oracle.adf.controller.struts.actions.DataActionMapping"
        type="toystore.controller.strutsactions.ShowProductDetailsAction"
        name="DataForm"
        parameter="/WEB-INF/jsp/showproductdetails.jsp"
        unknown="false">
  <set-property property="modelReference"
                value="WEB_INF_jsp_showproductdetailsUIModel"/>
  <forward name="addToCart" path="/yourcart.do"/>
</action>

DataActionの拡張クラスを用意して、このような initializeModelForPage()メソッドをライフサイクルに追加するよう、カスタマイズしました。 さらに、DataActionの prepareModel()ライフサイクル・フェーズで問合せが実行される前に 、ビュー・オブジェクトの問合せのバインド変数値をセットするように、アクションのメソッドをオーバーライドしました。 これは、追加のライフサイクル・メソッドによって処理が容易になることを示した代表的なユースケースです。

ToyStoreDataForwardActionを見てみると、既存の prepareModel()メソッドをオーバーライドし、イベントを処理していない場合は、最初に initializeModelForPage()をコールするようデフォルト動作を補強することによって、この新しいライフサイクル・メソッドを導入していることがわかります。

/* From: toystore.fwk.controller.ToyStoreDataAction */
  /**
   * Overridden method.
   *
   * Add two new overrideable methods into the ADF DataAction lifecycle as
   * part of the prepareModel() processing to make handling the page
   * initialization use case easier.
   */
  protected void prepareModel(DataActionContext ctx) throws Exception {
    if (!handlingEvents(ctx)) {
      initializeModelForPage(ctx);
    }
    super.prepareModel(ctx);
    if (!handlingEvents(ctx)) {
      initializeBindingsForPage(ctx);
    }
  }

図51: 製品の詳細表示ページ

ADF ToyStoreサンプル・アプリケーションのすべてのJSPページは、この基本的なアプローチに従ってデータの反復処理やフォーマットをしています。

バインディングとJSTLを使用した再利用可能なページング・コントロールの作成

このサンプル・アプリケーションでは、次の3つのページを用意しており、それぞれ検索結果を表示することができます。

• /search - 店全体の製品検索の結果を表示します。
• /showcategory - あるカテゴリの製品を表示します。
• /showproduct - 特定の製品タイプで有効な商品を表示します。

このようなページに対して 1-3 of 18 といった表示で現行のレコード位置を知らせたり、条件に応じて、 Previous や Next のリンクを表示するような、ページング・コントロールを作成し、かつ、再利用可能なものにしたいと考えていました。 これを作成するには、次の情報が必要です。

• データ行の総数
• 現行ページに示される最初の行番号
• 1ページに示される行数

上記の3つのページには、それぞれのバインディング・コンテナ内にレンジ・バインディングが1つ含まれています。 レンジ・バインディングは、データ行を区切られた範囲ごとに表示し、一度に1ページ分（または1つの「範囲」分）データをナビゲートできるよう設計されているADFのバインディング・オブジェクトです。 ユーザーは、イテレータ・バインディングのレンジ・サイズを使って、一度に1ページに表示する行数を設定できます。 レンジ・サイズを -1の値に設定すると、データ・セット内のすべての行が一度に表示されます。

図52: Search ページのバインディング・コンテナ

実行時には、レンジ・バインディングは、JSTLのEL式を介してアクセスできるプロパティを公開します。これらのプロパティによって、関連するイテレータとバインドされているデータ・コレクションの情報が取得できます。 これらのプロパティには、次のものがあります。

• estimatedRowCount - コレクション内の推定行数
• rangeStart - 行の現行範囲の最上位に表示する、ゼロから始まる行番号
• rangeSize - 1ページに表示する行数

search.jspページのソース・コードを見てみると、 pagingControl.jspページを再利用していることがわかります。ここでは、 <jsp:include>を使用し、ネストされている <jsp:param>タグによって、ページで必要なパラメータの組を渡しています。 ここでは、 <c:choose>タグを使用して、 not emptyというELの演算子によって、製品データが見つかったかどうかをテストしています。 製品データが見つからなかった場合は、結果として空の表を示すのではなく、「No matching products」というメッセージを出力します。

    <c:choose>
      <c:when test="${not empty bindings.FindProducts.rangeSet}">
        <jsp:include page="pagingControl.jsp">
          <jsp:param name="rangeBindingName" value="FindProducts"/>
          <jsp:param name="targetPageName" value="search.do"/>
        </jsp:include>
        <table border="0" bgcolor="#003399">
          <!-- etc. -->
        </table>
      </c:when>
      <c:otherwise>
        <br><br><bean:message key="search.nomatchingproducts"/>
      </c:otherwise>
    </c:choose>

pagingControl.jsp では、最初に、レンジ・バインディング・オブジェクトを検索するために必要な "名前" の情報を得るために、次の構文を使用して、渡される引数から rangeBindingNameパラメータの値を取得します。

<c:set var="rangeBinding" value="${bindings[param.rangeBindingName]}"/>

pagingControl.jspでは、EL式を使用してレンジ・バインディングのプロパティを参照し、ページ・コントロールの表示をレンダリングする作業を実行します。 この式では、 ${bindings.SomeRangeBinding}のようなELのドット表記法を使用せずに、角括弧を使用した配列インデックス・スタイルの表記法を使用していることに注意してください。 これによって、（この場合は bindingsオブジェクトに対して）アクセスしようとしているメンバー名を、そのまま名前で提供するのではなく、式値として提供することができます。

通常のフォーム・レイアウト・アプローチを使用したデータ入力フォーム

/editaccount DataPageは、ユーザー・プロファイル情報を編集するためのデータ入力フォームを表示するページを表しています。 これは、使用する各コントロールをHTMLフォーム内に配置するという、通常のJSPページ・レイアウトのアプローチを使用しています。

モデル層データの設定

EditAccountActionは、これまでに説明したアクションと同様に、initializeModelForPage() メソッド内でモデル層を設定します。 ここで、対象のユーザー名を引数として ToyStoreServiceインタフェースのカスタム・サービス・メソッド prepareToEditAccountInfoFor()をコールします。

HTMLフォームのレイアウト

editexistingaccount.jspという名前の、対応するJSPページでは、Struts HTMLタグ・ライブラリから <html:form>タグを使用し、次のようにアクションの宛て先を自分自身のDataPageへ戻る（バック）ように送信（ポスト）することによって、「ポストバック・パターン」を実装します。

<html:form action="/editaccount.do" method="post">

実行時に、Strutsの <html:form>タグは、action属性値である /editaccount.do を参照して、アクション・マッピング情報から、このフォームをレンダリングするために DataFormというFormBeanが使用されていることを判断します。 DataFormフォームBeanは struts-config.xmlで定義されており、ADFの BindingContainerActionFormを使用しています。

ユーザー・アカウント情報の1行のみについて、データ入力フォームをレンダリングしているため、このページではJSTL <c:forEach>を使用する必要はなく、バインディング・コンテナにもレンジ・バインディングは必要ありません。 通常のHTMLテーブル・タグを使用して、単純にそれぞれのフィールドをフォームにフォーマットし、ラベルと入力コントロールを一列に並べています。 このページは、いくつかの有用なテクニックの使用例でもあるため、次にそれぞれの重要なポイントを中心にして説明します。

データページのバインディング・コンテナ

図53: EditAccount ページのバインディング・コンテナ

ToyStoreServiceデータ・コントロールの組込みのCommit操作にバインドされている、 saveというアクション・バインディングもあります。

フォームでの読取り専用のデータの表示

フォームでの入力フィールドの作成

この例では、StrutsのHTMLタグ <html:errors>を使用して、 Password属性に固有の検証エラーを表示していることも表しています。 もちろん、フォームが最初に出力されるときは検証エラーがないため、この表のセルは空になります。 ただし、ユーザーがフォームを送信し、モデル層で検証エラーがスローされた場合は、このページがもう一度出力されるときに、 Passwordに関連するエラーが、画面上の Passwordフィールドの隣に表示されます。 また、このフィールドは必須であることがわかっているため、 <bean:message>タグを使用して、キー dataentryform.mandatoryに対応する文字列によって、このフィールドが入力必須であることをユーザーに示す視覚的なマーカーとして表示しています。 デフォルトでは、アスタリスクが出力されます。

ELを使用したラベル、ツールチップなどの情報の利用

データバインドされたポップリスト・コントロールの配置

図54: ポップリストには、現行の値と有効値のリストの両方がある

ADFには、このように、データ・バインディングの要件に対して複数の局面を持つコントロールを処理するための、より高度なバインディング・オブジェクトが提供されています。 ADFリスト・バインディングは、ポップリスト・タイプのコントロール要件を満たすべく、現行のバインディング属性値と、ユーザーに提示するための有効な選択リストの両方を管理できます。また、階層的なデータに対しては、場合によってはさらに便利に使用できるツリー・バインディング・オブジェクトを提供しています。

メタデータを使用した、より汎用的な手法によるデータ入力フォームの出力

ToyStoreサンプル・アプリケーションには、前に説明した「通常の」テクニックとは異なる、より汎用的なメタデータ駆動の手法でデータ入力フォームを出力するページも含まれています。 これらの2つの手法によるフォームは、両方とも、 Accountsデータに対する同じコントロール・セットを出力するため、2つのアプローチを比較して、自分のアプリケーションに適した方を簡単に選択できます。

「Register New User」ページ

したがって、行われる実際の処理は、 formControl.jspコンポーネント・ページの中にあります。 このページは、現行のバインディング・コンテナのコントロール値バインディングそれぞれに対応するコントロールを持つ、データ入力フォームを作成します。

汎用的なフォーム・コントロール・ページ

このページでは、最初に、 <c:choose>、 <c:if>、および <c:set>タグを使用して、渡されたパラメータの値に応じて、eventName、 buttonLabel、および buttonLabelKeyというページのローカル変数の値を設定するコードで始まっています。 これらのページの変数は、後に、生成されたフォームの下部の 「(Save)」ボタンを構成する際に使用します。

<c:choose>
  <c:when test="${not empty param.saveButtonEvent}">
    <c:set var="eventName" value="${param.saveButtonEvent}"/>
  </c:when>
  <c:otherwise>
    <c:set var="eventName" value="Commit"/>
  </c:otherwise>
</c:choose>
<c:if test="${not empty param.saveButtonLabel}">
  <c:set var="buttonLabel" value="${param.saveButtonLabel}"/>
</c:if>    
<c:if test="${not empty param.saveButtonLabelKey}">
  <c:set var="buttonLabelKey" value="${param.saveButtonLabelKey}"/>
</c:if> 

formControl.jspページは、次に入力フォームの「グローバル・エラー」セクション部分として <html:errors>タグを使用します。ここでは、属性固有ではない全般的なエラーが表示されます。

<center>
  <table border="0">
    <tr>
      <td><html:errors bundle="GlobalErrors"
                       property="<%= ActionErrors.GLOBAL_ERROR %>"/></td>
    </tr>
  </table>
</center>

次にこのフォームは、 <html:form>の開始タグの一部として、 jsp:includeによって渡される dataPageパラメータの値を使用します。 <html:form>タグのアクション属性の中ではEL式を直接使用できないため、 <c:set>を使用して、EL式の値を使用してnameというページ・ローカル変数を設定し、次にJSPスクリプトレットを使用して、このname変数の値を action属性へ渡していることがわかります。

<c:set var="name" value="/${param.dataPage}.do"/>
<html:form action='<%= pageContext.getAttribute("name")%>'>
  <!-- etc. -->
</html:form>

このフォームには、非表示フィールドが含まれています。ADFのコントローラ層はこのフィールドを使用して、ユーザーが連続して同じフォームを何度も送信しようとしたかどうかを判断します。

<input type="hidden" name="<c:out value='${bindings.statetokenid}'/>"
       value="<c:out value='${bindings.statetoken}'/>"/>


コントロール値バインディングの反復処理によるフォームの作成

次に、バインディング・コンテナ内の各コントロール値バインディングに対応するコントロールを作成するループを開始します。 <table>タグの中には、次の <c:forEach>の反復処理があります。

<c:forEach var="curBinding" items="${bindings.ctrlBindingList}">
  <% JUControlBinding cb =
       (JUControlBinding)pageContext.getAttribute("curBinding");
     if (cb instanceof JUCtrlValueBinding &&
       !(cb instanceof JUCtrlRangeBinding) &&
       !(cb instanceof JUCtrlHierNodeBinding)) { %>
   <!-- Build control for current control value binding in here -->
 <% } %>
</c:forEach>

<c:forEach>のループは、バインディング・コンテナ内のコントロール値バインディングのリストを反復処理します。 このリストには、アクション ・バインディングが含まれている可能性があるため、入力コントロールを出力する場合はこれらのバインディングをスキップする必要があります。 ここでは、簡潔にするために、レンジ・バインディングとツリー・バインディングもスキップしています。 EL式の言語には、組込みの instanceofオペレータがないため、JSPスクリプトレットを使用して、通常のJava言語の if文を使用し、 instanceofによるチェックを実行しています。

<c:forEach>タグに var="curBinding"属性を指定したため、フォームの入力コントロールの汎用的な生成処理の一部として、ループ内でこの curBindingループ変数を参照することで、現在のコントロール値バインディングにアクセスすることができます。EL式の中で、 tooltip、 mandatory、 labelなどのバインディング・プロパティを使用して、現在のコントロール・バインディングから情報を取得している様子を確認してください。

<c:forEach var="curBinding" items="${bindings.ctrlBindingList}">
  <% JUControlBinding cb =
       (JUControlBinding)pageContext.getAttribute("curBinding");
     if (cb instanceof JUCtrlValueBinding &&
       !(cb instanceof JUCtrlRangeBinding) &&
       !(cb instanceof JUCtrlHierNodeBinding)) { %>
   <tr>
     <th align="right" title="<c:out value='${curBinding.tooltip}'/>">
       <c:if test="${curBinding.mandatory}">*&nbsp;</c:if>
       <c:out value="${curBinding.label}"/>
     </th>
     <td>
        <c:set var="name" value="bindings.${curBinding.name}"/>
        <adf:inputrender model='<%= pageContext.getAttribute("name")%>'/>
     </td>
     <c:set var="name" value="${curBinding.name}"/>
     <td>
       <html:errors property='<%= pageContext.getAttribute("name") %>'/>
     </td>
   </tr>
 <% } %>
</c:forEach>

HTMLフォーム・コントロールの実際の出力のために、 <adf:inputrender>タグを使用しています。このタグは、現在のバインディングの属性値よって適切なタグを出力します（後で説明しますが、追加の属性メタデータを使用することで、 <adf:inputrender>タグによる出力をカスタマイズすることができます）。 ここでも <c:set>によるテクニックを使用して、文字列 「 bindings.」と現在のバインディングの名前を連結して、 nameというローカル・ページ変数に設定しています。これは、 <adf:inputrender>タグの model属性の値として参照されています。

最後に、 <html:errors>タグを使用して、発生する可能性のある属性レベルの検証エラーを、該当するコントロールの隣に示しています。 ここでも <c:set>のテクニックを使用して、 <html:errors>タグの property属性の値を現在のバインディングの名前に設定しています。

また、 <c:choose>を使用して、適切にラベルが付加された 「(Save)」ボタンをフォームの下部に配置しています。 ユーザーがボタン・ラベル、またはボタン・ラベル・キーを指定したかどうかによって、指定されたラベル文字列を使用するか、または bean:messageタグを使用してラベル・キーを参照するかを決定しています。 ページの上部に設定しているページのローカル変数 eventNameを使用して、ボタンに適切な名前を適用し、これによって、ユーザーがボタンをクリックしたときにイベントを生成しています。

<c:choose>
  <c:when test="${not empty buttonLabel}">
    <input name="event_<c:out value="${eventName}"/>" type="submit"
            value='<c:out value="${buttonLabel}"/>'/>
  </c:when>
  <c:when test="${not empty buttonLabelKey}">
    <input name="event_<c:out value="${eventName}"/>" type="submit"
            value='<bean:message name="buttonLabelKey"/>'>
  </c:when>
  <c:otherwise>
     <input name="event_<c:out value="${eventName}"/>" type="submit"
            value='Submit'/>
  </c:otherwise>                      
</c:choose>

メタデータを使用したカスタムの編集フィールド・レンダラの設定

ADF Business Components は、カスタム・プロパティの設定を機能があります。カスタム・プロパティは実行時に読み込むことが可能で、これを使用してメタデータ駆動の動作を実現することができます。 ADFのエンティティ・オブジェクトとビュー・オブジェクトでは、個々の属性レベルでもカスタム・プロパティを設定できます。

アプリケーションで、このような汎用的なデータ・フォームのレンダリング・テクニックを採用すると、アプリケーション内のすべてのデータ入力フォームで外観を統一し、同じように動作することを簡単に保証できます。これは、すべての入力フォームが汎用的な同じコードによって出力されるためです。

多言語アプリケーションを作成するためのStrutsとADFの機能

JSPページのいくつかの例で、翻訳可能な文字列の使用や、翻訳可能な属性ラベル、ツールチップ、書式マスクへの参照について見てきました。 この項では、StrutsおよびADFのフレームワークが提供する機能による、多言語対応のユーザー・インタフェースをサポートするアプリケーションの作成について簡単に説明します。

Strutsのメッセージ・リソース・ファイルのサポート

Strutsには、標準のJava *.propertiesファイルに格納されている、翻訳済のメッセージを使用するための基本的な機能があります。 デフォルトのメッセージ・リソースに加えて、ユーザー自身でセカンダリ・メッセージ・リソースを定義することもできます。 ADF ToyStoreサンプル・アプリケーションでは、次のメッセージ・ファイルを使用しています。

• デフォルトのStrutsリソース・メッセージ・ファイル
  これは ./ToyStoreView/src/toystore/view/ToyStoreResources.propertiesに格納されています。

• キー GlobalErrorsで特定されるグローバル・エラー用のセカンダリ・リソース・メッセージ・ファイル
  これは ./ToyStoreView/src/toystore/view/GlobalErrors.propertiesに格納されています。

メッセージは、文字列キーとテキスト・メッセージがペアになったプロパティとして格納されています。 たとえば、 ToyStoreResources.propertiesに次の2行があります。

  :
cart.addItem=Add Item to Your Shopping Cart
cart.removeItem=Remove Item from Your Cart
  :

ユーザーは、同じディレクトリ内に、ロケールの接尾辞を付加したファイル名でプロパティ・ファイルを作成して、リソース・ファイルのメッセージの翻訳版を提示することができます。 たとえば、 ToyStoreResources.propertiesのメッセージのイタリア語の翻訳は、同じディレクトリの ToyStoreResources_it.propertiesファイルになります。翻訳版となるメッセージ・リソース・ファイルには、デフォルトの言語と同じ文字列キーで、メッセージ文字列を翻訳したものを含みます。 たとえば、前述の2つのメッセージ（英語版）は、メッセージ・リソース・ファイルのイタリア語版で次のようになります。

  :
cart.addItem=Aggiungi al carrello
cart.removeItem=Togli dal carrello
  :

翻訳が不要なメッセージは、翻訳版のメッセージ・リソース・ファイルで繰り返す必要はありません。 ロケール固有のメッセージ・バンドルでメッセージを見つけられない場合は、デフォルトのメッセージ・リソース・ファイルのものが使用されます。

前述の項のとおり、StrutsのBeanタグ・ライブラリの <bean:message>タグを使用すると、文字列 keyを指定することで、メッセージ・リソース文字列をJSPページに含めることができます。

<bean:message key="cart.addItem"/>

実行時に、Strutsの <bean:message>タグは、一致した最も有効なメッセージ・リソース・ファイルの文字列を返そうとします。 たとえば、ユーザーのロケールがスイス系ドイツ語（Swiss German：de_CH）の場合は、次のようになります。

1. ToyStoreResources_de_CH.propertiesがある場合は、ここから文字列を返します。次に、
2. ToyStoreResources_de.propertiesがある場合は、ここで文字列を検索します。次に、
3. デフォルトのメッセージ・ソース・ファイルから、キーと一致する文字列を返します。

Strutsは、ブラウザが各リクエストで送信したHTTPリクエストのヘッダー・プロパティを参照して、現行ブラウザのユーザーのロケールを推測します。これによってユーザーの注文リストがユーザーの優先言語で表示されます。より詳細に説明すると、Strutsの RequestProcessorを介したそれぞれのリクエストで、 processLocale()メソッドのデフォルトの実装によって、Action.LOCALE_KEY定数で定義されている名前のHTTPセッション属性が存在するかどうかのチェックが行われます。 セッション属性が存在する場合は、処理を続行します。 存在しない場合は、Strutsはロケールを推測し、それを先のセッション属性として保存します。 このようにして、最終的に、Strutsによって1つのセッションにつきブラウザ・ユーザーの言語が1回特定されることになります。

カスタムADF Business Componentsのカスタム・メッセージ・バンドル

ADF Business Componentsのエンティティ・オブジェクトおよびビュー・オブジェクトは、Javaメッセージ・バンドルを関連付けることができます。 このコンポーネント用のメッセージ・バンドルには、ラベル、ツールチップ、書式マスクといった属性レベルのコントロール・ヒントの他に、コンポーネント用の例外メッセージなどの、ロケールによって異なる値を格納できます。 ADFの設計時ウィザードは、設定されるメッセージに対して、 デフォルトの言語用のコンポーネント・メッセージJavaクラスを自動的に作成し、そこで管理します。ユーザーは、名前の最後にロケール固有の接尾辞を付けて、翻訳版のメッセージ・バンドルを作成できます。

ToyStoreサンプル・アプリケーションには、次のような、エンティティ固有の例外メッセージを、文字列の2次元配列として手動で追加しています。

static final Object[][] sMessageStrings = {
    :
  {ErrorMessages.ENTITY_ALREADY_EXISTS,
   "Another user has already chosen this name. Please try another."},
    :
}

Strutsのメッセージ・リソースのプロパティ・ファイルにおいて文字列キーの順序が意味を持たないのと同様に、 Object配列の {String,String}要素の順序も意味がありません。

たとえば、このリソース・バンドルの翻訳バージョンをイタリア語で作成するには、 toystore.model.businessobjects.common パッケージに AccountImplMsgBundle_itクラスを作成します。 簡単な方法としては、

1. AccountImplMsgBundle.javaをコピーして、 AccountImplMsgBundle_it.javaを作成します。
2. 新しい AccountImplMsgBundle_it.javaで、クラスの宣言名を変更し、デフォルトの言語メッセージ・バンドル・クラスを拡張した形に修正します。

   public class AccountImplMsgBundle extends JboResourceBundle

   この行を次のように変更します。

   public class AccountImplMsgBundle_it extends AccountImplMsgBundle

3. 新しい AccountImplMsgBundle_it.javaファイルで、デフォルトのコンストラクタを修正します。

   public AccountImplMsgBundle(){}

   この行を次のように変更します。

   public AccountImplMsgBundle_it(){}

4. ユーザーに表示される文字列をイタリア語で編集します。

メッセージ・バンドル・クラスは、フレームワークのベース・クラスとして用意されている oracle.jbo.common.JboResourceBundleを拡張するため、メッセージの「マージ」機能を継承することができます。 マージは、メッセージ・バンドルの getContents()メソッドから super.getMergedArray()を呼び出したときに実施されます。 これによって、メッセージ・バンドル・クラスには翻訳が必要なメッセージのみを記述し、そのほかのメッセージは、スーパークラスから継承することができます。 メッセージのマージが確実に機能するように、翻訳版のリソース・バンドルには、オーバーライドされた getContents()メソッドも含めるようにします。

モデル層をサポートしているビジネス・サービスは、アクセスしているWeb層からリモートに配置されることもありえるため、モデル層は、ユーザーのロケールを、ユーザー・セッションごとに追跡します。 ADFBindingFilterも、同じような言語の優先機能を実装しており、ADFバインディング・コンテキスト上に現在の言語情報を設定します。 そこで、ADFの各データ・コントロールは、そのバインディング・コンテキストのロケールを取得します。

ADF、XSQLページ、XSLTおよびXMLスキーマの連携利用

このカスタム・アクション・ハンドラは、次の構文を使用してXSQLページ・テンプレートの内部で使用することができます。

<xsql:action handler="toystore.fwk.xsql.ADFViewObject" iterator="YourIteratorName"/>

以降の項では、このハンドラの面白い使い方についていくつか説明します。

XMLスキーマ・ダイアグラムによる設計とサービス

たとえば、ユーザーにXMLフォーマットで注文の内容を確認して欲しい場合があります。 これは、ワークフローのような自動化プロセスの一環として使用される場合であり、この方式を使うと、発行した注文の監査をある程度自動化できます。 一般的に、2つのプログラムでXMLをやり取りしなければならない場合は、交換するXMLの構造を記述したXMLスキーマの認識が必要です。その後、実行時に、このスキーマに準拠したXMLドキュメントを交換します。

図57: JDeveloperのXMLスキーマ設計ツールによるToystore Orderスキーマ

このXMLスキーマに準拠した注文確認のXMLデータを提供するために、次の処理を行いました。

1. Strutsページフロー図で /revieworderxml DataPageを作成します。
2. この新しいDataPageノードをダブルクリックし、ビュー層ページの名前として revieworderAsXML.xsqlを指定します。
3. Strutsページフロー図で /revieworderxml DataPageをもう一度クリックし、構造ウィンドウの「UIモデル」タブをクリックします。「<バインディングなし>」と表示されます。
4. 「<バインディングなし>」でマウスを右クリックし、 「UIモデルの作成」を選択します。
5. 作成したバインディング・コンテナ・ノードでマウスを右クリックし、 「バインディングの作成→データ→イテレータ」を選択して、ToyStoreServiceデータ・コントロールの ReviewOrderデータ・コレクションに対するイテレータ・バインディングを作成します。
6. 前の項で作成したカスタム・アクション・ハンドラを使用した <xsql:action>タグをXSQLページに追加し、それに対して、使用するイテレータの名前を指定します。

   <Page xmlns:xsql="urn:oracle-xsql">
  <xsql:action handler="toystore.fwk.xsql.ADFViewObject"
               iterator="ReviewOrderIterator"/>
</Page>

ベースとなる ReviewOrderビュー・オブジェクトには、バインド変数を使用するための問合せがあります。 前の例で行ったように、バインド変数を設定するためには、オーバーライドされた initializeModelForPage()メソッドを使用します。 そのため、 /revieworderxmlに対するDataForwardActionクラスをカスタマイズし、このサンプル・アプリケーションにある ReviewOrderActionクラスを作成しました。このクラスは、具体的には、次のようになります。

package toystore.controller.strutsactions;
import oracle.adf.controller.struts.actions.DataActionContext;

public class ReviewOrderAction extends ToyStoreServiceDataForwardAction {
  /**
   * Model initialization logic for this page.
   */
  protected void initializeModelForPage(DataActionContext ctx) {
    String id = ctx.getHttpServletRequest().getParameter("id");
    getToyStoreService(ctx).prepareToShowReviewOrder(id);
  }
  /**
   * Illustrate using an alternative mechanism, implemented in the
   * base ToyStoreServiceDataForwardAction class, to release all
   * data controls in use by the current binding container in 
   * stateless mode.
   */
  protected boolean releaseStateless() {
    return true;
  }
}

これにより、次のURLを使用して /revieworderxmlデータページにアクセスしようとすると

http://localhost:8988/ADFToyStore/revieworderxml.do?id=1001

最後に、XSQLページ・テンプレートを補強して、このXSLTスタイルシートで、クライアントに返す前にスムーズにXSQLデータページを変換できるようにする必要があります。 このためには、次のように revieworderAsXML.xsqlページの最初に特別な行を追加することが必要です。

<?xml-stylesheet type="text/xsl" href="revieworderASXML.xsl"?>

テンプレートにこの行を追加すると、XMLの注文確認のリクエストによって、次のようなスキーマ準拠のデータグラムが生成されます。

<Order id="1001" xsi:schemaLocation="urn:oracle-toystore-order schemas/Order.xsd"
       xmlns="urn:oracle-toystore-order"
       xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <OrderDate>2004-06-15</OrderDate>
  <OrderTotal>19.98</OrderTotal>
  <OrderedBy>
    <GivenName>Jay</GivenName>
    <FamilyName>Tooey</FamilyName>
  </OrderedBy>
  <Lines>
    <Line id="1">
      <ItemId>EST-27</ItemId>
      <Description>White Dice</Description>
      <Quantity>1</Quantity>
      <UnitPrice>3.99</UnitPrice>
      <LineTotal>3.99</LineTotal>
    </Line>
    <Line id="2">
      <ItemId>EST-18</ItemId>
      <Description>Apollo-13 Rocket</Description>
      <Quantity>1</Quantity>
      <UnitPrice>15.99</UnitPrice>
      <LineTotal>15.99</LineTotal>
    </Line>
  </Lines>
</Order>


XSLTを使用したXMLの変換

ADF ToyStoreのWebサイトで注文を発行すると、ユーザーにはブックマーク可能なリンクが表示され、そこで自分の注文確認ができます。 この /revieworderページを、前述の /revieworderxmlアクションに類似したXSQLテンプレートに関連付けられているDataPageとして設計しました。 モデル層で必要な設定は、前述のXMLを利用した注文確認の例と同じであるため、すでに学習した同じ ReviewOrderActionクラスを再利用できます。この設定のために、Strutsページフロー図で /revieworder DataPageに対して、ダブルクリックして新しいアクション・クラスを作成するのではなく、プロパティ・インスペクタを使用して、 typeプロパティの値を toystore.controller.strutsactions.ReviewOrderAction（前述と同じクラス）に設定しました。

revieworder.xsqlテンプレートは、XSLTスタイルシートの名前が違うことを除けば、前項で学習したものと同じです。

<?xml-stylesheet type="text/xsl" href="revieworder.xsl"?>
<Page xmlns:xsql="urn:oracle-xsql">
  <xsql:set-stylesheet-param name="orderId" value="{@id}"/>
  <xsql:action handler="toystore.fwk.xsql.ADFViewObject"
               iterator="ReviewOrderIterator"/>
</Page>

図58: ADFとXSQLを使用して構築された注文の概要ページ

• 本書はOracle Corporation発行の「Building a Web Store with Struts & ADF Frameworks」を翻訳し、再構成したものです。
• この文書はあくまでも参考資料であり、掲載されている情報は予告なしに変更されることがあります。 万一、誤植などにお気づきの場合は、オラクル社までお知らせください。オラクル社は本書の内容に関していかなる保証もしません。また、本書の内容に関連したいかなる損害についても責任を負いかねます。