第3章 基本情報

手順3.1 タスク

1. 新しい Smooks 設定を作成します。これは、<xxx> 要素の visitBefore および visitAfter イベントでビジターロジックを適用するために使用されます。
2. visitBefore および visitAfter イベントのロジックをイベントストリーム全体の特定の要素に適用します。ビジターロジックは、<xxx> 要素のイベントに適用されます。
3. FreeMarker で Smooks を使用して、巨大なメッセージに XML から XML への変換を実行します。
4. 次のソース形式を挿入します。

   <order id='332'>
       <header>
           <customer number="123">Joe</customer>
       </header>
       <order-items>
           <order-item id='1'>
               <product>1</product>
               <quantity>2</quantity>
               <price>8.80</price>
           </order-item>
   Â 
           <!-- etc etc -->
   Â 
       </order-items>
   </order>
   

5. このターゲット形式を挿入します。

   <salesorder>
       <details>
           <orderid>332</orderid>
           <customer>
               <id>123</id>
               <name>Joe</name>
           </customer>
       <details>
       <itemList>
           <item>
               <id>1</id>
               <productId>1</productId>
               <quantity>2</quantity>
               <price>8.80</price>
           <item>        
    
           <!-- etc etc -->
    
       </itemList>
   </salesorder>
   

6. 次の Smooks 設定を使用します。

   <?xml version="1.0"?>
   <smooks-resource-list xmlns="http://www.milyn.org/xsd/smooks-1.1.xsd"
                         xmlns:ftl="http://www.milyn.org/xsd/smooks/freemarker-1.1.xsd">
    
       <!--
       Filter the message using the SAX Filter (i.e. not DOM, so no
       intermediate DOM for the "complete" message - there are "mini" DOMs
       for the NodeModels below)....
       -->
       <params>
           <param name="stream.filter.type">SAX</param>
           <param name="default.serialization.on">false</param>
       </params>
    
       <!--
       Create 2 NodeModels.  One high level model for the "order"
       (header etc) and then one per "order-item".
    
       These models are used in the FreeMarker templating resources
       defined below.  You need to make sure you set the selector such
       that the total memory footprint is as low as possible.  In this
       example, the "order" model will contain everything accept the
       <order-item> data (the main bulk of data in the message).  The
       "order-item" model only contains the current <order-item> data
       (i.e. there's max 1 order-item in memory at any one time).
       -->
       <resource-config selector="order,order-item">
           <resource>org.milyn.delivery.DomModelCreator</resource>
       </resource-config>
    
       <!--
       Apply the first part of the template when we reach the start
       of the <order-items> element.  Apply the second part when we
       reach the end.
    
       Note the <?TEMPLATE-SPLIT-PI?> Processing Instruction in the
       template.  This tells Smooks where to split the template,
       resulting in the order-items being inserted at this point.
       -->
       <ftl:freemarker applyOnElement="order-items">
           <ftl:template><!--<salesorder>
       <details>
           <orderid>${order.@id}</orderid>
           <customer>
               <id>${order.header.customer.@number}</id>
               <name>${order.header.customer}</name>
           </customer>
       </details>
       <itemList>
           <?TEMPLATE-SPLIT-PI?>
       </itemList>
   </salesorder>--></ftl:template>
       </ftl:freemarker>
    
       <!--
       Output the <order-items> elements.  This will appear in the
       output message where the <?TEMPLATE-SPLIT-PI?> token appears in the
       order-items template.
       -->
       <ftl:freemarker applyOnElement="order-item">
           <ftl:template><!--        <item>
               <id>${.vars["order-item"].@id}</id>
               <productId>${.vars["order-item"].product}</productId>
               <quantity>${.vars["order-item"].quantity}</quantity>
               <price>${.vars["order-item"].price}</price>
           </item>
           --></ftl:template>
       </ftl:freemarker>
    
   </smooks-resource-list>
   

7. このコードを使用して、実行します。

   Smooks smooks = new Smooks("smooks-config.xml");
   try {
       smooks.filterSource(new StreamSource(new FileInputStream("input-message.xml")), new StreamResult(System.out));
   } finally {
       smooks.close();
   }
   

8. その結果、XML から XML への変換が行われます。

手順3.2 タスク

• コア設定 namespace によって namespace の接頭辞から URI へのマッピングを設定し、次の XML コードを変更して、使用する namespace を含めます。

  <?xml version="1.0"?>
  <smooks-resource-list xmlns="http://www.milyn.org/xsd/smooks-1.1.xsd"
      xmlns:core="http://www.milyn.org/xsd/smooks/smooks-core-1.3.xsd">
  
      <core:namespaces>
          <core:namespace prefix="a" uri="http://a"/>
          <core:namespace prefix="b" uri="http://b"/>
          <core:namespace prefix="c" uri="http://c"/>
          <core:namespace prefix="d" uri="http://d"/>
      </core:namespaces>
  
      <resource-config selector="c:item[@c:code = '8655']/d:units[text() = 1]">
          <resource>com.acme.visitors.MyCustomVisitorImpl</resource>
      </resource-config>
  
  </smooks-resource-list>
  

1. Smooks 内から DomModelCreator を設定して、order および注文品目メッセージフラグメントのモデルを作成します。以下の例を参照してください。

   <resource-config selector="order,order-item">
       <resource>org.milyn.delivery.DomModelCreator</resource>
   </resource-config>
   

2. 次のように、order のメモリー内モデルを設定します。

   <order id='332'>
        <header>
            <customer number="123">Joe</customer>
        </header>
        <order-items />
   </order>
   

   注記
   新しいモデルごとに前のモデルが上書きされるため、一度に複数の 注文品目 モデルがメモリーに存在することはありません。

1. Smooks.filterSource プロセスの最後に Bean コンテキストのコンテンツを返すには、Smooks.filterSource メソッドの呼び出しで org.milyn.delivery.java.JavaResult オブジェクトを指定します。この例は、次の方法を示しています。

    //Get the data to filter
   StreamSource source = new StreamSource(getClass().getResourceAsStream("data.xml"));
   
   //Create a Smooks instance (cachable)
   Smooks smooks = new Smooks("smooks-config.xml");
   
   //Create the JavaResult, which will contain the filter result after filtering
   JavaResult result = new JavaResult();
   
   //Filter the data from the source, putting the result into the JavaResult
   smooks.filterSource(source, result);
   
   //Getting the Order bean which was created by the Javabean cartridge
   Order order = (Order)result.getBean("order");
   

2. 起動時に Bean コンテキストにアクセスするには、これを BeanContext オブジェクトで指定します。 getBeanContext() メソッドで ExecutionContext から取得できます。
3. BeanContext からオブジェクトを追加または取得する場合は、まず、beanIdStore から beanId オブジェクトを取得してください。(beanId オブジェクトは、文字列キーもサポートされていますが、文字列キーよりも高いパフォーマンスを保証する特殊なキーです。)
4. getbeanIdStore() メソッドを使用して、ApplicationContext から beanIdStore を取得する必要があります。
5. beanId オブジェクトを作成するには、 register("beanId name") メソッドを呼び出します。(beanId がすでに登録されていることがわかっている場合は、 getbeanId("beanId name") メソッドを呼び出すと、取得できます)。
6. beanId オブジェクトは ApplicationContext スコープのオブジェクトです。それらをカスタムビジター実装の初期化メソッドに登録してから、ビジターオブジェクトにプロパティーとして配置します。その後、それらを visitBefore および visitAfter メソッドで使用できます。(beanId オブジェクトと beanIdStore はスレッドセーフです。)

• API に見られるように、複数の結果インスタンスを Smooks に提供します。

  public void filterSource(Source source, Result... results) throws SmooksException
  

  注記
  Smooks は、同じタイプの複数の結果インスタンスからの結果データの取得をサポートしていません。たとえば、 Smooks.filterSource メソッド呼び出しで複数の StreamResult インスタンスを指定できますが、Smooks は、これらの StreamResult インスタンスのうち 1 つ (最初の 1 つ) のみに出力します。

1. Smooks から実行レポートを取得するには、レポートを生成するように、ExecutionContext クラスを設定する必要があります。(Smooks は、メッセージを処理する際、イベントを発行します。) 次のサンプルコードは、HTML レポートを生成するように、Smooks を設定する方法を示しています。

   Smooks smooks = new Smooks("/smooks/smooks-transform-x.xml");
   ExecutionContext execContext = smooks.createExecutionContext();
   
   execContext.setEventListener(new HtmlReportGenerator("/tmp/smooks-report.html"));
   smooks.filterSource(execContext, new StreamSource(inputStream), new StreamResult(outputStream));
   

2. HtmlReportGenerator 機能を使用すると、デバッグ時に役立ちます。
   注記
   Web ページ http://www.milyn.org/docs/smooks-report/report.html でサンプルレポートを確認できます。
   注記
   また、カスタムの ExecutionEventListener 実装を作成できます。

1. メッセージの最後に到達する前に、Smooks フィルタリングプロセスを終了するには、<core:terminate> 設定を Smooks 設定に追加します。(これは SAX で機能し、DOM では必要ありません。)
   メッセージの顧客フラグメントの最後でフィルタリングを終了する設定例は次のとおりです。

   <smooks-resource-list xmlns="http://www.milyn.org/xsd/smooks-1.1.xsd" 
      xmlns:core="http://www.milyn.org/xsd/smooks/smooks-core-1.3.xsd">
   
       <!-- Visitors... -->
       <core:terminate onElement="customer" />
   
   </smooks-resource-list>

2. メッセージの先頭で終了するには (visitBeforeイベント)、次のコードを使用します。

   <smooks-resource-list xmlns="http://www.milyn.org/xsd/smooks-1.1.xsd" 
      xmlns:core="http://www.milyn.org/xsd/smooks/smooks-core-1.3.xsd">
   
      <!-- Visitors... -->
   
      <core:terminate onElement="customer" terminateBefore="true" />
   
   </smooks-resource-list>

1. 次のように、グローバルパラメーターは、<params> 要素で指定されます。

   <params>
       <param name="xyz.param1">param1-val</param>
   </params>
   

2. ExecutionContext でグローバルパラメーターにアクセスします。

   <smooks-resource-list xmlns="http://www.milyn.org/xsd/smooks-1.1.xsd" 
       xmlns:xsl="http://www.milyn.org/xsd/smooks/xsl-1.1.xsd" 
       default-selector="order">
   
       <resource-config>
           <resource>com.acme.VisitorA</resource>
           ...
       </resource-config>
   
       <resource-config>
           <resource>com.acme.VisitorB</resource>
           ...
       </resource-config>
   
   <smooks-resource-list>
   

• フィルタリングオプションを設定するには、smooks-core 設定 namespace を使用します。以下の例を参照してください。

  ;smooks-resource-list xmlns="http://www.milyn.org/xsd/smooks-1.1.xsd" 
     xmlns:core="http://www.milyn.org/xsd/smooks/smooks-core-1.3.xsd">
     <core:filterSettings type="SAX" defaultSerialization="true" 
        terminateOnException="true" readerPoolSize="3" closeSource="true" 
        closeResult="true" rewriteEntities="true" />
  
        .. Other visitor configs etc...
  
  </smooks-resource-list>