org.opengion.fukurou.transfer

## クラス TransferRead_FILELIST

- java.lang.Object
- - org.opengion.fukurou.transfer.TransferRead_FILELIST

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

      public class TransferRead_FILELIST
      extends Object
      implements TransferRead

       伝送要求に対して、ファイルまたはディレクトリをスキャンし、それに含まれる
       ファイルの絶対パスのリストを取得します。

       伝送定義マスタの読取対象は、スキャン対象のファイルまたはディレクトリを指定します。
       処理実行後は、正常終了した場合は、スキャンしたファイルを削除します。
       但し、読取パラメーターに"NODEL"を指定した場合、ファイルの削除は行われません。
       また、エラーが発生した場合は読取パラメーターの設定に関わらずファイルの削除は
       行われません。

       読取対象にディレクトリを指定した場合は、再起的にサブフォルダもスキャンされます。

  機能分類
    伝送システム
  バージョン
    5.0
  作成者
    Hiroki.Nakamura
  導入されたバージョン:
    JDK1.6

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

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

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

    すべてのメソッド インスタンス・メソッド concreteメソッド
    修飾子とタイプ | メソッドと説明
    --- | ---
    `void` | `complete(TransferConfig config, Transaction tran)` 読取した伝送データのヘッダーデータの状況を'2'(抜出済み)に更新します。
    `void` | `error(TransferConfig config, ApplicationInfo appInfo)` ここでは何もしません。
    `String[]` | `getKeys()` 更新(削除)対象のファイル名(配列)を返します。
    `String[]` | `read(TransferConfig config, Transaction tran)` ファイルまたはディレクトリをスキャンしファイルの絶対パスのリストを取得します。
    `void` | `setKeys(String[] keys)` 更新(削除)対象のファイル名(配列)をセットします。

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

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

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

    - #### TransferRead_FILELIST

          public TransferRead_FILELIST()

      デフォルトコンストラクター
      変更履歴:

        6.4.2.0 (2016/01/29) PMD refactoring. Each class should declare at least one constructor.

  - ### メソッドの詳細

    - #### read

          public String[] read(TransferConfig config,
                               Transaction tran)

      ファイルまたはディレクトリをスキャンしファイルの絶対パスのリストを取得します。
      定義:
        `read` インタフェース内 `TransferRead`
      パラメータ:
        `config` - 伝送設定オブジェクト
        `tran` - トランザクションオブジェクト
      戻り値:
        ファイル一覧(配列)
      変更履歴:

        5.4.3.2 (2011/12/06) コピー中のファイル判定追加
        5.5.2.4 (2012/05/16) 配列を返す場合は、内部表現を暴露しないように、clone を返します。

      このメソッドは、nullを返しません

    - #### getKeys

          public String[] getKeys()

      更新(削除)対象のファイル名(配列)を返します。
      定義:
        `getKeys` インタフェース内 `TransferRead`
      戻り値:
        ファイル名(配列)
      変更履歴:

        5.5.2.4 (2012/05/16) 配列を返す場合は、内部表現を暴露しないように、clone を返します。

    - #### setKeys

          public void setKeys(String[] keys)

      更新(削除)対象のファイル名(配列)をセットします。
      定義:
        `setKeys` インタフェース内 `TransferRead`
      パラメータ:
        `keys` - ファイル名配列(可変長引数)
      変更履歴:

        5.5.2.4 (2012/05/16) 参照の格納には、System.arraycopy を使います。

    - #### complete

          public void complete(TransferConfig config,
                               Transaction tran)

      読取した伝送データのヘッダーデータの状況を'2'(抜出済み)に更新します。 更新対象の通番NOについては、`setKeys(String[])`で外部からセットすることもできます。
      定義:
        `complete` インタフェース内 `TransferRead`
      パラメータ:
        `config` - 伝送設定オブジェクト
        `tran` - トランザクションオブジェクト
      関連項目:
        `setKeys(String[])`

    - #### error

          public void error(TransferConfig config,
                            ApplicationInfo appInfo)

      ここでは何もしません。
      定義:
        `error` インタフェース内 `TransferRead`
      パラメータ:
        `config` - 伝送設定オブジェクト
        `appInfo` - DB接続情報

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