001    /*
002     * Copyright (c) 2009 The openGion Project.
003     *
004     * Licensed under the Apache License, Version 2.0 (the "License");
005     * you may not use this file except in compliance with the License.
006     * You may obtain a copy of the License at
007     *
008     *     http://www.apache.org/licenses/LICENSE-2.0
009     *
010     * Unless required by applicable law or agreed to in writing, software
011     * distributed under the License is distributed on an "AS IS" BASIS,
012     * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND,
013     * either express or implied. See the License for the specific language
014     * governing permissions and limitations under the License.
015     */
016    package org.opengion.fukurou.process;
017    
018    import org.opengion.fukurou.util.Argument;
019    import org.opengion.fukurou.util.HybsEntry ;
020    import org.opengion.fukurou.util.FileUtil;
021    import org.opengion.fukurou.util.Closer ;
022    import org.opengion.fukurou.util.LogWriter;
023    
024    import java.util.Map ;
025    import java.util.LinkedHashMap ;
026    
027    import java.io.File;
028    import java.io.PrintWriter;
029    
030    /**
031     * Process_TableWriter は、上流から受け取ったデータをファイルに書き込?
032     * CainProcess インターフェースの実?ラスです?
033     *
034     * 上?プロセスチェインの??タは上流から下流へと渡されます?)から
035     * 受け取ったLineModel を?に、DBTableModel 形式ファイルを?力します?
036     *
037     * 引数??中にスペ?スを含??合?、ダブルコー??ション("") で括って下さ??
038     * 引数??の ?』?前後には、スペ?スは挟めません。??key=value の様に
039     * 繋げてください?
040     *
041     * @og.formSample
042     *  Process_TableWriter -outfile=OUTFILE -sep=, -encode=UTF-8 -append=true
043     *
044     *    -outfile=出力ファ??名       ??力ファ??名
045     *   [-sep=??゚レー???        ] ?区???初期値:タ?
046     *   [-encode=?エ?コ????     ] ??力ファ?????コ??????
047     *   [-append=[false/true]    ] ??力ファ??を、追記す?true)か新規作?する(false)か?
048     *   [-useHeader=[true/false] ] ?ヘッ??ー??(#NAME?を?力す?true)か?力しな?false)か?
049     *   [-useNumber=[true/false] ] ?行番号を?力す?true)か?力しな?false)か?
050     *   [-useWquot=[false/true]  ] ??力?ー????ブルク???????で括?true)かそのまま(false)か?
051     *   [-omitCTRL=[false/true]  ] ?コ??ー?文字を削除する(true)かそのまま(false)か?
052     *   [-const_XXXX=固定?      ] ??const_FGJ=1
053     *                                    LineModel のキー(const_ に続く??)の値に、固定?を設定します?
054     *                                   キーが異なれ?、?のカラ?を指定できます?
055     *   [-display=[false/true]   ] ?結果を標準?力に表示する(true)かしな?false)?初期値:false[表示しない])
056     *   [-debug=[false/true]     ] ?デバッグ??を標準?力に表示する(true)かしな?false)?初期値:false[表示しない])
057     *
058     * @version  4.0
059     * @author   Kazuhiko Hasegawa
060     * @since    JDK5.0,
061     */
062    public class Process_TableWriter extends AbstractProcess implements ChainProcess {
063            private static final String CNST_KEY = "const_" ;
064    
065            private String  outfile         = null;
066            private PrintWriter writer      = null;
067            private String  separator       = TAB;  // ?区???
068    
069            private String[]        cnstClm         = null;         // 固定?を設定するカラ?
070            private int[]           cnstClmNos      = null;         // 固定?を設定する?カラ?号
071            private String[]        constVal        = null;         // カラ?号に対応した固定?
072            private File            file            = null;         // 出力ファイル
073            private String          encode          = System.getProperty("file.encoding");  // 出力ファイルエンコー?
074            private boolean         append          = false;        // ファイル追?true:追?false:通常)
075            private boolean         useHeader       = true;         // ヘッ????(#NAME?を?力す?true)か?力しな?false)か?
076            private boolean         useNumber       = true;         // 行番号を?力す?true)か?力しな?false)か?
077            private boolean         useWquot        = false;        // 出力データをダブルクオー??ションで括?true)かそのまま(false)か?
078            private boolean         omitCTRL        = false;        // コントロール?を削除する(true)かそのまま(false)か?
079            private boolean         display         = false;        // 表示しな?
080            private boolean         debug           = false;        // 5.7.3.0 (2014/02/07) ????
081    
082            private boolean firstRow        = true; // ??の?目
083            private int             count           = 0;
084    
085            private static final Map<String,String> mustProparty   ;          // ?プロパティ???チェ?用 Map
086            private static final Map<String,String> usableProparty ;          // ?プロパティ?整合?チェ? Map
087    
088            static {
089                    mustProparty = new LinkedHashMap<String,String>();
090                    mustProparty.put( "outfile",    "出力ファ??名 (??)" );
091    
092                    usableProparty = new LinkedHashMap<String,String>();
093                    usableProparty.put( "sep",              "区???初期値:???" );
094                    usableProparty.put( "encode",   "出力ファ?????コ?????? );
095                    usableProparty.put( "append",   "出力ファ??を、追記す?true)か新規作?する(false)か?" );
096                    usableProparty.put( "useHeader",        "?ッ??ー??(#NAME?を?力す?true)か?力しな?false)か?" );
097                    usableProparty.put( "useNumber",        "行番号を?力す?true)か?力しな?false)か?" );
098                    usableProparty.put( "useWquot",         "出力?ー????ブルク???????で括?true)かそのまま(false)か?" );
099                    usableProparty.put( "omitCTRL",         "???ー?文字を削除する(true)かそのまま(false)か?" );
100                    usableProparty.put( "const_",   "LineModel のキー(const_ に続く??)の値に、固定?? +
101                                                                            CR + "設定します?キーが異なれ?、?のカラ?を指定できます?" +
102                                                                            CR + "? -const_FGJ=1" );
103                    usableProparty.put( "display",  "結果を標準?力に表示する(true)かしな?false)? +
104                                                                            CR + " (初期値:false:表示しな?" );
105                    usableProparty.put( "debug",    "????を標準?力に表示する(true)かしな?false)? +
106                                                                            CR + "(初期値:false:表示しな?" );                // 5.7.3.0 (2014/02/07) ????
107            }
108    
109            /**
110             * ?ォルトコンストラクター?
111             * こ?クラスは、動??されます??ォルトコンストラクターで?
112             * super クラスに対して、?な初期化を行っておきます?
113             *
114             */
115            public Process_TableWriter() {
116                    super( "org.opengion.fukurou.process.Process_TableWriter",mustProparty,usableProparty );
117            }
118    
119            /**
120             * プロセスの初期化を行います?初めに??、呼び出されます?
121             * 初期処?ファイルオープン??オープン?に使用します?
122             *
123             * @param   paramProcess ??タベ?スの接続???などを持って?オブジェク?
124             */
125            public void init( final ParamProcess paramProcess ) {
126                    Argument arg = getArgument();
127    
128                    outfile                 = arg.getProparty("outfile");
129                    encode                  = arg.getProparty("encode",encode);
130                    separator               = arg.getProparty("sep",separator );
131                    append                  = arg.getProparty("append",append);
132                    useHeader               = arg.getProparty("useHeader",useHeader);
133                    useNumber               = arg.getProparty("useNumber",useNumber);
134                    useWquot                = arg.getProparty("useWquot",useWquot);
135                    omitCTRL                = arg.getProparty("omitCTRL",omitCTRL);
136                    HybsEntry[] cnstKey = arg.getEntrys( CNST_KEY );                // 配?
137                    display                 = arg.getProparty("display",display);
138                    debug                   = arg.getProparty("debug",debug);                               // 5.7.3.0 (2014/02/07) ????
139    //              if( debug ) { println( arg.toString() ); }                      // 5.7.3.0 (2014/02/07) ????
140    
141                    int size   = cnstKey.length;
142                    cnstClm    = new String[size];
143                    constVal   = new String[size];
144                    for( int i=0; i<size; i++ ) {
145                            cnstClm[i]  = cnstKey[i].getKey();
146                            constVal[i] = cnstKey[i].getValue();
147                    }
148    
149                    if( outfile == null ) {
150                            String errMsg = "ファイル名が?されて?せん? ;
151                            throw new RuntimeException( errMsg );
152                    }
153    
154                    file = new File( outfile );
155                    File dir = file.getParentFile() ;
156    
157                    // ?レクトリが存在しな??合?処?
158                    if( ! dir.exists() && ! dir.mkdirs() ) {
159                            String errMsg = "?レクトリが作?できませんでした?" + dir + "]" ;
160                            throw new RuntimeException( errMsg );
161                    }
162            }
163    
164            /**
165             * プロセスの終?行います??に??、呼び出されます?
166             * 終???ファイルクローズ??クローズ?に使用します?
167             *
168             * @param   isOK ト?タルで、OK?たかど?[true:成功/false:失敗]
169             */
170            public void end( final boolean isOK ) {
171                    if( writer != null ) {
172                            writer.flush();
173                            Closer.ioClose( writer );
174                            writer = null;
175                    }
176            }
177    
178            /**
179             * 引数の LineModel を??るメソ?です?
180             * 変換処?? LineModel を返します?
181             * 後続??行わな?????タのフィルタリングを行う場?は?
182             * null ??タを返します?つまり?null ??タは、後続??行わな?
183             * フラグの代わりにも使用して?す?
184             * なお?変換処?? LineModel と、オリジナルの LineModel が?
185             * 同?、コピ?(クローン)か?、各処?ソ??決めて?す?
186             * ドキュメントに明記されて???合?、副作用が問題になる?合??
187             * ???とに自?コピ?(クローン)して下さ??
188             *
189             * @param   data        オリジナルのLineModel
190             *
191             * @return      処?換後?LineModel
192             */
193            public LineModel action( final LineModel data ) {
194                    count++ ;
195    //              if( display ) { println( data.dataLine() ); }
196                    if( firstRow ) {
197                            writer = FileUtil.getPrintWriter( file,encode,append );
198                            if( useHeader && useNumber ) { writeName( data ); }
199    
200                            int size   = cnstClm.length;
201                            cnstClmNos = new int[size];
202                            for( int i=0; i<size; i++ ) {
203                                    cnstClmNos[i] = data.getColumnNo( cnstClm[i] );
204                            }
205    
206                            firstRow = false;
207                            if( display ) { println( data.nameLine() ); }           // 5.7.3.0 (2014/02/07) ????
208                    }
209    
210                    // 固定?置き換え??
211                    for( int j=0; j<cnstClmNos.length; j++ ) {
212                            data.setValue( cnstClmNos[j],constVal[j] );
213                    }
214    
215                    writeData( data );
216    
217                    if( display ) { println( data.dataLine() ); }   // 5.1.2.0 (2010/01/01) display の条件変更
218                    return data;
219            }
220    
221            /**
222             * PrintWriter に LineModelの?名情報を書き込みます?
223             * 第?ラ?は??目名情報を示?"#Name" を書き込みます?
224             * こ?行?、?力形式に無関係に、TAB で区?れます?
225             *
226             * @param       data ラインモ?
227             */
228            private void writeName( final LineModel data ) {
229                    int size = data.size();
230                    writer.print( "#Name" );
231                    for( int clm=0; clm<size; clm++ ) {
232                            writer.print( TAB );
233                            writer.print( data.getName(clm) );
234                    }
235                    writer.println();
236            }
237    
238            /**
239             * PrintWriter に LineModelの??ブル??を書き込みます?
240             *
241             * @og.rev 5.2.2.0 (2010/11/01) 改行を含??合?、ダブルクオートを強制?前後に追?る?
242             * @og.rev 5.2.2.0 (2010/11/01) ?ルクオートを含??合?、その直前に?ルクオートを強制?追?る?
243             *
244             * @param       data ラインモ?
245             */
246            private void writeData( final LineModel data ) {
247                    int size = data.size();
248    
249                    if( useNumber ) { writer.print( data.getRowNo() ); }            // 行番号
250                    for( int clm=0; clm<size; clm++ ) {
251                            if( useNumber || clm!=0 ) { writer.print( separator ); }
252                            Object val = data.getValue(clm);
253                            if( val == null ) { val = ""; }
254    
255                            String sval = String.valueOf( val );
256                            // 5.2.2.0 (2010/11/01) ?ルクオートを含??合?、その直前に?ルクオートを強制?追?る?
257                            if( sval.indexOf( '"' ) >= 0 ) { sval = sval.replaceAll( "\"" ,"\"\"" ) ; }
258                            if( omitCTRL ) { sval = sval.replaceAll( "\\s" ," " ) ; }
259    //                      if( useWquot ) { sval = "\"" + sval + "\"" ; }
260                            // 5.2.2.0 (2010/11/01) 改行を含??合?、ダブルクオートを強制?前後に追?る?
261                            if( useWquot || ( !omitCTRL && sval.indexOf( CR ) >= 0 ) ) {
262                                    sval = "\"" + sval + "\"" ;
263                            }
264                            writer.print( sval );
265                    }
266                    writer.println();
267            }
268    
269            /**
270             * プロセスの処?果のレポ?ト表現を返します?
271             * 処??ログラ?、?力件数、?力件数などの??です?
272             * こ???をそのまま、標準?力に出すことで、結果レポ?トと出来るよ?
273             * 形式で出してください?
274             *
275             * @return   処?果のレポ??
276             */
277            public String report() {
278                    String report = "[" + getClass().getName() + "]" + CR
279                                    + TAB + "Output File  : " + outfile + CR
280                                    + TAB + "Output Count : " + count ;
281    
282                    return report ;
283            }
284    
285            /**
286             * こ?クラスの使用方法を返します?
287             *
288             * @return      こ?クラスの使用方?
289             */
290            public String usage() {
291                    StringBuilder buf = new StringBuilder();
292    
293                    buf.append( "Process_TableWriter は、上流から受け取ったデータをファイルに書き込?                    ).append( CR );
294                    buf.append( "CainProcess インターフェースの実?ラスです?"                                                               ).append( CR );
295                    buf.append( CR );
296                    buf.append( "上?プロセスチェインの??タは上流から下流へと渡されます?)から"                   ).append( CR );
297                    buf.append( "受け取ったLineModel を?に、DBTableModel 形式ファイルを?力します?"                        ).append( CR );
298                    buf.append( CR );
299                    buf.append( "引数??中に空白を含??合?、ダブルコー??ション(\"\") で括って下さ??" ).append( CR );
300                    buf.append( "引数??の ?』?前後には、空白は挟めません。??key=value の様に"             ).append( CR );
301                    buf.append( "繋げてください?                                                                                                                              ).append( CR );
302                    buf.append( CR ).append( CR );
303    
304                    buf.append( getArgument().usage() ).append( CR );
305    
306                    return buf.toString();
307            }
308    
309            /**
310             * こ?クラスは、main メソ?から実行できません?
311             *
312             * @param       args    コマンド引数配?
313             */
314            public static void main( final String[] args ) {
315                    LogWriter.log( new Process_TableWriter().usage() );
316            }
317    }