org.opengion.fukurou.process

## インタフェース HybsProcess

- 既知のサブインタフェースのリスト:
    ChainProcess, FirstProcess, LoggerProcess, ParamProcess
  既知の実装クラスのリスト:
    AbstractProcess, Process_BulkQuery, Process_DBCountFilter, Process_DBMerge, Process_DBParam, Process_DBReader, Process_DBWriter, Process_FileCopy, Process_FileFtp, Process_FileSearch, Process_Grep, Process_GrepChange, Process_GrepChangeExcel, Process_LDAPReader, Process_Logger, Process_StringUtil, Process_TableDiff, Process_TableFilter, Process_TableReader, Process_TableWriter, Process_UnicodeEscape, Process_XSLT

      public interface HybsProcess

  HybsProcess は、バッチ処理サブクラスの共通インターフェースです。 HybsProcess を用いて、順次、バッチプロセスを実行することができます。
  バージョン
    4.0
  作成者
    Kazuhiko Hasegawa
  導入されたバージョン:
    JDK5.0,

- - ### メソッドの概要

    メソッド
    修飾子とタイプ | メソッドと説明
    --- | ---
    `void` | `end(boolean isOK)` プロセスの終了を行います。
    `void` | `init(ParamProcess paramProcess)` プロセスの初期化を行います。
    `void` | `logging(java.lang.String msg)` ログファイルにメッセージを表示します。
    `void` | `println(java.lang.String msg)` ディスプレイにメッセージを表示します。
    `void` | `putArgument(java.lang.String arg)` 引数形式を解析する Argument オブジェクトに、引数を設定します。
    `void` | `putArgument(java.lang.String key, java.lang.String val)` Argument の文字列から、プロパティをセットします。
    `java.lang.String` | `report()` プロセスの処理結果のレポート表現を返します。
    `void` | `setLoggerProcess(LoggerProcess logger)` ディスプレイ出力する LoggerProcess オブジェクトをセットします。
    `java.lang.String` | `usage()` このクラスの使用方法を返します。

- - ### メソッドの詳細

    - #### putArgument

          void putArgument(java.lang.String arg)

      引数形式を解析する Argument オブジェクトに、引数を設定します。 Argument の文字列から、引数かプロパティをセットします。 ［プロパティ］のキー部の大文字･小文字は、厳格に判定しています。 Argument の文字列には、タイプがあります。 ［コメント］ ： # で始まる引数で、使用されません。(登録もされません。) ［引数］ ： #,-,= 以外で始まる通常の文字列。登録の順番が指定されます。 ［プロパティ］： - で始まり、キーと値を=で区切っているパラメータです。順序は無関係。
      パラメータ:
        `arg` - 引数

    - #### putArgument

          void putArgument(java.lang.String key,
                         java.lang.String val)

      Argument の文字列から、プロパティをセットします。 ［プロパティ］のキー部の大文字･小文字は、厳格に判定しています。 このメソッドは、引数 や コメントの判断を行いません。プロパティ のみ 設定されるものとして、処理します。 プロパティの key=val が初めから分割されている場合の簡易メソッドです。
      パラメータ:
        `key` - キー
        `val` - 値

    - #### init

          void init(ParamProcess paramProcess)

      プロセスの初期化を行います。初めに一度だけ、呼び出されます。 初期処理(ファイルオープン、ＤＢオープン等)に使用します。 引数の ParamProcess は、データベース接続、ログファイル、 エラー時メール送信などの基本設定を管理しているインターフェース です。
      パラメータ:
        `paramProcess` - データベースの接続先情報などを持っているオブジェクト

    - #### end

          void end(boolean isOK)

      プロセスの終了を行います。最後に一度だけ、呼び出されます。 終了処理(ファイルクローズ、ＤＢクローズ等)に使用します。
      パラメータ:
        `isOK` - トータルで、OKだったかどうか [true:成功/false:失敗]

    - #### println

          void println(java.lang.String msg)

      ディスプレイにメッセージを表示します。
      パラメータ:
        `msg` - 表示するメッセージ

    - #### logging

          void logging(java.lang.String msg)

      ログファイルにメッセージを表示します。
      パラメータ:
        `msg` - 表示するメッセージ

    - #### setLoggerProcess

          void setLoggerProcess(LoggerProcess logger)

      ディスプレイ出力する LoggerProcess オブジェクトをセットします。
      パラメータ:
        `logger` - LoggerProcessオブジェクト

    - #### report

          java.lang.String report()

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

    - #### usage

          java.lang.String usage()

      このクラスの使用方法を返します。
      戻り値:
        このクラスの使用方法

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