レポーターとは

レポーターは、MATLAB^® Report Generator™ レポートオブジェクトに追加されると書式設定済みコンテンツを生成する MATLAB オブジェクトです。MATLAB Report Generator には、タイトルページ、目次、章、節、図、および MATLAB 変数の値など、共通のレポートコンポーネントを生成するためのレポーターが用意されています。これらのレポーターのコンテンツと外観はカスタマイズできます。独自のレポーターを作成することもできます。組み込みレポート API オブジェクトの一覧については、次の MATLAB コマンドを入力します。

help mlreportgen.report

レポーターと DOM オブジェクト

レポーターに加えて、MATLAB Report Generator には、レポートのコンテンツを生成するための別の一連のオブジェクトが用意されています。これらのオブジェクトはドキュメントオブジェクトモデル (DOM) オブジェクトです。HTML、Word、およびその他のドキュメント作成ソフトウェアによって使用されるドキュメントのモデルを実装します。モデルは、テキスト文字列、段落、イメージ、およびテーブルなど、ドキュメント内に共通して見つかるオブジェクトの階層としてドキュメントを定義します。DOM API には、これらの基本的なドキュメントオブジェクトを生成するソフトウェアのオブジェクトが含まれます。DOM オブジェクトの一覧については、次の MATLAB コマンドを入力します。

help mlreportgen.dom

一方、レポーターは、タイトルページ、目次、章など、大まかなドキュメント構造を作成します。これらは多くのタイプのドキュメントに見られますが、すべてのタイプに見られるわけではありません。レポーターの利点は、単一のレポーターで DOM オブジェクトを多数必要とするコンテンツを作成できることです。ただし、Report Generator プログラムには一般的に DOM とレポーターの両方のオブジェクトが必要です。たとえば、章のレポーターはレポートの章のタイトルとページレイアウトを生成しますが、そのコンテンツは生成しません。DOM API には、レポーターのコンテンツの作成に使用できるテキスト、段落、テーブル、リスト、イメージ、およびその他のオブジェクトが用意されています。

次の MATLAB プログラムは、レポーターと DOM の両方のオブジェクトを使用した PDF レポートの作成を示しています。このプログラムは、DOM Text オブジェクトを使用して、章にテキストのブロックを追加します。この例に含まれるその他のオブジェクト (Report、TitlePage、TableOfContents、Chapter) は、すべてレポーターオブジェクトです。

rpt = mlreportgen.report.Report('myreport','pdf');
append(rpt,mlreportgen.report.TitlePage('Title','My Report',...
   'Author','Myself'))
append(rpt,mlreportgen.report.TableOfContents)
ch = mlreportgen.report.Chapter('Title','Sample Text');
append(ch,mlreportgen.dom.Text...
   ('Here is sample text using a DOM Text object.'))
append(rpt,ch)
close(rpt)
rptview(rpt)

Title page of the report with the title "My Report", the author "Myself", and the date

Table of contents listing one chapter

Chapter one has the title "Sample Text" and the text, "here is sample text using a DOM Text object".

レポーター要素

レポーターには一般的に次の要素が含まれます。

外観、固定コンテンツおよび、レポーターで生成される動的コンテンツのホールを定義するテンプレートドキュメント。レポーターには通常、一連のテンプレートファイルが、サポートされる次の出力タイプに対して 1 つ用意されています: Word、PDF、および HTML。各テンプレートファイルには、そのコンテンツを書式設定するレポーターが使用するテンプレートのライブラリが含まれます。たとえば、レポート API TitlePage レポーターは、TitlePage という名前のテンプレートを使用してタイトルページを書式設定します。TitlePage テンプレートは、そのテンプレートファイルのテンプレートライブラリに保存されます。このテンプレートを変更してタイトルページを再配置したり、タイトルページにコンテンツを追加することができます。詳細については、テンプレートを参照してください。
レポーターによって生成された動的なコンテンツを指定するプロパティ。これらのプロパティはレポーターテンプレートのホールに対応します。レポーターは、対応するプロパティの値でテンプレートホールを埋めます。
レポーターを作成および操作するために使用するレポーターのプロパティとメソッドを定義する MATLAB クラス。レポーターのクラス名は、接頭辞 mlreportgen.report で始まります。たとえば、タイトルページレポーターは mlreportgen.report.TitlePage です。スクリプトまたは関数の先頭にこのステートメントを挿入することによって、MATLAB スクリプトまたは関数の接頭辞を省略できます。
```
import mlreportgen.report.*
```
同様に、import mlreportgen.dom.* を含めることで DOM クラスの省略名を使用できます。
レポータークラスのインスタンスとしてレポーターオブジェクトを作成するコンストラクターメソッド。コンストラクターの名前はクラスの名前と同じです。
レポートによって生成されたコンテンツを含む DOM オブジェクト。このオブジェクトはレポーターの実装と呼ばれます。各レポーターには、実装オブジェクト (一般的に DOM DocumentPart オブジェクト) を作成する getImpl メソッドがあります。

MATLAB プログラムでのレポーターの使用

レポートプログラムでコンテンツを生成するには、次の手順に従います。

これらの手順で説明されているプログラムの例は、タイトルページのみを含むシンプルなドキュメントを作成します。ただし、この手順はレポート全体を作成するためのタスクを示しています。プログラム全体のリストは手順の説明の後に示されます。

レポートオブジェクトの作成

レポートオブジェクト (mlreportgen.report.Report) を作成して、レポートによって生成されたコンテンツを含めます。レポートオブジェクトは、レポーターによって生成されてレポートに追加されるコンテンツを DOM Document オブジェクトを使用して保持します。このコードはレポート API 名前空間をインポートします。このパッケージでは、コードでクラスの省略名を使用することができます。その後、PDF レポートオブジェクト (rpt) を作成します。

import mlreportgen.report.*
rpt = Report('myReport','pdf');

レポーターのインスタンスの作成

レポータークラスのインスタンスを作成します。つまり、そのコンストラクターを使用してレポーターをインスタンス化します。コンストラクターは作成するレポーターオブジェクトのプロパティを設定することもできます。たとえば、このコードはタイトルページレポーター (tp) を作成して、その Title と Author のプロパティを設定します。

tp = TitlePage('Title','My Report','Author','John Smith');

既存レポーターのプロパティの設定

プログラムがレポーターを作成した後にレポータープロパティを設定するには、プログラムは MATLAB ドット表記を使用します。たとえば、このコードは TitlePage レポーター (tp) の Subtitle および PubDate プロパティを設定します。

tp.Subtitle = 'on My Project';
tp.PubDate = date;

レポートへのレポーターの追加

レポーターを使用してコンテンツを生成するには、レポートプログラムではレポートオブジェクトの append メソッドを使用して、レポートオブジェクトにレポーターを追加しなければなりません。append メソッドは、レポーターの getImpl メソッドを呼び出すことで機能します。getImpl メソッドはレポーターの実装を作成します。その後、append メソッドは、レポートオブジェクトの実装として機能する DOM Document オブジェクトに実装を追加します。append メソッドを使用して、レポートに DOM オブジェクトを追加することもできます。ただし、レポートに別の DOM Document を追加することはできません。

たとえば、このコードはレポート (rpt) にタイトルページレポーター (tp) を追加します。

append(rpt,tp)

レポートオブジェクトを閉じる

レポートプログラムがレポートへのコンテンツの追加を終了したら、レポートオブジェクトの close メソッドを使用してレポートを閉じなければなりません。レポートを閉じてレポートオブジェクトのコンストラクターで指定された PDF などのタイプのドキュメントファイルにレポートコンテンツを書き込みます。

close(rpt)

このコードは、レポート用の完全なプログラムです。これにはタイトルページのみが含まれます。

import mlreportgen.report.*

rpt = Report('myReport','pdf');

tp = TitlePage('Title','My Report',...
    'Author','John Smith');
tp.Subtitle = 'on My Project';
tp.PubDate = date;

append(rpt,tp)
close(rpt)
rptview(rpt)

Report title page with the title "My Report on My Project", the author "John Smith", and the date