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

# クラス RequestCacheTag

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

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

public class RequestCacheTag extends CommonTagSupport
戻るリンクで戻る場合に使用する、検索時の request 情報をキャッシュするタグです(通常はquery.jsp に組込み)。 requestタグをキャッシュすることにより、 再検索時や、各画面遷移時の項目の持ち回りを行います。 command = "NEW" で、キャッシュし、"RENEW" で、取り出します。 暫定的にこのタグは、共通JSPファイルに設定し、HTMLそのもののキャッシュ制御も 行うように設定しています。

関連項目:
  - 直列化された形式
機能分類
  画面制御
形式ｻﾝﾌﾟﾙ:
  ●形式：<og:requestCache cacheKey="[･･･]" /> ●body：なし ●Tag定義： <og:requestCache cacheKey 【TAG】キャッシュするサブキーを指定します(初期値:"") action 【TAG】アクション(SET,DELETE)をセットします keys 【TAG】リンク先に渡すキーを指定します vals 【TAG】keys属性に対応する値をCSV形式で複数指定します debug 【TAG】デバッグ情報を出力するかどうか[true/false]を指定します(初期値:false) /> ●使用例 <og:requestCache cacheKey="{@GUI.KEY}" キャッシュするサブキーを指定します。 />
導入されたバージョン:
  JDK5.0,

- ## フィールドの概要

  フィールド
  修飾子とタイプ
  フィールド
  説明
  `static final String`
  `ACT_DELETE`
  action 引数に渡す事の出来る アクション 削除 "DELETE"
  `static final String`
  `ACT_SET`
  action 引数に渡す事の出来る アクション 設定 "SET"
  `static final String`
  `CMD_INIT`
  command 引数に渡す事の出来る アクションコマンド イニット "INIT"
  `static final String`
  `CMD_NEW`
  command 引数に渡す事の出来る アクションコマンド ニュー "NEW"
  `static final String`
  `CMD_RENEW`
  command 引数に渡す事の出来る アクションコマンド レニュー "RENEW"
  `static final String`
  `CMD_RESET`
  command 引数に渡す事の出来る アクションコマンド リセット "RESET"

  ### クラスから継承されたフィールド 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`

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

  コンストラクタ
  コンストラクタ
  説明
  `RequestCacheTag()`
  デフォルトコンストラクター

- ## メソッドの概要

  修飾子とタイプ
  メソッド
  説明
  `int`
  `doEndTag()`
  Taglibの終了タグが見つかったときに処理する doEndTag() を オーバーライドします。
  `protected void`
  `release2()`
  タグリブオブジェクトをリリースします。
  `void`
  `setAction(String act)`
  【TAG】アクション(SET,DELETE)をセットします。
  `void`
  `setCacheKey(String ck)`
  【TAG】キャッシュするサブキーを指定します(初期値:"")。
  `void`
  `setKeys(String key)`
  【TAG】リンク先に渡すキーを指定します。
  `void`
  `setVals(String val)`
  【TAG】keys属性に対応する値をCSV形式で複数指定します。
  `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, getTagName, 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`

- ## フィールド詳細

  - ### CMD_NEW

    public static final String CMD_NEW
    command 引数に渡す事の出来る アクションコマンド ニュー "NEW"
    関連項目:
      - 定数フィールド値

  - ### CMD_RENEW

    public static final String CMD_RENEW
    command 引数に渡す事の出来る アクションコマンド レニュー "RENEW"
    関連項目:
      - 定数フィールド値

  - ### CMD_INIT

    public static final String CMD_INIT
    command 引数に渡す事の出来る アクションコマンド イニット "INIT"
    関連項目:
      - 定数フィールド値

  - ### CMD_RESET

    public static final String CMD_RESET
    command 引数に渡す事の出来る アクションコマンド リセット "RESET"
    関連項目:
      - 定数フィールド値

  - ### ACT_SET

    public static final String ACT_SET
    action 引数に渡す事の出来る アクション 設定 "SET"
    関連項目:
      - 定数フィールド値

  - ### ACT_DELETE

    public static final String ACT_DELETE
    action 引数に渡す事の出来る アクション 削除 "DELETE"
    関連項目:
      - 定数フィールド値

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

  - ### RequestCacheTag

    public RequestCacheTag()
    デフォルトコンストラクター
    変更履歴:
      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`
    戻り値:
      後続処理の指示
    変更履歴:
      3.1.1.2 (2003/04/04) Tomcat4.1 対応。release2() を doEndTag()で呼ぶ。, 3.1.1.2 (2003/04/04) 継承元を、CommonTagSupport から TagSupport に変更する。, 3.1.3.0 (2003/04/10) Cache-Control ヘッダーのセットを削除します。, 3.1.6.0 (2003/04/24) キャッシュすべき値を、キー毎に指定できるように、cacheKey 属性を追加。, 3.1.7.0 (2003/05/02) command=INIT または、null のときに、キャッシュを削除するように変更する。, 3.1.7.0 (2003/05/02) command=INIT または、null のときに、キャッシュを削除するように変更する。, 3.1.8.0 (2003/05/16) BACK_GAMENID のキャッシュの設定先を変更する。, 3.5.1.0 (2003/10/03) GAMENID 情報を取得し、backGamenIdSetメソッドに渡すように変更。, 3.7.0.3 (2005/03/01) BACK_ROW 情報を取得し、backGamenIdSetメソッドに渡すように変更。, 4.0.1.0 (2007/12/17) BackAddress対応

  - ### release2

    protected void release2()
    タグリブオブジェクトをリリースします。 キャッシュされて再利用されるので、フィールドの初期設定を行います。
    オーバーライド:
      `release2` クラス内 `CommonTagSupport`
    変更履歴:
      3.5.5.3 (2004/04/09) Tomcat4.1 対応。release2() を doEndTag()で呼ぶ。, 3.8.8.0 (2006/12/22) action,keys,vals 追加

  - ### setCacheKey

    public void setCacheKey(String ck)
    【TAG】キャッシュするサブキーを指定します(初期値:"")。
    パラメータ:
      `ck` - キャッシュするサブキー
    変更履歴:
      3.1.6.0 (2003/04/24) キャッシュすべき値を、キー毎に指定できるように、cacheKey 属性を追加。
    説明:
      キャッシュすべき値を、キー毎に指定できるようにします。 例えば、これに、画面IDを追加しておけば、画面ごとに、自分のリクエスト情報を キャッシュしておき、自分の画面が呼ばれたら、再度使用することができる様になります。 NEW でキャッシュ登録を行い、RENEW で、通常のキャッシュキーに値を取り出します。

  - ### setAction

    public void setAction(String act)
    【TAG】アクション(SET,DELETE)をセットします。
    パラメータ:
      `act` - アクション (public static final 宣言されている文字列)
    関連項目:
      - アクション定数
    変更履歴:
      6.3.4.0 (2015/08/01) Arrays.toString から String.join に置き換え。, 6.4.3.4 (2016/03/11) String配列 から、Setに置き換えます。
    説明:
      アクションは,HTMLから(get/post)指定されますので,ACT_xxx で設定される フィールド定数値のいづれかを、指定できます。 無指定の場合は、なにもしません。

      アクションの説明
      action | 名称 | 機能
      --- | --- | ---
      SET | 登録 | 指定の keys のキーに vals のキャッシュをセットします。
      DELETE | 削除 | 指定の keys のキャッシュを削除します。

  - ### setKeys

    public void setKeys(String key)
    【TAG】リンク先に渡すキーを指定します。
    パラメータ:
      `key` - リンク先に渡すキー
    変更履歴:
      3.8.8.0 (2006/12/22) 新規追加
    説明:
      戻る時に、検索時のキャッシュに指定した引数以外に指定したり、別の値に置き換えたり する場合のキーを設定できます。CSV形式で複数指定できます。 vals 属性には、キーに対応する値を、設定してください。 分解方法は、CSV変数を先に分解してから、getRequestParameter で値を取得します。 こうしないとデータ自身にカンマを持っている場合に分解をミスる為です。

  - ### setVals

    public void setVals(String val)
    【TAG】keys属性に対応する値をCSV形式で複数指定します。
    パラメータ:
      `val` - keys属性に対応する値
    変更履歴:
      3.8.8.0 (2006/12/22) 新規追加
    説明:
      キーに設定した値を、CSV形式で複数して出来ます。 指定順序は、キーと同じにしておいて下さい。 分解方法は、CSV変数を先に分解してから、getRequestParameter で値を取得します。 こうしないとデータ自身にカンマを持っている場合に分解をミスる為です。

  - ### toString

    public String toString()
    このオブジェクトの文字列表現を返します。 基本的にデバッグ目的に使用します。
    オーバーライド:
      `toString` クラス内 `CommonTagSupport`
    戻り値:
      このクラスの文字列表現
    このﾒｿｯﾄﾞは、nullを返しません