    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.hayabusa.db;
    017
    018import org.opengion.fukurou.system.HybsConst ;                                          // 6.1.0.0 (2014/12/26)
    019import org.opengion.fukurou.util.ErrorMessage;
    020import org.opengion.fukurou.db.Transaction;
    021import org.opengion.hayabusa.common.HybsSystemException;
    022import org.opengion.hayabusa.resource.ResourceManager;
    023import org.opengion.hayabusa.html.ViewMarker;                                           // 8.0.0.0 (2021/09/30)
    024
    025import java.util.Locale;
    026import java.util.Map;
    027import java.util.LinkedHashMap ;
    028import java.util.concurrent.ConcurrentMap;                                                      // 6.4.3.3 (2016/03/04)
    029import java.util.concurrent.ConcurrentHashMap;                                          // 6.4.3.1 (2016/02/12) refactoring
    030import java.util.Collections;                                                                           // 6.4.3.1 (2016/02/12) refactoring
    031
    032/**
    033 * AbstractTableFilter は、TableUpda インターフェースを継承した、DBTableModel 処理用の
    034 * Abstract実装クラスです。
    035 *
    036 * @og.rev 5.5.2.6 (2012/05/25) protected変数をprivateに変更。インターフェースにメソッド追加
    037 * @og.rev 6.4.1.1 (2016/01/16) keysMap を、サブクラスから設定させるように変更。
    038 *
    039 * @version  0.9.0  2000/10/17
    040 * @author   Kazuhiko Hasegawa
    041 * @since    JDK1.1,
    042 */
    043public abstract class AbstractTableFilter implements TableFilter {
    044        /** システムの改行コードを設定します。*/
    045        protected static final String CR                 = HybsConst.CR;                        // 6.1.0.0 (2014/12/26) refactoring
    046        /** StringBilderなどの初期値を設定します。   {@value} */
    047        protected static final int BUFFER_MIDDLE = HybsConst.BUFFER_MIDDLE;     // 6.1.0.0 (2014/12/26) refactoring
    048
    049        // 5.5.2.6 (2012/05/25) protected変数をprivateに変更。インターフェースにメソッド追加
    050        private DBTableModel    table           ;
    051        private String                  modifyType      ;
    052        private int[]                   rowNo           ;
    053        private boolean                 useDebug        ;               // 6.0.2.5 (2014/10/31) refactoring メソッドと同じなので名称変更
    054        private Transaction             tran            ;               // 5.1.9.0 (2010/08/01) 追加
    055        private String                  sql                     ;               // 4.2.4.0 (2008/06/23)
    056        private String                  dbid            ;               // 4.2.4.0 (2008/06/23)
    057        private ResourceManager resource        ;               // 4.3.7.4 (2009/07/01)
    058        private ViewMarker              viewMarker      ;               // 8.0.0.0 (2021/09/30)
    059
    060        private int                     errCode         = ErrorMessage.OK;
    061        private ErrorMessage    errMessage      ;
    062
    063        /** 6.4.3.1 (2016/02/12) PMD refactoring. HashMap → ConcurrentHashMap に置き換え。  */
    064        private final ConcurrentMap<String,String> keyValMap = new ConcurrentHashMap<>();
    065
    066        /** 7.4.0.1 (2021/04/16) 値を返すための変数  */
    067        private final ConcurrentMap<String,String> rtnValMap = new ConcurrentHashMap<>();
    068
    069        // 5.6.6.0 (2013/07/05) keys の整合性チェックを行います。
    070        // 6.4.1.1 (2016/01/16) keysMap を、サブクラスから設定させるように変更
    071        /** 6.4.3.1 (2016/02/12) Collections.synchronizedMap で同期処理を行います。  */
    072        private final Map<String,String> keysMap = Collections.synchronizedMap( new LinkedHashMap<>() ) ;
    073
    074        // 6.0.2.3 (2014/10/10) plugin.table.TableFilter_XXXX から移動
    075        /** 各種定数  */
    076        protected static final String XML_START_TAG     = "<?xml version='1.0' encoding='UTF-8'?>" + CR + "<ROWSET tableName='xxx'>";
    077        /** 各種定数 {@value} */
    078        protected static final String XML_END_TAG       = "</ROWSET>";
    079        /** 各種定数 {@value} */
    080        protected static final String EXEC_START_TAG= "<EXEC_SQL>";
    081        /** 各種定数 {@value} */
    082        protected static final String EXEC_END_TAG      = "</EXEC_SQL>";
    083
    084        // 6.0.2.3 (2014/10/10) isXml で、CR + EXEC_END_TAG のキャッシュを作成します。
    085        /** XML形式かどうか  */
    086        protected boolean       isXml           ;               // 6.0.2.3 (2014/10/10)
    087        /** 終了タグ */
    088        protected String        execEndTag      ;               // 6.0.2.3 (2014/10/10)
    089
    090        /**
    091         * デフォルトコンストラクター
    092         *
    093         * @og.rev 6.4.2.0 (2016/01/29) PMD refactoring. Each class should declare at least one constructor.
    094         */
    095        protected AbstractTableFilter() { super(); }            // これも、自動的に呼ばれるが、空のメソッドを作成すると警告されるので、明示的にしておきます。
    096
    097        /**
    098         * keys の整合性チェックを行うための初期設定を行います。
    099         * サブクラスのコンストラクタ内で、設定するようにしてください。
    100         *
    101         * @og.rev 6.4.1.1 (2016/01/16) keys の整合性チェック対応
    102         * @og.rev 6.4.3.1 (2016/02/12) ConcurrentMap 系は、key,val ともに not null 制限です。
    103         *
    104         * @param       key  整合性チェックを行うための keysMap に設定するキー
    105         * @param       cmnt 整合性チェックを行うための キー の説明
    106         */
    107        protected void initSet( final String key , final String cmnt ) {
    108                if( key != null && cmnt != null ) {
    109                        keysMap.put( key , cmnt );
    110                }
    111        }
    112
    113        /**
    114         * DBTableModel をセットします。
    115         *
    116         * @param       table DBTableModelオブジェクト
    117         */
    118        public void setDBTableModel( final DBTableModel table ) {
    119                this.table = table;
    120        }
    121
    122        /**
    123         * DBTableModel を取得します。
    124         *
    125         * @og.rev 5.5.2.6 (2012/05/25) インターフェースにgetterメソッド追加
    126         *
    127         * @return      内部のDBTableModel
    128         */
    129        public DBTableModel getDBTableModel() {
    130                return table;
    131        }
    132
    133        /**
    134         * データ処理の方法(A:追加 C:更新 D:削除)を指定します。
    135         *
    136         * 通常は、DBTableModel に自動設定されている modifyType を元に、データ処理方法を
    137         * 選別します。(A:追加 C:更新 D:削除)
    138         * この場合、行単位で modifyType の値を取得して判別する必要がありますが、一般には
    139         * 処理対象は、全件おなじ modifyType である可能性が高いです。
    140         * また、selectedAll などで強制的に全件処理対象とする場合は、modifyType に値が
    141         * 設定さていません。その様な場合に外部より modifyType を指定します。
    142         * 初期値は、自動判定 です。
    143         *
    144         * @og.rev 5.5.2.6 (2012/05/25) 廃止
    145         *
    146         * @param  type データ処理の方法(A:追加 C:更新 D:削除)
    147         */
    148        public void setModifyType( final String type ) {
    149                modifyType = type;
    150        }
    151
    152        /**
    153         * データ処理の方法(A:追加 C:更新 D:削除)を取得します。
    154         *
    155         * 初期値は、自動判定 です。
    156         *
    157         * @og.rev 5.5.2.6 (2012/05/25) インターフェースにgetterメソッド追加
    158         *
    159         * @return  データ処理の方法(A:追加 C:更新 D:削除)
    160         */
    161        public String getModifyType() {
    162                return modifyType ;
    163        }
    164
    165        /**
    166         * キーと値のペアの変数配列を受け取ります。
    167         *
    168         * ここでは、この方式以外に、パラメーターMapを受け取る方法もあります。
    169         * この受け取る時に、キーを大文字化します。TableFilter の keys は、
    170         * 大文字のみで定義しておくことで、HTMLやWindows世代の曖昧な表記方法に
    171         * 対応しています。(unixやxmlのような厳格な方が好きですけど)
    172         *
    173         * keys,vals とパラメーターMapを同時に指定した場合は、両方とも有効です。
    174         * ただし、キーが重複した場合は、不定と考えてください。
    175         *
    176         * @og.rev 5.6.6.0 (2013/07/05) keys の整合性チェックを行います。
    177         *
    178         * @param   keys キー配列
    179         * @param   vals 値配列
    180         * @see         #setParamMap( ConcurrentMap )
    181         */
    182        public void setKeysVals( final String[] keys,final String[] vals ) {
    183                if( keys != null && vals != null ) {
    184                        for( int i=0; i<keys.length; i++ ) {
    185                                // 5.6.6.0 (2013/07/05) 共通のセッターメソッド経由で登録します。
    186                                setKeyVal( keys[i],vals[i] );
    187                        }
    188                }
    189        }
    190
    191        /**
    192         * キーと値のペアを受け取り、内部の keyValMap マップに追加します。
    193         *
    194         * キーか値のどちらかが null の場合は、何もしません。つまり、val に
    195         * null をセットすることはできません。
    196         *
    197         * このメソッドは、setKeysVals( String[] ,String[] ) メソッドと、
    198         * setParamMap( Map<String,String> ) メソッドの両方から、使用します。
    199         * 処理を行うに当たり、下記の処理を行います。
    200         * １．キーを大文字化します。
    201         * ２．各クラスの keys と整合性チェックを行います。
    202         *
    203         * ただし、setKeysVals と setParamMap の登録順は、不定と考えてください。
    204         * 両方に同じキーを指定すると、どちらの値がセットされたかは、不定です。
    205         *
    206         * @og.rev 5.6.6.0 (2013/07/05) keys の整合性チェックを行います。
    207         * @og.rev 6.4.3.4 (2016/03/12) Map#forEach で対応する。
    208         * @og.rev 6.7.9.1 (2017/05/19) keysMap が、空の場合も、keyValMap に登録する。(initSet 未登録時)
    209         * @og.rev 7.0.1.0 (2018/10/15) XHTML → HTML5 対応(空要素の、"／＞" 止めを、"＞" に変更します)。
    210         * @og.rev 8.0.0.0 (2021/09/30) brタグを止めてを、preタグに変更します。
    211         *
    212         * @param   key キー文字列(null の場合は、処理しない)
    213         * @param   val 値文字列(null の場合は、処理しない)
    214         * @see         #setKeysVals( String[] ,String[] )
    215         * @see         #setParamMap( ConcurrentMap )
    216         */
    217        private void setKeyVal( final String key,final String val ) {
    218                // key か val かどちらかが null の場合は、処理を行わない。
    219                if( key == null || val == null ) { return; }
    220
    221                final String upKey = key.toUpperCase(Locale.JAPAN);
    222
    223                // 6.7.9.1 (2017/05/19) keysMap が、空の場合も、keyValMap に登録する。(initSet 未登録時)
    224                if(  keysMap.isEmpty() || keysMap.containsKey( upKey ) ) {              // keysMap は、各サブクラスで定義
    225                        keyValMap.put( upKey,val );
    226                }
    227                else {
    228//                      final String BR = "<br />" + CR ;
    229//                      final String BR = "<br>" + CR ;                         // 7.0.1.0 (2018/10/15)
    230                        final String BR = CR ;                                          // 8.0.0.0 (2021/09/30)
    231                        final StringBuilder errMsg = new StringBuilder( BUFFER_MIDDLE );
    232                        // 6.0.2.5 (2014/10/31) char を append する。
    233//                      errMsg.append( BR )
    234                        errMsg.append( "<pre>" ).append( BR )
    235                                  .append( "指定のキーは、この tableFilter では、使用できません。" ).append( BR )
    236                                  .append( "  class=[" ).append( getClass().getName() ).append( ']' ).append( BR )
    237                                  .append( "  key  =[" ).append( key                              ).append( ']' ).append( BR )
    238                                  .append( "  ======== usage keys ======== " ).append( BR ) ;
    239                        // 6.4.3.4 (2016/03/12) Map#forEach で対応する。
    240                        keysMap.forEach( (k,v) -> { errMsg.append( ' ' ).append( k ).append( ':' ).append( v ).append( BR ); } );
    241                        errMsg.append( "  ============================ " ).append( BR ).append( "</pre>" );
    242
    243                        throw new HybsSystemException( errMsg.toString() );
    244                }
    245        }
    246
    247        /**
    248         * 選択された行番号の配列をセットします。
    249         *
    250         * 表示データの HybsSystem.ROW_SELECTED_KEY を元に、選ばれた 行を
    251         * 処理の対象とします。
    252         *
    253         * @param   rowNoTmp 行番号配列(可変長引数)
    254         */
    255        public void setParameterRows( final int... rowNoTmp ) {
    256                if( rowNoTmp != null && rowNoTmp.length > 0 ) {         // 6.1.1.0 (2015/01/17) 可変長引数でもnullは来る。
    257                        final int size = rowNoTmp.length ;
    258                        rowNo = new int[size];
    259                        System.arraycopy( rowNoTmp,0,rowNo,0,size );
    260                }
    261        }
    262
    263        /**
    264         * 選択された行番号の配列を取得します。
    265         *
    266         * 表示データの HybsSystem.ROW_SEL_KEY を元に、選ばれた 行を
    267         * 処理の対象とします。
    268         *
    269         * @og.rev 5.5.2.6 (2012/05/25) インターフェースにgetterメソッド追加
    270         * @og.rev 6.0.2.5 (2014/10/31) null ではなく、サイズ０の配列を返すように変更。
    271         *
    272         * @return   行番号の配列(選ばれていない場合は、サイズ０の配列を返す)
    273         * @og.rtnNotNull
    274         */
    275        public int[] getParameterRows() {
    276                // 6.4.1.1 (2016/01/16) PMD refactoring. Avoid if (x != y) ..; else ..;
    277                return rowNo == null ? new int[0] : rowNo.clone() ;
    278        }
    279
    280        /**
    281         * アクセスログ取得の為,Transactionオブジェクトを設定します。
    282         *
    283         * @og.rev 5.1.9.0 (2010/08/01) Transaction 対応(新規追加)
    284         *
    285         * @param   tran Transactionオブジェクト
    286         */
    287        public void setTransaction( final Transaction tran ) {
    288                this.tran = tran;
    289        }
    290
    291        /**
    292         * アクセスログ取得の為,Transactionオブジェクトを取得します。
    293         *
    294         * @og.rev 5.1.9.0 (2010/08/01) Transaction 対応(新規追加)
    295         * @og.rev 5.5.2.6 (2012/05/25) インターフェースにgetterメソッド追加
    296         *
    297         * @return   Transactionオブジェクト
    298         */
    299        public Transaction getTransaction() {
    300                return tran;
    301        }
    302
    303        /**
    304         * DBIDを指定します。
    305         *
    306         * @og.rev 4.2.4.0 (2008/06/23) 新規追加
    307         *
    308         * @param dbid 接続先ID
    309         */
    310        public void setDbid( final String dbid ) {
    311                this.dbid = dbid;
    312        }
    313
    314        /**
    315         * DBIDを取得します。
    316         *
    317         * @og.rev 4.2.4.0 (2008/06/23) 新規追加
    318         * @og.rev 5.5.2.6 (2012/05/25) インターフェースにgetterメソッド追加
    319         *
    320         * @return DBID(接続先情報)
    321         */
    322        public String getDbid() {
    323                return dbid;
    324        }
    325
    326        /**
    327         * ボディー部分のSQLを指定します。
    328         *
    329         * @og.rev 4.2.4.0 (2008/06/23) 新規追加
    330         *
    331         * @param sql ボディー部分のSQL
    332         */
    333        public void setSql( final String sql ) {
    334                this.sql = sql;
    335        }
    336
    337        /**
    338         * ボディー部分のSQLを取得します。
    339         *
    340         * @og.rev 4.2.4.0 (2008/06/23) 新規追加
    341         * @og.rev 5.5.2.6 (2012/05/25) インターフェースにgetterメソッド追加
    342         *
    343         * @return ボディー部分のSQL
    344         */
    345        public String getSql() {
    346                return sql;
    347        }
    348
    349        /**
    350         * パラメーターMapを指定します。
    351         *
    352         * keys,vals と パラメーターMapを同時に指定した場合は、両方とも有効です。
    353         * ただし、キーが重複した場合は、不定と考えてください。
    354         *
    355         * この受け取る時に、キーを大文字化します。TableFilter の keys は、
    356         * 大文字のみで定義しておくことで、HTMLやWindows世代の曖昧な表記方法に
    357         * 対応しています。(unixやxmlのような厳格な方が好きですけど)
    358         *
    359         * @og.rev 5.6.5.2 (2013/06/21) 新規追加
    360         * @og.rev 5.6.6.0 (2013/07/05) keys の整合性チェックを行います。
    361         * @og.rev 6.4.3.3 (2016/03/04) ConcurrentHashMap を受け取ることを明確にするため、I/FをConcurrentMapに変更します。
    362         *
    363         * @param paramMap パラメーターMap
    364         * @see         #setKeysVals( String[] ,String[] )
    365         */
    366        public void setParamMap( final ConcurrentMap<String,String> paramMap ) {
    367                // 6.4.3.3 (2016/03/04) Map#forEach に変更
    368                if( paramMap != null ) {
    369                        paramMap.forEach( (k,v) -> setKeyVal( k,v ) );
    370                }
    371        }
    372
    373        /**
    374         * リソースオブジェクトを指定します。
    375         *
    376         * @og.rev 4.3.7.4 (2009/07/01) 新規追加
    377         *
    378         * @param resource リソースオブジェクト
    379         */
    380        public void setResource( final ResourceManager resource ) {
    381                this.resource = resource;
    382        }
    383
    384        /**
    385         * リソースオブジェクトを取得します。
    386         *
    387         * @og.rev 4.3.7.4 (2009/07/01) 新規追加
    388         * @og.rev 5.5.2.6 (2012/05/25) インターフェースにgetterメソッド追加
    389         *
    390         * @return リソースオブジェクト
    391         */
    392        public ResourceManager getResource() {
    393                return resource;
    394        }
    395
    396        /**
    397         * viewMarkerオブジェクトを指定します。
    398         *
    399         * @og.rev 8.0.0.0 (2021/09/30) viewMarker追加
    400         *
    401         * @param marker viewMarkerオブジェクト
    402         */
    403        public void setViewMarker( final ViewMarker marker ) {
    404                viewMarker = marker;
    405        }
    406
    407        /**
    408         * viewMarkerオブジェクトを取得します。
    409         *
    410         * @og.rev 8.0.0.0 (2021/09/30) viewMarker追加
    411         *
    412         * @return viewMarkerオブジェクト
    413         */
    414        public ViewMarker getViewMarker() {
    415                return viewMarker;
    416        }
    417
    418        /**
    419         * 値を返すためのMapを返します。
    420         *
    421         * Mapそのものを返しますので、中身の書き換えは行わないでください。
    422         *
    423         * @og.rev 7.4.0.1 (2021/04/16) 値を返すための変数
    424         *
    425         * @return Mapオブジェクト
    426         */
    427        public Map<String,String> getReturnMap() {
    428                return rtnValMap;
    429        }
    430
    431        /**
    432         * デバッグ情報を出力するかどうか[true:する/false:しない]を指定します。
    433         * true でデバッグ情報を表示します。
    434         *
    435         * @param   flag  デバッグ出力するか [true:する/false:しない]
    436         */
    437        public void setDebug( final boolean flag ) {
    438                useDebug = flag;        // 6.0.2.5 (2014/10/31) refactoring メソッドと同じなので名称変更
    439        }
    440
    441        /**
    442         * デバッグ情報を出力するかどうか[true:する/false:しない]を取得します。
    443         * true でデバッグ情報を表示します。
    444         *
    445         * @og.rev 5.5.2.6 (2012/05/25) インターフェースにgetterメソッド追加
    446         *
    447         * @return  デバッグ出力 [true:する/false:しない]
    448         */
    449        public boolean isDebug() {
    450                return useDebug ;       // 6.0.2.5 (2014/10/31) refactoring メソッドと同じなので名称変更
    451        }
    452
    453        /**
    454         * エラーコード を取得します。
    455         * エラーコード は、ErrorMessage クラスで規定されているコードです。
    456         *
    457         * @return   エラーコード
    458         */
    459        public int getErrorCode() {
    460                return errCode;
    461        }
    462
    463        /**
    464         * エラーメッセージオブジェクト を取得します。
    465         *
    466         * @return   エラーメッセージオブジェクト
    467         */
    468        public ErrorMessage getErrorMessage() {
    469                return errMessage;
    470        }
    471
    472        /**
    473         * タイトルとエラーコードを指定して、エラーメッセージオブジェクト を作成します。
    474         * すでに、作成済みの場合は、作成済みのオブジェクトを、まだ、未作成の場合は、
    475         * 新規に作成します。
    476         *
    477         * @param       title   タイトル
    478         * @param       code    エラーコード
    479         *
    480         * @return      エラーメッセージオブジェクト
    481         */
    482        protected ErrorMessage makeErrorMessage( final String title,final int code ) {
    483                if( errMessage == null ) {
    484                        errMessage = new ErrorMessage( title );
    485                }
    486                if( errCode < code ) { errCode = code; }
    487                return errMessage;
    488        }
    489
    490        /**
    491         *  カラム名配列(String[])より、対応するカラムNo配列(int[])を作成します。
    492         *
    493         * @param       nameArray カラム名配列
    494         *
    495         * @return      カラムNo配列(可変長引数)
    496         */
    497        protected int[] getTableColumnNo( final String... nameArray ) {
    498                int[] clmNo = new int[nameArray.length];
    499                for( int i=0; i<clmNo.length; i++ ) {
    500                        clmNo[i] = table.getColumnNo( nameArray[i] );
    501                }
    502                return clmNo;
    503        }
    504
    505        /**
    506         * 設定されたパラメータキーに対する値を取得します。
    507         * 引数、および、パラメータが null の場合は、 null を返します。
    508         *
    509         * @og.rev 6.4.3.3 (2016/03/04) ConcurrentHashMap の not null制限のチェック追加
    510         *
    511         * @param       key     パラメータキー
    512         *
    513         * @return      パラメータ値
    514         */
    515        protected String getValue( final String key ) {
    516                return key == null ? null : keyValMap.get( key );
    517        }
    518
    519        /**
    520         * ﾌｨﾙﾀｰからtaglibのﾘｸｴｽﾄ変数に値を書き戻したい場合に、key と val をｾｯﾄします。
    521         * 引数、および、パラメータが null の場合は、何もしません。
    522         *
    523         * @og.rev 7.4.0.1 (2021/04/16) 値を返すための変数ｾｯﾄ
    524         *
    525         * @param       key     戻しキー
    526         * @param       val     戻し値
    527         */
    528        protected void setValue( final String key ,final String val ) {
    529                if( key != null && val != null ) {
    530                        rtnValMap.put( key,val );
    531                }
    532        }
    533
    534        /**
    535         * keyValMapに持っているキーの配列を取得します。
    536         * これは、サブクラスで、initSet(String,String) を行わない場合、keys には
    537         * 値を自由に設定できます。
    538         * その値を取り出すためです。
    539         *
    540         * @og.rev 6.7.9.1 (2017/05/19) 新規追加
    541         *
    542         * @return      キー値の配列(keyValMapに持っているキー)
    543         */
    544        protected String[] getKeys() {
    545                return keyValMap.keySet().toArray( new String[keyValMap.size()] );
    546        }
    547}