概要 | パッケージ | クラス | 階層ツリー | 非推奨 API | 索引 | ヘルプ
openGion 5.0.0.0
前のクラス 次のクラス | フレームあり フレームなし
概要: 入れ子 | フィールド | コンストラクタ | メソッド | 詳細: フィールド | コンストラクタ | メソッド

## org.opengion.fukurou.process
クラス Process_FileCopy

    java.lang.Object
      org.opengion.fukurou.process.AbstractProcess
          org.opengion.fukurou.process.Process_FileCopy

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

    public class Process_FileCopy

extends AbstractProcess
implements ChainProcess

Process_FileCopy は、上流から受け取った FileLineModel を処理する、 ChainProcess インターフェースの実装クラスです。 上流から受け取った FileLineModel の ファイルから、inPath の共通パス 以下のファイルを、outPath の共通パス以下にコピーします。 コピーの種類は、バイナリか、テキストで、テキストの場合は、エンコード 変換も行うことが可能です。 inPath と outPath が同じ、または、outPath が未設定の場合は、入力と出力が 同じですので、自分自身のエンコード変換処理を行うことになります。 コピーされるファイルのファイル名は、入力ファイル名と同一です。保存される フォルダが異なります。(同一にすることも可能です。) 上流プロセスでは、Name 属性として、『File』を持ち、値は、Fileオブジェクト である、Process_FileSearch を使用するのが、便利です。それ以外のクラスを 使用する場合でも、Name属性と、File オブジェクトを持つ LineModel を受け渡し できれば、使用可能です。 引数文字列中に空白を含む場合は、ダブルコーテーション("") で括って下さい。 引数文字列の 『=』の前後には、空白は挟めません。必ず、-key=value の様に 繋げてください。

形式サンプル:

       Process_FileCopy -inPath=入力共通パス -inEncode=Windows-31J -outPath=出力共通パス -outEncode=UTF-8

          -inPath=入力共通パス        ：上流で検索されたファイルパスの共通部分
         [-inEncode=入力エンコード  ] ：入力ファイルのエンコードタイプ
         [-outPath=出力共通パス     ] ：出力するファイルパスの共通部分
         [-outEncode=出力エンコード ] ：出力ファイルのエンコードタイプ
         [-binary=[false/true]      ] ：trueは、バイナリファイルのコピー(初期値：false）
         [-changeCrLf=[false/true]  ] ：trueは、バイナリファイルのコピー時にCR+LFに変換します(初期値：false）
         [-display=[false/true]     ] ：trueは、コピー状況を表示します。(初期値：false）

バージョン
  4.0
作成者
  Kazuhiko Hasegawa
導入されたバージョン:
  JDK5.0,

フィールドの概要

クラス org.opengion.fukurou.process.AbstractProcess から継承されたフィールド
`CR, TAB`

コンストラクタの概要
`Process_FileCopy()` デフォルトコンストラクター。

メソッドの概要
`LineModel` | `action(LineModel data)` 引数の LineModel を処理するメソッドです。
`void` | `end(boolean isOK)` プロセスの終了を行います。
`void` | `init(ParamProcess paramProcess)` プロセスの初期化を行います。
`static void` | `main(String[] args)` このクラスは、main メソッドから実行できません。
`String` | `report()` プロセスの処理結果のレポート表現を返します。
`String` | `usage()` このクラスの使用方法を返します。

クラス org.opengion.fukurou.process.AbstractProcess から継承されたメソッド
`getArgument, logging, println, putArgument, putArgument, setLoggerProcess, 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_FileCopy

    public Process_FileCopy()

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

メソッドの詳細

### init

    public void init(ParamProcess paramProcess)

  プロセスの初期化を行います。初めに一度だけ、呼び出されます。 初期処理（ファイルオープン、ＤＢオープン等）に使用します。

  定義:
    インタフェース `HybsProcess` 内の `init`
  パラメータ:
    `paramProcess` - ParamProcess
  変更履歴:

    4.2.2.0 (2008/05/10) changeCrLf 属性対応

### end

    public void end(boolean isOK)

  プロセスの終了を行います。最後に一度だけ、呼び出されます。 終了処理（ファイルクローズ、ＤＢクローズ等）に使用します。

  定義:
    インタフェース `HybsProcess` 内の `end`
  パラメータ:
    `isOK` - トータルで、OKだったかどうか(true:成功/false:失敗）

### action

    public LineModel action(LineModel data)

  引数の LineModel を処理するメソッドです。 変換処理後の LineModel を返します。 後続処理を行わない場合（データのフィルタリングを行う場合）は、 null データを返します。つまり、null データは、後続処理を行わない フラグの代わりにも使用しています。 なお、変換処理後の LineModel と、オリジナルの LineModel が、 同一か、コピー（クローン）かは、各処理メソッド内で決めています。 ドキュメントに明記されていない場合は、副作用が問題になる場合は、 各処理ごとに自分でコピー（クローン）して下さい。

  定義:
    インタフェース `ChainProcess` 内の `action`
  パラメータ:
    `data` - LineModel オリジナルのLineModel
  戻り値:
    LineModel 処理変換後のLineModel
  変更履歴:

    4.0.0.0 (2007/11/28) メソッドの戻り値をチェックします。
    4.2.2.0 (2008/05/10) changeCrLf 属性対応
    4.2.3.0 (2008/05/26) LineModel が FileLineModel でない場合の処理

### report

    public String report()

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

  定義:
    インタフェース `HybsProcess` 内の `report`
  戻り値:
    処理結果のレポート

### usage

    public String usage()

  このクラスの使用方法を返します。

  定義:
    インタフェース `HybsProcess` 内の `usage`
  戻り値:
    String

### main

    public static void main(String[] args)

  このクラスは、main メソッドから実行できません。

  パラメータ:
    `args` - String[]

概要 | パッケージ | クラス | 階層ツリー | 非推奨 API | 索引 | ヘルプ
| openGion 5.0.0.0
前のクラス 次のクラス | フレームあり フレームなし
概要: 入れ子 | フィールド | コンストラクタ | メソッド | 詳細: フィールド | コンストラクタ | メソッド

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