レポート・マニフェスト・ファイルは、レポートとその特性を定義します。このファイルは、com.ibm.xtools.publish.uml2¥resources¥reports¥reports.manifest に格納されています。
ReportManifest
レポートの XML タグ。
name
レポートの名前に使用される任意のテキスト・ストリング。この情報は、「レポートの生成」ウィンドウの「名前」フィールド内に表示されます。
description
レポートを説明する任意のテキスト・ストリング。この情報は、レポートへのリンクの説明として、「レポートの生成」ウィンドウの「説明」フィールド内およびレポートの HTML ソース・ページ上で表示されます。
author
レポートの作成者のための任意のテキスト・ストリング。
xsltFile
レポートの生成に使用する変換ファイル。定義済みの変換ファイルは、<install directory>/plugins/com.ibm.xtools.publish_uml2_x_y_z/resources/reports に格納されています。ここで、x_y_z はこのプラグインのバージョン番号です。
oclSelfType
選択されるデータの UML タイプ。
これはオプションのフィールドですが、使用する場合には oclQuery が必須です。UML タイプの例は、「クラス」または「パッケージ」です。
oclQuery
タイプ oclSelfType の要素に対するデータ選択に使用する Object Contraint Language (OCL) 句。これはオプションのフィールドですが、使用する場合には oclSelfType も必須です。
outFileExt
生成されるファイルのファイル拡張子。
USING_ICONS
ダイアグラムにアイコンを含めるかどうかを示すブール属性。
EXTRACTING_DIAGRAMS
ダイアグラムを作成するかどうかを示すブール属性。false の場合、ダイアグラム・レポートはテキストのみです。
DIAGRAM_FORMAT
EXTRACTING_DIAGRAMS が true である場合に、作成するダイアグラム・ファイルで使用するフォーマット。有効な値は、GIF、BMP、JPG、または JPEG です。
DETAIL_LEVEL
含まれる詳細のレベル。有効な値は、すべてを含める FULL または文書のみを含める MIMINUM です。
例
以下の例は、メトリック・レポートの定義に使用される XML を示します。
oclSelfType と
oclQuery のどちらの属性もないため、すべてのデータ要素が含まれます。
USING_ICONS、
EXTRACTING_DIAGRAMS、
DIAGRAM_FORMAT、および
DETAIL_LEVEL の各属性は必須ですが、このタイプのレポートでは使用されません。
<reportManifest name="Sample Metric Report"
description="Sample metric report for the selected model"
author="IBM Rational"
xsltFile="resources/reports/MetricsReport.xsl"
outFileExt="pdf"
USING_ICONS="false"
EXTRACTING_DIAGRAMS="false"
DIAGRAM_FORMAT="JPG"
DETAIL_LEVEL="FULL">
</reportManifest>