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