パッケージ org.opengion.hayabusa.db

# インタフェース TableFilter

既知の実装クラスのリスト:
  `AbstractTableFilter`, `TableFilter_BIKO2CODE`, `TableFilter_BIKOSET`, `TableFilter_CLM_LIKE`, `TableFilter_CLMSET`, `TableFilter_CMNT_CLM`, `TableFilter_CMNT_TBL`, `TableFilter_DBARG`, `TableFilter_DBARG_OUT`, `TableFilter_DBSELECT`, `TableFilter_DBSRC_OUT`, `TableFilter_DTYPE`, `TableFilter_INDEX`, `TableFilter_INDEX_DERBY`, `TableFilter_INDEX_FIREBIRD`, `TableFilter_INDEX_HSQLDB`, `TableFilter_INDEX_MYSQL`, `TableFilter_INDEX_ORACLE`, `TableFilter_INDEX_POSTGRES`, `TableFilter_INDEX_SQLSERVER`, `TableFilter_JUDG`, `TableFilter_KBCLM`, `TableFilter_KEY_BREAK`, `TableFilter_LABEL`, `TableFilter_MATCHES`, `TableFilter_NORMALIZE`, `TableFilter_REPORTDATA`, `TableFilter_REPORTLAYOUT`, `TableFilter_ROTATE`, `TableFilter_SEQRESET`, `TableFilter_SEQUENCE`, `TableFilter_SEQUENCE_DERBY`, `TableFilter_SEQUENCE_FIREBIRD`, `TableFilter_SEQUENCE_HSQLDB`, `TableFilter_SEQUENCE_MYSQL`, `TableFilter_SEQUENCE_ORACLE`, `TableFilter_SEQUENCE_POSTGRES`, `TableFilter_SEQUENCE_SQLSERVER`, `TableFilter_SKIPROW`, `TableFilter_STDDEV`, `TableFilter_STDDEV2`, `TableFilter_TABLE`, `TableFilter_TABLE_DERBY`, `TableFilter_TABLE_FIREBIRD`, `TableFilter_TABLE_HSQLDB`, `TableFilter_TABLE_MYSQL`, `TableFilter_TABLE_ORACLE`, `TableFilter_TABLE_POSTGRES`, `TableFilter_TABLE_SQLSERVER`, `TableFilter_THUMBNAIL`, `TableFilter_UNIQ_NAME`, `TableFilter_UPPER`

public interface TableFilter
TableFilter は､TableFilterTag で使用される DBTableModelの処理用のｲﾝﾀｰﾌｪｰｽです｡ 適切な実装(ｻﾌﾞｸﾗｽ)を TableFilterTag に与えることで，DBTableModelの処理を適宜 切り替えることが出来ます｡

変更履歴:
  3.8.5.0 (2006/03/20) 新規作成, 5.5.2.6 (2012/05/25) ｲﾝﾀｰﾌｪｰｽにgetterﾒｿｯﾄﾞ追加
導入されたバージョン:
  JDK1.1,

- ## メソッドの概要

  修飾子とタイプ
  メソッド
  説明
  `DBTableModel`
  `execute()`
  DBTableModelの処理を実行します｡ 処理自体は, 各ｻﾌﾞｸﾗｽの実装に依存します｡
  `String`
  `getDbid()`
  DBIDを取得します｡
  `DBTableModel`
  `getDBTableModel()`
  DBTableModel を取得します｡
  `int`
  `getErrorCode()`
  ｴﾗｰｺｰﾄﾞ を取得します｡ ｴﾗｰｺｰﾄﾞ は､ErrorMessage ｸﾗｽで規定されているｺｰﾄﾞです｡
  `ErrorMessage`
  `getErrorMessage()`
  ｴﾗｰﾒｯｾｰｼﾞｵﾌﾞｼﾞｪｸﾄ を取得します｡
  `String`
  `getModifyType()`
  ﾃﾞｰﾀ処理の方法(A:追加 C:更新 D:削除)を取得します｡ 初期値は､自動判定 です｡
  `int[]`
  `getParameterRows()`
  選択された行番号の配列を取得します｡ 表示ﾃﾞｰﾀの HybsSystem.ROW_SEL_KEY を元に､選ばれた 行を 処理の対象とします｡
  `ResourceManager`
  `getResource()`
  ﾘｿｰｽｵﾌﾞｼﾞｪｸﾄを取得します｡
  `Map<String,String>`
  `getReturnMap()`
  値を返すためのMapを返します｡ Mapそのものを返しますので､中身の書き換えは行わないでください｡
  `String`
  `getSql()`
  ﾎﾞﾃﾞｨｰ部分のSQLを取得します｡
  `Transaction`
  `getTransaction()`
  ｱｸｾｽﾛｸﾞ取得の為,Transactionｵﾌﾞｼﾞｪｸﾄを取得します｡
  `ViewMarker`
  `getViewMarker()`
  viewMarkerｵﾌﾞｼﾞｪｸﾄを取得します｡
  `boolean`
  `isDebug()`
  ﾃﾞﾊﾞｯｸﾞ情報を表示するかどうか[true/false]を取得します｡ true でﾃﾞﾊﾞｯｸﾞ情報を表示します｡
  `void`
  `setDbid(String dbid)`
  DBIDを指定します｡
  `void`
  `setDBTableModel(DBTableModel table)`
  DBTableModel をｾｯﾄします｡
  `void`
  `setDebug(boolean flag)`
  ﾃﾞﾊﾞｯｸﾞ情報を表示するかどうか[true/false]を指定します｡ true でﾃﾞﾊﾞｯｸﾞ情報を表示します｡
  `void`
  `setKeysVals(String[] keys, String[] vals)`
  ｷｰと値のﾍﾟｱの変数配列を受け取ります｡ ここでは､この方式以外に､ﾊﾟﾗﾒｰﾀｰMapを受け取る方法もあります｡ keys,vals とﾊﾟﾗﾒｰﾀｰMapを同時に指定した場合は､両方とも有効です｡ ただし､ｷｰが重複した場合は､不定と考えてください｡
  `void`
  `setMapList(List<Map<String,String>> valList)`
  TableFilter_MAPCLM 専用のMapを管理するListを設定します。
  `void`
  `setModifyType(String type)`
  ﾃﾞｰﾀ処理の方法(A:追加 C:更新 D:削除)を指定します｡ 通常は､DBTableModel に自動設定されている modifyType を元に､ﾃﾞｰﾀ処理方法を 選別します｡(A:追加 C:更新 D:削除) この場合､行単位で modifyType の値を取得して判別する必要がありますが､一般には 処理対象は､全件おなじ modifyType である可能性が高いです｡ また､selectedAll などで強制的に全件処理対象とする場合は､modifyType に値が 設定さていません｡その様な場合に外部より modifyType を指定します｡ 初期値は､自動判定 です｡
  `void`
  `setParameterRows(int... rowNo)`
  選択された行番号の配列をｾｯﾄします｡ 表示ﾃﾞｰﾀの HybsSystem.ROW_SEL_KEY を元に､選ばれた 行を 処理の対象とします｡
  `void`
  `setParamMap(ConcurrentMap<String,String> paramMap)`
  ﾊﾟﾗﾒｰﾀｰMapを指定します｡ keys,vals と ﾊﾟﾗﾒｰﾀｰMapを同時に指定した場合は､両方とも有効です｡ ただし､ｷｰが重複した場合は､不定と考えてください｡
  `void`
  `setResource(ResourceManager resource)`
  ﾘｿｰｽｵﾌﾞｼﾞｪｸﾄを指定します｡
  `void`
  `setSql(String sql)`
  ﾎﾞﾃﾞｨｰ部分のSQLを指定します｡
  `void`
  `setTransaction(Transaction tran)`
  ｱｸｾｽﾛｸﾞ取得の為,Transactionｵﾌﾞｼﾞｪｸﾄを設定します｡
  `void`
  `setViewMarker(ViewMarker marker)`
  viewMarkerｵﾌﾞｼﾞｪｸﾄを指定します｡

- ## メソッドの詳細

  - ### execute

    DBTableModel execute()
    DBTableModelの処理を実行します｡ 処理自体は, 各ｻﾌﾞｸﾗｽの実装に依存します｡
    戻り値:
      DBTableModelｵﾌﾞｼﾞｪｸﾄ

  - ### setDBTableModel

    void setDBTableModel(DBTableModel table)
    DBTableModel をｾｯﾄします｡
    パラメータ:
      `table` - DBTableModelｵﾌﾞｼﾞｪｸﾄ

  - ### getDBTableModel

    DBTableModel getDBTableModel()
    DBTableModel を取得します｡
    戻り値:
      内部のDBTableModel
    変更履歴:
      5.5.2.6 (2012/05/25) ｲﾝﾀｰﾌｪｰｽにgetterﾒｿｯﾄﾞ追加

  - ### setModifyType

    void setModifyType(String type)
    ﾃﾞｰﾀ処理の方法(A:追加 C:更新 D:削除)を指定します｡ 通常は､DBTableModel に自動設定されている modifyType を元に､ﾃﾞｰﾀ処理方法を 選別します｡(A:追加 C:更新 D:削除) この場合､行単位で modifyType の値を取得して判別する必要がありますが､一般には 処理対象は､全件おなじ modifyType である可能性が高いです｡ また､selectedAll などで強制的に全件処理対象とする場合は､modifyType に値が 設定さていません｡その様な場合に外部より modifyType を指定します｡ 初期値は､自動判定 です｡
    パラメータ:
      `type` - ﾃﾞｰﾀ処理の方法(A:追加 C:更新 D:削除)

  - ### getModifyType

    String getModifyType()
    ﾃﾞｰﾀ処理の方法(A:追加 C:更新 D:削除)を取得します｡ 初期値は､自動判定 です｡
    戻り値:
      ﾃﾞｰﾀ処理の方法(A:追加 C:更新 D:削除)
    変更履歴:
      5.5.2.6 (2012/05/25) ｲﾝﾀｰﾌｪｰｽにgetterﾒｿｯﾄﾞ追加

  - ### setKeysVals

    void setKeysVals(String[] keys, String[] vals)
    ｷｰと値のﾍﾟｱの変数配列を受け取ります｡ ここでは､この方式以外に､ﾊﾟﾗﾒｰﾀｰMapを受け取る方法もあります｡ keys,vals とﾊﾟﾗﾒｰﾀｰMapを同時に指定した場合は､両方とも有効です｡ ただし､ｷｰが重複した場合は､不定と考えてください｡
    パラメータ:
      `keys` - ｷｰ配列
      `vals` - 値配列

  - ### setParameterRows

    void setParameterRows(int... rowNo)
    選択された行番号の配列をｾｯﾄします｡ 表示ﾃﾞｰﾀの HybsSystem.ROW_SEL_KEY を元に､選ばれた 行を 処理の対象とします｡
    パラメータ:
      `rowNo` - 行番号の配列(可変長引数)

  - ### getParameterRows

    int[] getParameterRows()
    選択された行番号の配列を取得します｡ 表示ﾃﾞｰﾀの HybsSystem.ROW_SEL_KEY を元に､選ばれた 行を 処理の対象とします｡
    戻り値:
      行番号の配列
    変更履歴:
      5.5.2.6 (2012/05/25) ｲﾝﾀｰﾌｪｰｽにgetterﾒｿｯﾄﾞ追加

  - ### setTransaction

    void setTransaction(Transaction tran)
    ｱｸｾｽﾛｸﾞ取得の為,Transactionｵﾌﾞｼﾞｪｸﾄを設定します｡
    パラメータ:
      `tran` - Transactionｵﾌﾞｼﾞｪｸﾄ
    変更履歴:
      5.1.9.0 (2010/08/01) Transaction 対応(新規追加)

  - ### getTransaction

    Transaction getTransaction()
    ｱｸｾｽﾛｸﾞ取得の為,Transactionｵﾌﾞｼﾞｪｸﾄを取得します｡
    戻り値:
      Transactionｵﾌﾞｼﾞｪｸﾄ
    変更履歴:
      5.1.9.0 (2010/08/01) Transaction 対応(新規追加), 5.5.2.6 (2012/05/25) ｲﾝﾀｰﾌｪｰｽにgetterﾒｿｯﾄﾞ追加

  - ### setDbid

    void setDbid(String dbid)
    DBIDを指定します｡
    パラメータ:
      `dbid` - 接続先ID
    変更履歴:
      4.2.4.0 (2008/06/23) 新規追加

  - ### getDbid

    String getDbid()
    DBIDを取得します｡
    戻り値:
      DBID(接続先ID)
    変更履歴:
      4.2.4.0 (2008/06/23) 新規追加, 5.5.2.6 (2012/05/25) ｲﾝﾀｰﾌｪｰｽにgetterﾒｿｯﾄﾞ追加

  - ### setSql

    void setSql(String sql)
    ﾎﾞﾃﾞｨｰ部分のSQLを指定します｡
    パラメータ:
      `sql` - ﾎﾞﾃﾞｨｰ部分のSQL
    変更履歴:
      4.2.4.0 (2008/06/23) 新規追加

  - ### getSql

    String getSql()
    ﾎﾞﾃﾞｨｰ部分のSQLを取得します｡
    戻り値:
      ﾎﾞﾃﾞｨｰ部分のSQL
    変更履歴:
      4.2.4.0 (2008/06/23) 新規追加, 5.5.2.6 (2012/05/25) ｲﾝﾀｰﾌｪｰｽにgetterﾒｿｯﾄﾞ追加

  - ### setParamMap

    void setParamMap(ConcurrentMap<String,String> paramMap)
    ﾊﾟﾗﾒｰﾀｰMapを指定します｡ keys,vals と ﾊﾟﾗﾒｰﾀｰMapを同時に指定した場合は､両方とも有効です｡ ただし､ｷｰが重複した場合は､不定と考えてください｡
    パラメータ:
      `paramMap` - ﾊﾟﾗﾒｰﾀｰMap
    変更履歴:
      5.6.5.2 (2013/06/21) 新規追加, 6.4.3.3 (2016/03/04) ConcurrentHashMap を受け取ることを明確にするため､I/FをConcurrentMapに変更します｡

  - ### setResource

    void setResource(ResourceManager resource)
    ﾘｿｰｽｵﾌﾞｼﾞｪｸﾄを指定します｡
    パラメータ:
      `resource` - ﾘｿｰｽｵﾌﾞｼﾞｪｸﾄ
    変更履歴:
      4.3.7.4 (2009/07/01) 新規追加

  - ### getResource

    ResourceManager getResource()
    ﾘｿｰｽｵﾌﾞｼﾞｪｸﾄを取得します｡
    戻り値:
      ﾘｿｰｽｵﾌﾞｼﾞｪｸﾄ
    変更履歴:
      4.3.7.4 (2009/07/01) 新規追加, 5.5.2.6 (2012/05/25) ｲﾝﾀｰﾌｪｰｽにgetterﾒｿｯﾄﾞ追加

  - ### setViewMarker

    void setViewMarker(ViewMarker marker)
    viewMarkerｵﾌﾞｼﾞｪｸﾄを指定します｡
    パラメータ:
      `marker` - viewMarkerｵﾌﾞｼﾞｪｸﾄ
    変更履歴:
      8.0.0.0 (2021/09/30) viewMarker追加

  - ### getViewMarker

    ViewMarker getViewMarker()
    viewMarkerｵﾌﾞｼﾞｪｸﾄを取得します｡
    戻り値:
      viewMarkerｵﾌﾞｼﾞｪｸﾄ
    変更履歴:
      8.0.0.0 (2021/09/30) viewMarker追加

  - ### getReturnMap

    Map<String,String> getReturnMap()
    値を返すためのMapを返します｡ Mapそのものを返しますので､中身の書き換えは行わないでください｡
    戻り値:
      Mapｵﾌﾞｼﾞｪｸﾄ
    変更履歴:
      7.4.0.1 (2021/04/16) 値を返すための変数

  - ### setMapList

    void setMapList(List<Map<String,String>> valList)
    TableFilter_MAPCLM 専用のMapを管理するListを設定します。
    パラメータ:
      `valList` - Mapｵﾌﾞｼﾞｪｸﾄのﾘｽﾄ
    変更履歴:
      8.2.1.0 (2022/07/15) TableFilter_MAPCLM 専用のMapを管理するList

  - ### setDebug

    void setDebug(boolean flag)
    ﾃﾞﾊﾞｯｸﾞ情報を表示するかどうか[true/false]を指定します｡ true でﾃﾞﾊﾞｯｸﾞ情報を表示します｡
    パラメータ:
      `flag` - 表示するかどうか [true:表示する/false:表示しない]

  - ### isDebug

    boolean isDebug()
    ﾃﾞﾊﾞｯｸﾞ情報を表示するかどうか[true/false]を取得します｡ true でﾃﾞﾊﾞｯｸﾞ情報を表示します｡
    戻り値:
      ﾃﾞﾊﾞｯｸﾞ情報 [true:表示する/false:表示しない]
    変更履歴:
      5.5.2.6 (2012/05/25) ｲﾝﾀｰﾌｪｰｽにgetterﾒｿｯﾄﾞ追加

  - ### getErrorCode

    int getErrorCode()
    ｴﾗｰｺｰﾄﾞ を取得します｡ ｴﾗｰｺｰﾄﾞ は､ErrorMessage ｸﾗｽで規定されているｺｰﾄﾞです｡
    戻り値:
      ｴﾗｰｺｰﾄﾞ

  - ### getErrorMessage

    ErrorMessage getErrorMessage()
    ｴﾗｰﾒｯｾｰｼﾞｵﾌﾞｼﾞｪｸﾄ を取得します｡
    戻り値:
      ｴﾗｰﾒｯｾｰｼﾞｵﾌﾞｼﾞｪｸﾄ