AbstractBatch (抽象クラス)

フレームワーク部品 [com.onepg.bat]

← クラス一覧に戻る

クラス情報

パッケージ: com.onepg.bat

クラス名: AbstractBatch (抽象クラス)

説明

バッチ処理 基底クラス.
  • 各バッチ処理の共通処理(ログ出力、例外処理等)を提供します。
  • サブクラスで doExecuteメソッドを実装することで具体的なバッチ処理を定義します。
  • サブクラスは mainメソッドから本クラスの callMainメソッドを呼び出すと doExecuteメソッドが実行されます。
  • サブクラス mainメソッドへの引数は URLパラメータ形式で callMainメソッドにそのまま渡される前提としています。
  • URLパラメータ形式の引数はマップ形式に変換され、 IoItemsクラスとして doExecuteメソッドに渡されます。
  • サブクラス doExecuteメソッド内でのエラー時は Exception をスローする前提としています。
  • 正常終了時の callMainメソッドの戻値は 0 となります。
  • doExecuteメソッド内で Exception がスローされた場合の callMainメソッドの戻値は 1 となります。
[実装例]public class ExampleBatch extends AbstractBatch {
   public static void main(String[] args) {
     System.exit((new ExampleBatch()).callMain(args));
   }

定数・変数一覧

traceCode

protected String traceCode
トレースコード.

logger

protected LogWriter logger
ログライター.

メソッド一覧

doExecute (抽象メソッド)

protected void doExecute(IoItems args)
メイン処理.
  • サブクラスで具体的な バッチ処理を実装します。

パラメータ

名前 説明
args IoItems 引数

callMain

protected int callMain(String[] args)
メイン処理の呼び出し.
  • 引数をURLパラメータ形式からマップ形式に変換し、ログ開始処理を実行後、doExecuteメソッドを呼び出します。
  • コマンドライン引数1つあたりの長さ制限に対応するため、複数の引数を配列として受け取る。
  • 変換された引数は IoItemsクラスとして doExecuteメソッドに渡されます。
  • doExecuteメソッド内で Exception がスローされた場合は、処理が異常終了したとみなします。

パラメータ

名前 説明
args String[] 引数

戻り値

int - 正常終了時は 0、異常終了時は 1