org.opengion.fukurou.process

## クラス Process_TableReader

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

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

      public class Process_TableReader
      extends AbstractProcess
      implements FirstProcess

       Process_TableReaderは、ファイルから読み取った内容を、LineModel に設定後、
       下流に渡す、FirstProcess インターフェースの実装クラスです。

       DBTableModel 形式のファイルを読み取って、各行を LineModel にセットして、
       下流(プロセスチェインのデータは上流から下流に渡されます。)に渡します。

       columns 属性は、#NAME で列カラムを外部から指定する場合に使用します。
       この属性とuseNumber属性は独立していますが、一般には、#NAME を指定
       する場合は、useNumber="true"として、行番号欄は使用しますし、外部から
       指定する場合は、useNumber="false"にして先頭から読み取ります。
       (自動セットではないので、必要に応じて設定してください)
       useNumber の初期値は、"true" です。

       ※ 注意
        Process_TableReader では、セパレータ文字 で区切って読み込む処理で、前後のｽﾍﾟｰｽを
        削除しています。

       引数文字列中にスペースを含む場合は、ダブルコーテーション("") で括って下さい。
       引数文字列の 『=』の前後には、スペースは挟めません。必ず、-key=value の様に
       繋げてください。

  形式サンプル:

         Process_TableReader -infile=INFILE -sep=, -encode=UTF-8 -columns=AA,BB,CC

            -infile=入力ファイル名     ：入力ファイル名
           [-existCheck=存在確認     ] ：ファイルが存在しない場合エラーにする(初期値:true)
           [-sep=セパレータ文字      ] ：区切り文字(初期値:タブ)
           [-encode=文字エンコード   ] ：入力ファイルのエンコードタイプ
           [-columns=読み取りカラム名] ：入力カラム名(CSV形式)
           [-useNumber=[true/false]  ] ：行番号を使用する(true)か使用しない(false)か。
           [-display=[false/true]    ] ：結果を標準出力に表示する(true)かしない(false)か(初期値:false[表示しない])
           [-debug=[false/true]      ] ：デバッグ情報を標準出力に表示する(true)かしない(false)か(初期値:false[表示しない])

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

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

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

      `BUFFER_LARGE, BUFFER_MIDDLE, CR, TAB`

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

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

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

    すべてのメソッド staticメソッド インスタンス・メソッド concreteメソッド
    修飾子とタイプ | メソッドと説明
    --- | ---
    `void` | `end(boolean isOK)` プロセスの終了を行います。
    `void` | `init(ParamProcess paramProcess)` プロセスの初期化を行います。
    `static void` | `main(java.lang.String[] args)` このクラスは、main メソッドから実行できません。
    `LineModel` | `makeLineModel(int rowNo)` 最初に、 行データである LineModel を作成します FirstProcess は、次々と処理をチェインしていく最初の行データを 作成して、後続の ChainProcess クラスに処理データを渡します。
    `boolean` | `next()` このデータの処理において、次の処理が出来るかどうかを問い合わせます。
    `java.lang.String` | `report()` プロセスの処理結果のレポート表現を返します。
    `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_TableReader

          public Process_TableReader()

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

  - ### メソッドの詳細

    - #### init

          public void init(ParamProcess paramProcess)

      プロセスの初期化を行います。初めに一度だけ、呼び出されます。 初期処理(ファイルオープン、ＤＢオープン等)に使用します。
      定義:
        `init` インタフェース内 `HybsProcess`
      パラメータ:
        `paramProcess` - データベースの接続先情報などを持っているオブジェクト
      変更履歴:

        5.2.2.0 (2010/11/01) useNumber属性の追加

    - #### end

          public void end(boolean isOK)

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

    - #### next

          public boolean next()

      このデータの処理において、次の処理が出来るかどうかを問い合わせます。 この呼び出し１回毎に、次のデータを取得する準備を行います。
      定義:
        `next` インタフェース内 `FirstProcess`
      戻り値:
        処理できる:true / 処理できない:false
      変更履歴:

        5.2.2.0 (2010/11/01) ""で囲われているデータに改行が入っていた場合の対応
        6.3.1.0 (2015/06/28) nioを使用すると UTF-8とShuft-JISで、エラーになる。
        6.5.0.1 (2016/10/21) CharacterCodingException は、OgCharacterException に変換する。

    - #### makeLineModel

          public LineModel makeLineModel(int rowNo)

      最初に、 行データである LineModel を作成します FirstProcess は、次々と処理をチェインしていく最初の行データを 作成して、後続の ChainProcess クラスに処理データを渡します。 ファイルより読み込んだ１行のデータを テーブルモデルに セットするように分割します なお、読込みは，NAME項目分を読み込みます。データ件数が少ない場合は、 "" をセットしておきます。
      定義:
        `makeLineModel` インタフェース内 `FirstProcess`
      パラメータ:
        `rowNo` - 処理中の行番号
      戻り値:
        処理変換後のLineModel

    - #### report

          public java.lang.String report()

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

    - #### usage

          public java.lang.String usage()

      このクラスの使用方法を返します。
      定義:
        `usage` インタフェース内 `HybsProcess`
      戻り値:
        このクラスの使用方法
      変更履歴:

        5.2.2.0 (2010/11/01) useNumber属性のコメント追加

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

    - #### main

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

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

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