org.opengion.hayabusa.taglib

## クラス DBConfigEditorTag

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

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

      public class DBConfigEditorTag
      extends CommonTagSupport

       DBConfig.xmlの編集を行うためのタグです。

       自分自身のコンテキストのDBConfig.xmlの編集及び、ファイルパスを指定して他の
       コンテキストのDBConfig.xmlの編集を行うことができます。

       編集タイプは、type属性により、「DBドライバークラス」と「DBIDの設定情報」の2つを
       切り替えることができます。

       また、このタグ自体の機能としては、「取得」、「保存」、「情報」に分離されています。

       (1)取得(command="GET")
        type属性で指定された情報を読み取り、DBTableModel形式に変換し、セッションに登録します。
        (tableIdは"DEFAULT"です)

       (2)保存(command="SET")
        セッションからDBTableModelを読み取り、type属性で指定された情報の形式にオブジェクト化し、
        DBConfig.xmlに保存します。
        (DBTableModelを取得するtableIdは"DEFAULT"です)

        保存を実行すると、元のDBConfig.xmlファイルと同じ場所に、タイプスタンプ付きのバックアップ
        ファイルが自動的に作成されます。

        また、xmlFile(DBConfig.xml)を指定しない状態で、保存(command="SET")を行うと、
        内部にキャッシュしている接続情報は、一旦全てクリアされます。

       (3)情報(command="INFO")
        DBID情報のキーとタイトルから、プルダウンメニューを作成するための情報を画面出力します。
        この値を、valueタグで取込み、columnタグのcodeKeyVal変数にセットすれば、DBIDの選択メニューを
        作成できます。開発用に接続先を切り替える処理等に使います。

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

         ●形式：<dbConfigEditor command="..." type="..." xmlFile="..." />
         ●body：なし

         ●Tag定義：
           <og:dbConfigEditor
               command            【TAG】DBConfig.xmlに対する操作のコマンド (GET/SET/INFO)を指定します(初期値:GET)
               type               【TAG】DBConfig.xmlに対する操作のタイプ(DBID/CLASS)を指定します(初期値:DBID)
               xmlFile            【TAG】編集を行うDBConfig.xmlのファイルのパスを指定します(初期値:自身のDBConfig.xml)
               debug              【TAG】デバッグ情報を出力するかどうか[true/false]を指定します(初期値:false)
           />

         ●使用例
            ・取得
                <dbConfigEditor command="GET" type="{@TYPE}" xmlFile="{@DBCXML}" />

            ・保存
                <dbConfigEditor command="SET" type="{@MEM.TYPE}" xmlFile="{@MEM.DBCXML}" />

            ・情報
                <value command="SET" key="DBID_INFO" >
                  <dbConfigEditor command="INFO" />
                </value>

                <column name="DBID_INFO" codeKeyVal="{@DBID_INFO}" />

  機能分類
    その他部品
  バージョン
    4.0
  作成者
    Hiroki Nakamura
  導入されたバージョン:
    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`

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

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

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

    すべてのメソッド インスタンス・メソッド concreteメソッド
    修飾子とタイプ | メソッドと説明
    --- | ---
    `int` | `doEndTag()` Taglibの終了タグが見つかったときに処理する doEndTag() を オーバーライドします。
    `int` | `doStartTag()` Taglibの開始タグが見つかったときに処理する doStartTag() を オーバーライドします。
    `protected void` | `release2()` タグリブオブジェクトをリリースします。
    `void` | `setCommand(String cmd)` 【TAG】DBConfig.xmlに対する操作のコマンド (GET/SET/INFO)を指定します(初期値:GET)。
    `void` | `setType(String tp)` 【TAG】DBConfig.xmlに対する操作のタイプ(DBID/CLASS)を指定します(初期値:DBID)。
    `void` | `setXmlFile(String file)` 【TAG】編集を行うDBConfig.xmlのファイルのパスを指定します(初期値:自身のDBConfig.xml)。
    `String` | `toString()` このオブジェクトの文字列表現を返します。

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

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

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

    - #### DBConfigEditorTag

          public DBConfigEditorTag()

      デフォルトコンストラクター
      変更履歴:

        6.4.2.0 (2016/01/29) PMD refactoring. Each class should declare at least one constructor.

  - ### メソッドの詳細

    - #### doStartTag

          public int doStartTag()

      Taglibの開始タグが見つかったときに処理する doStartTag() を オーバーライドします。
      定義:
        `doStartTag` インタフェース内 `Tag`
      オーバーライド:
        `doStartTag` クラス内 `CommonTagSupport`
      戻り値:
        後続処理の指示( SKIP_BODY )

    - #### doEndTag

          public int doEndTag()

      Taglibの終了タグが見つかったときに処理する doEndTag() を オーバーライドします。
      定義:
        `doEndTag` インタフェース内 `Tag`
      オーバーライド:
        `doEndTag` クラス内 `CommonTagSupport`
      戻り値:
        後続処理の指示
      変更履歴:

        5.6.7.0 (2013/07/27) command="INFO" 対応

    - #### release2

          protected void release2()

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

    - #### setCommand

          public void setCommand(String cmd)

      【TAG】DBConfig.xmlに対する操作のコマンド (GET/SET/INFO)を指定します(初期値:GET)。
      パラメータ:
        `cmd` - コマンド
      説明:

             GET  ⇒ typeに応じた情報をDBConfig.xmlから読み出し、DBTableModelに登録します。
              SET  ⇒ typeに応じた情報をDBTableModelから読み出し、DBConfig.xmlに登録します。
              INFO ⇒ DBConfig.xmlに登録されている DBID のキーとタイトルを連結したコードリソース情報を画面出力します。

             なお、保存(SET)を実行すると、元のDBConfig.xmlファイルと同じ場所に、タイプスタンプ付きの
             バックアップファイルが自動的に作成されます。

             また、xmlFile(DBConfig.xml)を指定しない状態で、保存(command="SET")を行うと、
             内部にキャッシュしている接続情報は、一旦全てクリアされます。

      変更履歴:

        5.6.7.0 (2013/07/27) command として使用できる文字列をチェックします。

    - #### setType

          public void setType(String tp)

      【TAG】DBConfig.xmlに対する操作のタイプ(DBID/CLASS)を指定します(初期値:DBID)。
      パラメータ:
        `tp` - タイプ
      説明:

             DBID  ⇒ DBIDの各種情報を読み取り/書き込みします。
              CLASS ⇒ ロードするDBドライバーの一覧を読み取り/書き込みします。

      変更履歴:

        5.6.7.0 (2013/07/27) type として使用できる文字列をチェックします。

    - #### setXmlFile

          public void setXmlFile(String file)

      【TAG】編集を行うDBConfig.xmlのファイルのパスを指定します(初期値:自身のDBConfig.xml)。
      パラメータ:
        `file` - DBConfig.xmlのファイルパス
      説明:

             何も指定されない場合は、自身のコンテキストのDBConfig.xmlに対する編集となります。

    - #### toString

          public String toString()

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

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