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.plugin.io; 017 018import java.io.PrintWriter; 019import java.util.List; 020import java.util.Map ; 021import java.util.LinkedHashMap ; 022 023import org.opengion.fukurou.util.HybsEntry; 024import org.opengion.fukurou.util.StringUtil; 025import org.opengion.hayabusa.db.DBTableModel; 026 027/** 028 * TableWriter をXML形式で出力する為の実装クラスです。 029 * DefaultTableWriter を継承していますので、ラベル,名前,データの出力部のみ 030 * オーバーライドして、XML形式ファイルの出力機能を実現しています。 031 * 032 * 出力のXML形式は、拡張オラクル XDK形式のXMLファイルです。 033 * オラクルXDK形式のXMLとは、下記のような ROWSET をトップとする ROW の 034 * 集まりで1レコードを表し、各ROWには、カラム名をキーとするXMLになっています。 035 * 036 * <ROWSET> 037 * <ROW num="1"> 038 * <カラム1>値1</カラム1> 039 * ・・・ 040 * <カラムn>値n</カラムn> 041 * </ROW> 042 * ・・・ 043 * <ROW num="n"> 044 * ・・・ 045 * </ROW> 046 * <ROWSET> 047 * 048 * この形式であれば、XDK(Oracle XML Developer's Kit)を利用すれば、非常に簡単に 049 * データベースとXMLファイルとの交換が可能です。 050 * <a href="https://docs.oracle.com/cd/F19136_01/adxdk/introduction-to-XDK.html" target="_blank" > 051 * XDK(Oracle XML Developer's Kit)</a> 052 * 053 * 拡張XDK形式とは、ROW 以外に、SQL処理用タグ(EXEC_SQL)を持つ XML ファイルです。 054 * これは、オラクルXDKで処理する場合、無視されますので、同様に扱うことが出来ます。 055 * この、EXEC_SQL は、それそれの XMLデータをデータベースに登録する際に、 056 * SQL処理を自動的に流す為の、SQL文を記載します。 057 * この処理は、イベント毎に実行される為、その配置順は重要です。 058 * このタグは、複数記述することも出来ますが、BODY部には、1つのSQL文のみ記述します。 059 * 060 * <ROWSET tablename="GEXX" > 061 * <EXEC_SQL> 最初に記載して、初期処理(データクリア等)を実行させる。 062 * delete from GEXX where YYYYY 063 * </EXEC_SQL> 064 * <MERGE_SQL> このSQL文で UPDATEして、結果が0件ならINSERTを行います。 065 * update GEXX set AA=[AA] , BB=[BB] where CC=[CC] 066 * </MERGE_SQL> 067 * <ROW num="1"> 068 * <カラム1>値1</カラム1> 069 * ・・・ 070 * <カラムn>値n</カラムn> 071 * </ROW> 072 * ・・・ 073 * <ROW num="n"> 074 * ・・・ 075 * </ROW> 076 * <EXEC_SQL> 最後に記載して、項目の設定(整合性登録)を行う。 077 * update GEXX set AA='XX' , BB='XX' where YYYYY 078 * </EXEC_SQL> 079 * <ROWSET> 080 * 081 * @og.group ファイル出力 082 * 083 * @version 4.0 084 * @author Kazuhiko Hasegawa 085 * @since JDK5.0, 086 */ 087public class TableWriter_XML extends TableWriter_Default { 088 /** このプログラムのVERSION文字列を設定します。 {@value} */ 089 private static final String VERSION = "8.5.2.0 (2023/07/14)" ; 090 091 // 5.6.6.1 (2013/07/12) keys の整合性チェックを行います。 092 /** staticイニシャライザ後、読み取り専用にするので、ConcurrentHashMap を使用しません。 */ 093 private static final Map<String,String> KEYS_MAP = new LinkedHashMap<>(); 094 static { 095 KEYS_MAP.put( "TABLENAME" , "処理を実施するテーブル名を指定" ); 096 KEYS_MAP.put( "FIRST" , "最初に記載して、初期処理(データクリア等)を実行させる、EXEC_SQLを指定" ); 097 KEYS_MAP.put( "LAST" , "最後に記載して、項目の設定(整合性登録)を行う、EXEC_SQLを指定" ); 098 KEYS_MAP.put( "MERGESQL" , "このSQL文で UPDATEして、結果が0件ならINSERTを行う、MERGE_SQLを指定" ); 099 } 100 101 private String tableName = "" ; // 4.0.0 (2005/01/31) 102 private String firstExecSql = "" ; // 4.0.0 (2005/01/31) 103 private String lastExecSql = "" ; // 4.0.0 (2005/01/31) 104 private String mergeSql = "" ; // 5.6.6.1 (2013/07/12) MERGE_SQL 対応 105 106 /** 107 * デフォルトコンストラクター 108 * 109 * @og.rev 6.4.2.0 (2016/01/29) PMD refactoring. Each class should declare at least one constructor. 110 */ 111 public TableWriter_XML() { super(); } // これも、自動的に呼ばれるが、空のメソッドを作成すると警告されるので、明示的にしておきます。 112 113 /** 114 * DBTableModel から データを作成して、PrintWriter に書き出します。 115 * 116 * @og.rev 3.1.1.0 (2003/03/28) 同期メソッド(synchronized付き)を非同期に変更する。 117 * @og.rev 3.5.4.3 (2004/01/05) 引数に PrintWriter を受け取るように変更します。 118 * 119 * @param writer PrintWriterオブジェクト 120 */ 121 @Override 122 public void writeDBTable( final PrintWriter writer ) { 123 super.setHeaderSequence( "D" ); 124 super.writeDBTable( writer ); 125 } 126 127 /** 128 * PrintWriter に DBTableModelのヘッダー情報を書き込みます。 129 * XML のヘッダーは、<?xml version='1.0' encoding='encode値'?> になります。 130 * encoding属性には、encode値をセットします。 131 * encoding属性に設定できる値は、"UTF-8","UTF-16","Shift_JIS" です。 132 * 133 * @og.rev 3.1.1.0 (2003/03/28) 同期メソッド(synchronized付き)を非同期に変更する。 134 * @og.rev 4.0.0.0 (2005/01/31) XML宣言部のencoding属性を、encode値をセットする。 135 * 136 * @param writer PrintWriterオブジェクト 137 */ 138 @Override 139 protected void writeHeader( final PrintWriter writer ) { 140 final String encoding = getEncode(); 141 writer.println( "<?xml version='1.0' encoding='" + encoding + "'?>" ) ; 142 } 143 144 /** 145 * PrintWriter に DBTableModelのテーブル情報を書き込みます。 146 * 147 * 出力のXML形式は、ORACLE XDK での出力ファイルと同じ形式ですので、直接データベースに 148 * 登録することができます。 149 * 150 * @og.rev 3.1.1.0 (2003/03/28) 同期メソッド(synchronized付き)を非同期に変更する。 151 * @og.rev 3.8.0.1 (2005/06/17) DBTypeが NVAR の場合は、元のUnicodeに戻します。 152 * @og.rev 4.0.0.0 (2005/01/31) EXEC_SQL タグ機能の追加 153 * @og.rev 5.1.6.0 (2010/05/01) DbType の初期値(dbType)を利用する。 154 * @og.rev 5.2.1.0 (2010/10/01) useRenderer 対応 155 * @og.rev 5.6.6.1 (2013/07/12) MERGE_SQL 対応 156 * @og.rev 5.6.7.0 (2013/07/27) 改行処理の見直し 157 * @og.rev 6.0.1.2 (2014/08/08) カラム飛ばしできる機能を追加 158 * @og.rev 6.0.4.0 (2014/11/28) データ出力用のレンデラー 159 * @og.rev 8.5.2.0 (2023/07/14) 一部の機能廃止による修正(問合・トラブル 0200010980) 160 * 161 * @param table DBTableModelオブジェクト 162 * @param writer PrintWriterオブジェクト 163 */ 164 @Override 165 protected void writeData( final DBTableModel table,final PrintWriter writer ) { 166 final int numberOfRows = table.getRowCount(); 167 final boolean useRenderer = isUseRenderer(); // 5.2.1.0 (2010/10/01) 168 169 writer.print( "<ROWSET" ); 170 writer.print( tableName ); 171 writer.println( ">" ); 172 173 // 4.0.0 (2005/01/31) 174 writer.print( firstExecSql ); // 5.6.7.0 (2013/07/27) 改行処理の見直し 175 176 // 5.6.6.1 (2013/07/12) MERGE_SQL 対応 177 writer.print( mergeSql ); // 5.6.7.0 (2013/07/27) 改行処理の見直し 178 179 for( int row=0; row<numberOfRows; row++ ) { 180 writer.print( "<ROW num=\"" ); 181 writer.print( row+1 ); 182 writer.println( "\">" ); 183 for( int i=0; i<numberOfColumns; i++ ) { 184 final int clm = clmNo[i]; 185 if( clm < 0 ) { continue; } // 6.0.1.2 (2014/08/08) カラム飛ばし 186 187 String val = table.getValue(row,clm); 188// if( dbType[i] == NVAR ) { // 8.5.2.0 (2023/07/14) Delete 189// val = StringUtil.getReplaceEscape( val ); // 8.5.2.0 (2023/07/14) Delete 190// } // 8.5.2.0 (2023/07/14) Delete 191 // 5.2.1.0 (2010/10/01) useRenderer 対応 192// else if( useRenderer ) { // 8.5.2.0 (2023/07/14) Modify 193 if( useRenderer ) { 194 // 6.0.4.0 (2014/11/28) データ出力用のレンデラー 195 val = dbColumn[clm].getWriteValue( val ); 196 } 197 198 writer.print( "<" ); 199 writer.print( table.getColumnName(clm) ); 200 writer.print( ">" ); 201 writer.print( StringUtil.htmlFilter( val ) ); 202 writer.print( "</" ); 203 writer.print( table.getColumnName(clm) ); 204 writer.println( ">" ); 205 } 206 writer.println( "</ROW>" ); 207 } 208 209 // 4.0.0 (2005/01/31) 210 writer.print( lastExecSql ); // 5.6.7.0 (2013/07/27) 改行処理の見直し 211 writer.println( "</ROWSET>" ); 212 } 213 214 /** 215 * パラメーターリストをセットします。 216 * 内部は、HybsEntry クラスを持っています。 217 * 引数が、null の場合は、何もしません。 218 * 219 * @og.rev 4.0.0.0 (2005/01/31) 新規追加 220 * @og.rev 5.6.6.1 (2013/07/12) MERGE_SQL 対応 221 * @og.rev 5.6.6.1 (2013/07/12) keys の整合性チェックを行います。 222 * 223 * @param listParam HybsEntryリスト 224 */ 225 @Override 226 public void setParam( final List<HybsEntry> listParam ) { 227 if( listParam != null && ! listParam.isEmpty() ) { 228 final StringBuilder first = new StringBuilder( BUFFER_MIDDLE ) ; 229 final StringBuilder last = new StringBuilder( BUFFER_MIDDLE ) ; 230 final StringBuilder merge = new StringBuilder( BUFFER_MIDDLE ) ; // 5.6.6.1 (2013/07/12) MERGE_SQL 対応 231 232 for( final HybsEntry entry : listParam ) { 233 final String key = entry.getKey() ; // 5.6.6.1 (2013/07/12) keys の整合性チェック 234 checkParam( key , KEYS_MAP ); 235 236 final String val = entry.getValue() ; // 5.6.6.1 (2013/07/12) val を先に取得 237 if( val != null && val.length() > 0 ) { 238 // 処理を実施するテーブル名を指定 239 // 複数の key="TableName" があれば、最後のみが有効。 240 if( "TableName".equalsIgnoreCase( key ) ) { 241 tableName = " tableName=\"" + val + "\"" ; 242 } 243 // 最初に記載して、初期処理(データクリア等)を実行させる、EXEC_SQLを指定 244 else if( "First".equalsIgnoreCase( key ) ) { 245 first.append( "<EXEC_SQL>" ) 246 .append( StringUtil.htmlFilter( val ) ) 247 .append( "</EXEC_SQL>" ) 248 .append( CR ); 249 } 250 // 最後に記載して、項目の設定(整合性登録)を行う、EXEC_SQLを指定 251 else if( "Last".equalsIgnoreCase( key ) ) { 252 last.append( "<EXEC_SQL>" ) 253 .append( StringUtil.htmlFilter( val ) ) 254 .append( "</EXEC_SQL>" ) 255 .append( CR ); 256 } 257 // このSQL文で UPDATEして、結果が0件ならINSERTを行う、MERGE_SQLを指定 258 else if( "MergeSql".equalsIgnoreCase( key ) ) { 259 merge.append( "<MERGE_SQL>" ) 260 .append( StringUtil.htmlFilter( val ) ) 261 .append( "</MERGE_SQL>" ) 262 .append( CR ); 263 } 264 } 265 } 266 firstExecSql = first.toString(); 267 lastExecSql = last.toString(); 268 mergeSql = merge.toString(); // 5.6.6.1 (2013/07/12) MERGE_SQL 対応 269 } 270 } 271}