org.opengion.plugin.table

## クラス TableFilter_CLMSET

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

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

      public class TableFilter_CLMSET
      extends AbstractTableFilter

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

       ここでは、CLM,SYSTEM_ID,LANG より、カラムリソースのRENDERER,EDITOR,DBTYPE,BIKOを設定します。
       検索した DBTableModel の属性として、RENDERER,EDITOR,DBTYPE,BIKO という名称の
       カラムが必要です。
       引数として指定可能なのは、SYSTEM_ID,LANG のみです。
        CLM :カラムリソースのキーとなる値が設定されているカラム名を指定します。
        SYSTEM_ID:コードリソースの作成システムIDを指定します。無指定時は、ログイン時のリソースになります。
        LANG:ラベルリソースの言語を指定します。無指定時は、日本語になります。
        USE_RESOURCE:リソース情報を利用するかどうか[true/false]。無指定時は、true:利用するになります。

       また、CLM,RENDERER,EDITOR,DBTYPE,BIKO,CLS_NAME,USE_LENGTH で指定したカラムが DBTableModel に存在しない場合は、
       処理そのものを無視します。その場合は、警告も出力されませんので、ご注意ください。

       パラメータは、tableFilterタグの keys, vals にそれぞれ記述するか、BODY 部にCSS形式で記述します。
       【パラメータ】
        {
             USE_RESOURCE   : [true/false] ;    リソースを利用するかどうかを指定[true/false](初期値:true)。使う場合、DBColumnを構築し、そこから RENDERE 等を取得します。
             CLM            : CLM ;             カラムリソースのキーとなる値が設定されているカラム名を指定します。
             SYSTEM_ID      : GF ;              リソースを使う場合に、コードリソースの作成システムIDを指定します。
             LANG           : ja ;              リソースを使う場合に、ラベルリソースの言語を指定します。
             RENDERER       : 設定するカラム名
             EDITOR         : 設定するカラム名
             DBTYPE         : 設定するカラム名
             BIKO           : 設定するカラム名
             CLS_NAME       : 設定するカラム名
             USE_LENGTH     : 設定するカラム名
        }

  形式サンプル:

         ●形式：
              ① <og:tableFilter classId="CLMSET" keys="USE_RESOURCE,CLM,SYSTEM_ID,RENDERER,EDITOR,DBTYPE,BIKO,CLS_NAME,USE_LENGTH"
                                                     vals="true,CLM,SYSTEM_ID,RENDERER,EDITOR,DBTYPE,BIKO,CLS_NAME,USE_LENGTH" />

              ② <og:tableFilter classId="CLMSET" >
                       {
                               USE_RESOURCE   : [true/false] ;    リソースを利用するかどうかを指定[true/false](初期値:true)。使う場合、DBColumnを構築し、そこから RENDERE 等を取得します。
                               CLM            : CLM ;             カラムリソースのキーとなる値が設定されているカラム名を指定します。
                               SYSTEM_ID      : GF ;              リソースを使う場合に、コードリソースの作成システムIDを指定します。
                               LANG           : ja ;              リソースを使う場合に、ラベルリソースの言語を指定します。
                               RENDERER       : 設定するカラム名
                               EDITOR         : 設定するカラム名
                               DBTYPE         : 設定するカラム名
                               BIKO           : 設定するカラム名
                               CLS_NAME       : 設定するカラム名
                               USE_LENGTH     : 設定するカラム名
                       }
                 </og:tableFilter>

  変更履歴:

    4.1.0.0(2008/01/18) 新規作成
    5.6.6.0 (2013/07/05) keys の整合性チェックを追加

  バージョン
    0.9.0 2000/10/17
  作成者
    Kazuhiko Hasegawa
  導入されたバージョン:
    JDK1.5,

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

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

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

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

    コンストラクタ
    コンストラクタと説明
    `TableFilter_CLMSET()`

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

    すべてのメソッド インスタンス・メソッド concreteメソッド
    修飾子とタイプ | メソッドと説明
    --- | ---
    `DBTableModel` | `execute()` DBTableModel処理を実行します。
    `protected void` | `init(Map keysMap)` keys の整合性チェックを行うための初期設定を行います。

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

      `getDbid, getDBTableModel, getErrorCode, getErrorMessage, getModifyType, getParameterRows, getResource, getSql, getTableColumnNo, getTransaction, getValue, 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`

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

    - #### TableFilter_CLMSET

          public TableFilter_CLMSET()

  - ### メソッドの詳細

    - #### init

          protected void init(Map keysMap)

      keys の整合性チェックを行うための初期設定を行います。
      オーバーライド:
        `init` クラス内 `AbstractTableFilter`
      パラメータ:
        `keysMap` - keys の整合性チェックを行うための Map
      変更履歴:

        5.6.6.1 (2013/07/12) keys の整合性チェック対応

    - #### execute

          public DBTableModel execute()

      DBTableModel処理を実行します。
      戻り値:
        処理結果のDBTableModel
      変更履歴:

        5.5.2.6 (2012/05/25) protected変数を、private化したため、getterメソッドで取得するように変更
        5.5.7.4 (2012/10/25) 備考欄の処理は、ここでは行いません。
        5.5.8.2 (2012/11/09) RENDERER,EDITOR,DBTYPE の条件分けを変更します。
        5.5.8.5 (2012/11/27) USE_RESOURCE 引数追加

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