org.opengion.hayabusa.taglib

## クラス GuiQueryTag

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

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

      public class GuiQueryTag
      extends QueryTag

       画面リソースのオブジェクトを検索し、DBTableModel にセットするタグです。

       ファイルの検索結果は、GUIKEY,ADDRESS,REALADDRESS,SEQNO,GROUPS,CLASSIFY,LEVEL,
       NAME_JA,SNAME,LNAME,ROLES,RWMODE,TARGET,PARAM,KBLINK,DESCRIPTION,DYUPD のカラムを持つ
       DBTableModel にセット されます。このカラムは、固定です。
       並び替え、および、画面リソースの選別(where 条件)は、固定で、指定できません。

       [カラム名]      検索するオブジェクトの属性は、以下のカラム名で作成されます。(固定)
           GUIKEY        画面ID
           ADDRESS       実行アドレス
           REALADDRESS   実行実アドレス
           SEQNO         表示順
           GROUPS        メニュグループ
           CLASSIFY      メニュ分類
           LEVEL         メニュ階層番号
           NAME_JA       画面名称
           SNAME         画面名称(short)
           LNAME         画面名称(long)
           ROLES         ロールズ
           MODE          アクセスモード列(mr,mw,-r,-w の羅列)
           TARGET        ターゲット
           PARAM         設定値(パラメータ)
           KBLINK        リンク区分
           DESCRIPTION   概要説明
           DYUPD         更新日時

       [roles 属性]      画面リソースの選別となる、ROLES 属性

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

         ●形式：<og:guiQuery command="…" roles="…" />
         ●body：なし

         ●Tag定義：
           <og:guiQuery
               roles              【TAG】画面リソースの条件となるロールズを指定します
               level              【TAG】画面リソースの条件となるレベルを指定します
               rwmode             【TAG】画面リソースの条件となるRWモードを指定します
               command            【TAG】コマンド (NEW,RENEW)をセットします(PlsqlUpdateTag,UpdateTag の場合は、ENTRY)
               scope              【TAG】キャッシュする場合のスコープ[request/page/session/application]を指定します(初期値:session)
               displayMsg         【TAG】検索結果を画面上に表示するメッセージリソースIDを指定します (初期値:VIEW_DISPLAY_MSG[=])
               notfoundMsg        【TAG】検索結果がゼロ件の場合に表示するメッセージリソースIDを指定します(初期値:MSG0077[対象データはありませんでした])
               tableId            【TAG】(通常は使いません)結果のDBTableModelを、sessionに登録するときのキーを指定します
               useBeforeHtmlTag   【TAG】 処理時間(queryTime)などの情報出力[true:有効/false:無効]を指定します(初期値:true)
               debug              【TAG】デバッグ情報を出力するかどうか[true/false]を指定します(初期値:false)
           >   ... Body ...
           </og:guiQuery>

         ●使用例
                 <og:guiQuery
                        command = "NEW"
                        roles   = "AA|BB|CC"
                 />

  機能分類
    その他入力
  変更履歴:
    5.2.2.0 (2010/11/01) 新規追加
  バージョン
    4.0
  作成者
    Kazuhiko Hasegawa
  導入されたバージョン:
    JDK5.0,

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

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

      `CMD_NEW, CMD_RENEW, command, dispError, displayMsg, dyStart, ERR_MSG_ID, errCode, errMessage, executeCount, maxRowCount, names, outMessage, quotCheck, skipRowCount, sql, stopError, table, tableId, useTimeView, xssCheck`

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

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

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

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

    すべてのメソッド インスタンス・メソッド concreteメソッド
    修飾子とタイプ | メソッドと説明
    --- | ---
    `int` | `doStartTag()` Taglibの開始タグが見つかったときに処理する doStartTag() を オーバーライドします。
    `protected void` | `execute()` guiQuery を実行します。
    `protected void` | `release2()` タグリブオブジェクトをリリースします。
    `void` | `setLevel(java.lang.String lvl)` 【TAG】画面リソースの条件となるレベルを指定します。
    `void` | `setRoles(java.lang.String rols)` 【TAG】画面リソースの条件となるロールズを指定します。
    `void` | `setRwmode(java.lang.String mode)` 【TAG】画面リソースの条件となるRWモードを指定します。
    `java.lang.String` | `toString()` このオブジェクトの文字列表現を返します。

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

      `addPlaceValue, doAfterBody, doEndTag, execute, getRequest, setCheckNames, setCommand, setDbid, setDispError, setDisplayMsg, setMainTrans, setMaxRowCount, setModifyType, setNames, setNotfoundMsg, setOutMessage, setOverflowMsg, setQueryType, setQuotCheck, setSkipRowCount, setStopError, setStopZero, setTableId, setTrace, setUseBeforeHtmlTag, setUseTimeView, setXssCheck`

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

      `add, add, addEventColumn, addEventColumn, check, commitTableObject, debugPrint, doCatch, doFinally, 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`

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

    - #### GuiQueryTag

          public GuiQueryTag()

      デフォルトコンストラクター
      変更履歴:
        6.4.2.0 (2016/01/29) PMD refactoring. Each class should declare at least one constructor.

  - ### メソッドの詳細

    - #### doStartTag

          public int doStartTag()

      Taglibの開始タグが見つかったときに処理する doStartTag() を オーバーライドします。 通常の QueryTagでは、Body を評価する(EVAL_BODY_BUFFERED)を返しますが、 GuiQueryでは BODYを評価しない為、SKIP_BODY を返します。
      定義:
        `doStartTag` インタフェース内 `Tag`
      オーバーライド:
        `doStartTag` クラス内 `QueryTag`
      戻り値:
        後続処理の指示(SKIP_BODY)

    - #### release2

          protected void release2()

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

    - #### execute

          protected void execute()

      guiQuery を実行します。

    - #### setRoles

          public void setRoles(java.lang.String rols)

      【TAG】画面リソースの条件となるロールズを指定します。
      パラメータ:
        `rols` - ロールズ
      説明:
        ロールズ判定は、ダミーユーザーを作成して通常の処理と同様の判定方式で 有効な画面リソースをピックアップします。

    - #### setLevel

          public void setLevel(java.lang.String lvl)

      【TAG】画面リソースの条件となるレベルを指定します。
      パラメータ:
        `lvl` - ロールズ
      説明:
        レベル判定は、文字列レベルの判定を行います。 画面リソースの階層番号(レベル)は、 　0:グループ分類メニュー(class="GUI_GRP"のtdタグで囲われます) 　1:トップ階層(【分類名称】) 　2:選択階層(通常の折りたたみメニュー) 　3:選択非表示(通常は、隠してあります) です。 ロール等の他の条件でピックアップされたリソースと AND 処理されます。 何も指定しなければ、すべてを対象とします。

    - #### setRwmode

          public void setRwmode(java.lang.String mode)

      【TAG】画面リソースの条件となるRWモードを指定します。
      パラメータ:
        `mode` - RWモード
      説明:
        RWモード判定は、文字列レベルの判定を行います。(通常のRW判定と異なります) RWモードの代表的な記述は、mw,mr,-w,-r です。ここでは、特殊な検索は出来ないため、 上記文字列そのままで、一致するか、m,- の前方一致で判断するかのどちらかです。 ロール等の他の条件でピックアップされたリソースと AND 処理されます。 何も指定しなければ、すべてを対象とします。

    - #### toString

          public java.lang.String toString()

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

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