S-JIS[2013-12-23] 変更履歴

Asakusa Toad Editor Flow Diagram

Asakusa Toad Editorのフローダイアグラム（Flow DSLの図）の説明です。

概要

「フローダイアグラム」は、Flow DSLをToad Editorで表現した図のことです。
フローダイアグラムはジョブフローとフロー演算子の2種類ありますが、ほとんど同じです。

• ジョブフローではインポーター/エクスポーターを配置しますが、フロー演算子では配置しません。
• フロー演算子では値引数を持つことが出来ます。
  • ただし、フロー演算子内の各演算子でその値引数を使うことが出来ませんorz（現状では、Flow DSLを生成した後にJavaソースの方を手で修正するしかありません＞＜）

ファイルの拡張子はジョブフローが「jtoad」、フロー演算子が「ftoad」となります。

※多相データフローには対応していません。

新規ファイル作成

新規のフローダイアグラム（Flow DSL用toadファイル）は以下のようにして作成します。

1. Eclipseのメニューバーで「ファイル(F)」→「新規(N)」→「その他(O)」を選択し、「新規」ダイアログを開きます。
2. 「Asakusa Toad Editor」⇒「ジョブフローダイアグラム」または「フローパートダイアグラム」を選択して「次へ(N)」ボタンを押します。
   
3. 各項目を入力して「完了」ボタンを押します。

   項目	説明	備考
   name	ジョブフロー名	Flow DSLの@JobFlowのname（フロー演算子の場合は入力不要）
   description	フローのタイトル（日本語名）
   class name	フローのクラス名（FQCN）	これを元にtoadファイルのパスが決まる。→ファイルパスのルール

   

図形の配置

パレットの「インポーター」「エクスポーター」や「演算子」を使って図形をエディター上に配置します。
→図形の配置方法・接続（線を引く）方法

フロー情報の編集

エディター上の何も無いところ又はフローの枠をダブルクリックすると、フローの編集ダイアログが開きます。

Basicタブ

フローの基本的な情報を入力します。

Memoタブ

→使用方法説明（共通）のMemoタブ

Portタブ

フローの入出力ポートの情報を入力します。

演算子のPortタブと同様です。

Parameterタブ

フロー演算子の値引数の定義を入力します。

インポーター・エクスポーターの編集

エディター上に配置されているインポーター・エクスポーターの図形をダブルクリックすると、インポーター・エクスポーターの編集ダイアログが開きます。

Basicタブ

インポーター・エクスポーターの基本的な情報を入力します。

「既存クラスから選択」ボタンを押すと、既存のインポーター・エクスポーターのクラスを選択するダイアログが開きます。
そこで選択したクラスの内容がclass name等に入力されます。

「既存データモデルから選択」ボタンを押すと、DMDLファイルに存在するデータモデルを選択することが出来ます。
「新規データモデルを作成」ボタンを押すと、新しいデータモデルをDMDLファイル上に作成し、そのデータモデルを選択することが出来ます。
「連動データモデルを確認」は、編集ダイアログのOKボタンを押したときに連動して変更される図形を確認・選択できます。→Sibling DataModelについて

各行の右端にある「open」ボタンを押すと、編集ダイアログの内容を保存し、該当ファイルを開きます。

Memoタブ

→使用方法説明（共通）のMemoタブ

DataModelタブ

データモデルのレイアウトを確認できます。
（DMDL EditorX（Xtext）の機能を使用する為、初回は表示されるまでに時間がかかります）

DataFileタブ

インポーター・エクスポーターの個別の情報を入力します。

演算子（オペレーター）の編集

エディター上に配置されている演算子（Operator）の図形をダブルクリックすると、演算子の編集ダイアログが開きます。

Basicタブ

演算子の基本的な情報を入力します。

各行の右端にある「open」ボタンを押すと、編集ダイアログの内容を保存し、該当ファイルを開きます。

「既存クラスから選択」ボタンを押すと、既存のOperatorクラスを選択するダイアログが開きます。
そこで選択したクラスがclass nameに入力されます。

「Operator DSLの雛形を表示」ボタンは、ユーザー演算子のみ使用可能です。
現在の編集ダイアログの内容をOperator DSL（Javaのメソッド）にしたらどうなるかを表示します。

※実際のJavaソースの生成はコンテキストメニューから行います。

Memoタブ

→使用方法説明（共通）のMemoタブ

Keyタブ

結合系演算子および集計系演算子のキー情報を入力します。

キー項目を複数入力できます。
（Operator DSLのメソッドの引数に付ける@Keyのgroupに相当します）

ただし、マスター結合演算子（@MasterJoin）と単純集計演算子（@Summarize）はデータモデル（DMDL）でキー項目を指定する為、
キーを変更する際には（DMDL EditorXの）データモデルの変更ウィザードが起動します。

Portタブ

演算子の入出力ポートの情報を入力します。ポートの追加・削除もここで行います。

Parameterタブ

演算子の値引数の情報を入力します。
値引数が指定可能な演算子のみ使用できます。

Attributeタブ

演算子の属性（演算子メソッドのアノテーション）の情報を入力します。
ユーザー演算子のみ使用できます。

ポートの編集

エディター上に配置されている入出力ポートの図形をダブルクリックすると、ポートの編集ダイアログが開きます。

※ポートの追加削除は、ポートの属する図形（フローの枠や演算子）のPortタブで行います。

Basicタブ

ポートの基本的な情報を入力します。

データモデルに関する部分はインポーター・エクスポーターのBasicタブと同様です。

Memoタブ

→使用方法説明（共通）のMemoタブ

DataModelタブ

データモデルのレイアウトを確認できます。
インポーター・エクスポーターのDataModelタブと同様です。

Attributeタブ

ポートの属性（演算子メソッドの引数に使われる際のアノテーション）の情報を入力します。
演算子のAttributeタブと同様です。

Sibling DataModelについて

データモデルを保持する図形（インポーター/エクスポーターやポートおよび一部の演算子）では、
図形を右クリックして開くコンテキストメニューに「View Sibling DataModel」というメニューがあります。
また、その図形の編集ダイアログに「連動データモデルの確認」というボタンがあります。

これは、“同一のデータモデルになるはずである”データモデルの一覧を表示する機能です。
例えば更新演算子（@Update）は入力と出力が同じデータモデルにならないといけません。
また、接続された線の両端は同じデータモデルでないといけません。

「View Sibling DataModel」メニューは、それを確認する為のビューを開きます。

ビュー上の行をクリックすると、エディター上の該当の図形が選択状態になります。

※DataFileはインポーターあるいはエクスポーター、JobPortはフローのポート、OpePortは演算子のポートを意味します。

「連動データモデルの確認」ボタンがある編集ダイアログでは、OKボタンを押して編集内容を保存する際に、
連動するデータモデル（sibling DataModel）を全て「編集ダイアログで指定されたデータモデル」に書き換えます。

ただし、「連動データモデルの確認」ボタンを押すと上記のビューと同等のダイアログが表示され、連動して変更するかどうかを指定することが出来ます。

Flow DSLの生成

フローダイアグラムからFlow DSL（Javaソース）を生成することが出来ます。

1. パッケージエクスプローラー上でフローダイアグラムのtoadファイルを右クリックし、コンテキストメニューの「Asakusa Toad Editor」→「Generate DSL Class」を選択します。