この章では Generatorを效果的に使うために必要な Generatorの基本概念と Generatorを利用した文書生成 方法, 配置処理方法に対して調べます.
コードまたは文書のためのテンプレート作成方法は開発者ガイドを参照してください.
StarUML Generatorは StarUMLのモデル要素(UML Model Elements)とテンプレート 文書(Tempate document)を利用してそれぞれ他の形態の産出物(MS Word, MS Excel, MS PowerPoint...)で 生成してくれるアドインです. 使用者自らがいくらでも新しいテンプレートを定義して既存テンプレートを変形して使うことができるように構成されているので, 一つの モデルからさまざまなテンプレートを利用して多様な形態の産出物を易しくて早く生成することができます.
StarUML Generatorは次のような機能たちを提供します.
使用者が直接該当のフォーマットのテンプレートを作成することができます. 別途の複雑なフォーマットデザイナーを使わなくて, doc(ワード派である), xls(エクセル派である), ppt(パワーポイント派である)ファイルがすなわちすぐテンプレートになるので易しく作成することができます.
正義されたテンプレートが使用者の環境や意図によって変数を適用するようにパラメーター指定を提供しています. これを通じてやや小い変化のため いちいちテンプレートを修正しなければならない不便さをとり除いて単純にパラメーターの値段だけ指定することでテンプレートの柔軟性を確保することができるように提供します.
正義されたテンプレートが使用者の環境や意図によって変数を適用するようにパラメーター指定を提供しています. これを通じてやや小い変化のため いちいちテンプレートを修正しなければならない不便さをとり除いて単純にパラメーターの値段だけ指定することでテンプレートの柔軟性を確保することができるように提供します.
プレアンブルと底文部分に情報を入力することができるし, ワード固有のスタイル適用が皆可能になるので使用者が願うすべてのフォーマットのテンプレートを作成する ことがあってすなわちすぐ出力ばかりすれば良い良質の文書生成が可能になります.
エクセルのセルを繰り返してアーキテクチャの各種データを収集して入力することができます. これを通じて測定情報を多様なグラフで表現することができます. また さまざまな基準によるフィルタリングやアライメントを適用することができて分析と報告書に活用することができます.
パワーポイントはスライドをすべて階層で繰り返して生成することができるし, スライドにはダイヤグラム及び各種情報を自由自在で挿入することができます. これを通じて検討回の及び各種プレゼンテーション用産出物たちを自動で生成することができて, 発表のための別途の作業努力を大きく減らすことができる.
テキスト基盤のプログラムコード, XML, HTML などのどんな産出物でもテンプレート基盤で生成することができます.
テンプレートから文書を生成するためには現在作業中のプロジェクトがテンプレートと対応される UML モデルではなければなりません.
ボタンをクリックします. そしてテンプレート因子の値段を願う設定に変更します. (生成因子に対する詳しい内容は
テンプレート登録 > パラメーター情報を参照します) 
使用者が直接作成した自分ばかりのテンプレート文書を Generatorに登録することができます.
ボタンをクリックしてテンプレート情報が保存されられるファイルの位置を選択します.
| 項目 | 説明 |
|---|---|
| Template Name | 登録されるテンプレート人を指定します. |
| Group | テンプレートが属するグループを指定します. 既存にあるグループ外に新しいグループを定義することができます. |
| Category | プロジェクト管理, 要求事項などの分類を指定します. |
| Description | テンプレートの概略的な説明を記述します. |
| 項目 | 説明 |
|---|---|
| Document Type | テンプレートの文書形態を指定します. DOCUMENT(文書), CODE(ソースコード) 中一つを選択します. |
| Format | 文書生成の結果に生成される文書のフォーマットを指定します. |
| Version | テンプレートのバージョン情報を "1.0"のような形式を記録します. |
| Related Profile | テンプレートを適用するモデルに含むプロファイルたちを選択します. |
| Related Approach | テンプレートを適用するモデルの基本接近法を選択します. |
| Translator Type | 文書生成器の種類を明示します. WORD(ワード文書生成器), EXCEL(エクセル文書生成器), POWERPOINT(パワーポイント 文書生成器), TEXT(テキスト文書生成器), COM(COM コンポネント基盤の使用者正義生成器), SCRIPT(スクリプト基盤の 使用者正義生成器), EXE(実行ファイル基盤の使用者正義生成器) 中一つを選択します. |
| Translator | 文書生成器の名前を明示します. ビルトイン文書生成器(WORD, EXCEL, POWERPOINT, TEXT)は指定しないです. 使用者正義生成器は生成器のファイル名を書きます. |
| Example | 文書生成に当たる例題モデルファイルを指定します. |
| Parameters | 文書生成に必要な因子を定義します. |
| Related files | 文書生成に必要な付加的なファイルたちを指定します. |
ボタンをクリックします.
ボタンをクリックして, パラメーターを削除するためには
ボタンをクリックする.
Translator Typeによる基本パラメーターリストを次のように設定します.
| 項目 | タイプ | Translator Type | 説明 |
| TemplateFile | FILENAME or STRING |
WORD,EXCEL, POWERPOINT |
文書生成時に使われるテンプレート文書ファイル名を指定します. |
| OutputFile | FILENAME or STRING |
WORD,EXCEL, POWERPOINT, TEXT |
文書生成の結果に生成されるファイル名を指定します. |
| Keep Comment | BOOLEAN |
WORD,EXCEL, POWERPOINT |
生成された文書内にコマンド情報を残すか可否を指定します. |
| ShowGenerationProcess | BOOLEAN |
WORD,EXCEL, POWERPOINT |
MS Officeに起きる生成過程を見せてくれるか可否を指定します. この項目が true値段に設定されれば生成時パフォーマンスが落ちること あります. |
| Normal Generation | BOOLEAN | WORD | コマンドの相帯経路を最上位プロジェクトと指定します. もし falseに設定されれば現在モデルで選択された要素から相帯経路が 指定されます. |
| Generate Index | BOOLEAN | WORD | 生成された文書内で索引要素を検索して, 文書索引を生成します. |
| intermediate | STRING | TEXT | コード生成に必要な中間コードを保存するファイル名を指定します. |
| target | STRING | TEXT | 生成されるコードファイルがいくつかの場合にコードファイルたちが存在する最上位経路人を指定します. |
ファイル名と係わるパラメーター値段を設定する場合には StarUML Generatorに 明示された定数を使うことができます. 定数には次のようなものなどがあります.
|
名前 |
説明 |
| $PATH$ |
現在テンプレート情報とテンプレートが存在するディレクトリー経路を意味します. (例) $PATH$¥BusinessActorReport.doc |
| $GROUP$ | グループ人を意味します. |
| $CATEGORY$ | 分類人を意味します. |
| $NAME$ | テンプレート人を意味します. |
| $TARGET$ | [Generator] ダイアローグで使用者が指定した文書 生成経路を意味します. |
既存に登録されられたテンプレートを複製して新しいテンプレートを生成することができます.
登録されたテンプレートの情報を見るとか修正することができます.
登録されたテンプレート文書を開いて使用者が願う形態で編集することができます.
List of templatesには Generatorに登録されたすべてのテンプレートたちが羅列されます. もし使用者が特定テンプレートに対して頻繁に 文書生成を遂行しなければならなかったら, このようなテンプレートたちを一つの配置作業で登録して次文書生成時に別途のテンプレート選択過程なしに配置のみを選択して 文書を生成することができるようにしてくれます.
新しい配置作業を作って, 現在選択されたテンプレートを新たに作られた配置作業に登録します.
選択されたテンプレートを既存に存在する配置作業に追加します.
配置を利用して多くの文書の生成を一括的に処理します.
ボタンをクリックします. そしてテンプレート因子の値段を願う設定に変更します. (生成因子に対する詳しい内容は
テンプレート登録 > パラメーター情報を参照します) 
配置作業リストに追加したテンプレートを配置作業リストでまたとり除くことができます.
配置作業を新たに作ることができます.
既存配置作業衣名前と説明情報を修正することができます.
選択された配置作業を削除します.
テンプレートは staruml-generator 下端に設置されられます. staruml-generator 下端に templates フォルダーに StarUML Generatorで使うすべてのテンプレートたちが存在します. また配置作業リストたちも存在します. 一般的に一つのテンプレートは一つの フォルダーの中に係わるすべてのリソースファイルを含んでいるし, すべてのテンプレートフォルダーたちは templates フォルダーのすぐ下に位します. 一つのテンプレートは 二つの種類のファイルで構成されます. 一番目はテンプレート正義技術ファイル(.tdf)とテンプレート文書(.doc, .ppt, .xls, .cot)です. テンプレート正義技術ファイルではテンプレート登録すること > 基本/詳細/パラメーター情報で設定した 内容が保存されているし, テンプレート文書はモデルを持って来て見せてくれるためのコマンドとスタイルを含んでいます. 配置リストは staruml-generator フォルダーの下の batches フォルダーに配置作業ファイル(.btf) 形態で存在します.
staruml-generator モジュールのフォルダーコンフィギュレーションは次のようだ.
staruml-generator¥
templates¥
template1¥
template1.tdf
template1.doc
template2¥
...
batches¥
batch1.btf
...
テンプレートを設置する方法は非常に簡単です. もし他の使用者に自分が作成したテンプレート配布して設置したければ staruml-generator¥templates フォルダーの下で配布するテンプレートを含むフォルダーをコピーして, 設置されるコンピュータの staruml-generator¥templates フォルダーの下の経路に 付けて入れれば設置が終わります.
テンプレートをとり除く方法も非常に簡単です. staruml-generator¥templates フォルダーの下で削除しようとする該当のテンプレート フォルダーを削除すれば設置が除去されます.
配置作業を設置してとり除く方法も非常に簡単です. まず配置作業リストで使われるテンプレートフォルダーを テンプレート設置と除去プロセスによって設置して, staruml-generator¥batches フォルダーの下で願う配置作業(.btf) ファイルをコピーして, 設置されるコンピュータの staruml-generator¥batches フォルダー下にコピーすれば 配置の設置が完了します.
配置作業衣設置除去は staruml-generator¥batches フォルダーの下の .btf ファイルを削除することとして完了します.