org.opengion.hayabusa.taglib
クラス ReportTableTag
java.lang.Object
javax.servlet.jsp.tagext.TagSupport
javax.servlet.jsp.tagext.BodyTagSupport
org.opengion.hayabusa.taglib.CommonTagSupport
org.opengion.hayabusa.taglib.ReportTableTag
- すべての実装されたインタフェース:
- Serializable, BodyTag, IterationTag, JspTag, Tag, TryCatchFinally
public class ReportTableTag
- extends CommonTagSupport
検索結果の DBTableModel オブジェクトをレポート形式に変換するタグです。
データ(DBTableModel)と、コントローラ(DBTableReport クラス)を与えて、
外部からコントロールすることで、各種形式で データ(DBTableModel)を表示させることが
可能です。
- 関連項目:
- 直列化された形式
- 機能階層
- その他出力
- 形式サンプル:
●形式:<og:report fileURL="[・・・]" listId="[・・・]" ・・・ />
●body:なし
●使用例
<og:report
fileURL "雛型のHTMLファイルの保存してある ディレクトリを指定します。"
listId "雛型のHTMLファイル名を指定します。(必須)"
outFileURL "出力HTMLファイルの保存してあるディレクトリを指定します。"
outFilename "ファイルを作成するときの出力ファイル名をセットします。"
programFile "HTMLファイルのEXCEL化を行うバッチファイルを指定します。"
headerKeys "固定部の{@KEY} の KEY 部分をCSV形式で複数指定します。"
reportClass "実際に書き出すクラス名の略称(DBTableReport_**** の ****)をセットします(初期値:HTML)。"
language "タグ内部で使用する言語コードを指定します。"
tableId "(通常使いません)sessionから所得する DBTableModel オブジェクトの ID。"
scope "キャッシュする場合のスコープ(request,page,session,applicaton)を指定します(初期値:session)。"
debug "デバッグ情報を 出力するかどうか(true/false)を指定します(初期値:false)。"
headerVals "固定部のKEY に対応する値をCSV形式で複数指定します。"
footerKeys "繰り返し部の終了後に表示する key 部分をCSV形式で複数指定します。"
footerVals "固定部のKEY に対応する値をCSV形式で複数指定します。"
pageEndCut "ボディー部(繰り返し部)がなくなったときに、それ以降を表示するかどうか(true/false)を指定します(初期値:true)。"
/>
- バージョン
- 4.0
- 作成者
- Kazuhiko Hasegawa
- 導入されたバージョン:
- JDK5.0,
クラス org.opengion.hayabusa.taglib.CommonTagSupport から継承されたメソッド |
add, add, addEventColumnSQL, check, check, commitTableObject, debugPrint, doAfterBody, doCatch, doFinally, doStartTag, get, getApplicationInfo, getAttributes, getBodyRawString, getBodyString, getContextAttribute, getContextPath, getCookie, getCSVParameter, getDataCondition, getDateFormat, getDBColumn, getDBFunctionName, getDocumentLink, getGUIInfo, getGUIInfoAttri, getLabel, getLabelInterface, getLanguage, getLongLabel, getMsglbl, getObject, getParameterNames, getParameterRows, getRequest, getRequestAttribute, getRequestCacheData, getRequestParameter, getRequestParameterValues, getRequestValue, getRequestValue, getRequestValues, getResource, getScope, getSessionAttribute, getUser, getUserInfo, isAjaxSubmitRequest, isDebug, isNoTransitionRequest, isNull, jspPrint, removeContextAttribute, removeObject, removeRequestAttribute, removeSessionAttribute, set, setAjaxSubmitRequest, setContextAttribute, setCookie, setDebug, setLanguage, setLbl, setMsglbl, setNoTransitionRequest, setObject, setParameterRows, setRequestAttribute, setRequestCacheData, setScope, setSessionAttribute, setUserInfo, setUseValue, startQueryTransaction, sys, sysBool, sysInt, useQuotCheck, useXssCheck |
ReportTableTag
public ReportTableTag()
doEndTag
public int doEndTag()
- Taglibの終了タグが見つかったときに処理する doEndTag() を オーバーライドします。
- 定義:
- インタフェース
Tag
内の doEndTag
- オーバーライド:
- クラス
CommonTagSupport
内の doEndTag
- 戻り値:
- int
- 変更履歴:
3.1.1.2 (2003/04/04) Tomcat4.1 対応。release2() を doEndTag()で呼ぶ。 |
3.8.0.4 (2005/08/08) 帳票出力に準拠した方式に変更 |
4.0.0.0 (2007/10/18) メッセージリソース統合( getResource().getMessage > getResource().getLabel ) |
4.0.0.0 (2007/11/28) メソッドの戻り値をチェックします。 |
release2
protected void release2()
- タグリブオブジェクトをリリースします。
キャッシュされて再利用されるので、フィールドの初期設定を行います。
- オーバーライド:
- クラス
CommonTagSupport
内の release2
- 変更履歴:
2.0.0.4 (2002/09/27) カスタムタグの release() メソッドを、追加 |
3.1.1.2 (2003/04/04) Tomcat4.1 対応。release2() を doEndTag()で呼ぶ。 |
3.1.3.0 (2003/04/10) REPORT_ENCODE(帳票エンコーディング)を利用するように修正。 |
3.8.0.4 (2005/08/08) filename 削除、listId ,programFile 追加 , |
setTableId
public void setTableId(String tableId)
- 【TAG】(通常使いません)sessionから所得する DBTableModel オブジェクトの ID。
- パラメータ:
tableId
- sessionに登録する時の ID- TagLib:
表示処理後に,(内部ポインタを書き換えた)DBTableModel オブジェクトを
同じキーで、sessionに登録します。
初期値は、HybsSystem.TBL_MDL_KEY です。 |
setListId
public void setListId(String listId)
- 【TAG】帳票IDを指定します。
- パラメータ:
listId
- String 帳票ID- TagLib:
雛形ファイルは、帳票ID.html となります。また、ファーストページ対応の場合は、
帳票ID_FIRST.html になります。
なお、filename 属性が指定された場合は、そちらが優先されます。 |
- 変更履歴:
3.8.0.4 (2005/08/08) 新規追加 |
setHeaderKeys
public void setHeaderKeys(String hKeys)
- 【TAG】固定部の{@KEY} の KEY 部分をCSV形式で複数指定します。
- パラメータ:
hKeys
- 固定部の key- TagLib:
カンマで複数指定できます。
分解方法は、CSV変数を先に分解してから、getRequestParameter で値を取得します。
こうしないとデータ自身にカンマを持っている場合に分解をミスる為です。 |
- 変更履歴:
3.5.6.2 (2004/07/05) 先に配列に分解してからリクエスト変数の値を取得 |
setHeaderVals
public void setHeaderVals(String hVals)
- 【TAG】固定部のKEY に対応する値をCSV形式で複数指定します。
- パラメータ:
hVals
- 固定部の値- TagLib:
カンマで複数指定で、リクエスト情報でも設定できます。
分解方法は、CSV変数を先に分解してから、getRequestParameter で値を取得します。
こうしないとデータ自身にカンマを持っている場合に分解をミスる為です。 |
- 変更履歴:
3.5.6.2 (2004/07/05) 先に配列に分解してからリクエスト変数の値を取得 |
setFooterKeys
public void setFooterKeys(String ftKeys)
- 【TAG】繰り返し部の終了後に表示する key 部分をCSV形式で複数指定します。
- パラメータ:
ftKeys
- 繰り返し部の終了後に表示する key- TagLib:
カンマで複数指定できます。
分解方法は、CSV変数を先に分解してから、getRequestParameter で値を取得します。
こうしないとデータ自身にカンマを持っている場合に分解をミスる為です。 |
- 変更履歴:
3.5.6.2 (2004/07/05) 先に配列に分解してからリクエスト変数の値を取得 |
setFooterVals
public void setFooterVals(String ftVals)
- 【TAG】固定部のKEY に対応する値をCSV形式で複数指定します。
- パラメータ:
ftVals
- 繰り返し部の終了後に表示する値- TagLib:
カンマで複数指定で、リクエスト情報でも設定できます。
分解方法は、CSV変数を先に分解してから、getRequestParameter で値を取得します。
こうしないとデータ自身にカンマを持っている場合に分解をミスる為です。 |
- 変更履歴:
3.5.6.2 (2004/07/05) 先に配列に分解してからリクエスト変数の値を取得 |
3.8.1.2 (2005/12/19) footer 関連の値とpageEndCut の関係を解除します。 |
setPageEndCut
public void setPageEndCut(String peCut)
- 【TAG】ボディー部(繰り返し部)がなくなったときに、それ以降を表示するかどうか(true/false)を指定します(初期値:true)。
- パラメータ:
peCut
- 繰り返し部の終了後に継続処理するかどうか (true:処理しない/false:処理する)- TagLib:
true では、それ以降を出力しません。
初期値は "true" (なくなった時点で、出力しない。)です。 |
- 変更履歴:
3.8.1.2 (2005/12/19) footer 関連の値とpageEndCut の関係を解除します。 |
setFileURL
public void setFileURL(String url)
- 【TAG】雛型のHTMLファイルの保存してある ディレクトリを指定します。
- パラメータ:
url
- 雛型のHTMLファイルのディレクトリ- TagLib:
この属性で指定されるディレクトリのファイルを読み取ります。
指定方法は、通常の fileURL 属性と同様に、先頭が、'/' (UNIX) または、2文字目が、
":" (Windows)の場合は、指定のURLそのままのディレクトリに、そうでない場合は、
システムパラメータ の FILE_URL 属性で指定のフォルダの下に、作成されます。
fileURL = "{@USER.ID}" と指定すると、FILE_URL 属性で指定のフォルダの下に、
さらに、各個人ID別のフォルダを作成して、そこを操作します。 |
- 変更履歴:
4.0.0 (2005/01/31) StringUtil.urlAppend メソッドの利用 |
4.0.0.0 (2007/11/20) 指定されたディレクトリ名の最後が"\"or"/"で終わっていない場合に、"/"を付加する。 |
setProgramFile
public void setProgramFile(String programFile)
- 【TAG】HTMLファイルをEXCEL変換する場合に使用するBATファイルを指定します。
- パラメータ:
programFile
- プログラムファイル名- TagLib:
ファイルは、フルパスで指定してください。
指定がない場合は、変換処理は行いません。
通常は、dbdef2/def/Script/runExcelPrint.bat を呼び出してください。
初期値は、null(変換処理しない)です。 |
- 変更履歴:
3.8.0.4 (2005/08/08) 新規追加 |
setOutFileURL
public void setOutFileURL(String url)
- 【TAG】出力HTMLファイルの保存してあるディレクトリを指定します。
- パラメータ:
url
- 出力HTMLファイルのディレクトリ- TagLib:
この属性で指定されるディレクトリにファイルを出力します。
指定方法は、通常の fileURL 属性と同様に、先頭が、'/' (UNIX) または、2文字目が、
":" (Windows)の場合は、指定のURLそのままのディレクトリに、そうでない場合は、
システムパラメータ の FILE_URL 属性で指定のフォルダの下に、作成されます。
fileURL = "{@USER.ID}" と指定すると、FILE_URL 属性で指定のフォルダの下に、
さらに、各個人ID別のフォルダを作成して、そこに出力します。 |
- 変更履歴:
4.0.0.0 (2007/11/20) 指定されたディレクトリ名の最後が"\"or"/"で終わっていない場合に、"/"を付加する。 |
setOutFilename
public void setOutFilename(String filename)
- 【TAG】ファイルを作成するときの出力ファイル名をセットします。
- パラメータ:
filename
- 出力ファイル名- TagLib:
ファイルを作成するときの出力ファイル名をセットします。 |
setReportClass
public void setReportClass(String reportClass)
- 【TAG】実際に書き出すクラス名の略称(DBTableReport_**** の ****)をセットします(初期値:HTML)。
- パラメータ:
reportClass
- クラス名(の略称)- 関連項目:
DBTableReportのサブクラス
- TagLib:
これは、org.opengion.hayabusa.report 以下の DBTableReport_**** クラスの **** を
与えます。これらは、DBTableReport インターフェースを継承したサブクラスです。
初期値は、"HTML" です。
属性クラス定義の
reportClass
を参照願います。 |
getTagName
protected String getTagName()
- タグの名称を、返します。
自分自身のクラス名より、自動的に取り出せないため、このメソッドをオーバーライドします。
- オーバーライド:
- クラス
CommonTagSupport
内の getTagName
- 戻り値:
- タグの名称
- 関連項目:
CommonTagSupport.getDocumentLink()
- 変更履歴:
toString
public String toString()
- このオブジェクトの文字列表現を返します。
基本的にデバッグ目的に使用します。
- オーバーライド:
- クラス
CommonTagSupport
内の toString
- 戻り値:
- このクラスの文字列表現
Webアプリケーションフレームワーク openGion
Copyright (c) 2009 The openGion Project.