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

# インタフェース TableFilter

既知の実装クラスのリスト:
  `AbstractTableFilter`, `TableFilter_BIKO2CODE`, `TableFilter_BIKOSET`, `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_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`
  `getErrorMessage()`
  エラーメッセージオブジェクト を取得します。
  `String`
  `getModifyType()`
  データ処理の方法(A:追加 C:更新 D:削除)を取得します。
  `int[]`
  `getParameterRows()`
  選択された行番号の配列を取得します。
  `ResourceManager`
  `getResource()`
  リソースオブジェクトを取得します。
  `Map<String,String>`
  `getReturnMap()`
  値を返すためのMapを返します。
  `String`
  `getSql()`
  ボディー部分のSQLを取得します。
  `Transaction`
  `getTransaction()`
  アクセスログ取得の為,Transactionオブジェクトを取得します。
  `ViewMarker`
  `getViewMarker()`
  viewMarkerオブジェクトを取得します。
  `boolean`
  `isDebug()`
  デバッグ情報を表示するかどうか[true/false]を取得します。
  `void`
  `setDbid(String dbid)`
  DBIDを指定します。
  `void`
  `setDBTableModel(DBTableModel table)`
  DBTableModel をセットします。
  `void`
  `setDebug(boolean flag)`
  デバッグ情報を表示するかどうか[true/false]を指定します。
  `void`
  `setKeysVals(String[] keys, String[] vals)`
  キーと値のペアの変数配列を受け取ります。
  `void`
  `setModifyType(String type)`
  データ処理の方法(A:追加 C:更新 D:削除)を指定します。
  `void`
  `setParameterRows(int... rowNo)`
  選択された行番号の配列をセットします。
  `void`
  `setParamMap(ConcurrentMap<String,String> paramMap)`
  パラメーター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) 値を返すための変数

  - ### 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()
    エラーメッセージオブジェクト を取得します。
    戻り値:
      エラーメッセージオブジェクト