帳票ライブラリ¶

リソースの配置と実装¶

リソースの配置例

sample_application/
   ├─ src/
   │   ├─ main/
   │   │   ├─ java/     # java fileなど
   │   │   │   └─ please/
   │   │   │         └─ change/
   │   │   │           ## 中略 ##
   │   │   │
   │   │   └─ resource/
   │   │       ├─ batch/
   │   │       ├─ web/
   │   │       └─ report/    # 帳票テンプレートのルート。FilePathSettingで指定する。
   │   │            ├─ R001/ # REPORT ID = R001用ディレクトリ。ここからは業務コードにて指定。
   │   │            │      ├─ index.jasper     # デフォルトで利用するテンプレート
   │   │            │      └─ userdata.jasper  # テンプレート名指定で利用できるテンプレート
   │   │          ## 後略 ##

実装例

/**
 * R001/index.jsaperテンプレートを利用して帳票を出力する。
 *
 * @param data 帳票に出力するkeyとdataを持つMap
 * @return 出力した帳票ファイルオブジェクト
 **/
private File printReport(Map<String,String> data) {
    // R001配下の帳票テンプレートを利用。テンプレートの指定がないのでindex.jasperを利用する。
    ReportParam param = new ReportParam(data);
    ReportContext ctx = new ReportContext("R001");
    ctx.addReportParam(param);

    return ReportManager.createReport(ctx);
}

/**
 * R001/userdata.jsaperテンプレートを利用して帳票を出力する。
 *
 * @param data 帳票に出力するkeyとdataを持つMap
 * @return 出力した帳票ファイルオブジェクト
 **/
private File printReport(Map<String,String> data) {
    // テンプレートを指定しているのでuserdata.jasperを利用する。
    ReportParam param = new ReportParam("userdata", data);
    ReportContext ctx = new ReportContext("R001");
    ctx.addReportParam(param);

    return ReportManager.createReport(ctx);
}

補足

帳票のテストは出力結果のPDFファイルを目視で確認すること。

コンポーネントファイル定義設定例(report)

<!-- 帳票作成処理コンポーネントの設定 -->
<!-- デフォルトのコンポーネント名は「reportCreator」 -->
<component name="reportCreator" class="nablarch.integration.report.creator.BasicReportCreator">

 <!-- 帳票テンプレートファイル解決コンポーネントの設定 -->
 <property name="reportTemplateResolver">
   <component class="nablarch.integration.report.templateresolver.BasicReportTemplateResolver" />
 </property>

 <!-- 帳票出力処理コンポーネントの設定 -->
 <property name="reportExporter">
   <component class="nablarch.integration.report.exporter.BasicReportExporter">

     <!-- 帳票出力先解決コンポーネントの設定 -->
     <property name="reportOutputResolver">
       <component class="nablarch.integration.report.outputresolver.BasicReportOutputResolver" />
     </property>

   </component>
 </property>
</component>

コンポーネントファイル定義設定例(FilePathSetting)

# 帳票ベースフォルダ
file.path.report=classpath:report

 <component name="filePathSetting"
            class="nablarch.core.util.FilePathSetting" autowireType="None">
  <property name="basePathSettings">
    <map>
      <entry key="report" value="${file.path.report}" />
    </map>
  </property>
</component>