org.opengion.hayabusa.taglib

## クラス DatabaseMetaDataTag

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

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

      public class DatabaseMetaDataTag
      extends CommonTagSupport

       DatabaseMetaData の情報を検索するタグです。

       ﾃﾞｰﾀﾍﾞｰｽに関する包括的な情報を提供する、DatabaseMetaData の内容を
       表示する、タグです。テスト的に使用します。

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

         ●形式：
          <og:databaseMetaData
              dbid            = "{@DBID}"
              catalog         = "{@catalog}"
              schema          = "{@schema}"
              tableName       = "{@tableName}"
              columnName      = "{@columnName}"
              typeName        = "{@typeName}"
              attributeName   = "{@attriName}"
              procedureName   = "{@procName}"
              maxRowCount     = "{@maxRowCount}"
              likeKey         = "{@likeKey}"
          />

         ●body：なし

         ●Tag定義：
           <og:databaseMetaData
               dbid               【TAG】(通常は使いません)Queryオブジェクトを作成する時のDB接続IDを指定します(初期値:null)
               catalog            【TAG】(通常は使いません)Queryオブジェクトを作成する時のカタログを指定します
               schema             【TAG】(通常は使いません)Queryオブジェクトを作成する時のスキーマを指定します
               attributeName      【TAG】(通常は使いません)Queryオブジェクトを作成する時の属性名を指定します
               columnName         【TAG】(通常は使いません)Queryオブジェクトを作成する時のカラム名を指定します
               procedureName      【TAG】(通常は使いません)Queryオブジェクトを作成する時のプロダクト名を指定します
               tableName          【TAG】(通常は使いません)Queryオブジェクトを作成する時のテーブル名を指定します
               typeName           【TAG】(通常は使いません)Queryオブジェクトを作成する時のタイプ名を指定します
               maxRowCount        【TAG】maxRowCount ResultSetで検索するパラメータの最大検索件数を指定します(初期値:20)
               likeKey            【TAG】実行するメソッドを選別するための部分一致するｷｰを指定します
               debug              【TAG】デバッグ情報を出力するかどうか[true/false]を指定します(初期値:false)
           />

         ●使用例
               <og:databaseMetaData />

  機能分類
    ＤＢ検索
  バージョン
    0.9.0 2000/10/17
  作成者
    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`

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

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

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

    すべてのメソッド インスタンス・メソッド concreteメソッド
    修飾子とタイプ | メソッドと説明
    --- | ---
    `int` | `doEndTag()` Taglibの終了タグが見つかったときに処理する doEndTag() を オーバーライドします。
    `protected void` | `release2()` タグリブオブジェクトをリリースします。
    `void` | `setAttributeName(String val)` 【TAG】(通常は使いません)Queryオブジェクトを作成する時の属性名を指定します。
    `void` | `setCatalog(String val)` 【TAG】(通常は使いません)Queryオブジェクトを作成する時のカタログを指定します(初期値:null)。
    `void` | `setColumnName(String val)` 【TAG】(通常は使いません)Queryオブジェクトを作成する時のカラム名を指定します。
    `void` | `setDbid(String id)` 【TAG】(通常は使いません)Queryオブジェクトを作成する時のDB接続IDを指定します(初期値:null)。
    `void` | `setLikeKey(String key)` 【TAG】実行するメソッドを選別するための部分一致するキーを指定します。
    `void` | `setMaxRowCount(String maxSize)` 【TAG】maxRowCount ResultSetで検索するパラメータの最大検索件数を指定します(初期値:20)。
    `void` | `setProcedureName(String val)` 【TAG】(通常は使いません)Queryオブジェクトを作成する時のプロダクト名を指定します。
    `void` | `setSchema(String val)` 【TAG】(通常は使いません)Queryオブジェクトを作成する時のスキーマを指定します。
    `void` | `setTableName(String val)` 【TAG】(通常は使いません)Queryオブジェクトを作成する時のテーブル名を指定します。
    `void` | `setTypeName(String val)` 【TAG】(通常は使いません)Queryオブジェクトを作成する時のタイプ名を指定します。
    `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, 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`

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

    - #### DatabaseMetaDataTag

          public DatabaseMetaDataTag()

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

        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`
      戻り値:
        後続処理の指示(EVAL_PAGE)
      変更履歴:

        3.8.7.0 (2006/12/15) アクセスログ取得の為,ApplicationInfoオブジェクトを設定
        4.0.0.1 (2007/12/03) try ～ catch ～ finally をきちんと行う。

    - #### release2

          protected void release2()

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

        4.0.0.0 (2007/10/10) dbid の初期値を、"DEFAULT" から null に変更
        5.5.3.2 (2012/06/08) maxRowCount 最大検索件数を、指定できるようにする。
        5.5.3.2 (2012/06/08) likeKey 特定の処理だけを実行できるように、あいまい検索

    - #### setDbid

          public void setDbid(String id)

      【TAG】(通常は使いません)Queryオブジェクトを作成する時のDB接続IDを指定します(初期値:null)。
      パラメータ:
        `id` - ﾃﾞｰﾀﾍﾞｰｽ接続ID
      説明:

             Queryオブジェクトを作成する時のDB接続IDを指定します。

    - #### setCatalog

          public void setCatalog(String val)

      【TAG】(通常は使いません)Queryオブジェクトを作成する時のカタログを指定します(初期値:null)。
      パラメータ:
        `val` - ｶﾀﾛｸﾞ情報
      説明:

             Queryオブジェクトを作成する時のカタログを指定します。

    - #### setSchema

          public void setSchema(String val)

      【TAG】(通常は使いません)Queryオブジェクトを作成する時のスキーマを指定します。
      パラメータ:
        `val` - ｽｷｰﾏ情報
      説明:

             Queryオブジェクトを作成する時のｽｷｰﾏを指定します。

    - #### setTableName

          public void setTableName(String val)

      【TAG】(通常は使いません)Queryオブジェクトを作成する時のテーブル名を指定します。
      パラメータ:
        `val` - テーブル名情報
      説明:

             Queryオブジェクトを作成する時のテーブル名を指定します。

    - #### setColumnName

          public void setColumnName(String val)

      【TAG】(通常は使いません)Queryオブジェクトを作成する時のカラム名を指定します。
      パラメータ:
        `val` - カラム名情報
      説明:

             Queryオブジェクトを作成する時のカラム名を指定します。

    - #### setTypeName

          public void setTypeName(String val)

      【TAG】(通常は使いません)Queryオブジェクトを作成する時のタイプ名を指定します。
      パラメータ:
        `val` - タイプ名情報
      説明:

             Queryオブジェクトを作成する時のタイプ名を指定します。

    - #### setProcedureName

          public void setProcedureName(String val)

      【TAG】(通常は使いません)Queryオブジェクトを作成する時のプロダクト名を指定します。
      パラメータ:
        `val` - プロダクト名情報
      説明:

             Queryオブジェクトを作成する時のプロダクト名を指定します。

    - #### setAttributeName

          public void setAttributeName(String val)

      【TAG】(通常は使いません)Queryオブジェクトを作成する時の属性名を指定します。
      パラメータ:
        `val` - 属性名情報
      説明:

             Queryオブジェクトを作成する時の属性名を指定します。

    - #### setMaxRowCount

          public void setMaxRowCount(String maxSize)

      【TAG】maxRowCount ResultSetで検索するパラメータの最大検索件数を指定します(初期値:20)。
      パラメータ:
        `maxSize` - 最大件数
      説明:

             ResultSetで検索する最大検索件数を指定します
             大量に検索されて、処理速度が低下するのを避けるため、最大件数を指定します。
             他のタグの maxRowCount の初期値設定(初期値:DB_MAX_ROW_COUNT)は利用せず、独自に設定値を持っています。
             0は、無制限とします。

      変更履歴:

        5.5.3.2 (2012/06/08) likeKey 特定の処理だけを実行できるように、あいまい検索
        5.5.8.5 (2012/11/27) 0を無制限として処理します。

    - #### setLikeKey

          public void setLikeKey(String key)

      【TAG】実行するメソッドを選別するための部分一致するキーを指定します。
      パラメータ:
        `key` - 実行するﾒｿｯﾄﾞを選別するためのｷｰ
      説明:

             DatabaseMetaData で取得できる各種情報をアクセスするにあたり、指定のキーで部分一致する
             メソッドだけ処理するように指定します。
             メソッドの部分一致で判断します。
             処理は、大文字、小文字を認識したうえで、部分一致で判定します。

      変更履歴:

        5.5.3.2 (2012/06/08) likeKey 特定の処理だけを実行できるように、あいまい検索

    - #### toString

          public String toString()

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

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