openGionopenGion
5.3.7.0

org.opengion.fukurou.process
クラス Process_Grep

java.lang.Object
  上位を拡張 org.opengion.fukurou.process.AbstractProcess
      上位を拡張 org.opengion.fukurou.process.Process_Grep
すべての実装されたインタフェース:
ChainProcess, HybsProcess

public class Process_Grep
extends AbstractProcess
implements ChainProcess

Process_Grep は、上流から受け取った FileLineModelから、文字列を見つけ出す ChainProcess インターフェースの実装クラスです。 正規表現の keyword を上流から受け取った FileLineModel から検索します。 見つかった対象ファイルから、指定の文字列を置換する場合は、-change か -changeFile で、keyword を置換する文字列を指定して下さい。 置換する文字列には、\t と \n の特殊文字が使用できます。 処理対象は、通常は、1行づつ読み取りながら処理を行います。存在チェックの場合は、 見つかった時点で処理を中止します。これは、該当箇所をピックアップするのではなく、 存在しているかどうかを判断して、あれば、下流に流すというのが目的だからです。 keyword を、改行を含む正規表現で、検索・置換する場合は、-useBulkRead 属性を true に設定してください。これは、入力ファイルを一括して読み込みます。 -ignoreCase は、正規表現の検索時にキーの大文字小文字を無視するように指定します。 -notEquals は、結果(見つかればtrue)を反転(見つからなければtrue)します。 これは、行単位ではなく、ファイル単位に判定しますので、change 指定した場合 でも、対象行は、見つかった行です。ただし、下流に対して、見つからない 場合だけ処理を継続させます。 -inEncode は、入力ファイルのエンコード指定になります。 -outEncode は、出力ファイルのエンコードや、changeFileで指定の置換文字列ファイルの エンコード指定になります。(changeFile は、必ず 出力ファイルと同じエンコードです。) これらのエンコードが無指定の場合は、System.getProperty("file.encoding") で 求まる値を使用します。 -changeFile を使用することで、複数行の文字列に置換することが可能です。 -outfile では、処理を行ったファイル名一覧をセーブします。 上流(プロセスチェインのデータは上流から渡されます。)からのLineModel の ファイルオブジェクトより、指定の文字列が含まれているか検索します。 上流プロセスでは、Name 属性として、『File』を持ち、値は、Fileオブジェクト である、Process_FileSearch を使用するのが、便利です。それ以外のクラスを 使用する場合でも、Name属性と、File オブジェクトを持つ LineModel を受け渡し できれば、使用可能です。 引数文字列中に空白を含む場合は、ダブルコーテーション("") で括って下さい。 引数文字列の 『=』の前後には、空白は挟めません。必ず、-key=value の様に 繋げてください。

形式サンプル:
 Process_Grep -keyword=検索文字列 -ignoreCase=true -outfile=OUTFILE -encode=UTF-8

    -keyword=キーワード        :検索する語句
   [-ignoreCase=大文字小文字 ] :検索時に大文字小文字を区別しない(true)かどうか(初期値:区別する[false])
   [-notEquals=判定結果の反転] :判定結果を反転させる(true)かどうか(初期値:反転させない[false])
   [-inEncode=入力エンコード ] :入力ファイルのエンコードタイプ
   [-outEncode=出力エンコード] :出力ファイルや置換ファイルのエンコードタイプ
   [-change=置換文字列       ] :-change="ABCD" \t や \n などの特殊文字が使用できます。
   [-changeFile=置換ファイル ] :-changeFile=change.txt このファイルの記述すべてと置換します。
                                     -change と、-changeFile は、同時に指定できません。
                                     置換機能使用時は、必ず、_backup というファイルが作成されます。
   [-insert=[BEFORE/AFTER]   ] : 置換でなく挿入する場合の位置を指定します。(初期値:CHANGE)
                                 スペースで区切って数字を記述すると、挿入位置にオフセットできます。
   [-delete=[false/true]     ] : 置換でなく削除します。(初期値:false)
   [-useBackup=[false/true]  ] :trueは、backupファイルを作成します。(初期値:false)
   [-useBulkRead=[false/true]] :trueは、入力ファイルを一括読込します。(初期値:false)
   [-display=[false/true]    ] :trueは、検索状況を表示します。(初期値:false)
   [-debug=false|true        ] :デバッグ情報を標準出力に表示する(true)かしない(false)か(初期値 false:表示しない)
バージョン
4.0
作成者
Kazuhiko Hasegawa
導入されたバージョン:
JDK5.0,

フィールドの概要
 
クラス org.opengion.fukurou.process.AbstractProcess から継承されたフィールド
CR, TAB
 
コンストラクタの概要
Process_Grep()
          デフォルトコンストラクター。
 
メソッドの概要
 LineModel action(LineModel data)
          引数の LineModel を処理するメソッドです。
 void end(boolean isOK)
          プロセスの終了を行います。
 void init(ParamProcess paramProcess)
          プロセスの初期化を行います。
static void main(java.lang.String[] args)
          このクラスは、main メソッドから実行できません。
 java.lang.String report()
          プロセスの処理結果のレポート表現を返します。
 java.lang.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_Grep

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

メソッドの詳細

init

public void init(ParamProcess paramProcess)
プロセスの初期化を行います。初めに一度だけ、呼び出されます。 初期処理(ファイルオープン、DBオープン等)に使用します。

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

end

public void end(boolean isOK)
プロセスの終了を行います。最後に一度だけ、呼び出されます。 終了処理(ファイルクローズ、DBクローズ等)に使用します。

定義:
インタフェース 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.1.0 (2007/12/14) ファイルの一括処理対応。

report

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

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

usage

public java.lang.String usage()
このクラスの使用方法を返します。

定義:
インタフェース HybsProcess 内の usage
戻り値:
String このクラスの使用方法

main

public static void main(java.lang.String[] args)
このクラスは、main メソッドから実行できません。

パラメータ:
args - String[]

openGion 5.3.7.0

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