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.4.2 (2024/01/12)" ; 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して、結果が０件なら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 * @og.rev 8.5.4.2 (2024/01/12) writeHeader(PrintWriter) は、XML のみなので、一般から削除 119 * 120 * @param writer PrintWriterｵﾌﾞｼﾞｪｸﾄ 121 */ 122 @Override 123 public void writeDBTable( final PrintWriter writer ) { 124 if( ! createDBColumn() ) { return ; } // super.writeDBTable( PrintWriter ) 内でも判定しているが… 125 126 final String encoding = getEncode(); 127 writer.println( "<?xml version='1.0' encoding='" + encoding + "'?>" ) ; 128 129 super.setHeaderSequence( "D" ); 130 super.writeDBTable( writer ); 131 } 132 133// /** 134// * PrintWriter に DBTableModelのﾍｯﾀﾞｰ情報を書き込みます。 135// * XML のﾍｯﾀﾞｰは、<?xml version='1.0' encoding='encode値'?> になります。 136// * encoding属性には、encode値をｾｯﾄします。 137// * encoding属性に設定できる値は、"UTF-8","UTF-16","Shift_JIS" です。 138// * 139// * @og.rev 3.1.1.0 (2003/03/28) 同期ﾒｿｯﾄﾞ(synchronized付き)を非同期に変更する。 140// * @og.rev 4.0.0.0 (2005/01/31) XML宣言部のencoding属性を、encode値をｾｯﾄする。 141// * @og.rev 8.5.4.2 (2024/01/12) writeHeader(PrintWriter) は、XML のみなので、一般から削除 142// * 143// * @param writer PrintWriterｵﾌﾞｼﾞｪｸﾄ 144// */ 145// @Override 146// protected void writeHeader( final PrintWriter writer ) { 147// final String encoding = getEncode(); 148// writer.println( "<?xml version='1.0' encoding='" + encoding + "'?>" ) ; 149// } 150 151 /** 152 * PrintWriter に DBTableModelのﾃｰﾌﾞﾙ情報を書き込みます。 153 * 154 * 出力のXML形式は、ORACLE XDK での出力ﾌｧｲﾙと同じ形式ですので、直接ﾃﾞｰﾀﾍﾞｰｽに 155 * 登録することができます。 156 * 157 * @og.rev 3.1.1.0 (2003/03/28) 同期ﾒｿｯﾄﾞ(synchronized付き)を非同期に変更する。 158 * @og.rev 3.8.0.1 (2005/06/17) DBTypeが NVAR の場合は、元のUnicodeに戻します。 159 * @og.rev 4.0.0.0 (2005/01/31) EXEC_SQL ﾀｸﾞ機能の追加 160 * @og.rev 5.1.6.0 (2010/05/01) DbType の初期値(dbType)を利用する。 161 * @og.rev 5.2.1.0 (2010/10/01) useRenderer 対応 162 * @og.rev 5.6.6.1 (2013/07/12) MERGE_SQL 対応 163 * @og.rev 5.6.7.0 (2013/07/27) 改行処理の見直し 164 * @og.rev 6.0.1.2 (2014/08/08) ｶﾗﾑ飛ばしできる機能を追加 165 * @og.rev 6.0.4.0 (2014/11/28) ﾃﾞｰﾀ出力用のﾚﾝﾃﾞﾗｰ 166 * @og.rev 8.5.2.0 (2023/07/14) 一部の機能廃止による修正(問合・ﾄﾗﾌﾞﾙ 0200010980) 167 * 168 * @param table DBTableModelｵﾌﾞｼﾞｪｸﾄ 169 * @param writer PrintWriterｵﾌﾞｼﾞｪｸﾄ 170 */ 171 @Override 172 protected void writeData( final DBTableModel table,final PrintWriter writer ) { 173 final int numberOfRows = table.getRowCount(); 174 final boolean useRenderer = isUseRenderer(); // 5.2.1.0 (2010/10/01) 175 176 writer.print( "<ROWSET" ); 177 writer.print( tableName ); 178 writer.println( ">" ); 179 180 // 4.0.0 (2005/01/31) 181 writer.print( firstExecSql ); // 5.6.7.0 (2013/07/27) 改行処理の見直し 182 183 // 5.6.6.1 (2013/07/12) MERGE_SQL 対応 184 writer.print( mergeSql ); // 5.6.7.0 (2013/07/27) 改行処理の見直し 185 186 for( int row=0; row<numberOfRows; row++ ) { 187 writer.print( "<ROW num=\"" ); 188 writer.print( row+1 ); 189 writer.println( "\">" ); 190 for( int i=0; i<numberOfColumns; i++ ) { 191 final int clm = clmNo[i]; 192 if( clm < 0 ) { continue; } // 6.0.1.2 (2014/08/08) ｶﾗﾑ飛ばし 193 194 String val = table.getValue(row,clm); 195// if( dbType[i] == NVAR ) { // 8.5.2.0 (2023/07/14) Delete 196// val = StringUtil.getReplaceEscape( val ); // 8.5.2.0 (2023/07/14) Delete 197// } // 8.5.2.0 (2023/07/14) Delete 198 // 5.2.1.0 (2010/10/01) useRenderer 対応 199// else if( useRenderer ) { // 8.5.2.0 (2023/07/14) Modify 200 if( useRenderer ) { 201 // 6.0.4.0 (2014/11/28) ﾃﾞｰﾀ出力用のﾚﾝﾃﾞﾗｰ 202 val = dbColumn[clm].getWriteValue( val ); 203 } 204 205 writer.print( "<" ); 206 writer.print( table.getColumnName(clm) ); 207 writer.print( ">" ); 208 writer.print( StringUtil.htmlFilter( val ) ); 209 writer.print( "</" ); 210 writer.print( table.getColumnName(clm) ); 211 writer.println( ">" ); 212 } 213 writer.println( "</ROW>" ); 214 } 215 216 // 4.0.0 (2005/01/31) 217 writer.print( lastExecSql ); // 5.6.7.0 (2013/07/27) 改行処理の見直し 218 writer.println( "</ROWSET>" ); 219 } 220 221 /** 222 * ﾊﾟﾗﾒｰﾀｰﾘｽﾄをｾｯﾄします。 223 * 内部は、HybsEntry ｸﾗｽを持っています。 224 * 引数が、null の場合は、何もしません。 225 * 226 * @og.rev 4.0.0.0 (2005/01/31) 新規追加 227 * @og.rev 5.6.6.1 (2013/07/12) MERGE_SQL 対応 228 * @og.rev 5.6.6.1 (2013/07/12) keys の整合性ﾁｪｯｸを行います。 229 * 230 * @param listParam HybsEntryﾘｽﾄ 231 */ 232 @Override 233 public void setParam( final List<HybsEntry> listParam ) { 234 if( listParam != null && ! listParam.isEmpty() ) { 235 final StringBuilder first = new StringBuilder( BUFFER_MIDDLE ) ; 236 final StringBuilder last = new StringBuilder( BUFFER_MIDDLE ) ; 237 final StringBuilder merge = new StringBuilder( BUFFER_MIDDLE ) ; // 5.6.6.1 (2013/07/12) MERGE_SQL 対応 238 239 for( final HybsEntry entry : listParam ) { 240 final String key = entry.getKey() ; // 5.6.6.1 (2013/07/12) keys の整合性ﾁｪｯｸ 241 checkParam( key , KEYS_MAP ); 242 243 final String val = entry.getValue() ; // 5.6.6.1 (2013/07/12) val を先に取得 244 if( val != null && val.length() > 0 ) { 245 // 処理を実施するﾃｰﾌﾞﾙ名を指定 246 // 複数の key="TableName" があれば、最後のみが有効。 247 if( "TableName".equalsIgnoreCase( key ) ) { 248 tableName = " tableName=\"" + val + "\"" ; 249 } 250 // 最初に記載して、初期処理(ﾃﾞｰﾀｸﾘｱ等)を実行させる、EXEC_SQLを指定 251 else if( "First".equalsIgnoreCase( key ) ) { 252 first.append( "<EXEC_SQL>" ) 253 .append( StringUtil.htmlFilter( val ) ) 254 .append( "</EXEC_SQL>" ) 255 .append( CR ); 256 } 257 // 最後に記載して、項目の設定(整合性登録)を行う、EXEC_SQLを指定 258 else if( "Last".equalsIgnoreCase( key ) ) { 259 last.append( "<EXEC_SQL>" ) 260 .append( StringUtil.htmlFilter( val ) ) 261 .append( "</EXEC_SQL>" ) 262 .append( CR ); 263 } 264 // このSQL文で UPDATEして、結果が0件ならINSERTを行う、MERGE_SQLを指定 265 else if( "MergeSql".equalsIgnoreCase( key ) ) { 266 merge.append( "<MERGE_SQL>" ) 267 .append( StringUtil.htmlFilter( val ) ) 268 .append( "</MERGE_SQL>" ) 269 .append( CR ); 270 } 271 } 272 } 273 firstExecSql = first.toString(); 274 lastExecSql = last.toString(); 275 mergeSql = merge.toString(); // 5.6.6.1 (2013/07/12) MERGE_SQL 対応 276 } 277 } 278}