パッケージ org.opengion.hayabusa.taglib

# クラス ReportTableTag2

java.lang.Object
jakarta.servlet.jsp.tagext.TagSupport
jakarta.servlet.jsp.tagext.BodyTagSupport
org.opengion.hayabusa.taglib.CommonTagSupport
org.opengion.hayabusa.taglib.ReportTableTag2

すべての実装されたインタフェース:
  `BodyTag`, `IterationTag`, `JspTag`, `Tag`, `TryCatchFinally`, `Serializable`

public class ReportTableTag2 extends CommonTagSupport
検索結果の DBTableModelｵﾌﾞｼﾞｪｸﾄをﾚﾎﾟｰﾄ形式に変換するﾀｸﾞです｡ ﾃﾞｰﾀ(DBTableModel)と､ｺﾝﾄﾛｰﾗ(QueueManager_DIRECT ｸﾗｽ)を与えて､ 外部からｺﾝﾄﾛｰﾙすることで､各種形式で ﾃﾞｰﾀ(DBTableModel)を表示させることが 可能です｡ このﾀｸﾞを使用するには､OpenOffice.orgのﾓｼﾞｭｰﾙがｲﾝｽﾄｰﾙされてている必要があります｡ また､出力するために帳票ｼｽﾃﾑ関連のﾃﾞｰﾀ設定やﾏｽﾀ設定は一切必要ありません｡

関連項目:
  - 直列化された形式
機能分類
  その他出力
形式ｻﾝﾌﾟﾙ:
  ●形式：<og:report fileURL="[･･･]" listId="[･･･]" ･･･ /> ●body：なし ●Tag定義： <og:report2 fileURL 【TAG】雛型のHTMLﾌｧｲﾙの保存してある ﾃﾞｨﾚｸﾄﾘを指定します listId ○【TAG】帳票IDを指定します(必須)｡ outFileURL 【TAG】出力HTMLﾌｧｲﾙの保存してあるﾃﾞｨﾚｸﾄﾘを指定します(初期値:FILE_URL[=]) outFilename ○【TAG】ﾌｧｲﾙを作成するときの出力ﾌｧｲﾙ名をｾｯﾄします(必須)｡ headerKeys 【TAG】固定部の{@KEY} の KEY 部分をCSV形式で複数指定します headerVals 【TAG】固定部のKEY に対応する値をCSV形式で複数指定します footerKeys 【TAG】繰り返し部の終了後に表示する key 部分をCSV形式で複数指定します footerVals 【TAG】固定部のKEY に対応する値をCSV形式で複数指定します pageEndCut 【TAG】ﾎﾞﾃﾞｨｰ部(繰り返し部)がなくなったときに､それ以降を表示するかどうか[true/false]を指定します(初期値:true) useLocalResource 【TAG】各ｼｽﾃﾑのﾘｿｰｽ(ﾛｰｶﾙﾘｿｰｽ)を使用するか[true/false]を指定します(初期値:true) useSheetName 【TAG】PAGEBREAKｶﾗﾑの値を､ｼｰﾄ名として使うかどうか[true/false]を指定します(初期値:false) fgrun 【TAG】出力方法を指定します(初期値:P(PDF出力)) printerName 【TAG】ﾌﾟﾘﾝﾀｰ名を指定します useLocal 【TAG】ｼｽﾃﾑ定数でｸﾗｳﾄﾞ設定されていても､ｸﾗｳﾄﾞ環境を使用しない場合､trueを指定します(初期値:false) 8.0.1.0 (2021/10/29) language 【TAG】ﾀｸﾞ内部で使用する言語ｺｰﾄﾞ[ja/en/zh/…]を指定します scope 【TAG】ｷｬｯｼｭする場合のｽｺｰﾌﾟ[request/page/session/application]を指定します(初期値:session) tableId 【TAG】(通常は使いません)sessionから所得する DBTableModelｵﾌﾞｼﾞｪｸﾄの ID debug 【TAG】ﾃﾞﾊﾞｯｸﾞ情報を出力するかどうか[true/false]を指定します(初期値:false) /> ●使用例
導入されたバージョン:
  JDK5.0,

- ## フィールドの概要

  ### クラスから継承されたフィールド org.opengion.hayabusa.taglib.CommonTagSupport

  `BR, BUFFER_MIDDLE, CR`

  ### クラスから継承されたフィールド jakarta.servlet.jsp.tagext.BodyTagSupport

  `bodyContent`

  ### クラスから継承されたフィールド jakarta.servlet.jsp.tagext.TagSupport

  `id, pageContext`

  ### インタフェースから継承されたフィールド jakarta.servlet.jsp.tagext.BodyTag

  `EVAL_BODY_BUFFERED, EVAL_BODY_TAG`

  ### インタフェースから継承されたフィールド jakarta.servlet.jsp.tagext.IterationTag

  `EVAL_BODY_AGAIN`

  ### インタフェースから継承されたフィールド jakarta.servlet.jsp.tagext.Tag

  `EVAL_BODY_INCLUDE, EVAL_PAGE, SKIP_BODY, SKIP_PAGE`

- ## コンストラクタの概要

  コンストラクタ
  コンストラクタ
  説明
  `ReportTableTag2()`
  ﾃﾞﾌｫﾙﾄｺﾝｽﾄﾗｸﾀｰ

- ## メソッドの概要

  修飾子とタイプ
  メソッド
  説明
  `int`
  `doEndTag()`
  Taglibの終了ﾀｸﾞが見つかったときに処理する doEndTag() を ｵｰﾊﾞｰﾗｲﾄﾞします｡
  `protected String`
  `getTagName()`
  ﾀｸﾞの名称を､返します｡ 自分自身のｸﾗｽ名より､自動的に取り出せないため､このﾒｿｯﾄﾞをｵｰﾊﾞｰﾗｲﾄﾞします｡
  `protected void`
  `release2()`
  ﾀｸﾞﾘﾌﾞｵﾌﾞｼﾞｪｸﾄをﾘﾘｰｽします｡ ｷｬｯｼｭされて再利用されるので､ﾌｨｰﾙﾄﾞの初期設定を行います｡
  `void`
  `setFgrun(String code)`
  【TAG】出力方法を指定します(初期値:P(PDF出力))｡
  `void`
  `setFileURL(String url)`
  【TAG】雛型のHTMLﾌｧｲﾙの保存してある ﾃﾞｨﾚｸﾄﾘを指定します｡
  `void`
  `setFooterKeys(String ftKeys)`
  【TAG】繰り返し部の終了後に表示する key 部分をCSV形式で複数指定します｡
  `void`
  `setFooterVals(String ftVals)`
  【TAG】固定部のKEY に対応する値をCSV形式で複数指定します｡
  `void`
  `setHeaderKeys(String hKeys)`
  【TAG】固定部の{@KEY} の KEY 部分をCSV形式で複数指定します｡
  `void`
  `setHeaderVals(String hVals)`
  【TAG】固定部のKEY に対応する値をCSV形式で複数指定します｡
  `void`
  `setListId(String listId)`
  【TAG】帳票IDを指定します｡
  `void`
  `setOutFilename(String filename)`
  【TAG】ﾌｧｲﾙを作成するときの出力ﾌｧｲﾙ名をｾｯﾄします｡
  `void`
  `setOutFileURL(String url)`
  【TAG】出力HTMLﾌｧｲﾙの保存してあるﾃﾞｨﾚｸﾄﾘを指定します (初期値:FILE_URL[=])｡
  `void`
  `setPageEndCut(String peCut)`
  【TAG】ﾍﾟｰｼﾞｴﾝﾄﾞｶｯﾄするかどうか[true:する/false:しない]を指定します(初期値:true:ｶｯﾄする)｡
  `void`
  `setPrinterName(String ptnm)`
  【TAG】ﾌﾟﾘﾝﾀｰ名を指定します｡
  `void`
  `setTableId(String id)`
  【TAG】(通常は使いません)結果のDBTableModelを､sessionに登録するときのｷｰを指定します (初期値:HybsSystem#TBL_MDL_KEY[=])｡
  `void`
  `setUseLocal(String flag)`
  【TAG】ｼｽﾃﾑ定数でｸﾗｳﾄﾞ設定されていても､ｸﾗｳﾄﾞ環境を使用しない場合､trueを指定します(初期値:false)｡
  `void`
  `setUseLocalResource(String fgl)`
  【TAG】各ｼｽﾃﾑのﾘｿｰｽ(ﾛｰｶﾙﾘｿｰｽ)を使用するかどうか[true:する/false:しない]を指定します(初期値:true)｡
  `void`
  `setUseSheetName(String useSName)`
  【TAG】PAGEBREAKｶﾗﾑの値を､ｼｰﾄ名として使うかどうかをｾｯﾄします(初期値:false)｡
  `String`
  `toString()`
  このｵﾌﾞｼﾞｪｸﾄの文字列表現を返します｡ 基本的にﾃﾞﾊﾞｯｸﾞ目的に使用します｡

  ### クラスから継承されたメソッド org.opengion.hayabusa.taglib.CommonTagSupport

  `add, add, addEventColumn, addEventColumn, check, commitTableObject, debugPrint, doAfterBody, doCatch, doFinally, doStartTag, get, getApplicationInfo, getAttributes, getBodyRawString, getBodyString, getContextAttribute, getContextPath, getCookie, getCSVParameter, getCSVParameter, getDateFormat, getDBColumn, getDBFunctionName, getDocumentLink, getGUIInfo, getGUIInfoAttri, getHostName, getLabel, getLabelInterface, getLanguage, getLongLabel, getMsg, getMsglbl, getObject, getParameterNames, getParameterRows, getRequest, getRequestAttribute, getRequestCacheData, getRequestMethod, getRequestParameter, getRequestParameterValues, getRequestValue, getRequestValue, getRequestValues, getReservedParameter, getReservedValue, getResource, getSanitizedBodyString, getScope, getSessionAttribute, getTransaction, getUser, getUserEditInfo, getUserInfo, isAjaxSubmitRequest, isDebug, isNoTransitionRequest, isNull, jspPrint, makeUrl, removeContextAttribute, removeObject, removeRequestAttribute, removeSessionAttribute, set, setAjaxSubmitRequest, setCaseIf, setCaseKey, setCaseNN, setCaseNull, setCaseVal, setContextAttribute, setCookie, setDebug, setLanguage, setLbl, setNoTransitionRequest, setObject, setObject, setParameterNames, setParameterRows, setRequestAttribute, setRequestCacheData, setScope, setSessionAttribute, setUserInfo, startQueryTransaction, sys, sysBool, sysInt, useMainTrans, useQuotCheck, useTag, useXssCheck`

  ### クラスから継承されたメソッド jakarta.servlet.jsp.tagext.BodyTagSupport

  `doInitBody, getBodyContent, getPreviousOut, release, setBodyContent`

  ### クラスから継承されたメソッド jakarta.servlet.jsp.tagext.TagSupport

  `findAncestorWithClass, getId, getParent, getValue, getValues, removeValue, setId, setPageContext, setParent, setValue`

  ### クラスから継承されたメソッド java.lang.Object

  `clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait`

  ### インタフェースから継承されたメソッド jakarta.servlet.jsp.tagext.Tag

  `getParent, setPageContext, setParent`

- ## コンストラクタの詳細

  - ### ReportTableTag2

    public ReportTableTag2()
    ﾃﾞﾌｫﾙﾄｺﾝｽﾄﾗｸﾀｰ
    変更履歴:
      6.4.2.0 (2016/01/29) PMD refactoring. Each class should declare at least one constructor.

- ## メソッドの詳細

  - ### doEndTag

    public int doEndTag()
    Taglibの終了ﾀｸﾞが見つかったときに処理する doEndTag() を ｵｰﾊﾞｰﾗｲﾄﾞします｡
    定義:
      `doEndTag` インタフェース内 `Tag`
    オーバーライド:
      `doEndTag` クラス内 `CommonTagSupport`
    戻り値:
      後続処理の指示
    変更履歴:
      8.0.0.2 (2021/10/15) ﾛｰｶﾙﾌｧｲﾙとｸﾗｳﾄﾞﾌｧｲﾙ間の移動

  - ### release2

    protected void release2()
    ﾀｸﾞﾘﾌﾞｵﾌﾞｼﾞｪｸﾄをﾘﾘｰｽします｡ ｷｬｯｼｭされて再利用されるので､ﾌｨｰﾙﾄﾞの初期設定を行います｡
    オーバーライド:
      `release2` クラス内 `CommonTagSupport`
    変更履歴:
      5.7.6.2 (2014/05/16) PAGEBREAKｶﾗﾑの値を､ｼｰﾄ名として使うかどうか｡, 8.0.1.0 (2021/10/29) useLocal 属性を追加｡

  - ### setFileURL

    public void setFileURL(String url)
    【TAG】雛型のHTMLﾌｧｲﾙの保存してある ﾃﾞｨﾚｸﾄﾘを指定します｡
    パラメータ:
      `url` - 雛型のHTMLﾌｧｲﾙのﾃﾞｨﾚｸﾄﾘ
    変更履歴:
      6.4.2.1 (2016/02/05) URLの最後に､"/" を追加する処理を廃止｡
    説明:
      この属性で指定されるﾃﾞｨﾚｸﾄﾘのﾌｧｲﾙを読み取ります｡ 指定方法は､通常の fileURL 属性と同様に､先頭が､'/' (UNIX) または､２文字目が､ ":" (Windows)の場合は､指定のURLそのままのﾃﾞｨﾚｸﾄﾘに､そうでない場合は､ ｼｽﾃﾑﾊﾟﾗﾒｰﾀ の FILE_URL 属性で指定のﾌｫﾙﾀﾞの下に､作成されます｡ fileURL = "{@USER.ID}" と指定すると､FILE_URL 属性で指定のﾌｫﾙﾀﾞの下に､ さらに､各個人ID別のﾌｫﾙﾀﾞを作成して､そこを操作します｡

  - ### setListId

    public void setListId(String listId)
    【TAG】帳票IDを指定します｡
    パラメータ:
      `listId` - 帳票ID
    説明:
      帳票IDを指定します｡

  - ### setOutFileURL

    public void setOutFileURL(String url)
    【TAG】出力HTMLﾌｧｲﾙの保存してあるﾃﾞｨﾚｸﾄﾘを指定します (初期値:FILE_URL[=])｡
    パラメータ:
      `url` - 出力HTMLﾌｧｲﾙのﾃﾞｨﾚｸﾄﾘ
    変更履歴:
      6.4.2.1 (2016/02/05) URLの最後に､"/" を追加する処理を廃止｡
    説明:
      この属性で指定されるﾃﾞｨﾚｸﾄﾘにﾌｧｲﾙを出力します｡ 指定方法は､通常の fileURL 属性と同様に､先頭が､'/' (UNIX) または､２文字目が､ ":" (Windows)の場合は､指定のURLそのままのﾃﾞｨﾚｸﾄﾘに､そうでない場合は､ ｼｽﾃﾑﾊﾟﾗﾒｰﾀ の FILE_URL 属性で指定のﾌｫﾙﾀﾞの下に､作成されます｡ fileURL = "{@USER.ID}" と指定すると､FILE_URL 属性で指定のﾌｫﾙﾀﾞの下に､ さらに､各個人ID別のﾌｫﾙﾀﾞを作成して､そこに出力します｡ (初期値:FILE_URL[=])｡

  - ### setOutFilename

    public void setOutFilename(String filename)
    【TAG】ﾌｧｲﾙを作成するときの出力ﾌｧｲﾙ名をｾｯﾄします｡
    パラメータ:
      `filename` - 出力ﾌｧｲﾙ名
    説明:
      ﾌｧｲﾙを作成するときの出力ﾌｧｲﾙ名をｾｯﾄします｡ 紙に印字する場合などﾌｧｲﾙに出力しない場合は不要です｡

  - ### setHeaderKeys

    public void setHeaderKeys(String hKeys)
    【TAG】固定部の{@KEY} の KEY 部分をCSV形式で複数指定します｡
    パラメータ:
      `hKeys` - 固定部のkey
    説明:
      ｶﾝﾏで複数指定できます｡ 分解方法は､CSV変数を先に分解してから､getRequestParameter で値を取得します｡ こうしないとﾃﾞｰﾀ自身にｶﾝﾏを持っている場合に分解をﾐｽる為です｡

  - ### setHeaderVals

    public void setHeaderVals(String hVals)
    【TAG】固定部のKEY に対応する値をCSV形式で複数指定します｡
    パラメータ:
      `hVals` - 固定部の値
    説明:
      ｶﾝﾏで複数指定で､ﾘｸｴｽﾄ情報でも設定できます｡ 分解方法は､CSV変数を先に分解してから､getRequestParameter で値を取得します｡ こうしないとﾃﾞｰﾀ自身にｶﾝﾏを持っている場合に分解をﾐｽる為です｡

  - ### setFooterKeys

    public void setFooterKeys(String ftKeys)
    【TAG】繰り返し部の終了後に表示する key 部分をCSV形式で複数指定します｡
    パラメータ:
      `ftKeys` - 繰り返し部の終了後に表示するkey
    説明:
      ｶﾝﾏで複数指定できます｡ 分解方法は､CSV変数を先に分解してから､getRequestParameter で値を取得します｡ こうしないとﾃﾞｰﾀ自身にｶﾝﾏを持っている場合に分解をﾐｽる為です｡

  - ### setFooterVals

    public void setFooterVals(String ftVals)
    【TAG】固定部のKEY に対応する値をCSV形式で複数指定します｡
    パラメータ:
      `ftVals` - 繰り返し部の終了後に表示する値
    説明:
      ｶﾝﾏで複数指定で､ﾘｸｴｽﾄ情報でも設定できます｡ 分解方法は､CSV変数を先に分解してから､getRequestParameter で値を取得します｡ こうしないとﾃﾞｰﾀ自身にｶﾝﾏを持っている場合に分解をﾐｽる為です｡

  - ### setPageEndCut

    public void setPageEndCut(String peCut)
    【TAG】ﾍﾟｰｼﾞｴﾝﾄﾞｶｯﾄするかどうか[true:する/false:しない]を指定します(初期値:true:ｶｯﾄする)｡
    パラメータ:
      `peCut` - ﾍﾟｰｼﾞ終了ｶｯﾄ [true:する/false:しない]
    説明:
      ﾍﾟｰｼﾞｴﾝﾄﾞｶｯﾄとは､ﾎﾞﾃﾞｨｰ部(繰り返し部)がなくなったときに､それ以降の表示を打ち切る（ｶｯﾄする） 機能で､(true:ｶｯﾄする) を指定すると､それ以降を出力しません｡ 初期値は "true" (なくなった時点で､出力しない)です｡

  - ### setUseLocalResource

    public void setUseLocalResource(String fgl)
    【TAG】各ｼｽﾃﾑのﾘｿｰｽ(ﾛｰｶﾙﾘｿｰｽ)を使用するかどうか[true:する/false:しない]を指定します(初期値:true)｡
    パラメータ:
      `fgl` - ﾛｰｶﾙﾘｿｰｽの使用 [true:する/false:しない]
    説明:
      true の場合､各ｼｽﾃﾑに登録されたﾘｿｰｽ情報を使用して帳票ﾃﾞｰﾀが変換されます｡ false の場合は､帳票ﾃﾞｰﾓﾝが起動しているｼｽﾃﾑ(通常は'GE')のﾘｿｰｽが適用されます｡ 初期値は "true" (ﾛｰｶﾙﾘｿｰｽを使用する)です｡

  - ### setUseSheetName

    public void setUseSheetName(String useSName)
    【TAG】PAGEBREAKｶﾗﾑの値を､ｼｰﾄ名として使うかどうかをｾｯﾄします(初期値:false)｡
    パラメータ:
      `useSName` - PAGEBREAKｶﾗﾑのｼｰﾄ名使用可否 [true:使用/false:使用しない]
    変更履歴:
      5.7.6.2 (2014/05/16) 新規追加
    説明:
      PAGEBREAK で､ｼｰﾄﾁｪﾝｼﾞを行う場合､ｼｰﾄ名も指定したい場合があります｡ その場合､この､useSheetName="true" とすることで､PAGEBREAKｶﾗﾑの値を､ｼｰﾄ名として 使用します｡ useSheetName="false" の場合は､"Page"+ﾍﾟｰｼﾞ番号+"_Row"+現在行番号 がｼｰﾄ名になります｡ PAGEBREAK は､FIRSTｼｰﾄ雛形にも適用されます｡ ちなみに､FIRSTｼｰﾄ雛形は､特殊で､useSheetName="false" の場合でも､ FIRST_**** などと記述した場合は､**** 文字列をｼｰﾄ名に使用します｡ FIRST だけの場合は､従来と同じｼｰﾄ名になります｡ 初期値は､互換性を考慮し､false:ｼｰﾄ名として使用しない です｡

  - ### setFgrun

    public void setFgrun(String code)
    【TAG】出力方法を指定します(初期値:P(PDF出力))｡
    パラメータ:
      `code` - 出力方法(FGRUNのｺｰﾄﾞﾘｿｰｽと同じもの)
    説明:
      出力方法のｺｰﾄﾞは､FGRUNのｺｰﾄﾞﾘｿｰｽと同じものが指定できます｡ 初期値は "P" (PDF出力)です｡

  - ### setPrinterName

    public void setPrinterName(String ptnm)
    【TAG】ﾌﾟﾘﾝﾀｰ名を指定します｡
    パラメータ:
      `ptnm` - ﾌﾟﾘﾝﾀｰ名
    説明:
      ﾌﾟﾘﾝﾀｰ名を指定します｡このﾌﾟﾘﾝﾀｰ名は帳票ｻｰﾊﾞｰ上でのﾌﾟﾘﾝﾀ名です｡ ﾌｧｲﾙ出力等､紙に印刷しない場合は不要です｡

  - ### setUseLocal

    public void setUseLocal(String flag)
    【TAG】ｼｽﾃﾑ定数でｸﾗｳﾄﾞ設定されていても､ｸﾗｳﾄﾞ環境を使用しない場合､trueを指定します(初期値:false)｡
    パラメータ:
      `flag` - ﾛｰｶﾙ環境のみ [true:ﾛｰｶﾙのみ/false:設定どおり]
    変更履歴:
      8.0.1.0 (2021/10/29) useLocal 属性を追加｡
    説明:
      ｸﾗｳﾄﾞ設定は､ｼｽﾃﾑ定数の『CLOUD_TARGET』と『CLOUD_BUCKET』の設定で自動的に使用しますが､ どうしてもﾛｰｶﾙでのみ使いたい場合は､この属性を true に設定します｡ 標準はfalse:設定どおりとなります｡ true/false以外を指定した場合はfalse扱いとします｡

  - ### setTableId

    public void setTableId(String id)
    【TAG】(通常は使いません)結果のDBTableModelを､sessionに登録するときのｷｰを指定します (初期値:HybsSystem#TBL_MDL_KEY[=])｡
    パラメータ:
      `id` - ﾃｰﾌﾞﾙID (sessionに登録する時のID)
    説明:
      検索結果より､DBTableModelｵﾌﾞｼﾞｪｸﾄを作成します｡これを､下流のviewﾀｸﾞ等に 渡す場合に､通常は､session を利用します｡その場合の登録ｷｰです｡ query ﾀｸﾞを同時に実行して､結果を求める場合､同一ﾒﾓﾘに配置される為､ この tableId 属性を利用して､ﾒﾓﾘ空間を分けます｡ (初期値:HybsSystem#TBL_MDL_KEY[=])｡

  - ### getTagName

    protected String getTagName()
    ﾀｸﾞの名称を､返します｡ 自分自身のｸﾗｽ名より､自動的に取り出せないため､このﾒｿｯﾄﾞをｵｰﾊﾞｰﾗｲﾄﾞします｡
    オーバーライド:
      `getTagName` クラス内 `CommonTagSupport`
    戻り値:
      ﾀｸﾞの名称
    関連項目:
      - `CommonTagSupport.getDocumentLink()`
    変更履歴:
      4.0.0.0 (2005/01/31) 新規追加
    このﾒｿｯﾄﾞは、nullを返しません

  - ### toString

    public String toString()
    このｵﾌﾞｼﾞｪｸﾄの文字列表現を返します｡ 基本的にﾃﾞﾊﾞｯｸﾞ目的に使用します｡
    オーバーライド:
      `toString` クラス内 `CommonTagSupport`
    戻り値:
      このｸﾗｽの文字列表現
    このﾒｿｯﾄﾞは、nullを返しません