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 */ 016package org.opengion.hayabusa.taglib; 017 018import org.opengion.hayabusa.common.HybsSystem; 019import org.opengion.hayabusa.common.HybsSystemException; 020import org.opengion.hayabusa.db.DBTableModel; 021import org.opengion.fukurou.util.ErrorMessage; 022import org.opengion.fukurou.util.FileUtil; 023 024import org.opengion.fukurou.util.StringUtil ; 025import static org.opengion.fukurou.util.StringUtil.nval ; 026 027import java.util.Locale ; 028import java.util.Set ; 029import java.util.TreeSet ; 030import java.util.Comparator ; 031import java.io.File ; 032import java.io.ObjectOutputStream; 033import java.io.ObjectInputStream; 034import java.io.IOException; 035import java.io.Serializable; 036 037/** 038 * ファイル検索リストを元に、action に基づいた処理を行うタグです。 039 * command="ENTRY" 時のみ処理を行います。 040 * 041 * fileQuery などで検索したファイル一覧のDBTableModel を元に、ファイルの 042 * コピー(COPY)、移動(MOVE,MODIFY)、削除(DELETE)などの処理を行います。 043 * 処理を行うオリジナルファイルは、PARENT,NAME というカラムでなければなりません。 044 * このカラム名は、fileQuery の検索時には、必ず作成されるカラムです。 045 * また、各アクションに対応するターゲットファイルは、TO_PARENT,TO_NAME という 046 * カラムで指定するか、targetDir 属性を利用してフォルダを指定します。 047 * TO_PARENT(先フォルダ)と、TO_NAME(先ファイル名)は、処理に応じて、必要なカラムが 048 * あれば、自動的に処理します。 049 * つまり、TO_PARENT のみの場合は、ファイル名はオリジナルのまま、フォルダのみ変更します。 050 * 逆に、TO_NAME の場合は、フォルダはそのままで、ファイル名のみ指定します。 051 * 両方同時に指定することも可能です。 052 * targetDir 属性で指定する場合は、TO_PARENT のみに同じ値を設定した場合と同じになります。 053 * この属性を指定すると、TO_PARENT は無視されます。(TO_NAME は有効です。) 054 * COPY、MOVE(,MODIFY) の場合は、指定のフォルダに一括処理可能です。 055 * COPY、MOVE(,MODIFY) などの処理で、ターゲットフォルダが存在しないときに、作成するか、エラーにするかは 056 * createDir属性 で指定できます。初期値は、(true:作成する) です。 057 * これは、COPY先やMOVE(,MODIFY)先が存在している前提のシステムで、不要な箇所に間違ってフォルダを 058 * 自動作成されると困る場合に、(false:作成しない) とすれば、間違いに気づく確率が上がります。 059 * 060 * ※ このタグは、Transaction タグの対象ではありません。 061 * 062 * @og.formSample 063 * ●body:なし 064 * ●形式: 065 * ・<og:fileUpdate 066 * action = "COPY|MOVE|MODIFY|DELETE" アクション属性(必須) 067 * command = "[ENTRY]" ENTRY 時のみ実行します(初期値:ENTRY) 068 * targetDir = "[指定フォルダ]" ターゲットとなるフォルダ 069 * createDir = "[true/false]" ターゲットとなるフォルダがなければ作成する(true)かどうか(初期値:true) 070 * tableId = [HybsSystem.TBL_MDL_KEY] DBTableModel を取り出すキー 071 * outMessage = "[true/false]" 検索結果のメッセージを表示する(true)かどうかを指定(初期値:true) 072 * displayMsg = "MSG0040"; 処理結果を表示します(初期値:「 件登録しました。」) 073 * selectedAll = "[false/true]" データを全件選択済みとして処理する(true)かどうか指定(初期値:false) 074 * keepTimeStamp = "[false/true]" COPY,親違いMOVE(,MODIFY)の時にオリジナルのタイムスタンプを使用するかどうか(初期値:false) 075 * /> 076 * 077 * [action属性(必須)] 078 * COPY オリジナルファイルを、ターゲット(TO_PARENT,TO_NAMEで指定)にコピーします。 079 * MOVE オリジナルファイルを、ターゲットに移動(COPY+DELETE)/名称変更(RENAME)します。 080 * MODIFY (MOVE と同じ。エンジンの command を利用するための簡易action) 081 * DELETE オリジナルファイルを削除します(ターゲット(TO_PARENT,TO_NAME)は、関係しません)。 082 * 083 * ●Tag定義: 084 * <og:fileUpdate 085 * action ○【TAG】アクション[COPY|MOVE|MODIFY|DELETE]をセットします(必須)。 086 * command 【TAG】コマンド[ENTRY]をセットします 087 * targetDir 【TAG】ターゲットとなるフォルダを指定します 088 * createDir 【TAG】ターゲットとなるフォルダがなければ、作成するかどうかを指定します(初期値:true) 089 * tableId 【TAG】(通常は使いません)結果のDBTableModelを、sessionに登録するときのキーを指定します 090 * outMessage 【TAG】検索結果のメッセージを表示する/しない[true/false]を指定します(初期値:true) 091 * displayMsg 【TAG】処理結果を画面上に表示するメッセージリソースIDを指定します(初期値:MSG0040[ 件登録しました]) 092 * selectedAll 【TAG】データを全件選択済みとして処理するかどうか[true/false]を指定します(初期値:false) 093 * keepTimeStamp 【TAG】オリジナルのタイムスタンプを利用するかどうかを指定します(初期値:false) 094 * caseKey 【TAG】このタグ自体を利用するかどうかの条件キーを指定します(初期値:null) 095 * caseVal 【TAG】このタグ自体を利用するかどうかの条件値を指定します(初期値:null) 096 * scope 【TAG】キャッシュする場合のスコープ[request/page/session/applicaton]を指定します(初期値:session) 097 * debug 【TAG】デバッグ情報を出力するかどうか[true/false]を指定します(初期値:false) 098 * /> 099 * 100 * ●使用例 101 * ・<og:fileUpdate command="{@command}" action="COPY" /> 102 * TO_PARENT または、 TO_NAME(両方指定も可)による行単位 COPY 処理 103 * fileQuery の useUpdateClm="true" を設定し、検索結果に、TO_PARENT、 TO_NAMEカラムを追加します。 104 * TO_PARENT または、 TO_NAME は、columnSet などで値をセットしておきます。 105 * 106 * ・<og:fileUpdate command="{@command}" action="MODIFY" targetDir="AAA_DIR" /> 107 * fileQuery の検索結果を、AAA_DIR フォルダに移動します。 108 * ファイル名は、そのままオリジナルの値が使用されます。 109 * 110 * @og.rev 5.3.4.0 (2011/04/01) 新規追加 111 * @og.group ファイル出力 112 * 113 * @version 4.0 114 * @author Kazuhiko Hasegawa 115 * @since JDK5.0, 116 */ 117public class FileUpdateTag extends CommonTagSupport { 118 //* このプログラムのVERSION文字列を設定します。 {@value} */ 119 private static final String VERSION = "5.6.5.2 (2013/06/21)" ; 120 121 private static final long serialVersionUID = 565220130621L ; 122 123 /** command 引数に渡す事の出来る コマンド 登録{@value} */ 124 public static final String CMD_ENTRY = "ENTRY" ; 125 /** command 引数に渡す事の出来る コマンド リスト */ 126 private static final String COMMAND_LIST = CMD_ENTRY; 127 128 /** エラーメッセージID {@value} */ 129 private static final String errMsgId = HybsSystem.ERR_MSG_KEY; 130 131 /** action 引数に渡す事の出来る アクションコマンド COPY {@value} */ 132 public static final String ACT_COPY = "COPY" ; 133 /** action 引数に渡す事の出来る アクションコマンド MOVE {@value} */ 134 public static final String ACT_MOVE = "MOVE" ; 135 /** action 引数に渡す事の出来る アクションコマンド MODIFY {@value} */ 136 public static final String ACT_MODIFY = "MODIFY" ; 137 /** action 引数に渡す事の出来る アクションコマンド DELETE {@value} */ 138 public static final String ACT_DELETE = "DELETE" ; 139 140 private static final String[] ACTION_LIST = new String[] { ACT_COPY , ACT_MOVE , ACT_MODIFY , ACT_DELETE }; 141 142 private String action = null; 143 private String targetDir = null; // ターゲットとなるフォルダ 144 private boolean createDir = true; // ターゲットとなるフォルダがなければ、作成するかどうか(true:作成する) 145 146 private String tableId = HybsSystem.TBL_MDL_KEY; 147 private String command = CMD_ENTRY; 148 private boolean outMessage = true; 149 private String displayMsg = "MSG0040"; // 件登録しました。 150 private boolean selectedAll = false; 151 private boolean keepTimeStamp = false; // オリジナルのタイムスタンプを利用する場合、true 152 153 private transient DBTableModel table = null; 154 private transient ErrorMessage errMessage = null; 155 private int executeCount = -1; // 処理件数 156 private int errCode = ErrorMessage.OK; 157 private long dyStart = 0; 158 159 /** 160 * Taglibの終了タグが見つかったときに処理する doEndTag() を オーバーライドします。 161 * 162 * @return 後続処理の指示 163 */ 164 @Override 165 public int doEndTag() { 166 debugPrint(); 167 // 5.2.2.0 (2010/11/01) caseKey 、caseVal 属性対応 168 if( !useTag() ) { return EVAL_PAGE ; } 169 170 dyStart = System.currentTimeMillis(); 171 172 table = (DBTableModel)getObject( tableId ); 173 174 String label = ""; // 4.0.0 (2005/11/30) 検索しなかった場合。 175 if( table != null && table.getRowCount() > 0 && check( command, COMMAND_LIST ) ) { 176 startQueryTransaction( tableId ); 177 178 execute(); // 実際の処理を実行します。 179 180 StringBuilder buf = new StringBuilder( HybsSystem.BUFFER_SMALL ); 181 182 setRequestAttribute( "DB.COUNT" , String.valueOf( executeCount ) ); 183 setRequestAttribute( "DB.ERR_CODE", String.valueOf( errCode ) ); 184 185 String err = TaglibUtil.makeHTMLErrorTable( errMessage,getResource() ); 186 if( err != null && err.length() > 0 ) { 187 buf.append( err ); 188 setSessionAttribute( errMsgId,errMessage ); 189 } 190 label = buf.toString(); 191 192 if( table != null && ! commitTableObject( tableId, table ) ) { 193 jspPrint( "FileUpdateTag Query処理が割り込まれました。DBTableModel は登録しません。" ); 194 return SKIP_PAGE ; 195 } 196 } 197 198 jspPrint( label ); 199 200 // 実行件数の表示 201 // 4.0.0 (2005/11/30) 出力順の変更。一番最初に出力します。 202 if( displayMsg != null && displayMsg.length() > 0 ) { 203 String status = executeCount + getResource().getLabel( displayMsg ) ; 204 jspPrint( status + HybsSystem.BR ); 205 } 206 207 // 3.5.4.7 (2004/02/06) 208 long dyTime = System.currentTimeMillis()-dyStart; 209 jspPrint( "<div id=\"queryTime\" value=\"" + (dyTime) + "\"></div>" ); // 3.5.6.3 (2004/07/12) 210 211 return EVAL_PAGE ; 212 } 213 214 /** 215 * タグリブオブジェクトをリリースします。 216 * キャッシュされて再利用されるので、フィールドの初期設定を行います。 217 * 218 */ 219 @Override 220 protected void release2() { 221 super.release2(); 222 tableId = HybsSystem.TBL_MDL_KEY; 223 command = CMD_ENTRY; 224 action = null; 225 targetDir = null; // ターゲットとなるフォルダ 226 createDir = true; // ターゲットとなるフォルダがなければ、作成するかどうか(true:作成する) 227 outMessage = true; 228 displayMsg = "MSG0040"; // 件登録しました。 229 selectedAll = false; 230 keepTimeStamp = false; // オリジナルのタイムスタンプを利用する場合、true 231 table = null; 232 errMessage = null; 233 executeCount= -1; // 処理件数 234 errCode = ErrorMessage.OK; 235 dyStart = 0; // 処理時間 236 } 237 238 /** 239 * 処理を実行します。 240 * 241 */ 242 private void execute() { 243 int[] rowNo = getParameterRows(); 244 if( rowNo.length > 0 ) { 245 246 FromToFiles fromToFiles = new FromToFiles( table , targetDir , createDir ); 247 248 if( ACT_COPY.equalsIgnoreCase( action ) ) { 249 actionCOPY( rowNo,fromToFiles ); 250 } 251 // ACT_MODIFY は、エンジンの command で使うため、便利 252 else if( ACT_MOVE.equalsIgnoreCase( action ) || ACT_MODIFY.equalsIgnoreCase( action ) ) { 253 actionMOVE( rowNo,fromToFiles ); 254 } 255 else if( ACT_DELETE.equalsIgnoreCase( action ) ) { 256 actionDELETE( rowNo,fromToFiles ); 257 } 258 } 259 } 260 261 /** 262 * COPY アクションを実行します。 263 * 264 * @og.rev 5.6.5.2 (2013/06/21) From側がファイルの場合のみ処理します。 265 * 266 * @param rowNo 処理を実施する行番号 267 * @param fromToFiles FromFile,ToFile をまとめた補助クラス 268 * @throws HybsSystemException 処理中に何らかのエラーが発生した場合 269 */ 270 private void actionCOPY( final int[] rowNo , final FromToFiles fromToFiles ) { 271 File fromFile = null ; 272 File toFile = null ; 273 274 executeCount = 0 ; // 開始前に初期化しておく。 275 int rowCount = rowNo.length ; 276 for( int i=0; i<rowCount; i++ ) { 277 File[] files = fromToFiles.makeFromToFile( rowNo[i] ); // FromFile,ToFile 278 fromFile = files[0]; 279 toFile = files[1]; 280 281 // 5.6.5.2 (2013/06/21) From側がファイルの場合のみ処理します。 282 if( fromFile.isFile() && !FileUtil.copy( fromFile,toFile,keepTimeStamp ) ) { 283 String errMsg = "アクション=[" + action + "]中にエラーが発生しました。" + HybsSystem.CR 284 + "From=[" + fromFile + "],To=[" + toFile + "]" + HybsSystem.CR; 285 throw new HybsSystemException( errMsg ); 286 } 287 executeCount++ ; 288 } 289 } 290 291 /** 292 * MOVE アクションを実行します。 293 * 294 * @og.rev 5.5.2.4 (2012/05/16) メソッドの戻り値の設定 295 * @og.rev 5.6.5.2 (2013/06/21) From側がファイルの場合のみ処理します。 296 * 297 * @param rowNo 処理を実施する行番号 298 * @param fromToFiles FromFile,ToFile をまとめた補助クラス 299 * @throws HybsSystemException 処理中に何らかのエラーが発生した場合 300 */ 301 private void actionMOVE( final int[] rowNo , final FromToFiles fromToFiles ) { 302 File fromFile = null ; 303 File toFile = null ; 304 305 executeCount = 0 ; // 開始前に初期化しておく。 306 int rowCount = rowNo.length ; 307 for( int i=0; i<rowCount; i++ ) { 308 File[] files = fromToFiles.makeFromToFile( rowNo[i] ); // FromFile,ToFile 309 fromFile = files[0]; 310 toFile = files[1]; 311 312 if( fromToFiles.lastParentEquals() ) { // FromDirとToDirが同じなので、RENAMEできる。 313 if( !fromFile.renameTo( toFile ) ) { 314 String errMsg = "アクション=[" + action + "]中にエラーが発生しました。" + HybsSystem.CR 315 + "同一親フォルダのため、RENAME処理を行っています。" + HybsSystem.CR 316 + "From=[" + fromFile + "],To=[" + toFile + "]" + HybsSystem.CR; 317 throw new HybsSystemException( errMsg ); 318 } 319 } 320 // 5.6.5.2 (2013/06/21) From側がファイルの場合のみ処理します。 321 else if( fromFile.isFile() ) { // FromDirとToDirが異なるので、COPY + DELETE する。 322 if( !FileUtil.copy( fromFile,toFile,keepTimeStamp ) ) { 323 String errMsg = "アクション=[" + action + "]中にエラーが発生しました。" + HybsSystem.CR 324 + "移動前のCOPY処理を行っていました。" + HybsSystem.CR 325 + "From=[" + fromFile + "],To=[" + toFile + "]" + HybsSystem.CR; 326 throw new HybsSystemException( errMsg ); 327 } 328 329 if( !fromFile.delete() ) { 330 String errMsg = "アクション=[" + action + "]中にエラーが発生しました。" + HybsSystem.CR 331 + "移動後のオリジナルファイルの削除処理を行っていました。" + HybsSystem.CR 332 + "From=[" + fromFile + "],To=[" + toFile + "]" + HybsSystem.CR; 333 // 5.5.2.4 (2012/05/16) メソッドの戻り値の設定 334 if(! toFile.delete() ) { 335 errMsg = errMsg + "toFile も削除に失敗しました。" + HybsSystem.CR; 336 } 337 338 throw new HybsSystemException( errMsg ); 339 } 340 } 341 executeCount++ ; 342 } 343 } 344 345 /** 346 * DELETE アクションを実行します。 347 * 348 * この処理では、リストにフォルダが含まれている場合も削除します。 349 * 通常、フォルダの削除は、その要素(内部)にファイル等が存在しない場合のみ 350 * 行いますが、検索リストから削除する順番によっては、フォルダもファイルも 351 * 削除対象になる場合があります。そこで、まず。ファイルだけ削除し、フォルダは、 352 * あとで削除するように処理を行います。 353 * 354 * @og.rev 5.6.5.2 (2013/06/21) フォルダも削除対象にします。 355 * 356 * @param rowNo 処理を実施する行番号 357 * @param fromToFiles FromFile,ToFile をまとめた補助クラス 358 * @throws HybsSystemException 処理中に何らかのエラーが発生した場合 359 */ 360 private void actionDELETE( final int[] rowNo , final FromToFiles fromToFiles ) { 361 File fromFile = null; 362 363 // 5.6.5.2 (2013/06/21) フォルダを削除する為の、退避 364 Set<File> dirSet = new TreeSet<File>( new FileNameLengthComparator() ); // ファイルの文字数順に並べたSet 365 366 executeCount = 0 ; // 開始前に初期化しておく。 367 int rowCount = rowNo.length ; 368 for( int i=0; i<rowCount; i++ ) { 369 fromFile = fromToFiles.makeFromOnly( rowNo[i] ); // FromFile 370 371 // 5.6.5.2 (2013/06/21) まず、ファイルを削除します。 372 if( fromFile.isFile() ) { 373 if( !fromFile.delete() ) { 374 String errMsg = "アクション=[" + action + "]中にエラーが発生しました。" + HybsSystem.CR 375 + "From=[" + fromFile + "]" + HybsSystem.CR; 376 throw new HybsSystemException( errMsg ); 377 } 378 } 379 else { 380 // 5.6.5.2 (2013/06/21) フォルダの場合は、アドレスの桁数をキーにソートしておきます。 381 dirSet.add( fromFile ); 382 } 383 executeCount++ ; 384 } 385 386 // 5.6.5.2 (2013/06/21) フォルダの削除は、アドレスの桁数の大きい順(階層の深い順)に削除します。 387 for( File file : dirSet ) { 388 if( !file.delete() ) { 389 String errMsg = "アクション=[" + action + "]中にエラーが発生しました。" + HybsSystem.CR 390 + "From(Dir)=[" + file + "]" + HybsSystem.CR; 391 throw new HybsSystemException( errMsg ); 392 } 393 } 394 } 395 396 /** 397 * ファイルの名称の長さ順(長い順)に比較する、Comparator インターフェースの実装クラス 398 * 399 * ここでの大小比較は、ファイル名の文字数が、大きい方が、小さいとみなされます。 400 * つまり階層が深いので、先に処理する必要があるという事を意味します。 401 * 処理としては、f1 != null && f2 != null で、len1 = f1.getAbsolutePath().length() と len2 = f2.getAbsolutePath().length() を比較し 402 * len1 > len2 ⇒ 負 , len1 < len2 ⇒ 正 , len1 == len2 ⇒ 0 を返します。 403 * 具体的には、return ( len2 - len1 ); です。 404 * 405 * 注: このコンパレータは equals と一貫性のない順序付けを課します。 406 * 407 * @og.rev 5.6.5.2 (2013/06/21) 新規追加 408 * 409 */ 410 private static final class FileNameLengthComparator implements Comparator<File> , Serializable { 411 private static final long serialVersionUID = 565220130621L ; // 5.6.5.2 (2013/06/21) 412 /** 413 * 順序付けのために 2 つの引数を比較します。 414 * 415 * ここでの大小比較は、ファイル名の文字数が、大きい方が、小さいとみなされます。 416 * 具体的には、return ( len2 - len1 ); です。 417 * 418 * @param 比較対象の最初のオブジェクト 419 * @param 比較対象の 2 番目のオブジェクト 420 * @return 最初の引数が 2 番目の引数より小さい場合は負の整数、両方が等しい場合は 0、最初の引数が 2 番目の引数より大きい場合は正の整数 421 */ 422 public int compare( final File f1 , final File f2 ) { 423 if( f1 == null || f2 == null ) { 424 String errMsg = "引数のFileにnullが含まれています。file1=[" + f1 + "] , file2=[" + f2 + "]" ; 425 throw new IllegalArgumentException( errMsg ); 426 } 427 428 int len1 = f1.getAbsolutePath().length(); 429 int len2 = f2.getAbsolutePath().length(); 430 431 return len2 - len1 ; 432 } 433 } 434 435 /** 436 * 表示データの HybsSystem.ROW_SEL_KEY を元に、選ばれた 行を処理の対象とします。 437 * 438 * @return 選択行の配列 439 */ 440 @Override 441 protected int[] getParameterRows() { 442 final int[] rowNo ; 443 if( selectedAll ) { 444 int rowCnt = table.getRowCount(); 445 rowNo = new int[ rowCnt ]; 446 for( int i=0; i<rowCnt; i++ ) { 447 rowNo[i] = i; 448 } 449 } else { 450 rowNo = super.getParameterRows(); 451 } 452 return rowNo ; 453 } 454 455 /** 456 * 【TAG】アクション[COPY|MOVE|MODIFY|DELETE]をセットします(必須)。 457 * 458 * @og.tag 459 * アクションは、ファイルをコピー(COPY)したり、移動(MOVE,MODIFY)したり、削除(DELETE)する 460 * などの操作を指定する必須属性です。 461 * 462 * <table border="1" frame="box" rules="all" > 463 * <caption>action属性(必須)のキーワード</caption> 464 * <tr><th>action</th><th>名称</th><th>機能</th></tr> 465 * <tr><td>COPY </td><td>コピー</td><td>オリジナルファイルを、ターゲット(TO_PARENT,TO_NAMEで指定)にコピーします。</td></tr> 466 * <tr><td>MOVE </td><td>移動 </td><td>オリジナルファイルを、ターゲットに移動(COPY+DELETE)/名称変更(RENAME)します。</td></tr> 467 * <tr><td>MODIFY</td><td>移動 </td><td>(MOVE と同じ。エンジンの command を利用するための簡易action)</td></tr> 468 * <tr><td>DELETE</td><td>削除 </td><td>オリジナルファイルを、削除します。(フォルダ、ファイルに関わらず)</td></tr> 469 * </table> 470 * 471 * @param act アクション(public static final 宣言されている文字列) 472 * @see <a href="../../../../constant-values.html#org.opengion.hayabusa.taglib.FileUpdateTag.ACT_COPY">アクション定数</a> 473 */ 474 public void setAction( final String act ) { 475 action = nval( getRequestParameter( act ),action ); 476 477 if( action != null && !check( action, ACTION_LIST ) ) { 478 String errMsg = "指定のアクションは実行できません。アクションエラー" + HybsSystem.CR 479 + "action=[" + action + "] " + HybsSystem.CR 480 + StringUtil.array2csv( ACTION_LIST ) ; 481 throw new HybsSystemException( errMsg ); 482 } 483 } 484 485 /** 486 * 【TAG】ターゲットとなるフォルダを指定します。 487 * 488 * @og.tag 489 * targetDir 属性を利用する場合は、引数のファイル、またはフォルダが指定されたことに 490 * なります。COPY、MOVE(,MODIFY) の場合は、targetDir 属性にフォルダを指定することで一括処理可能です。 491 * 指定先のフォルダが存在しない場合は、createDir属性の値により処理が異なります。 492 * createDir="true"(初期値)で、ターゲットフォルダが存在しない場合は、自動作成します。 493 * 494 * @param dir ターゲットとなるフォルダ 495 * @see #setCreateDir( String ) 496 */ 497 public void setTargetDir( final String dir ) { 498 targetDir = nval( getRequestParameter( dir ),targetDir ); 499 } 500 501 /** 502 * 【TAG】ターゲットとなるフォルダがなければ、作成するかどうかを指定します(初期値:true)。 503 * 504 * @og.tag 505 * COPY,MOVE(,MODIFY) などの処理で、ターゲットフォルダが存在しないときに、作成するか、エラーにするかを 506 * createDir属性 で指定できます。 507 * これは、COPY先やMOVE(,MODIFY)先が存在している前提のシステムで、不要な箇所に間違ってフォルダを 508 * 自動作成されると困る場合に、false:作成しない とすれば、間違いに気づく確率が上がります。 509 * 初期値は true:作成する です。 510 * 511 * @param flag ターゲットとなるフォルダを自動作成する(true)か、しない(false) 初期値は、true:作成する 512 */ 513 public void setCreateDir( final String flag ) { 514 createDir = nval( getRequestParameter( flag ),createDir ); 515 } 516 517 /** 518 * 【TAG】(通常は使いません)結果のDBTableModelを、sessionに登録するときのキーを指定します 519 * (初期値:HybsSystem#TBL_MDL_KEY[={@og.value org.opengion.hayabusa.common.HybsSystem#TBL_MDL_KEY}])。 520 * 521 * @og.tag 522 * 検索結果より、DBTableModelオブジェクトを作成します。これを、下流のviewタグ等に 523 * 渡す場合に、通常は、session を利用します。その場合の登録キーです。 524 * query タグを同時に実行して、結果を求める場合、同一メモリに配置される為、 525 * この tableId 属性を利用して、メモリ空間を分けます。 526 * (初期値:HybsSystem#TBL_MDL_KEY[={@og.value org.opengion.hayabusa.common.HybsSystem#TBL_MDL_KEY}])。 527 * 528 * @param id sessionに登録する時の ID 529 */ 530 public void setTableId( final String id ) { 531 tableId = nval( getRequestParameter( id ),tableId ); 532 } 533 534 /** 535 * 【TAG】コマンド(ENTRY)をセットします。 536 * 537 * @og.tag 538 * このタグは、command="ENTRY" でのみ実行されます。 539 * コマンドは,HTMLから(get/post)指定されますので,CMD_xxx で設定される 540 * フィールド定数値のいづれかを、指定できます。 541 * 初期値は、ENTRY なので、何も指定しなければ、実行されます。 542 * 543 * @param cmd コマンド(public static final 宣言されている文字列) 544 * @see <a href="../../../../constant-values.html#org.opengion.hayabusa.taglib.FileUpdateTag.CMD_ENTRY">コマンド定数</a> 545 */ 546 public void setCommand( final String cmd ) { 547 String cmd2 = getRequestParameter( cmd ); 548 if( cmd2 != null && cmd2.length() >= 0 ) { command = cmd2.toUpperCase(Locale.JAPAN); } 549 } 550 551 /** 552 * 【TAG】検索結果のメッセージを表示する/しない[true/false]を指定します(初期値:true)。 553 * 554 * @og.tag 555 * 初期値は、表示する:true です。 556 * 557 * @param flag [true:表示する/それ以外:含めない] 558 */ 559 public void setOutMessage( final String flag ) { 560 outMessage = nval( getRequestParameter( flag ),outMessage ); 561 } 562 563 /** 564 * 【TAG】処理結果を画面上に表示するメッセージリソースIDを指定します(初期値:MSG0040[ 件登録しました])。 565 * 566 * @og.tag 567 * ここでは、検索結果の件数や登録された件数をまず出力し、 568 * その次に、ここで指定したメッセージをリソースから取得して表示します。 569 * 表示させたくない場合は, displayMsg = "" をセットしてください。 570 * displayMsg の初期値は、MSG0040[ 件登録しました]です。 571 * 572 * @param id ディスプレイに表示させるメッセージ ID 573 */ 574 public void setDisplayMsg( final String id ) { 575 String ids = getRequestParameter( id ); 576 if( ids != null ) { displayMsg = ids; } 577 } 578 579 /** 580 * 【TAG】データを全件選択済みとして処理するかどうか[true/false]を指定します(初期値:false)。 581 * 582 * @og.tag 583 * 全てのデータを選択済みデータとして扱って処理します。 584 * 全件処理する場合に、(true/false)を指定します。 585 * 初期値は false です。 586 * 587 * @param all データを全件選択済み [true:全件選択済み/false:通常] 588 */ 589 public void setSelectedAll( final String all ) { 590 selectedAll = nval( getRequestParameter( all ),selectedAll ); 591 } 592 593 /** 594 * 【TAG】オリジナルのタイムスタンプを利用するかどうかを指定します(初期値:false)。 595 * 596 * @og.tag 597 * COPYや親違いMOVE(,MODIFY)の時に、オリジナルのタイムスタンプをそのままコピー先のファイルにも 598 * 適用するかどうかを指定します。 599 * タイムスタンプを初期化されたくない場合に、true に設定します。 600 * 初期値は 利用しない:false です。 601 * 602 * @param flag タイムスタンプを利用するかどう(初期値:利用しない)。 603 */ 604 public void setKeepTimeStamp( final String flag ) { 605 keepTimeStamp = nval( getRequestParameter( flag ),keepTimeStamp ); 606 } 607 608 /** 609 * DBTableModel から、FromFile,ToFile を作成するための処理をまとめた補助クラスです。 610 * 611 * ここでは、オリジナルファイルやターゲットファイルを作成するための処理のみを集めています。 612 * メソッドにすると、ローカル変数を多く管理するか、多数の引数渡しを繰り返すことになるため、 613 * このローカルクラスに処理と、値を格納します。 614 * 615 */ 616 private static final class FromToFiles { 617 private final DBTableModel table ; 618 619 private final int PARENT ; 620 private final int NAME ; 621 private final int TO_PARENT ; 622 private final int TO_NAME ; 623 624 private final File toDir ; 625 private final boolean createDir; // ターゲットとなるフォルダがなければ、作成するかどうか(true:作成する) 626 627 private boolean equalParent = false; // 最後に実行された処理で、親フォルダが同一の場合は、true 628 629 /** 630 * 引数指定のコンストラクター 631 * 632 * 必要なパラメータを渡して、オブジェクトを構築します。 633 * 634 * @param table DBTableModel 一覧が格納されているDBTableModel 635 * @param targetDir ターゲットとなるフォルダ 636 * @param createDir ターゲットとなるフォルダがなければ、作成するかどうか(true:作成する) 637 */ 638 public FromToFiles( final DBTableModel table , final String targetDir , final boolean createDir ) { 639 this.table = table; 640 this.createDir = createDir ; 641 toDir = mkDirs( targetDir,createDir ); // targetDir が指定されていない場合は、null 642 643 // "PARENT","NAME","TO_PARENT","TO_NAME" のカラム名のDBTableModelのカラム番号。存在しない場合は、-1 644 PARENT = table.getColumnNo( "PARENT" , false ); 645 NAME = table.getColumnNo( "NAME" , false ); 646 TO_PARENT = table.getColumnNo( "TO_PARENT", false ); 647 TO_NAME = table.getColumnNo( "TO_NAME" , false ); 648 } 649 650 /** 651 * 行番号より、対応するオリジナルファイル(FromFile)を返します。 652 * 653 * ここでは、TO_PARENT や TO_NAME は、判定する必要がないため、makeFromToFile( int ) の 654 * 一部のみで処理が終了できます。 655 * 1.FromDir は、PARENT 列の値から作成する。 656 * 2.FromFileは、FromDir + NAME列の値から作成する。 657 * 658 * 配列返しの関係で、メソッド(および内部処理)を分けています。 659 * 660 * @param rowNo カラムNo 661 * @return File オリジナルファイル(FromFile) 662 * @see #makeFromToFile( int ) 663 */ 664 public File makeFromOnly( final int rowNo ) { 665 String[] value = table.getValues( rowNo ); 666 File fromDir = mkDirs( value[PARENT],createDir ); 667 668 return new File( fromDir, value[NAME] ) ; 669 } 670 671 /** 672 * 行番号より、対応するオリジナルファイル(FromFile)とターゲットファイル(ToFile)を配列に格納して返します。 673 * 674 * ここでは、TO_PARENT や TO_NAME は、存在するかどうか不明なので、以下の手順で作成します。 675 * 1.FromDir は、PARENT 列の値から作成する。 676 * 2.FromFileは、FromDir + NAME列の値から作成する。 677 * 3.toDir は、 678 * A.targetDir が有れば、それを使う。 679 * B.なければ、TO_PARENT 列の値から作成する。 680 * C.TO_PARENT 列がないか、値が未設定の場合は、FromDir をそのまま使う。 681 * 4.toFile は、 682 * A.toDir + TO_NAME 列の値から作成する。 683 * B.TO_NAME 列がないか、値が未設定の場合は、toDir + NAME列の値から作成する。 684 * 返り値は、new File[] { formFile , toFile }; とする。 685 * 686 * @param rowNo カラムNo 687 * @return File[] ファイル配列(0:オリジナルファイル 1:ターゲットファイル) 688 */ 689 public File[] makeFromToFile( final int rowNo ) { 690 691 String[] value = table.getValues( rowNo ); 692 File fromDir = mkDirs( value[PARENT],createDir ); 693 File formFile = new File( fromDir, value[NAME] ); 694 File tempToDir = toDir; 695 696 equalParent = false; // 最後に実行された処理で、親フォルダが同一かどうかのフラグをリセットする。 697 if( tempToDir == null ) { 698 if( TO_PARENT >= 0 && nval(value[TO_PARENT],null) != null ) { 699 tempToDir = mkDirs( value[TO_PARENT],createDir ); 700 } 701 else { 702 tempToDir = fromDir; 703 equalParent = true; // 最後に実行された処理で、親フォルダが同一の場合は、true 704 } 705 } 706 707 File toFile = null; 708 if( TO_NAME >= 0 && nval(value[TO_NAME],null) != null ) { 709 toFile = new File( tempToDir, value[TO_NAME] ); 710 } 711 else { 712 toFile = new File( tempToDir, value[NAME] ); 713 } 714 715 return new File[] { formFile , toFile }; 716 } 717 718 /** 719 * 最後に実行された処理で、親フォルダが同一かどうかを返します(同一の場合は、true)。 720 * 721 * makeFromToFile( int ) が処理されたときの、FromDir と toDir が同一であれば、true を、 722 * 異なる場合は、false を返します。 723 * ここでの結果は、厳密な同一判定ではなく、処理的に、同一かどうかを判定しています。 724 * つまり、toDir に FromDir をセットする(3.Cのケース)場合に、true を内部変数にセットします。 725 * この判定値は、ファイルの移動処理で、異なる親フォルダの場合は、COPY & DELETE しなければ 726 * なりませんが、同一親フォルダの場合は、RENAME で済む という処理負荷の軽減が目的です。 727 * よって、結果的に、PARENT と TO_PARENT が同じとか、PARENT と targetDir が同じでも 728 * ここでのフラグは、false が返されます。 729 * 730 * @return 最後に実行された処理で、親フォルダが同一の場合は、true 731 * @see #makeFromToFile( int ) 732 */ 733 public boolean lastParentEquals() { 734 return equalParent ; 735 } 736 737 /** 738 * カラム名配列(String[])より、対応するカラムNo配列(int[])を作成します。 739 * 740 * ここでは、TO_PARENT や TO_NAME は、存在するかどうか不明なので、 741 * EXCEPTION にせず、配列番号に、-1 を返すようにしています。 742 * 743 * @param table DBTableModel 一覧が格納されているDBTableModel 744 * @param nameArray カラム名配列 745 * @return カラムNo配列(カラム名が存在しない場合は、-1) 746 */ 747 // private int[] getTableColumnNo( final DBTableModel table ,final String[] nameArray ) { 748 // int[] clmNo = new int[ nameArray.length ]; 749 // for( int i=0; i<clmNo.length; i++ ) { 750 // clmNo[i] = table.getColumnNo( nameArray[i] , false ); // カラム名が存在しない場合は、-1 を返す。 751 // } 752 // return clmNo; 753 // } 754 755 /** 756 * フォルダを作成します。 757 * 758 * フォルダが存在しない場合は、途中階層をすべて作成します。 759 * 760 * @param fname フォルダ名 761 * @param createDir ターゲットとなるフォルダがなければ、作成するかどうか(true:作成する) 762 * @return File フォルダを表すファイルオブジェクト。引数が null の場合は、null を返します。 763 * @throws HybsSystemException ファイルか、存在しない場合に、createDir=false か、mkdirs() が false の場合 764 */ 765 private File mkDirs( final String fname , final boolean createDir ) { 766 File target = null; 767 if( fname != null ) { 768 target = new File( fname ); 769 if( target.exists() ) { // 存在する 770 if( target.isFile() ) { 771 String errMsg = "ターゲットに、ファイル名は指定できません。" + HybsSystem.CR 772 + "ターゲット=[" + fname + "]" + HybsSystem.CR; 773 throw new HybsSystemException( errMsg ); 774 } 775 } 776 else { // 存在しない 777 // 存在しないのに、作成しない 778 if( !createDir ) { 779 String errMsg = "ターゲットが存在しません。 " + HybsSystem.CR 780 + "ターゲット=[" + fname + "]" + HybsSystem.CR; 781 throw new HybsSystemException( errMsg ); 782 } 783 // 作成できない 784 if( !target.mkdirs() ) { 785 String errMsg = "ターゲットを自動作成使用としましたが、作成できませんでした。" + HybsSystem.CR 786 + "ターゲット=[" + fname + "]" + HybsSystem.CR; 787 throw new HybsSystemException( errMsg ); 788 } 789 } 790 } 791 return target; 792 } 793 } 794 795 /** 796 * シリアライズ用のカスタムシリアライズ書き込みメソッド 797 * 798 * @og.rev 4.0.0.0 (2006/09/31) 新規追加 799 * @serialData 一部のオブジェクトは、シリアライズされません。 800 * 801 * @param strm ObjectOutputStreamオブジェクト 802 * @throws IOException シリアライズに関する入出力エラーが発生した場合 803 */ 804 private void writeObject( final ObjectOutputStream strm ) throws IOException { 805 strm.defaultWriteObject(); 806 } 807 808 /** 809 * シリアライズ用のカスタムシリアライズ読み込みメソッド 810 * 811 * ここでは、transient 宣言された内部変数の内、初期化が必要なフィールドのみ設定します。 812 * 813 * @og.rev 4.0.0.0 (2006/09/31) 新規追加 814 * @serialData 一部のオブジェクトは、シリアライズされません。 815 * 816 * @param strm ObjectInputStreamオブジェクト 817 * @see #release2() 818 * @throws IOException シリアライズに関する入出力エラーが発生した場合 819 * @throws ClassNotFoundException クラスを見つけることができなかった場合 820 */ 821 private void readObject( final ObjectInputStream strm ) throws IOException , ClassNotFoundException { 822 strm.defaultReadObject(); 823 } 824 825 /** 826 * このオブジェクトの文字列表現を返します。 827 * 基本的にデバッグ目的に使用します。 828 * 829 * @return このクラスの文字列表現 830 */ 831 @Override 832 public String toString() { 833 return org.opengion.fukurou.util.ToString.title( this.getClass().getName() ) 834 .println( "VERSION" ,VERSION ) 835 .println( "action" ,action ) 836 .println( "command" ,command ) 837 .println( "targetDir" ,targetDir ) 838 .println( "createDir" ,createDir ) 839 .println( "tableId" ,tableId ) 840 .println( "outMessage" ,outMessage ) 841 .println( "displayMsg" ,displayMsg ) 842 .println( "selectedAll" ,selectedAll ) 843 .println( "keepTimeStamp" ,keepTimeStamp ) 844 .fixForm().toString() ; 845 } 846}