org.opengion.hayabusa.taglib

## クラス EngineTag

- java.lang.Object
- - javax.servlet.jsp.tagext.TagSupport
  - - javax.servlet.jsp.tagext.BodyTagSupport
    - - org.opengion.hayabusa.taglib.CommonTagSupport
      - - org.opengion.hayabusa.taglib.EngineTag

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

      public class EngineTag
      extends CommonTagSupport

       キャッシュしている各種データを初期化(クリア)します。

       データベースリソースを使用している場合は、キャッシュをクリアすることで、再度
       読み込みなおしますので、データベースの値を変更した後には、クリアが必要です。

       クリアする対象は、connection,resource,gui,query,calendar があります。
       all という キーワードは、下記のすべてのリソースキャッシュをクリアします。

         初期化(クリア)対象のキーワード
         対象        説明
         connection  コネクションプーリングのコネクションを開放します。
         resource    ユーザー、システムを除くリソースキャッシュをクリアします。
         gui         GUI情報のキャッシュをクリアします。
         calendar    事業所カレンダを含むカレンダオブジェクトキャッシュをクリアします。

  関連項目:
    直列化された形式
  形式サンプル:

         ●形式：<og:engine connectionClear="[true|false]" ･･･ />
         ●body：なし

         ●Tag定義：
           <og:engine
               allClear           【TAG】すべてのキャッシュデータをクリアします(初期値:false)
               connectionClear    【TAG】データベースコネクションプールのコネクションを削除(開放)します(初期値:false)
               resourceClear      【TAG】リソースデータをクリアします(初期値:false)
               guiClear           【TAG】GUI情報のキャッシュをクリアします(初期値:false)
               userClear          【TAG】User情報のパラメータデータをクリアします(初期値:false)
               calendarClear      【TAG】カレンダオブジェクトのキャッシュをクリアします(初期値:false)
               debug              【TAG】デバッグ情報を出力するかどうか[true/false]を指定します(初期値:false)
           />

         ●使用例
             <og:engine
                 connectionClear = "true"  初期値:false
                 resourceClear   = "true"  初期値:false
                 guiClear        = "true"  初期値:false
                 userClear       = "true"  初期値:false
                 calendarClear   = "true"  初期値:false
             />

             <og:engine
                 allClear = "true"
             />

  機能分類
    ログイン制御
  変更履歴:
    3.6.0.0 (2004/09/17) 新規作成
  バージョン
    4.0
  作成者
    Kazuhiko Hasegawa
  導入されたバージョン:
    JDK5.0,

- - ### フィールドのサマリー

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

      `BR, BUFFER_MIDDLE, CR`

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

      `bodyContent`

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

      `id, pageContext`

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

      `EVAL_BODY_BUFFERED, EVAL_BODY_TAG`

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

      `EVAL_BODY_AGAIN`

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

      `EVAL_BODY_INCLUDE, EVAL_PAGE, SKIP_BODY, SKIP_PAGE`

  - ### コンストラクタのサマリー

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

  - ### メソッドのサマリー

    すべてのメソッド インスタンス・メソッド concreteメソッド
    修飾子とタイプ | メソッドと説明
    --- | ---
    `int` | `doEndTag()` Taglibの終了タグが見つかったときに処理する doEndTag() を オーバーライドします。
    `protected void` | `release2()` タグリブオブジェクトをリリースします。
    `void` | `setAllClear(java.lang.String flag)` 【TAG】すべてのキャッシュデータをクリアします(初期値:false)。
    `void` | `setCalendarClear(java.lang.String flag)` 【TAG】カレンダオブジェクトのキャッシュをクリアします(初期値:false)。
    `void` | `setConnectionClear(java.lang.String flag)` 【TAG】データベースコネクションプールのコネクションを削除(開放)します(初期値:false)。
    `void` | `setGuiClear(java.lang.String flag)` 【TAG】GUI情報のキャッシュをクリアします(初期値:false)。
    `void` | `setResourceClear(java.lang.String flag)` 【TAG】リソースデータをクリアします(初期値:false)。
    `void` | `setUserClear(java.lang.String flag)` 【TAG】User情報のパラメータデータをクリアします(初期値:false)。
    `java.lang.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, getDataCondition, getDateFormat, getDBColumn, getDBFunctionName, getDocumentLink, getGUIInfo, getGUIInfoAttri, getHostName, getLabel, getLabelInterface, getLanguage, getLASTAttri, getLongLabel, getMsg, getMsglbl, getNVLAttri, getObject, getParameterNames, getParameterRows, getRequest, getRequestAttribute, getRequestCacheData, getRequestMethod, getRequestParameter, getRequestParameterValues, getRequestValue, getRequestValue, getRequestValues, getReservedParameter, getReservedValue, getResource, getSanitizedBodyString, getScope, getSessionAttribute, getSumRequestValue, 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`

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

      `doInitBody, getBodyContent, getPreviousOut, release, setBodyContent`

    - ### クラスから継承されたメソッド javax.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`

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

      `getParent, setPageContext, setParent`

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

    - #### EngineTag

          public EngineTag()

      デフォルトコンストラクター
      変更履歴:
        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`
      戻り値:
        後続処理の指示

    - #### release2

          protected void release2()

      タグリブオブジェクトをリリースします。 キャッシュされて再利用されるので、フィールドの初期設定を行います。
      オーバーライド:
        `release2` クラス内 `CommonTagSupport`

    - #### setAllClear

          public void setAllClear(java.lang.String flag)

      【TAG】すべてのキャッシュデータをクリアします(初期値:false)。
      パラメータ:
        `flag` - キャッシュクリア [true:すべて/false:個別]
      説明:
        connectionClear,resourceClear,guiClear,calendarClearの すべてを、true に設定することと同じです。

    - #### setConnectionClear

          public void setConnectionClear(java.lang.String flag)

      【TAG】データベースコネクションプールのコネクションを削除(開放)します(初期値:false)。
      パラメータ:
        `flag` - コネクション削除可否 [true:する/false:しない]
      説明:
        データベース操作がおかしい場合は、クリアしてみてください。

    - #### setResourceClear

          public void setResourceClear(java.lang.String flag)

      【TAG】リソースデータをクリアします(初期値:false)。
      パラメータ:
        `flag` - リソースデータのクリア可否 [true:する/false:しない]
      説明:
        ユーザーリソースとシステムリソースを除くリソースキャッシュ データをクリアします。

    - #### setUserClear

          public void setUserClear(java.lang.String flag)

      【TAG】User情報のパラメータデータをクリアします(初期値:false)。
      パラメータ:
        `flag` - パラメータデータのクリア可否 [true:する/false:しない]
      説明:
        User情報のパラメータデータ(GE16から読み込み)に追加/更新/削除が発生したときは、 キャッシュをクリアする必要があります。 User情報のパラメータデータは、{@USER.XXXX}でアクセスできる値ではなく、 システムパラメータ {@SYS.XXXX}としてアクセスできるユーザー個別情報のことです。

    - #### setGuiClear

          public void setGuiClear(java.lang.String flag)

      【TAG】GUI情報のキャッシュをクリアします(初期値:false)。
      パラメータ:
        `flag` - GUI情報キャッシュのクリア可否 [true:する/false:しない]
      説明:
        GUI情報の追加/更新/削除が発生したときは、キャッシュをクリアする必要があります。

    - #### setCalendarClear

          public void setCalendarClear(java.lang.String flag)

      【TAG】カレンダオブジェクトのキャッシュをクリアします(初期値:false)。
      パラメータ:
        `flag` - カレンダのキャッシュのクリア可否 [true:する/false:しない]
      説明:
        カレンダオブジェクトは、事業所カレンダ(例：GE13)毎にオブジェクトを 作成します。キャッシュに持っているため、データベースを更新するたびに、 キャッシュをクリアしなおす必要があります。

    - #### toString

          public java.lang.String toString()

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

Webアプリケーションフレームワーク openGion
Copyright (c) 2009 The openGion Project.