org.opengion.fukurou.process

## クラス Process_DBParam

- java.lang.Object
- - org.opengion.fukurou.process.AbstractProcess
  - - org.opengion.fukurou.process.Process_DBParam

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

      public class Process_DBParam
      extends AbstractProcess
      implements ParamProcess

       Process_DBParam は、他のプロセスへ共通のデータベース接続を割り当てる為の、
       ParamProcess インターフェースの実装クラスです。

       DB接続 が必要な Process (DBCountFilter、DBMerge、DBReader、DBWriterなど)を
       使用して処理する場合に、接続を指定することができます。
       DBID(接続先) は、Process_DBParam の -configFile で指定する DBConfig.xml ファイルを使用します。

  形式サンプル:

         Process_DBParam -infoUSER=C00000 -infoPGID=GE1234 -configFile=DBConfig.xml

           [ -infoUSER=実行ユーザー       ] ： DB接続履歴取得用の実行ユーザー(例:C00000)
           [ -infoPGID=実行プログラムID   ] ： DB接続履歴取得用の実行プログラムID(例:GE1234)
           [ -configFile=実行プログラムID ] ： DB接続情報設定 XMLファイル(例:DBConfig.xml)
           [ -display=[false/true]        ] ： trueは、接続状況を詳細表示します(初期値:false)

  変更履歴:
    4.0.0.0 (2007/11/22) DBConfig.xml による DBID(接続先)指定に変更。, 6.3.1.0 (2015/06/28) 履歴取得用パラメータの必須解除
  バージョン
    4.0
  作成者
    Kazuhiko Hasegawa
  導入されたバージョン:
    JDK5.0,

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

    - ### クラスから継承されたフィールド org.opengion.fukurou.process.AbstractProcess

      `BUFFER_LARGE, BUFFER_MIDDLE, CR, DB_BATCH_SIZE, TAB`

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

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

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

    すべてのメソッド staticメソッド インスタンス・メソッド concreteメソッド
    修飾子とタイプ | メソッドと説明
    --- | ---
    `void` | `end(boolean isOK)` プロセスの終了を行います。
    `java.util.Set` | `getBulkData()` 検索した結果が設定された Set オブジェクトを返します。
    `java.sql.Connection` | `getConnection(java.lang.String key)` 指定の 接続先ID に対する コネクションを返します。
    `void` | `init(ParamProcess paramProcess)` プロセスの初期化を行います。
    `static void` | `main(java.lang.String[] args)` このクラスは、main メソッドから実行できません。
    `java.lang.String` | `report()` プロセスの処理結果のレポート表現を返します。
    `void` | `setAppInfo(ApplicationInfo appInfo)` ApplicationInfoオブジェクトを登録します。
    `void` | `setBulkData(java.util.Set bulkData)` 検索した結果が設定された Set オブジェクトを設定します。
    `java.lang.String` | `usage()` このクラスの使用方法を返します。

    - ### クラスから継承されたメソッド org.opengion.fukurou.process.AbstractProcess

      `getArgument, logging, println, putArgument, putArgument, setLoggerProcess, throwException, throwException, toString`

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

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

    - ### インタフェースから継承されたメソッド org.opengion.fukurou.process.HybsProcess

      `logging, println, putArgument, putArgument, setLoggerProcess`

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

    - #### Process_DBParam

          public Process_DBParam()

      デフォルトコンストラクター。 このクラスは、動的作成されます。デフォルトコンストラクターで、 super クラスに対して、必要な初期化を行っておきます。

  - ### メソッドの詳細

    - #### setAppInfo

          public void setAppInfo(ApplicationInfo appInfo)

      ApplicationInfoオブジェクトを登録します。 これは、通常の初期処理ではなく、タグリブから起動される場合のみ 呼ばれるメソッドです。 初期処理メソッド(init)では、appInfo がセット済みの場合は、 ConnectionFactoryの初期化を行いません。
      パラメータ:
        `appInfo` - アプリ情報オブジェクト
      変更履歴:
        4.3.1.1 (2008/09/04) 新規追加(taglib呼出専用)

    - #### init

          public void init(ParamProcess paramProcess)

      プロセスの初期化を行います。初めに一度だけ、呼び出されます。 初期処理(ファイルオープン、ＤＢオープン等)に使用します。
      定義:
        `init` インタフェース内 `HybsProcess`
      パラメータ:
        `paramProcess` - データベースの接続先情報などを持っているオブジェクト
      変更履歴:
        4.3.1.1 (2008/09/04) taglib呼出時は、ConnectionFactoryの初期化を行わない, 6.3.1.0 (2015/06/28) display属性の追加

    - #### getConnection

          public java.sql.Connection getConnection(java.lang.String key)

      指定の 接続先ID に対する コネクションを返します。
      定義:
        `getConnection` インタフェース内 `ParamProcess`
      パラメータ:
        `key` - 接続先ID
      戻り値:
        コネクション
      例外:
        `java.lang.RuntimeException` - DB接続先が未設定の場合
      このメソッドは、nullを返しません

    - #### setBulkData

          public void setBulkData(java.util.Set bulkData)

      検索した結果が設定された Set オブジェクトを設定します。
      定義:
        `setBulkData` インタフェース内 `ParamProcess`
      パラメータ:
        `bulkData` - 検索した結果が設定されたSetオブジェクト
      変更履歴:
        5.3.4.0 (2011/04/01) 新規追加

    - #### getBulkData

          public java.util.Set getBulkData()

      検索した結果が設定された Set オブジェクトを返します。
      定義:
        `getBulkData` インタフェース内 `ParamProcess`
      戻り値:
        検索した結果が設定された Setオブジェクト
      変更履歴:
        5.3.4.0 (2011/04/01) 新規追加

    - #### end

          public void end(boolean isOK)

      プロセスの終了を行います。最後に一度だけ、呼び出されます。 終了処理(ファイルクローズ、ＤＢクローズ等)に使用します。
      定義:
        `end` インタフェース内 `HybsProcess`
      パラメータ:
        `isOK` - トータルで、OKだったかどうか[true:成功/false:失敗]
      変更履歴:
        4.0.0.0 (2007/11/27) commit,rollback,remove 処理を追加

    - #### report

          public java.lang.String report()

      プロセスの処理結果のレポート表現を返します。 処理プログラム名、入力件数、出力件数などの情報です。 この文字列をそのまま、標準出力に出すことで、結果レポートと出来るような 形式で出してください。
      定義:
        `report` インタフェース内 `HybsProcess`
      戻り値:
        処理結果のレポート

    - #### usage

          public java.lang.String usage()

      このクラスの使用方法を返します。
      定義:
        `usage` インタフェース内 `HybsProcess`
      戻り値:
        このクラスの使用方法
      このメソッドは、nullを返しません

    - #### main

          public static void main(java.lang.String[] args)

      このクラスは、main メソッドから実行できません。
      パラメータ:
        `args` - コマンド引数配列

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