HTMLビルダー

HTMLビルダーとは

HTMLビルダーとは、HTMLアダプタにおけるVelocityテンプレートを編集するためのエディタです。

HTMLビルダーは以下の機能を提供しています。
  1. 変数の参照を、マウス操作でVelocityテンプレートに挿入できます。

  2. 処理コンポーネントの結果データの参照を、マウス操作でVelocityテンプレートに挿入できます。

  3. Velocityテンプレート言語(VTL)で定義される繰り返し処理や条件分岐処理の入力支援を行います。

HTMLビルダーの起動と終了

HTMLビルダーの起動方法

HTMLアダプタのアイコンをダブルクリックすると、HTMLビルダー編集画面がタブ画面として起動します。

HTMLビルダーの終了方法

HTMLビルダー編集画面にある「×」ボタンを押下すると終了します。

HTMLビルダーの画面構成




画像内の番号 画面名 説明 備考
(1) 入力元 入力データのスキーマ、スクリプト変数、コンポーネント変数がツリー表示されます。
  • 入力データのスキーマの編集については、Mapperの「スキーマ編集」を参照してください。
  • HTMLビルダーではMapperと異なり、プロジェクト保存時にHTMLビルダーで編集したスキーマを保存することはできません。
(2) テンプレートエリア Velocityテンプレートを記述します。
変数・入力データの参照、および繰り返し処理・条件分岐処理の構文はカラーリングされて表示されます。
 
(3) ツールパレット 「入力データの追加」と「繰り返し処理の挿入」「条件分岐処理の挿入」に関するツールが表示されます。
テンプレートエリアにドラッグ&ドロップすることで、それぞれのツールを起動することができます。
 

開発手順について

HTMLビルダーの開発手順を「HTMLファイル生成処理」を使用した例で説明します。
  1. HTMLファイル生成処理アイコンをスクリプトキャンバスに配置します。

  2. アイコンをダブルクリックすると、HTMLビルダー編集画面が開きます。
    詳細については、「HTMLビルダーの起動と終了」を参照してください。

  3. HTMLビルダー編集画面で、変数の参照をVelocityテンプレートに追加します。
    詳細については、「変数の使用方法」を参照してください。


  4. HTMLビルダー編集画面で、入力データを追加します。
    詳細については、「入力データの追加・削除」を参照してください。


  5. スキーマが自動生成されないアダプタの場合にはスキーマを設定します。
    詳細については、「スキーマ編集」を参照してください。

  6. HTMLビルダー編集画面で、入力データを用いた繰り返し処理をVelocityテンプレートに追加します。
    詳細については、「入力データを用いた繰り返し処理の挿入」を参照してください。


  7. HTMLビルダー編集画面で、変数や入力データを用いた条件分岐処理をVelocityテンプレートに追加します。
    変数を用いた条件分岐処理については、「変数の使用方法」を参照してください。
    入力データを用いた条件分岐処理については、「入力データを用いた条件分岐処理の挿入」を参照してください。

    条件分岐処理の挿入直後


    条件分岐処理の修正後

  8. HTMLを整えて完成です。

入力データの使用方法

以下の表記により、DataSpiderにて使用される結果データに対する参照をVelocityコンテキストに渡すことができます。
表記 説明
$component.<処理コンポーネント名> <処理コンポーネント名>で示される処理コンポーネントの結果データに対応したオブジェクトが返されます。

入力データの型による違い

入力データがテーブルモデル型データ・XML型データのいずれかによって、Velocityコンテキストに渡されるオブジェクトが異なります。そのため、入力データの型によって、繰り返し処理や条件分岐処理の記述が異なります。

XML型データ

XML型の入力データの場合、JDOMドキュメントに変換して扱われます。「$component.<処理コンポーネント名>」の書式で記述することで、JDOMドキュメントのルート要素を取得できます。
JDOMについては、「jdom.org」(http://www.jdom.org/)を参照してください。

テーブルモデル型データ

テーブルモデル型の入力データの場合、「$component.<処理コンポーネント名>.rows」の書式で記述することで、行に関するCollectionオブジェクトを取得できます。
メソッド名 引数 返り値の型 説明
rows なし Collection 各行にアクセスするためのCollectionオブジェクトです。

また、行オブジェクトには以下のメソッドが実装されています。
メソッド名 引数 返り値の型 説明
getColumnValue int Column インデックスを指定して列オブジェクトを取得します。
getColumnCount なし int 行に含まれる列数を返します。
getColumnData なし Column[] 行オブジェクトに含まれる列オブジェクトの配列を返します。

列オブジェクトには以下のメソッドが実装されています。
また列オブジェクト自体は、getStringValueと等しい文字列表現を返します。
メソッド名 引数 返り値の型 説明
getData なし Object 列の入力値をそのまま返します。
getStringValue なし String String型としての値
getIntegerValue なし Integer Integer型としての値
getLongValue なし Long Long型としての値
getShortValue なし Short Short型としての値
getFloatValue なし Float Float型としての値
getDoubleValue なし Double Double型としての値
getBigDecimalValue なし BigDecimal BigDecimal型としての値
getBooleanValue なし Boolean Boolean型としての値

入力データの追加・削除

HTMLビルダーの入力データ

HTMLビルダーでは、ほかの書き込み処理アダプタやMapperなどとは異なり、Velocityテンプレートの内容に基づき、動的に入力データの追加・削除が行われます。

入力データの追加

入力データの追加を行います。
  1. 以下のいずれかの操作を行い、「入力データの追加」画面を開きます。
  2. 「入力データの追加」画面の[入力データ]に追加するデータを選択して[完了]ボタンを押下します。



    [次へ]ボタンを押下することで、追加したデータを用いた繰り返し処理や条件分岐処理を挿入することもできます。

  3. テンプレートエリアに「$component.<処理コンポーネント名>」と記述され、入力データが追加されます。
    テンプレートエリアに示されるVelocityテンプレートに手動で「$component.<処理コンポーネント名>」と記述して入力データを追加することもできます。
入力データの追加を行うと、デザイナのデータフローおよび入力元ツリーが自動的に更新されます。

入力データの削除方法

テンプレート中から「$component.<処理コンポーネント名>」の記述をすべて削除することで入力データが削除され、デザイナのデータフローおよび入力元ツリーが自動的に更新されます。

入力データを用いた繰り返し処理の挿入

入力データを用いた繰り返し処理の挿入を行います。
  1. 以下のいずれかの操作を行い、「繰り返し処理の挿入」画面を開きます。
  2. 「繰り返し処理の挿入」画面の[対象データ]から繰り返し処理の対象とするデータを選択して[次へ]ボタンを押下します。



    「入力データ」ツリーから繰り返し処理の対象とするデータのノードをテンプレートエリアにドラッグ&ドロップして「繰り返し処理の挿入」画面を開いた場合は、本手順は必要ありません。

  3. 「繰り返し処理の挿入」画面で繰り返し処理の展開形式を選択して[完了]ボタンを押下します。

入力データを用いた条件分岐処理の挿入

入力データを用いた条件分岐処理の挿入を行います。
  1. 以下のいずれかの操作を行い、「条件分岐処理の挿入」画面を開きます。
  2. 「条件分岐処理の挿入」画面の[対象変数/データ]から条件分岐処理の対象とするデータを選択して[完了]ボタンを押下します。

入力元の「入力データ」ツリーから条件分岐処理の対象とするデータのノードをテンプレートエリアにドラッグ&ドロップし、表示されたメニューの[条件分岐処理の挿入]を選択して、条件分岐処理を追加することもできます。

変数の使用方法

以下の表記により、DataSpider Servistaにて使用される変数に対する参照をVelocityコンテキストに渡すことができます。

種類 表記 説明
スクリプト変数 $script.<スクリプト変数名> <スクリプト変数名>で示されるスクリプト変数の文字列表現を返します。
$start.<XML型スクリプト入力変数名> <XML型スクリプト入力変数名>で示されるスクリプト変数のXMLデータを返します。
使用方法については、「XML型データ」を参照してください。
$component.<XML型スクリプト入力変数名>
コンポーネント変数 $property.<処理コンポーネント名>.<コンポーネント変数名> <処理コンポーネント名>と<コンポーネント変数名>で示されるコンポーネント変数の文字列表現を返します。

環境変数は使用できません。
変数については、「変数」を参照してください。

コンポーネント変数

コンポーネント変数とは、各コンポーネントで取得できる変数です。
アダプタの結果を用いて、後続の処理を切り替えたい時に使用します。
取得できる値はコンポーネントによって異なります。詳細については、各アダプタのヘルプを参照してください。

HTMLビルダーでは、Velocityテンプレートに対して「コンポーネント変数の挿入」や「コンポーネント変数を対象とした条件分岐処理の挿入」を行うことができます。

コンポーネント変数の挿入

コンポーネント変数の挿入を行います。
  1. テンプレートエリアの右クリックメニュー[コンポーネント変数の挿入]を選択し、「コンポーネント変数の挿入」画面を開きます。

  2. 「コンポーネント変数の挿入」画面の[コンポーネント変数]に挿入する変数を選択し、[完了]ボタンを押下します。

入力元の「コンポーネント変数」ツリーから挿入するコンポーネント変数をテンプレートエリアにドラッグ&ドロップし、表示されたメニューの[コンポーネント変数の挿入]を選択することで、コンポーネント変数を挿入することもできます。

コンポーネント変数を用いた条件分岐処理の挿入

コンポーネント変数を用いた条件分岐処理の挿入を行います。
  1. 以下のいずれかの操作を行い、「条件分岐処理の挿入」画面を開きます。
  2. 「条件分岐処理の挿入」画面の[対象変数/データ]に条件分岐処理の対象とするコンポーネント変数を選択して[完了]ボタンを押下します。

入力元の「コンポーネント変数」ツリーから挿入するコンポーネント変数をテンプレートエリアにドラッグ&ドロップし、表示されたメニューの[条件分岐処理の挿入]を選択することで、条件分岐処理を挿入することもできます。

スクリプト変数

スクリプト変数とは、デザイナで作成可能な変数です。
データを一時的に格納し、後続の処理で使いたい時に使用します。

HTMLビルダーでは、Velocityテンプレートに対して「スクリプト変数の挿入」や「スクリプト変数を対象とした条件分岐処理の挿入」を行うことができます。

スクリプト変数の挿入

スクリプト変数の挿入を行います。
  1. テンプレートエリアの右クリックメニュー[スクリプト変数の挿入]を選択し、「スクリプト変数の挿入」画面を開きます。

  2. 「スクリプト変数の挿入」画面の[スクリプト変数]に挿入する変数を選択し、[完了]ボタンを押下します。

入力元の「スクリプト変数」ツリーから挿入するスクリプト変数をテンプレートエリアにドラッグ&ドロップし、表示されたメニューの[スクリプト変数の挿入]を選択することで、スクリプト変数を挿入することもできます。

スクリプト変数を用いた条件分岐処理の挿入

スクリプト変数を用いた条件分岐処理の挿入を行います。
  1. 以下のいずれかの操作を行い、「条件分岐処理の挿入」画面を開きます。
  2. 「条件分岐処理の挿入」画面の[対象変数/データ]に条件分岐処理の対象とするスクリプト変数を選択して[完了]ボタンを押下します。

入力元の「スクリプト変数」ツリーから挿入するスクリプト変数をテンプレートエリアにドラッグ&ドロップし、表示されたメニューの[条件分岐処理の挿入]を選択することで、条件分岐処理を挿入することもできます。

仕様制限

注意事項