クラス 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
検索結果の 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】プリンター名を指定します 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
-
コンストラクタの概要
コンストラクタ -
メソッドの概要
修飾子とタイプメソッド説明int
doEndTag()
Taglibの終了タグが見つかったときに処理する doEndTag() を オーバーライドします。protected String
タグの名称を、返します。protected void
release2()
タグリブオブジェクトをリリースします。void
【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
【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
【TAG】各システムのリソース(ローカルリソース)を使用するかどうか[true:する/false:しない]を指定します(初期値:true)。void
setUseSheetName
(String useSName) 【TAG】PAGEBREAKカラムの値を、シート名として使うかどうかをセットします(初期値:false)。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
Taglibの終了タグが見つかったときに処理する doEndTag() を オーバーライドします。- 定義:
doEndTag
インタフェース内Tag
- オーバーライド:
doEndTag
クラス内CommonTagSupport
- 戻り値:
- 後続処理の指示
-
release2
タグリブオブジェクトをリリースします。 キャッシュされて再利用されるので、フィールドの初期設定を行います。- オーバーライド:
release2
クラス内CommonTagSupport
- 変更履歴:
- 5.7.6.2 (2014/05/16) PAGEBREAKカラムの値を、シート名として使うかどうか。
-
setFileURL
【TAG】雛型のHTMLファイルの保存してある ディレクトリを指定します。- パラメータ:
url
- 雛型のHTMLファイルのディレクトリ- 変更履歴:
- 6.4.2.1 (2016/02/05) URLの最後に、"/" を追加する処理を廃止。
- 説明:
- この属性で指定されるディレクトリのファイルを読み取ります。 指定方法は、通常の fileURL 属性と同様に、先頭が、'/' (UNIX) または、2文字目が、 ":" (Windows)の場合は、指定のURLそのままのディレクトリに、そうでない場合は、 システムパラメータ の FILE_URL 属性で指定のフォルダの下に、作成されます。 fileURL = "{@USER.ID}" と指定すると、FILE_URL 属性で指定のフォルダの下に、 さらに、各個人ID別のフォルダを作成して、そこを操作します。
-
setListId
【TAG】帳票IDを指定します。- パラメータ:
listId
- 帳票ID- 説明:
- 帳票IDを指定します。
-
setOutFileURL
【TAG】出力HTMLファイルの保存してあるディレクトリを指定します (初期値:FILE_URL[=])。- パラメータ:
url
- 出力HTMLファイルのディレクトリ- 変更履歴:
- 6.4.2.1 (2016/02/05) URLの最後に、"/" を追加する処理を廃止。
- 説明:
- この属性で指定されるディレクトリにファイルを出力します。 指定方法は、通常の fileURL 属性と同様に、先頭が、'/' (UNIX) または、2文字目が、 ":" (Windows)の場合は、指定のURLそのままのディレクトリに、そうでない場合は、 システムパラメータ の FILE_URL 属性で指定のフォルダの下に、作成されます。 fileURL = "{@USER.ID}" と指定すると、FILE_URL 属性で指定のフォルダの下に、 さらに、各個人ID別のフォルダを作成して、そこに出力します。 (初期値:FILE_URL[=])。
-
setOutFilename
【TAG】ファイルを作成するときの出力ファイル名をセットします。- パラメータ:
filename
- 出力ファイル名- 説明:
- ファイルを作成するときの出力ファイル名をセットします。 紙に印字する場合などファイルに出力しない場合は不要です。
-
setHeaderKeys
【TAG】固定部の{@KEY} の KEY 部分をCSV形式で複数指定します。- パラメータ:
hKeys
- 固定部のkey- 説明:
- カンマで複数指定できます。 分解方法は、CSV変数を先に分解してから、getRequestParameter で値を取得します。 こうしないとデータ自身にカンマを持っている場合に分解をミスる為です。
-
setHeaderVals
【TAG】固定部のKEY に対応する値をCSV形式で複数指定します。- パラメータ:
hVals
- 固定部の値- 説明:
- カンマで複数指定で、リクエスト情報でも設定できます。 分解方法は、CSV変数を先に分解してから、getRequestParameter で値を取得します。 こうしないとデータ自身にカンマを持っている場合に分解をミスる為です。
-
setPageEndCut
【TAG】ページエンドカットするかどうか[true:する/false:しない]を指定します(初期値:true:カットする)。- パラメータ:
peCut
- ページ終了カット [true:する/false:しない]- 説明:
- ページエンドカットとは、ボディー部(繰り返し部)がなくなったときに、それ以降の表示を打ち切る(カットする) 機能で、(true:カットする) を指定すると、それ以降を出力しません。 初期値は "true" (なくなった時点で、出力しない)です。
-
setUseLocalResource
【TAG】各システムのリソース(ローカルリソース)を使用するかどうか[true:する/false:しない]を指定します(初期値:true)。- パラメータ:
fgl
- ローカルリソースの使用 [true:する/false:しない]- 説明:
- true の場合、各システムに登録されたリソース情報を使用して帳票データが変換されます。 false の場合は、帳票デーモンが起動しているシステム(通常は'GE')のリソースが適用されます。 初期値は "true" (ローカルリソースを使用する)です。
-
setUseSheetName
【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
【TAG】出力方法を指定します(初期値:P(PDF出力))。- パラメータ:
code
- 出力方法(FGRUNのコードリソースと同じもの)- 説明:
- 出力方法のコードは、FGRUNのコードリソースと同じものが指定できます。 初期値は "P" (PDF出力)です。
-
setPrinterName
【TAG】プリンター名を指定します。- パラメータ:
ptnm
- プリンター名- 説明:
- プリンター名を指定します。このプリンター名は帳票サーバー上でのプリンタ名です。 ファイル出力等、紙に印刷しない場合は不要です。
-
setTableId
【TAG】(通常は使いません)結果のDBTableModelを、sessionに登録するときのキーを指定します (初期値:HybsSystem#TBL_MDL_KEY[=])。- パラメータ:
id
- テーブルID (sessionに登録する時のID)- 説明:
- 検索結果より、DBTableModelオブジェクトを作成します。これを、下流のviewタグ等に 渡す場合に、通常は、session を利用します。その場合の登録キーです。 query タグを同時に実行して、結果を求める場合、同一メモリに配置される為、 この tableId 属性を利用して、メモリ空間を分けます。 (初期値:HybsSystem#TBL_MDL_KEY[=])。
-
getTagName
タグの名称を、返します。 自分自身のクラス名より、自動的に取り出せないため、このメソッドをオーバーライドします。- オーバーライド:
getTagName
クラス内CommonTagSupport
- 戻り値:
- タグの名称
- 関連項目:
- 変更履歴:
- 4.0.0.0 (2005/01/31) 新規追加
- このメソッドは、nullを返しません
-
toString
このオブジェクトの文字列表現を返します。 基本的にデバッグ目的に使用します。- オーバーライド:
toString
クラス内CommonTagSupport
- 戻り値:
- このクラスの文字列表現
- このメソッドは、nullを返しません
-