概要 | パッケージ | クラス | 使用 | 階層ツリー | 非推奨 API | 索引 | ヘルプ
前のクラス 次のクラス | フレームあり フレームなし
概要: 入れ子 | フィールド | コンストラクタ | メソッド | 詳細: フィールド | コンストラクタ | メソッド

## jp.terasoluna.toursample.common.action
クラス AbstractReportAction<T>

    java.lang.Object
      org.apache.struts.action.Action
          jp.terasoluna.fw.web.struts.actions.ActionEx
              jp.terasoluna.toursample.common.action.AbstractReportAction<T>

型パラメータ:
  `T` - 帳票出力情報オブジェクト

直系の既知のサブクラス:
  RP_A01_05_01_01Action

    public abstract class AbstractReportAction<T>

extends jp.terasoluna.fw.web.struts.actions.ActionEx

帳票出力起動抽象クラス
PDF形式の帳票を作成し出力を行なう。
帳票生成用のTemplateはJasperReportを利用する。
以下の４つのメソッドを実装することで帳票の生成が出来る。

- getParameterMap(ActionForm, HttpServletRequest)
  - 各帳票に出力される変更可能な固定文字列を取得する。
  固定文字のため、取得が出来なくても帳票は生成される。
- getReportData(ActionForm, HttpServletRequest)
  - 帳票で出力したい情報を取得する。
  帳票出力対象のため、取得が出来ない場合は空の帳票が 生成される
- getTemplatePath(ActionForm, HttpServletRequest)
  - 帳票生成用のTemplateファイルのパスを取得する。
- getFileName(ActionForm, HttpServletRequest)
  - 生成される帳票ファイルのファイル名を取得する。
・共通処理CP0005：帳票出力処理

関連項目:
  `ActionEx`

フィールドの概要

クラス jp.terasoluna.fw.web.struts.actions.ActionEx から継承されたフィールド
`FORWARD_TXTOKEN_ERROR`

クラス org.apache.struts.action.Action から継承されたフィールド
`defaultLocale, servlet`

コンストラクタの概要
`AbstractReportAction()`

メソッドの概要
`org.apache.struts.action.ActionForward` | `doExecute(org.apache.struts.action.ActionMapping mapping, org.apache.struts.action.ActionForm form, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)` 帳票出力を行なう。
`abstract java.lang.String` | `getFileName(org.apache.struts.action.ActionForm form, javax.servlet.http.HttpServletRequest request)` 生成される帳票のファイル名を返す。
`abstract java.util.Map` | `getParameterMap(org.apache.struts.action.ActionForm form, javax.servlet.http.HttpServletRequest request)` パラメータマップを返す。
`abstract java.util.List<T>` | `getReportData(org.apache.struts.action.ActionForm form, javax.servlet.http.HttpServletRequest request)` 帳票出力情報リストを返す。
`abstract java.lang.String` | `getTemplatePath(org.apache.struts.action.ActionForm form, javax.servlet.http.HttpServletRequest request)` テンプレートファイルの相対パスを返す。

クラス jp.terasoluna.fw.web.struts.actions.ActionEx から継承されたメソッド
`addErrors, addMessages, execute, isSaveToken, isTokenCheck, processTokenCheck, setSaveToken, setTokenCheck`

クラス org.apache.struts.action.Action から継承されたメソッド
`addErrors, addMessages, execute, generateToken, getDataSource, getDataSource, getErrors, getLocale, getMessages, getResources, getResources, getServlet, isCancelled, isTokenValid, isTokenValid, resetToken, saveErrors, saveErrors, saveErrors, saveMessages, saveMessages, saveToken, setLocale, setServlet`

クラス java.lang.Object から継承されたメソッド
`clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

コンストラクタの詳細

### AbstractReportAction

    public AbstractReportAction()

メソッドの詳細

### doExecute

    public org.apache.struts.action.ActionForward doExecute(org.apache.struts.action.ActionMapping mapping,
                                                            org.apache.struts.action.ActionForm form,
                                                            javax.servlet.http.HttpServletRequest request,
                                                            javax.servlet.http.HttpServletResponse response)
                                                     throws net.sf.jasperreports.engine.JRException,
                                                            java.io.IOException

  帳票出力を行なう。
  出力される帳票は以下の形式で出力される。
  ・ファイル形式：PDF形式
  ・ファイル名：getFileNameの結果
  複数の帳票を出力する場合、結果ファイルに複数の帳票が生成される。

  定義:
    クラス `jp.terasoluna.fw.web.struts.actions.ActionEx` 内の `doExecute`
  パラメータ:
    `mapping` - アクションマッピング
    `form` - アクションフォーム
    `request` - リクエスト
    `response` - レスポンス
  戻り値:
    遷移処理を行わないため、ヌルを返す。
  例外:
    `net.sf.jasperreports.engine.JRException` - 帳票作成処理で問題が発生した場合
    `java.io.IOException` - Streamの処理で問題が発生した場合

### getParameterMap

    public abstract java.util.Map getParameterMap(org.apache.struts.action.ActionForm form,
                                                  javax.servlet.http.HttpServletRequest request)

  パラメータマップを返す。
  パラメータは帳票出力時、全ての帳票に出力される情報である。

  パラメータ:
    `form` - アクションフォーム
    `request` - リクエスト
  戻り値:
    パラメータマップ

### getReportData

    public abstract java.util.List<T> getReportData(org.apache.struts.action.ActionForm form,
                                                    javax.servlet.http.HttpServletRequest request)

  帳票出力情報リストを返す。
  複数の帳票を出力する場合、その情報をリストとして返す。

  パラメータ:
    `form` - アクションフォーム
    `request` - リクエスト
  戻り値:
    帳票出力情報リスト

### getTemplatePath

    public abstract java.lang.String getTemplatePath(org.apache.struts.action.ActionForm form,
                                                     javax.servlet.http.HttpServletRequest request)

  テンプレートファイルの相対パスを返す。
  相対パスはクラスパスのルートを基準として記述する。
  ※ 注意点：クラスパス上ではないファイルは対応出来ない。

  パラメータ:
    `form` - アクションフォーム
    `request` - リクエスト
  戻り値:
    テンプレートファイルの相対パス

### getFileName

    public abstract java.lang.String getFileName(org.apache.struts.action.ActionForm form,
                                                 javax.servlet.http.HttpServletRequest request)

  生成される帳票のファイル名を返す。

  パラメータ:
    `form` - アクションフォーム
    `request` - リクエスト
  戻り値:
    ファイル名

概要 | パッケージ | クラス | 使用 | 階層ツリー | 非推奨 API | 索引 | ヘルプ
前のクラス 次のクラス | フレームあり フレームなし
概要: 入れ子 | フィールド | コンストラクタ | メソッド | 詳細: フィールド | コンストラクタ | メソッド