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.xml.XSLT; 021 import org.opengion.fukurou.util.LogWriter; 022 023 import java.util.Map ; 024 import java.util.LinkedHashMap ; 025 import java.io.File; 026 027 /** 028 * XSLT変換結果を指定?ファイルに出力します? 029 * 030 * Process_XSLT は、AbstractProcess を継承した、ChainProcess インターフェース 031 * の実?ラスです? 032 * 上?プロセスチェインの??タは上流から渡されます?)からのLineModel の 033 * ファイルオブジェクトに対して、指定? XSL ファイルを適用して、XSL変換を行います? 034 * 出力結果は、ファイル、また? 標準?力に出力できます? 035 * 036 * 上流?ロセスでは、Name 属?として、?File』を持ち、?は、Fileオブジェク? 037 * である、Process_FileSearch を使用するのが?便利です?それ以外?クラス? 038 * 使用する場合でも?Name属?と、File オブジェクトを持つ LineModel を受け渡? 039 * できれば、使用可能です? 040 * 041 * -param_XXXX=固定? を使用して、XSLTにパラメータを設定できます? 042 * 043 * それ以外では、org.opengion.fukurou.xml.XSLT で、?力ファイル??の設定が可能に 044 * なって?為、?部??を使用するかど? -useFileInfo を指定できます? 045 * -useFileInfo=true とセ?すると、以下???目が?部?セ?されます? 046 * 047 * 入力ファイル(inXMLのフルパス) : FILEPATH (? G:\webapps\gf\jsp\DOC10\query.jsp) 048 * 入力親フォル?inXMLの親フォル? : ADDRESS (? DOC10) 049 * 入力ファイル(inXMLのファイル? : FILENAME (? query.jsp) 050 * 入力ファイル(inXMLの更新日? ) : MODIFIED (? yyyyMMddHHmmss形? 051 * 052 * xsl ファイルでは、xsl:param で宣?、xsl:value-of で取り出します? 053 * <xsl:param name="ADDRESS" select="" /> と宣?ておき、?な?で 054 * <xsl:value-of select="$ADDRESS" /> とすれば、取得できます? 055 * 056 * 引数??中にスペ?スを含??合?、ダブルコー??ション("") で括って下さ?? 057 * 引数??の ?』?前後には、スペ?スは挟めません。??key=value の様に 058 * 繋げてください? 059 * 060 * @og.formSample 061 * Process_XSLT -xslfile=xslファイル -outfile=OUTFILE -append=true 062 * 063 * -xslfile=xslファイル ?変換を行う XSLファイル 064 * [-outfile=出力ファイル?] ?変換結果の出力ファイル? 065 * [-append=false|true ] ??力ファイルを?追記す?true)か新規作?する(false)? 066 * [-useFileInfo=false|true ] ??力ファイル??を?XSLTのパラメータにセ?する(true)かしな?(false)? 067 * [-addROWSET=??ブル? ] ???ー/フッターに ROWSET を追記します? 068 * [-headerXX=ヘッ????] ??力ファイルに、??ー??を追記します? 069 * 添え?XX)が異なれ??のヘッ??が指定できます? 070 * [-footerXX=フッター??] ??力ファイルに、フ?ー??を追記します? 071 * 添え?XX)が異なれ??のフッターが指定できます? 072 * [-param_XXXX=固定? ] ??param_SYSTEM_ID=GE 073 * XSLパ?サーに対して、paramater を設定します? 074 * キーが異なれ?、?のパラメータを指定できます? 075 * [ -errAbend=true|false ] ?異常発生時に、??中断(true)するか?継?false)するかを?す?初期値:true[中断する]) 076 * [ -errXmlIn=false|true ] ?異常発生時に、?力ファイルに、XML形式でエラーを追記するかを指定す?初期値:false[使用しない]) 077 * [ -jspInclude=true|false ] ?jsp:directive.include 発見時に、そのファイル?INCLUDE するかを?す?初期値:true[使用する]) 078 * [ -display=false|true ] ?結果を標準?力に表示する(true)かしな?false)?初期値:false[表示しない]) 079 * 080 * @version 4.0 081 * @author Kazuhiko Hasegawa 082 * @since JDK5.0, 083 */ 084 public class Process_XSLT extends AbstractProcess implements ChainProcess { 085 private static final String PARAM_KEY = "param_" ; 086 private static final String HEADER_KEY = "header" ; 087 private static final String FOOTER_KEY = "footer" ; 088 private static final String FILE_KEY = "File"; 089 090 private static final String HEADER_XML = "<?xml version=\"1.0\" encoding=\"UTF-8\"?>" ; 091 private static final String HEADER_ROWSET = "<ROWSET tableName=\"TABLENAME\">" ; 092 private static final String FOOTER_ROWSET = "</ROWSET>" ; 093 094 private XSLT xslt = null ; 095 private HybsEntry[] footerEntry = null; 096 private String xslfile = null ; 097 private String outfile = null ; 098 private boolean errAbend = true; // 中断する 099 private boolean errXmlIn = false; // エラーXML形? 100 private boolean jspInclude = true; // 4.2.3.0 (2008/05/26) 101 private boolean display = false; // 表示しな? 102 103 private int clmNo = -1; 104 private int inCount = 0; 105 private int errCount = 0; 106 private String tableName = null; 107 108 private static final Map<String,String> mustProparty ; // ?プロパティ???チェ?用 Map 109 private static final Map<String,String> usableProparty ; // ?プロパティ?整合?チェ? Map 110 111 static { 112 mustProparty = new LinkedHashMap<String,String>(); 113 mustProparty.put( "xslfile", "変換を行う XSLファイル(??)" ); 114 115 usableProparty = new LinkedHashMap<String,String>(); 116 usableProparty.put( "outfile", "変換結果の出力ファイル? ); 117 usableProparty.put( "append", "出力ファイルを?追記す?true)か新規作?する(false)? ); 118 usableProparty.put( "useFileInfo", "入力ファイル??を?XSLTのパラメータにセ?する(true)かしな?(false)? ); 119 usableProparty.put( "addROWSET" , "ヘッ??/フッターに ROWSET を追記します?"); 120 usableProparty.put( "header", "出力ファイルに、??ー??を追記します?" + 121 CR + "添え?XX)が異なれ??のヘッ??が指定できます?" ); 122 usableProparty.put( "footer", "出力ファイルに、フ?ー??を追記します?" + 123 CR + "添え?XX)が異なれ??のヘッ??が指定できます?" ); 124 usableProparty.put( "param_", "XSLパ?サーに対して、paramater を設定します?" + 125 CR + "キーが異なれ?、?のパラメータを指定できます?" + 126 CR + "? -param_SYSTEM_ID=GE" ); 127 usableProparty.put( "errAbend", "異常発生時に、??中断(true)するか?継?false)する? + 128 CR + "(初期値:true:中断する)" ); 129 usableProparty.put( "errXmlIn", "異常発生時に、?力ファイルに、XML形式でエラーを追記するかを指定す? + 130 CR + "(初期値:false:使用しな?" ); 131 usableProparty.put( "jspInclude","jsp:directive.include 発見時に、そのファイル?INCLUDE するかを?す? + 132 CR + "(初期値:true:使用する)" ); 133 usableProparty.put( "display", "結果を標準?力に表示する(true)かしな?false)? + 134 CR + "(初期値:false:表示しな?" ); 135 } 136 137 /** 138 * ?ォルトコンストラクター? 139 * こ?クラスは、動??されます??ォルトコンストラクターで? 140 * super クラスに対して、?な初期化を行っておきます? 141 * 142 */ 143 public Process_XSLT() { 144 super( "org.opengion.fukurou.process.Process_XSLT",mustProparty,usableProparty ); 145 } 146 147 /** 148 * プロセスの初期化を行います?初めに??、呼び出されます? 149 * 初期処?ファイルオープン??オープン?に使用します? 150 * 151 * @og.rev 4.2.3.0 (2008/05/26) jsp:directive.include 処??実施可否を引数?します? 152 * 153 * @param paramProcess ??タベ?スの接続???などを持って?オブジェク? 154 */ 155 public void init( final ParamProcess paramProcess ) { 156 Argument arg = getArgument(); 157 158 xslfile = arg.getProparty( "xslfile" ); 159 outfile = arg.getProparty( "outfile" ); 160 tableName = arg.getProparty( "addROWSET" ); 161 boolean isAppend = arg.getProparty( "append",false ); 162 boolean useFileInfo = arg.getProparty( "useFileInfo",false ); 163 HybsEntry[] paramEntry = arg.getEntrys( PARAM_KEY ); // 配? 164 HybsEntry[] headerEntry = arg.getEntrys( HEADER_KEY ); // 配? 165 footerEntry = arg.getEntrys( FOOTER_KEY ); // 配? 166 errAbend =arg.getProparty("errAbend",errAbend); 167 errXmlIn =arg.getProparty("errXmlIn",errXmlIn); 168 jspInclude =arg.getProparty("jspInclude",jspInclude); // 4.2.3.0 (2008/05/26) 169 display =arg.getProparty("display",display); 170 171 // File file = new File( outfile ); 172 if( outfile != null ) { 173 File file = new File( outfile ); // 5.5.2.6 (2012/05/25) findbugs対? 174 File dir = file.getParentFile() ; 175 176 // 親?レクトリを示さな??合? null 。ディレクトリが存在しな??かつ、ディレクトリが作?できな??合?処? 177 if( dir != null && ! dir.exists() && ! dir.mkdirs() ) { 178 String errMsg = "?レクトリが作?できませんでした?" + dir + "]" ; 179 throw new RuntimeException( errMsg ); 180 } 181 } 182 else { 183 // 出力?ファイル名が、指定されて???? 184 String errMsg = "outfile が指定されて?せん?; 185 throw new RuntimeException( errMsg ); 186 } 187 188 xslt = new XSLT(); 189 190 xslt.setOutFile( outfile,isAppend ); 191 xslt.setXslFile( xslfile ); 192 xslt.setParamEntry( paramEntry ); 193 xslt.useFileInfo( useFileInfo ); 194 xslt.errClose( errAbend ); // エラー時に出力ファイルを閉じるかど?? 195 xslt.useErrXmlIn( errXmlIn ); // エラー時にXML形式で出力ファイルに追記するかど?? 196 xslt.jspInclude( jspInclude ); // 4.2.3.0 (2008/05/26) jsp:directive.include するかど? 197 198 if( tableName != null ) { 199 xslt.setOutData( HEADER_XML ); 200 xslt.setOutData( HEADER_ROWSET.replace( "TABLENAME",tableName ) ); 201 } 202 203 int size = headerEntry.length; 204 for( int i=0; i<size; i++ ) { 205 xslt.setOutData( headerEntry[i].getValue() ); 206 } 207 } 208 209 /** 210 * 引数の LineModel を??るメソ?です? 211 * 変換処?? LineModel を返します? 212 * 後続??行わな?????タのフィルタリングを行う場?は? 213 * null ??タを返します?つまり?null ??タは、後続??行わな? 214 * フラグの代わりにも使用して?す? 215 * なお?変換処?? LineModel と、オリジナルの LineModel が? 216 * 同?、コピ?(クローン)か?、各処?ソ??決めて?す? 217 * ドキュメントに明記されて???合?、副作用が問題になる?合?? 218 * ???とに自?コピ?(クローン)して下さ?? 219 * 220 * @param data オリジナルのLineModel 221 * 222 * @return 処?換後?LineModel 223 */ 224 public LineModel action( final LineModel data ) { 225 inCount++ ; 226 if( display ) { println( data.dataLine() ); } 227 if( clmNo < 0 ) { clmNo = data.getColumnNo( FILE_KEY ); } 228 File file = (File)data.getValue( clmNo ); 229 230 if( ! file.isFile() ) { return data; } 231 232 String filePath = file.getPath(); 233 234 try { 235 xslt.transform( filePath ); 236 } 237 catch( RuntimeException ex ) { 238 errCount++ ; 239 if( errAbend ) { throw ex; } 240 else { 241 logging( ex.getMessage() ); 242 logging( "xslfile = " + xslfile ); 243 logging( "outfile = " + outfile ); 244 logging( "xmlFile = " + filePath ); 245 } 246 } 247 248 return data ; 249 } 250 251 /** 252 * プロセスの終?行います??に??、呼び出されます? 253 * 終???ファイルクローズ??クローズ?に使用します? 254 * 255 * @param isOK ト?タルで、OK?たかど?[true:成功/false:失敗] 256 */ 257 public void end( final boolean isOK ) { 258 if( xslt != null ) { 259 if( isOK ) { 260 int size = footerEntry.length; 261 for( int i=0; i<size; i++ ) { 262 xslt.setOutData( footerEntry[i].getValue() ); 263 } 264 if( tableName != null ) { 265 xslt.setOutData( FOOTER_ROWSET ); 266 } 267 } 268 xslt.close(); 269 } 270 } 271 272 /** 273 * プロセスの処?果のレポ?ト表現を返します? 274 * 処??ログラ?、?力件数、?力件数などの??です? 275 * こ???をそのまま、標準?力に出すことで、結果レポ?トと出来るよ? 276 * 形式で出してください? 277 * 278 * @return 処?果のレポ?? 279 */ 280 public String report() { 281 String report = "[" + getClass().getName() + "]" + CR 282 + TAB + "XSL File : " + xslfile + CR 283 + TAB + "OUT File : " + outfile + CR 284 + TAB + "Table Name : " + tableName + CR 285 + TAB + "File Count : " + inCount + CR 286 + TAB + "Err Count : " + errCount ; 287 288 return report ; 289 } 290 291 /** 292 * こ?クラスの使用方法を返します? 293 * 294 * @return こ?クラスの使用方? 295 */ 296 public String usage() { 297 StringBuilder buf = new StringBuilder(); 298 299 buf.append( "XSLT変換結果を指定?ファイルに出力します?" ).append( CR ); 300 buf.append( CR ); 301 buf.append( "Process_XSLT は、AbstractProcess を継承した、ChainProcess インターフェース" ).append( CR ); 302 buf.append( "の実?ラスです?" ).append( CR ); 303 buf.append( "上?プロセスチェインの??タは上流から渡されます?)からのLineModel の" ).append( CR ); 304 buf.append( "ファイルオブジェクトに対して、指定? XSL ファイルを適用して、XSL変換? ).append( CR ); 305 buf.append( "行います?出力結果は、ファイル、また? 標準?力に出力できます?" ).append( CR ); 306 buf.append( CR ); 307 buf.append( "上流?ロセスでは、Name 属?として、?File』を持ち、?は、Fileオブジェク? ).append( CR ); 308 buf.append( "である、Process_FileSearch を使用するのが?便利です?それ以外?クラス? ).append( CR ); 309 buf.append( "使用する場合でも?Name属?と、File オブジェクトを持つ LineModel を受け渡? ).append( CR ); 310 buf.append( "できれば、使用可能です?" ).append( CR ); 311 buf.append( CR ); 312 buf.append( "-param_XXXX=固定? を使用して、XSLTにパラメータを設定できます?" ).append( CR ); 313 buf.append( CR ); 314 buf.append( "それ以外では、org.opengion.fukurou.xml.XSLT で、?力ファイル??の設定が可能に" ).append( CR ); 315 buf.append( "なって?為、?部??を使用するかど? -useFileInfo を指定できます?" ).append( CR ); 316 buf.append( "-useFileInfo=true とセ?すると、以下???目が?部?セ?されます?" ).append( CR ); 317 buf.append( CR ); 318 buf.append( "入力ファイル(inXMLのフルパス) : FILEPATH (? G:/temp/DOC10/query.jsp)" ).append( CR ); 319 buf.append( "入力親フォル?inXMLの親フォル? : ADDRESS (? DOC10)" ).append( CR ); 320 buf.append( "入力ファイル(inXMLのファイル? : FILENAME (? query.jsp)" ).append( CR ); 321 buf.append( "入力ファイル(inXMLの更新日? ) : MODIFIED (? yyyyMMddHHmmss形?" ).append( CR ); 322 buf.append( CR ); 323 buf.append( "xsl ファイルでは、xsl:param で宣?、xsl:value-of で取り出します?" ).append( CR ); 324 buf.append( "<xsl:param name=\"ADDRESS\" select=\"\" /> と宣?ておき、?な?で" ).append( CR ); 325 buf.append( "<xsl:value-of select=\"$ADDRESS\" /> とすれば、取得できます?" ).append( CR ); 326 buf.append( CR ); 327 buf.append( "引数??中に空白を含??合?、ダブルコー??ション(\"\") で括って下さ??" ).append( CR ); 328 buf.append( "引数??の ?』?前後には、空白は挟めません。??key=value の様に" ).append( CR ); 329 buf.append( "繋げてください? ).append( CR ); 330 buf.append( CR ).append( CR ); 331 332 buf.append( getArgument().usage() ).append( CR ); 333 334 return buf.toString(); 335 } 336 337 /** 338 * こ?クラスは、main メソ?から実行できません? 339 * 340 * @param args コマンド引数配? 341 */ 342 public static void main( final String[] args ) { 343 LogWriter.log( new Process_XSLT().usage() ); 344 } 345 }