Velocityテンプレート

Velocityテンプレート設定例

「売上データ」を入力データに売り上げデータ一覧をHTML出力する設定例です。
見出しにはスクリプト変数の「集計開始日」「集計終了日」を対象期日として表示し、「売上データ」の取得件数も合わせて表示します。
一覧表示には、「売上データ」の会社名、売上、種別の項目を表形式で表示します。
売上項目の値が下記条件に該当した場合、それぞれの表示形式で表示します。

売上≧1000 の場合：文字色を赤
1000>売上≧100 の場合：文字色を青

入力データの使用方法

以下の表記により、DataSpider Cloudにて使用される結果データに対する参照を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ビルダーの入力元ツリーで編集されたスキーマの保存・読み込みは行われません。
XML型のデータ取得について
- XML型のデータをJDOMのメソッドで取得した場合、エスケープした文字がエスケープしていない状態で取得されます。
  その場合、XML内の対象のデータを「CDATA」で囲むことで回避することができます。

コンポーネント名および変数名の文字制約について

以下の文字を含むコンポーネント名および変数名は使用できません。

文字	説明
	半角スペース
!	半角感嘆符
?	半角疑問符
\	半角円記号
$	半角ドル記号
@	半角アットマーク
%	半角パーセント
&	半角アンパサンド
#	半角ナンバー
*	半角アスタリスク
^	半角ハット
~	半角チルダ
,	半角カンマ
.	半角ピリオド
+	半角プラス
/	半角スラッシュ
\|	半角バーティカルバー
:	半角コロン
;	半角セミコロン
<	半角不等号(より小)
=	半角等号
>	半角不等号(より大)
ｰ	半角長音記号
'	半角引用符
"	半角二重引用符
`	半角バッククォート
(	半角小括弧(始)
)	半角少括弧(終)
{	半角中括弧(始)
}	半角中括弧(終)
[	半角大括弧(始)
]	半角大括弧(終)
「	全角かぎ括弧(始)
」	全角かぎ括弧(終)
・	全角中点

注意事項

{}で囲むコンポーネント名および変数名の表記について
- Velocityテンプレート言語では{}で囲む形式的表記(例:${var} $!{var})が可能ですが、これらの表記は「DataSpider Cloudの変数使用」とみなされVelocity実行前に展開されます。
  したがって、HTMLビルダーのVelocityテンプレートにおいて、${script.スクリプト変数名}や${property.処理コンポーネント名.コンポーネント変数名}と表記することはできません。
- 直後に文字列を表示させるなど、スクリプト変数およびコンポーネント変数に対して{}で囲む表記が必要な場合は、DataSpider Cloudの変数を使用してください。
  例:合計${script.スクリプト変数名}件 → 合計${スクリプト変数名}件
- テンプレートエリアで、「$script.スクリプト変数名」のあとに「.」を記述した場合、スクリプトのビルド時にコンパイルに失敗する場合があります。
  その場合、スクリプト変数の表記部分を「{}」で囲うことで回避することができます。
  例:$script.スクリプト変数名.csv → ${スクリプト変数名}.csv
2バイト文字を含むコンポーネント名および変数名について
- Velocityテンプレート言語では2バイト文字を含む変数名を使用できませんが、HTMLビルダーにおいては、コンポーネント名および変数名に関して2バイト文字を使用することができます。
存在しない変数名について
- 存在しないスクリプト変数名を指定した場合、当該スクリプトのコンパイル時にエラーが発生します。
- 存在しないコンポーネント変数名を指定した場合、コンパイル時エラーとはならず、文字列「null」が出力されます。
コンポーネント名の変更について
- テンプレートエリアで使用しているコンポーネントの名前を変更した場合、スクリプトの実行時にエラーが発生します。
  その場合、テンプレートエリアの記述を変更後のコンポーネント名に変更してください。
コンポーネント名に「(」もしくは「)」が含まれるコンポーネントを入力データに指定することができません。
例:「mapping(1)」

Velocityテンプレート