org.opengion.plugin.table

## クラス TableFilter_CMNT_CLM

- java.lang.Object
- - org.opengion.hayabusa.db.AbstractTableFilter
  - - org.opengion.plugin.table.TableFilter_CMNT_CLM

- すべての実装されたインタフェース:
    TableFilter

      public class TableFilter_CMNT_CLM
      extends AbstractTableFilter

       TableFilter_CMNT_CLM は、TableFilter インターフェースを継承した、DBTableModel 処理用の
       実装クラスです。

       ここでは、テーブルカラム一覧の検索結果より、ORACLE のテーブルカラムにコメントを作成します。
       構文は、「COMMENT ON COLUMN テーブル名.カラム名 IS 'コメント'」です。
       このコメントを取り出す場合は、
      「SELECT COLUMN_NAME, COMMENTS FROM USER_COL_COMMENTS WHERE TABLE_NAME = 'テーブル名'」
       とします。

       SQLのツール類には、このコメントを使用して、テーブルカラムの日本語名を表示させたりします。

       検索では、(TABLE_NAME,CLM,NAME_JA) の項目を取得する必要があります。

       パラメータは、tableFilterタグの keys, vals にそれぞれ記述するか、BODY 部にCSS形式で記述します。
       出力ファイル名は、通常、テーブル で１つ、カラムで１つにまとめて作成されます。
       【パラメータ】
        {
             DIR  : {@BASE_DIR}/sql/install/08_CMNT ;    出力ファイルの基準フォルダ(必須)
             FILE : false ;                                   出力ファイル名(初期値:CMNT_CLM[.sql|.xml])
             XML  : false ;                                   XML出力を行うかどうか[true/false]を指定します(初期値:false)
        }

  形式サンプル:

         ●形式：
              select SYSTEM_ID,TABLE_NAME,NAME_JA from GF02

              ① <og:tableFilter classId="CMNT_CLM" keys="DIR" vals='"{@BASE_DIR}/sql/install/08_CMNT"' />

              ② <og:tableFilter classId="CMNT_CLM" >
                       {
                           DIR   : {@BASE_DIR}/sql/install/08_CMNT ;
                           FILE  : CMNT_CLM ;
                           XML   : false ;
                       }
                 </og:tableFilter>

  変更履歴:
    4.0.0.0 (2005/08/31) 新規作成
  バージョン
    0.9.0 2000/10/17
  作成者
    Kazuhiko Hasegawa
  導入されたバージョン:
    JDK1.6,

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

    フィールド
    修飾子とタイプ | フィールドと説明
    --- | ---
    `protected static int` | `CLM` データのアクセス用の配列番号 1
    `protected static int` | `NAME_JA` データのアクセス用の配列番号 2
    `protected static int` | `TABLE_NAME` データのアクセス用の配列番号 0

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

      `BUFFER_MIDDLE, CR, EXEC_END_TAG, EXEC_START_TAG, execEndTag, isXml, XML_END_TAG, XML_START_TAG`

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

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

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

    すべてのメソッド インスタンス・メソッド concreteメソッド
    修飾子とタイプ | メソッドと説明
    --- | ---
    `DBTableModel` | `execute()` DBTableModel処理を実行します。

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

      `getDbid, getDBTableModel, getErrorCode, getErrorMessage, getKeys, getModifyType, getParameterRows, getResource, getSql, getTableColumnNo, getTransaction, getValue, initSet, isDebug, makeErrorMessage, setDbid, setDBTableModel, setDebug, setKeysVals, setModifyType, setParameterRows, setParamMap, setResource, setSql, setTransaction`

    - ### クラスから継承されたメソッド java.lang.Object

      `clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

- - ### フィールドの詳細

    - #### TABLE_NAME

          protected static final int TABLE_NAME

      データのアクセス用の配列番号 0
      関連項目:
        定数フィールド値

    - #### CLM

          protected static final int CLM

      データのアクセス用の配列番号 1
      関連項目:
        定数フィールド値

    - #### NAME_JA

          protected static final int NAME_JA

      データのアクセス用の配列番号 2
      関連項目:
        定数フィールド値

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

    - #### TableFilter_CMNT_CLM

          public TableFilter_CMNT_CLM()

      デフォルトコンストラクター
      変更履歴:
        6.4.1.1 (2016/01/16) keysMap を、サブクラスから設定させるように変更。

  - ### メソッドの詳細

    - #### execute

          public DBTableModel execute()

      DBTableModel処理を実行します。
      戻り値:
        実行結果のテーブルモデル
      変更履歴:
        6.0.2.3 (2014/10/10) EXEC_END_TAG を追加。キャッシュします。, 6.3.7.0 (2015/09/04) AutoCloseableを使用したtry-with-resources構築に対応。

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