概要 | パッケージ | クラス | 階層ツリー | 非推奨 API | 索引 | ヘルプ
openGion 5.0.0.3
前のクラス 次のクラス | フレームあり フレームなし
概要: 入れ子 | フィールド | コンストラクタ | メソッド | 詳細: フィールド | コンストラクタ | メソッド

## org.opengion.hayabusa.taglib
クラス DBMetaDataQueryTag

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

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

    public class DBMetaDataQueryTag

extends CommonTagSupport

データベース情報(DBMetaData)より、テーブル、カラム等の情報を取得するタグです。 データベースに関する包括的な情報を提供する、DatabaseMetaData の内容を 取得して、DBTableModel にセットするタグです。

関連項目:
  直列化された形式
機能階層
  ＤＢ検索
形式サンプル:

       ●形式：<og:dbMetaDataQuery action="･･･" ･･･ />
       ●body：なし

       ●使用例
          command属性 は、columnSetタグのcommand属性と同一の場合のみ、処理します。
          [command属性]
            NEW       新規
            RENEW     再検索

          [action属性]
            SCHEMAS    このデータベースで使用可能なスキーマ名を取得します。
            TABLES     指定されたカタログで使用可能なテーブルに関する記述を取得します。
            COLUMNS    指定されたカタログで使用可能なテーブル列の記述を取得します。
            INDEXINFO  指定されたテーブルのインデックスと統計情報に関する記述を取得します。
            PROCEDURES 指定されたカタログで使用可能なストアドプロシージャに関する記述を取得します。

バージョン
  4.0
作成者
  Kazuhiko Hasegawa
導入されたバージョン:
  JDK5.0,

フィールドの概要
`static java.lang.String` | `ACT_COLUMNS` action 引数に渡す事の出来る アクションコマンド テーブル列 "COLUMNS"
`static java.lang.String` | `ACT_INDEXINFO` action 引数に渡す事の出来る アクションコマンド インデックスと統計情報"INDEXINFO"
`static java.lang.String` | `ACT_PROCEDURES` action 引数に渡す事の出来る アクションコマンド ストアドプロシージャ"PROCEDURES"
`static java.lang.String` | `ACT_SCHEMAS` action 引数に渡す事の出来る アクションコマンド スキーマ名 "SCHEMAS"
`static java.lang.String` | `ACT_TABLES` action 引数に渡す事の出来る アクションコマンド テーブル "TABLES"
`static java.lang.String` | `CMD_NEW` command 引数に渡す事の出来る コマンド 新規 "NEW"
`static java.lang.String` | `CMD_RENEW` command 引数に渡す事の出来る コマンド 再検索 "RENEW"

クラス 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`

コンストラクタの概要
`DBMetaDataQueryTag()`

メソッドの概要
`int` | `doEndTag()` Taglibの終了タグが見つかったときに処理する doEndTag() を オーバーライドします。
`int` | `doStartTag()` Taglibの開始タグが見つかったときに処理する doStartTag() を オーバーライドします。
`protected java.lang.String` | `getTagName()` タグの名称を、返します。
`protected void` | `release2()` タグリブオブジェクトをリリースします。
`void` | `setAction(java.lang.String cmd)` 【TAG】アクション(SCHEMAS,TABLES,COLUMNS,INDEXINFO,PROCEDURES)を指定します。
`void` | `setApproximate(java.lang.String appFlag)` 【TAG】統計情報の精度(true:概数 / false:正確)を指定します(初期値:true)。
`void` | `setCatalog(java.lang.String catalog)` 【TAG】カタログ名をセットします(初期値:null)。
`void` | `setColumnName(java.lang.String columnName)` 【TAG】列名パターンをセットします(初期値:null)。
`void` | `setCommand(java.lang.String cmd)` 【TAG】コマンド(NEW,RENEW)をセットします(初期値:NEW)。
`void` | `setDbid(java.lang.String id)` 【TAG】(通常は使いません)Queryオブジェクトを作成する時のDB接続IDを指定します。
`void` | `setDisplayMsg(java.lang.String id)` 【TAG】検索結果を画面上に表示するメッセージリソースIDを指定します(初期値:MSG0033[　件検索しました])。
`void` | `setNotfoundMsg(java.lang.String id)` 【TAG】検索結果がゼロ件の場合に表示するメッセージリソースIDを指定します(初期値:MSG0077[対象データはありませんでした])。
`void` | `setProcName(java.lang.String procName)` 【TAG】プロシージャ名パターンをセットします(初期値:null)。
`void` | `setSchema(java.lang.String schema)` 【TAG】スキーマ名パターンをセットします(初期値:null)。
`void` | `setTableId(java.lang.String id)` 【TAG】(通常は使いません)結果をDBTableModelに書き込んで、sessionに登録するときのキーを指定します。
`void` | `setTableName(java.lang.String tableName)` 【TAG】テーブル名パターンをセットします(初期値:null)。
`void` | `setUnique(java.lang.String uniqFlag)` 【TAG】返すインデックスの種類(true:ユニークのみ / false:非ユニーク含む)を指定します(初期値:false)。
`java.lang.String` | `toString()` このオブジェクトの文字列表現を返します。

クラス org.opengion.hayabusa.taglib.CommonTagSupport から継承されたメソッド
`add, add, addEventColumnSQL, check, check, commitTableObject, debugPrint, doAfterBody, doCatch, doFinally, get, getApplicationInfo, getAttributes, getBodyRawString, getBodyString, getContextAttribute, getContextPath, getCookie, getCSVParameter, getDataCondition, getDateFormat, getDBColumn, getDBFunctionName, getDocumentLink, getGUIInfo, getGUIInfoAttri, getLabel, getLabelInterface, getLanguage, getLongLabel, getMsglbl, getObject, getParameterNames, getParameterRows, getRequest, getRequestAttribute, getRequestCacheData, getRequestParameter, getRequestParameterValues, getRequestValue, getRequestValue, getRequestValues, getResource, getScope, getSessionAttribute, getUser, getUserInfo, isAjaxSubmitSession, isDebug, isNoTransitionSession, isNull, jspPrint, removeContextAttribute, removeObject, removeRequestAttribute, removeSessionAttribute, set, setAjaxSubmitSession, setContextAttribute, setCookie, setDebug, setLanguage, setLbl, setMsglbl, setNoTransitionSession, setObject, setParameterRows, setRequestAttribute, setRequestCacheData, setScope, setSessionAttribute, setUserInfo, setUseValue, startQueryTransaction, sys, sysBool, sysInt, useQuotCheck, 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`

フィールドの詳細

### CMD_NEW

    public static final java.lang.String CMD_NEW

  command 引数に渡す事の出来る コマンド 新規 "NEW"

  関連項目:
    定数フィールド値

### CMD_RENEW

    public static final java.lang.String CMD_RENEW

  command 引数に渡す事の出来る コマンド 再検索 "RENEW"

  関連項目:
    定数フィールド値

### ACT_SCHEMAS

    public static final java.lang.String ACT_SCHEMAS

  action 引数に渡す事の出来る アクションコマンド スキーマ名 "SCHEMAS"

  関連項目:
    定数フィールド値

### ACT_TABLES

    public static final java.lang.String ACT_TABLES

  action 引数に渡す事の出来る アクションコマンド テーブル "TABLES"

  関連項目:
    定数フィールド値

### ACT_COLUMNS

    public static final java.lang.String ACT_COLUMNS

  action 引数に渡す事の出来る アクションコマンド テーブル列 "COLUMNS"

  関連項目:
    定数フィールド値

### ACT_INDEXINFO

    public static final java.lang.String ACT_INDEXINFO

  action 引数に渡す事の出来る アクションコマンド インデックスと統計情報"INDEXINFO"

  関連項目:
    定数フィールド値

### ACT_PROCEDURES

    public static final java.lang.String ACT_PROCEDURES

  action 引数に渡す事の出来る アクションコマンド ストアドプロシージャ"PROCEDURES"

  関連項目:
    定数フィールド値

コンストラクタの詳細

### DBMetaDataQueryTag

    public DBMetaDataQueryTag()

メソッドの詳細

### doStartTag

    public int doStartTag()

  Taglibの開始タグが見つかったときに処理する doStartTag() を オーバーライドします。

  定義:
    インタフェース `javax.servlet.jsp.tagext.Tag` 内の `doStartTag`
  オーバーライド:
    クラス `CommonTagSupport` 内の `doStartTag`
  戻り値:
    int

### doEndTag

    public int doEndTag()

  Taglibの終了タグが見つかったときに処理する doEndTag() を オーバーライドします。

  定義:
    インタフェース `javax.servlet.jsp.tagext.Tag` 内の `doEndTag`
  オーバーライド:
    クラス `CommonTagSupport` 内の `doEndTag`
  戻り値:
    int
  変更履歴:

    4.0.0 (2006/11/14) notfoundMsg 属性を追加。displayMsg は、VIEW_USE_DISPLAY_MSG で制御
    4.0.0.0 (2007/10/18) メッセージリソース統合( getResource().getMessage > getResource().getLabel )

### release2

    protected void release2()

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

  オーバーライド:
    クラス `CommonTagSupport` 内の `release2`
  変更履歴:

    4.0.0.0 (2007/10/10) dbid の初期値を、"DEFAULT" から null に変更

### setCommand

    public void setCommand(java.lang.String cmd)

  【TAG】コマンド(NEW,RENEW)をセットします(初期値:NEW)。

  パラメータ:
    `cmd` - コマンド（public static final 宣言されている文字列)
  関連項目:
    コマンド定数
  TagLib:

    コマンドは,HTMLから（get/post)指定されますので,CMD_xxx で設定される フィールド定数値のいづれかを、指定できます。

### setAction

    public void setAction(java.lang.String cmd)

  【TAG】アクション(SCHEMAS,TABLES,COLUMNS,INDEXINFO,PROCEDURES)を指定します。

  パラメータ:
    `cmd` - アクション文字列
  関連項目:
    アクション定数
  TagLib:

    アクションは,HTMLから（get/post)指定されますので,ACT_xxx で設定される フィールド定数値のいづれかを、指定できます。 SCHEMAS このデータベースで使用可能なスキーマ名を取得します。 TABLES 指定されたカタログで使用可能なテーブルに関する記述を取得します。 COLUMNS 指定されたカタログで使用可能なテーブル列の記述を取得します。 INDEXINFO 指定されたテーブルのインデックスと統計情報に関する記述を取得します。 PROCEDURES 指定されたカタログで使用可能なストアドプロシージャに関する記述を取得します。

### setDbid

    public void setDbid(java.lang.String id)

  【TAG】(通常は使いません)Queryオブジェクトを作成する時のDB接続IDを指定します。

  パラメータ:
    `id` - データベース接続ID
  TagLib:

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

### setCatalog

    public void setCatalog(java.lang.String catalog)

  【TAG】カタログ名をセットします(初期値:null)。

  パラメータ:
    `catalog` - カタログ名
  TagLib:

    データベースに格納されたカタログ名と一致しなければならない。 "" はカタログなしでカタログ名を検索する。 null は、カタログ名を検索の限定に使用してはならないことを意味する

### setSchema

    public void setSchema(java.lang.String schema)

  【TAG】スキーマ名パターンをセットします(初期値:null)。

  パラメータ:
    `schema` - スキーマ名パターン
  TagLib:

    データベースに格納されたスキーマ名と一致しなければならない。 "" はスキーマなしでスキーマ名を検索する。 null は、スキーマ名を検索の限定に使用してはならないことを意味する

### setTableName

    public void setTableName(java.lang.String tableName)

  【TAG】テーブル名パターンをセットします(初期値:null)。

  パラメータ:
    `tableName` - テーブル名パターン
  TagLib:

    。データベースに格納されたテーブル名と一致しなければならない

### setProcName

    public void setProcName(java.lang.String procName)

  【TAG】プロシージャ名パターンをセットします(初期値:null)。

  パラメータ:
    `procName` - プロシージャ名パターン
  TagLib:

    。データベースに格納されたプロシージャ名と一致しなければならない

### setColumnName

    public void setColumnName(java.lang.String columnName)

  【TAG】列名パターンをセットします(初期値:null)。

  パラメータ:
    `columnName` - 列名パターン
  TagLib:

    データベースに格納された列名と一致しなければならない

### setUnique

    public void setUnique(java.lang.String uniqFlag)

  【TAG】返すインデックスの種類(true:ユニークのみ / false:非ユニーク含む)を指定します(初期値:false)。

  パラメータ:
    `uniqFlag` - 返すインデックスの種類(true:ユニークのみ / false:非ユニーク含む)
  TagLib:

    true の場合は、一意の値のインデックスだけを返す。 false の場合は、一意であるかどうかにかかわらずインデックスを返す 初期値は、false:非ユニーク含む です。

### setApproximate

    public void setApproximate(java.lang.String appFlag)

  【TAG】統計情報の精度(true:概数 / false:正確)を指定します(初期値:true)。

  パラメータ:
    `appFlag` - 統計情報の精度(true:概数 / false:正確)
  TagLib:

    指定されたテーブルのインデックスと統計情報に関する記述を取得する場合に 結果の精度を指定します。 true の場合は、結果は概数またはデータ値から外れることもある。 false の場合は、正確であることが要求される 初期値は、true:概数 です。

### setTableId

    public void setTableId(java.lang.String id)

  【TAG】(通常は使いません)結果をDBTableModelに書き込んで、sessionに登録するときのキーを指定します。

  パラメータ:
    `id` - sessionに登録する時の ID
  TagLib:

    初期値は、HybsSystem.TBL_MDL_KEY です。

### setDisplayMsg

    public void setDisplayMsg(java.lang.String id)

  【TAG】検索結果を画面上に表示するメッセージリソースIDを指定します(初期値:MSG0033[　件検索しました])。

  パラメータ:
    `id` - ディスプレイに表示させるメッセージ ID
  TagLib:

    ここでは、検索結果の件数や登録された件数をまず出力し、 その次に、ここで指定したメッセージをリソースから取得して 表示します。 表示させたくない場合は, displayMsg = "" をセットしてください。 初期値は、検索件数を表示します。

### setNotfoundMsg

    public void setNotfoundMsg(java.lang.String id)

  【TAG】検索結果がゼロ件の場合に表示するメッセージリソースIDを指定します(初期値:MSG0077[対象データはありませんでした])。

  パラメータ:
    `id` - ディスプレイに表示させるメッセージ ID
  TagLib:

    ここでは、検索結果がゼロ件の場合のみ、特別なメッセージを表示させます。 従来は、displayMsg と兼用で、『0　件検索しました』という表示でしたが、 displayMsg の初期表示は、OFF になりましたので、ゼロ件の場合のみ別に表示させます。 表示させたくない場合は, notfoundMsg = "" をセットしてください。 初期値は、MSG0077[対象データはありませんでした]です。

### getTagName

    protected java.lang.String getTagName()

  タグの名称を、返します。 自分自身のクラス名より、自動的に取り出せないため、このメソッドをオーバーライドします。

  オーバーライド:
    クラス `CommonTagSupport` 内の `getTagName`
  戻り値:
    タグの名称
  関連項目:
    `CommonTagSupport.getDocumentLink()`
  変更履歴:

    4.0.0 (2005/01/31) 新規追加

### toString

    public java.lang.String toString()

  このオブジェクトの文字列表現を返します。 基本的にデバッグ目的に使用します。

  オーバーライド:
    クラス `CommonTagSupport` 内の `toString`
  戻り値:
    このクラスの文字列表現

概要 | パッケージ | クラス | 階層ツリー | 非推奨 API | 索引 | ヘルプ
| openGion 5.0.0.3
前のクラス 次のクラス | フレームあり フレームなし
概要: 入れ子 | フィールド | コンストラクタ | メソッド | 詳細: フィールド | コンストラクタ | メソッド

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