    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 *   &lt;ROWSET&gt;
    037 *       &lt;ROW num="1"&gt;
    038 *           &lt;ｶﾗﾑ1&gt;値1&lt;/ｶﾗﾑ1&gt;
    039 *             ･･･
    040 *           &lt;ｶﾗﾑn&gt;値n&lt;/ｶﾗﾑn&gt;
    041 *       &lt;/ROW&gt;
    042 *        ･･･
    043 *       &lt;ROW num="n"&gt;
    044 *          ･･･
    045 *       &lt;/ROW&gt;
    046 *   &lt;ROWSET&gt;
    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 *   &lt;ROWSET tablename="GEXX" &gt;
    061 *       &lt;EXEC_SQL&gt;                    最初に記載して、初期処理(ﾃﾞｰﾀｸﾘｱ等)を実行させる。
    062 *           delete from GEXX where YYYYY
    063 *       &lt;/EXEC_SQL&gt;
    064 *       &lt;MERGE_SQL&gt;                   このSQL文で UPDATEして、結果が0件ならINSERTを行います。
    065 *           update GEXX set AA=[AA] , BB=[BB] where CC=[CC]
    066 *       &lt;/MERGE_SQL&gt;
    067 *       &lt;ROW num="1"&gt;
    068 *           &lt;ｶﾗﾑ1&gt;値1&lt;/ｶﾗﾑ1&gt;
    069 *             ･･･
    070 *           &lt;ｶﾗﾑn&gt;値n&lt;/ｶﾗﾑn&gt;
    071 *       &lt;/ROW&gt;
    072 *        ･･･
    073 *       &lt;ROW num="n"&gt;
    074 *          ･･･
    075 *       &lt;/ROW&gt;
    076 *       &lt;EXEC_SQL&gt;                    最後に記載して、項目の設定(整合性登録)を行う。
    077 *           update GEXX set AA='XX' , BB='XX' where YYYYY
    078 *       &lt;/EXEC_SQL&gt;
    079 *   &lt;ROWSET&gt;
    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 = "6.4.2.0 (2016/01/29)" ;
    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         *
    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 のﾍｯﾀﾞｰは、&lt;?xml version='1.0' encoding='encode値'?&gt; になります。
    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         *
    160         * @param       table   DBTableModelｵﾌﾞｼﾞｪｸﾄ
    161         * @param       writer  PrintWriterｵﾌﾞｼﾞｪｸﾄ
    162         */
    163        @Override
    164        protected void writeData( final DBTableModel table,final PrintWriter writer ) {
    165                final int numberOfRows =  table.getRowCount();
    166                final boolean useRenderer = isUseRenderer();    // 5.2.1.0 (2010/10/01)
    167
    168                writer.print( "<ROWSET" );
    169                writer.print( tableName );
    170                writer.println( ">" );
    171
    172                // 4.0.0 (2005/01/31)
    173                writer.print( firstExecSql );                                           // 5.6.7.0 (2013/07/27) 改行処理の見直し
    174
    175                // 5.6.6.1 (2013/07/12) MERGE_SQL 対応
    176                writer.print( mergeSql );                                                       // 5.6.7.0 (2013/07/27) 改行処理の見直し
    177
    178                for( int row=0; row<numberOfRows; row++ ) {
    179                        writer.print( "<ROW num=\"" );
    180                        writer.print( row+1 );
    181                        writer.println( "\">" );
    182                        for( int i=0; i<numberOfColumns; i++ ) {
    183                                final int clm = clmNo[i];
    184                                if( clm < 0 ) { continue; }                                     // 6.0.1.2 (2014/08/08) ｶﾗﾑ飛ばし
    185
    186                                String val = table.getValue(row,clm);
    187                                if( dbType[i] == NVAR ) {
    188                                        val = StringUtil.getReplaceEscape( val );
    189                                }
    190                                // 5.2.1.0 (2010/10/01) useRenderer 対応
    191                                else if( useRenderer ) {
    192                                        // 6.0.4.0 (2014/11/28) ﾃﾞｰﾀ出力用のﾚﾝﾃﾞﾗｰ
    193                                        val = dbColumn[clm].getWriteValue( val );
    194                                }
    195
    196                                writer.print( "<" );
    197                                writer.print( table.getColumnName(clm) );
    198                                writer.print( ">" );
    199                                writer.print( StringUtil.htmlFilter( val ) );
    200                                writer.print( "</" );
    201                                writer.print( table.getColumnName(clm) );
    202                                writer.println( ">" );
    203                        }
    204                        writer.println( "</ROW>" );
    205                }
    206
    207                // 4.0.0 (2005/01/31)
    208                writer.print( lastExecSql );                                                                                    // 5.6.7.0 (2013/07/27) 改行処理の見直し
    209                writer.println( "</ROWSET>" );
    210        }
    211
    212        /**
    213         * ﾊﾟﾗﾒｰﾀｰﾘｽﾄをｾｯﾄします。
    214         * 内部は、HybsEntry ｸﾗｽを持っています。
    215         * 引数が、null の場合は、何もしません。
    216         *
    217         * @og.rev 4.0.0.0 (2005/01/31) 新規追加
    218         * @og.rev 5.6.6.1 (2013/07/12) MERGE_SQL 対応
    219         * @og.rev 5.6.6.1 (2013/07/12) keys の整合性ﾁｪｯｸを行います。
    220         *
    221         * @param       listParam       HybsEntryﾘｽﾄ
    222         */
    223        @Override
    224        public void setParam( final List<HybsEntry> listParam ) {
    225                if( listParam != null && ! listParam.isEmpty() ) {
    226                        final StringBuilder first = new StringBuilder( BUFFER_MIDDLE ) ;
    227                        final StringBuilder last  = new StringBuilder( BUFFER_MIDDLE ) ;
    228                        final StringBuilder merge = new StringBuilder( BUFFER_MIDDLE ) ;        // 5.6.6.1 (2013/07/12) MERGE_SQL 対応
    229
    230                        for( final HybsEntry entry : listParam ) {
    231                                final String key = entry.getKey() ;                                                             // 5.6.6.1 (2013/07/12) keys の整合性ﾁｪｯｸ
    232                                checkParam( key , KEYS_MAP );
    233
    234                                final String val = entry.getValue() ;                                                   // 5.6.6.1 (2013/07/12) val を先に取得
    235                                if( val != null && val.length() > 0 ) {
    236                                        // 処理を実施するﾃｰﾌﾞﾙ名を指定
    237                                        // 複数の key="TableName" があれば、最後のみが有効。
    238                                        if( "TableName".equalsIgnoreCase( key ) ) {
    239                                                tableName = " tableName=\"" + val + "\"" ;
    240                                        }
    241                                        // 最初に記載して、初期処理(ﾃﾞｰﾀｸﾘｱ等)を実行させる、EXEC_SQLを指定
    242                                        else if( "First".equalsIgnoreCase( key ) ) {
    243                                                first.append( "<EXEC_SQL>" )
    244                                                        .append( StringUtil.htmlFilter( val ) )
    245                                                        .append( "</EXEC_SQL>" )
    246                                                        .append( CR );
    247                                        }
    248                                        // 最後に記載して、項目の設定(整合性登録)を行う、EXEC_SQLを指定
    249                                        else if( "Last".equalsIgnoreCase( key ) ) {
    250                                                last.append( "<EXEC_SQL>" )
    251                                                        .append( StringUtil.htmlFilter( val ) )
    252                                                        .append( "</EXEC_SQL>" )
    253                                                        .append( CR );
    254                                        }
    255                                        // このSQL文で UPDATEして、結果が0件ならINSERTを行う、MERGE_SQLを指定
    256                                        else if( "MergeSql".equalsIgnoreCase( key ) ) {
    257                                                merge.append( "<MERGE_SQL>" )
    258                                                        .append( StringUtil.htmlFilter( val ) )
    259                                                        .append( "</MERGE_SQL>" )
    260                                                        .append( CR );
    261                                        }
    262                                }
    263                        }
    264                        firstExecSql = first.toString();
    265                        lastExecSql  = last.toString();
    266                        mergeSql     = merge.toString();                                                                        // 5.6.6.1 (2013/07/12) MERGE_SQL 対応
    267                }
    268        }
    269}