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 * [-delKey_XXXX=?? ] ??-delKey_File=G:\\webapps\\ver4\\src
056 * LineModel のキー(delKey_ に続く??)の値から、指定???を削除します?
057 * キーが異なれ?、?のカラ?を指定できます?
058 * [-insKey_XXXX=?? ] ??-insKey_File=src\\t
059 * LineModel のキー(insKey_ に続く??)の値に、指定???を追?ます?
060 * キーが異なれ?、?のカラ?を指定できます?
061 * [ -display=false|true ] ??結果を標準?力に表示する(true)かしな?false)?初期値:false[表示しない])
062 *
063 *</pre>
064 * @version 4.0
065 * @author Kazuhiko Hasegawa
066 * @since JDK5.0,
067 */
068 public class Process_TableWriter extends AbstractProcess implements ChainProcess {
069 private static final String CNST_KEY = "const_" ;
070
071 private String outfile = null;
072 private PrintWriter writer = null;
073 private String separator = TAB; // ?区???
074
075 private String[] cnstClm = null; // 固定?を設定するカラ?
076 private int[] cnstClmNos = null; // 固定?を設定する?カラ?号
077 private String[] constVal = null; // カラ?号に対応した固定?
078 private File file = null; // 出力ファイル
079 private String encode = System.getProperty("file.encoding"); // 出力ファイルエンコー?
080 private boolean append = false; // ファイル追?true:追?false:通常)
081 private boolean useHeader = true; // ヘッ????(#NAME?を?力す?true)か?力しな?false)か?
082 private boolean useNumber = true; // 行番号を?力す?true)か?力しな?false)か?
083 private boolean useWquot = false; // 出力データをダブルクオー??ションで括?true)かそのまま(false)か?
084 private boolean omitCTRL = false; // コントロール?を削除する(true)かそのまま(false)か?
085 private boolean display = false; // 表示しな?
086
087 private boolean firstRow = true; // ??の?目
088 private int count = 0;
089
090 private static final Map<String,String> mustProparty ; // ?プロパティ???チェ?用 Map
091 private static final Map<String,String> usableProparty ; // ?プロパティ?整合?チェ? Map
092
093 static {
094 mustProparty = new LinkedHashMap<String,String>();
095 mustProparty.put( "outfile", "出力ファイル?(??)" );
096
097 usableProparty = new LinkedHashMap<String,String>();
098 usableProparty.put( "sep", "区???初期値:タ?" );
099 usableProparty.put( "encode", "出力ファイルのエンコードタイ? );
100 usableProparty.put( "append", "出力ファイルを?追記す?true)か新規作?する(false)か?" );
101 usableProparty.put( "useHeader", "ヘッ????(#NAME?を?力す?true)か?力しな?false)か?" );
102 usableProparty.put( "useNumber", "行番号を?力す?true)か?力しな?false)か?" );
103 usableProparty.put( "useWquot", "出力データを?ﾌﾞﾙｸ???????で括?true)かそのまま(false)か?" );
104 usableProparty.put( "omitCTRL", "コントロール?を削除する(true)かそのまま(false)か?" );
105 usableProparty.put( "const_", "LineModel のキー(const_ に続く??)の値に、固定?? +
106 CR + "設定します?キーが異なれ?、?のカラ?を指定できます?" +
107 CR + "? -const_FGJ=1" );
108 usableProparty.put( "display", "結果を標準?力に表示する(true)かしな?false)? +
109 CR + " (初期値:false:表示しな?" );
110 }
111
112 /**
113 * ?ォルトコンストラクター?
114 * こ?クラスは、動??されます??ォルトコンストラクターで?
115 * super クラスに対して、?な初期化を行っておきます?
116 *
117 */
118 public Process_TableWriter() {
119 super( "org.opengion.fukurou.process.Process_TableWriter",mustProparty,usableProparty );
120 }
121
122 /**
123 * プロセスの初期化を行います?初めに??、呼び出されます?
124 * 初期処?ファイルオープン??オープン?に使用します?
125 *
126 * @param paramProcess ??タベ?スの接続???などを持って?オブジェク?
127 */
128 public void init( final ParamProcess paramProcess ) {
129 Argument arg = getArgument();
130
131 outfile = arg.getProparty("outfile");
132 encode = arg.getProparty("encode",encode);
133 separator = arg.getProparty("sep",separator );
134 append = arg.getProparty("append",append);
135 useHeader = arg.getProparty("useHeader",useHeader);
136 useNumber = arg.getProparty("useNumber",useNumber);
137 useWquot = arg.getProparty("useWquot",useWquot);
138 omitCTRL = arg.getProparty("omitCTRL",omitCTRL);
139 HybsEntry[] cnstKey = arg.getEntrys( CNST_KEY ); // 配?
140 display =arg.getProparty("display",display);
141
142 int size = cnstKey.length;
143 cnstClm = new String[size];
144 constVal = new String[size];
145 for( int i=0; i<size; i++ ) {
146 cnstClm[i] = cnstKey[i].getKey();
147 constVal[i] = cnstKey[i].getValue();
148 }
149
150 if( outfile == null ) {
151 String errMsg = "ファイル名が?されて?せん? ;
152 throw new RuntimeException( errMsg );
153 }
154
155 file = new File( outfile );
156 File dir = file.getParentFile() ;
157
158 // ?レクトリが存在しな??合?処?
159 if( ! dir.exists() && ! dir.mkdirs() ) {
160 String errMsg = "?レクトリが作?できませんでした?" + dir + "]" ;
161 throw new RuntimeException( errMsg );
162 }
163 }
164
165 /**
166 * プロセスの終?行います??に??、呼び出されます?
167 * 終???ファイルクローズ??クローズ?に使用します?
168 *
169 * @param isOK ト?タルで、OK?たかど?[true:成功/false:失敗]
170 */
171 public void end( final boolean isOK ) {
172 if( writer != null ) {
173 writer.flush();
174 Closer.ioClose( writer );
175 writer = null;
176 }
177 }
178
179 /**
180 * 引数の LineModel を??るメソ?です?
181 * 変換処?? LineModel を返します?
182 * 後続??行わな?????タのフィルタリングを行う場?は?
183 * null ??タを返します?つまり?null ??タは、後続??行わな?
184 * フラグの代わりにも使用して?す?
185 * なお?変換処?? LineModel と、オリジナルの LineModel が?
186 * 同?、コピ?(クローン)か?、各処?ソ??決めて?す?
187 * ドキュメントに明記されて???合?、副作用が問題になる?合??
188 * ???とに自?コピ?(クローン)して下さ??
189 *
190 * @param data オリジナルのLineModel
191 *
192 * @return 処?換後?LineModel
193 */
194 public LineModel action( final LineModel data ) {
195 count++ ;
196 // if( display ) { println( data.dataLine() ); }
197 if( firstRow ) {
198 writer = FileUtil.getPrintWriter( file,encode,append );
199 if( useHeader && useNumber ) { writeName( data ); }
200
201 int size = cnstClm.length;
202 cnstClmNos = new int[size];
203 for( int i=0; i<size; i++ ) {
204 cnstClmNos[i] = data.getColumnNo( cnstClm[i] );
205 }
206
207 firstRow = false;
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 }