org.opengion.fukurou.process

## クラス Process_StringUtil

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

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

      public class Process_StringUtil
      extends AbstractProcess
      implements ChainProcess

       Process_StringUtil は、上流から受け取ったデータをStringUtilクラスの特定の
       メソッドでデータ変換する、CainProcess インターフェースの実装クラスです。

       上流(プロセスチェインのデータは上流から下流へと渡されます。)から
        LineModel を元に、指定のカラムの文字を、変換します。

       現時点で利用できるStringUtil のメソッドは、下記の通りです。
          urlEncode        : UTF-8 で、URLエンコードを行う。
          rTrim            : 文字列の後ろのスペースを削除
          htmlFilter       : HTML上のエスケープ文字を変換
          code39           : CODE39 の 文字列を作成(チェックデジット付き)
          getUnicodeEscape : HTML のエスケープ記号(&#xZZZZ;)に変換
          getReplaceEscape : HTML のエスケープ記号(&#xZZZZ;)を戻す
          spanCut          : 引数からspanタグを取り除く

       HybsCryptography のメソッドも呼び出せます。
          getMD5           : MessageDigestにより、MD5 でハッシュした文字に変換
          encrypt          : Hybs独自の暗号化を行います(Hybs内部設定の秘密鍵)
          decrypt          : Hybs独自の復号化を行います(Hybs内部設定の秘密鍵)

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

  形式サンプル:

         Process_StringUtil -action=getMD5|encrypt|decrypt|code39|getUnicodeEscape|getReplaceEscape|･･･ -keys=AA,BB,CC

             -action=ESC|REV        ：StringUtilクラスの特定のメソッド名を指定します(必須)。
                                      urlEncode|rTrim|htmlFilter|getMD5|code39|getUnicodeEscape|getReplaceEscape|spanCut
             -keys=AA,BB,CC         ：変換するカラムをCSV形式で複数指定できます(必須)。
           [ -display=[false/true]] ：結果を標準出力に表示する(true)かしない(false)か(初期値:false[表示しない])
           [ -debug=[false/true]  ] ：デバッグ情報を標準出力に表示する(true)かしない(false)か(初期値:false[表示しない])

  変更履歴:

    5.0.0.2 (2009/09/15) 新規クラス作成

  バージョン
    0.9.0 2004/02/27
  作成者
    Kazuhiko Hasegawa
  導入されたバージョン:
    JDK5.0,

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

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

      `BUFFER_LARGE, BUFFER_MIDDLE, CR, TAB`

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

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

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

    すべてのメソッド staticメソッド インスタンス・メソッド concreteメソッド
    修飾子とタイプ | メソッドと説明
    --- | ---
    `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, 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_StringUtil

          public Process_StringUtil()

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

  - ### メソッドの詳細

    - #### init

          public void init(ParamProcess paramProcess)

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

    - #### action

          public LineModel action(LineModel data)

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

    - #### end

          public void end(boolean isOK)

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

    - #### report

          public String report()

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

    - #### usage

          public String usage()

      このクラスの使用方法を返します。
      定義:
        `usage` インタフェース内 `HybsProcess`
      戻り値:
        このクラスの使用方法
      このメソッドは、nullを返しません

    - #### main

          public static void main(String[] args)

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

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