    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 java.util.HashMap;
    019import java.util.Locale;
    020import java.util.Map;
    021import java.util.LinkedHashMap ;
    022import java.util.Map.Entry;
    023
    024import org.opengion.fukurou.util.ErrorMessage;
    025import org.opengion.fukurou.db.Transaction;
    026import org.opengion.hayabusa.resource.ResourceManager;
    027import org.opengion.hayabusa.common.HybsSystemException;
    028
    029/**
    030 * AbstractTableFilter は、TableUpda インターフェースを継承した、DBTableModel 処理用の
    031 * Abstract実装クラスです。
    032 *
    033 * @og.rev 5.5.2.6 (2012/05/25) protected変数をprivateに変更。インターフェースにメソッド追加
    034 *
    035 * @version  0.9.0  2000/10/17
    036 * @author   Kazuhiko Hasegawa
    037 * @since    JDK1.1,
    038 */
    039abstract public class AbstractTableFilter implements TableFilter {
    040
    041        /** CR 定義 */
    042//      5.5.2.6 (2012/05/25) I/F 側に移動
    043//      protected static final String CR        = HybsSystem.CR ;       // 5.1.1.0 (2009/12/01) CR 定義をここで行う。
    044
    045//      protected DBTableModel  table           = null;
    046//      protected String                modifyType      = null;
    047//      protected int[]                 rowNo           = null;
    048//      protected boolean               isDebug         = false;
    049//      protected ApplicationInfo appInfo       = null; // 5.1.9.0 (2010/08/01) 廃止
    050//      protected Transaction   tran            = null; // 5.1.9.0 (2010/08/01) 追加
    051//      protected String                sql                     = null; // 4.2.4.0 (2008/06/23)
    052//      protected String                dbid            = null; // 4.2.4.0 (2008/06/23)
    053//      protected ResourceManager resource      = null; // 4.3.7.4 (2009/07/01)
    054
    055        // 5.5.2.6 (2012/05/25) protected変数をprivateに変更。インターフェースにメソッド追加
    056        private DBTableModel    table           = null;
    057        private String                  modifyType      = null;
    058        private int[]                   rowNo           = null;
    059        private boolean                 isDebug         = false;
    060        private Transaction             tran            = null; // 5.1.9.0 (2010/08/01) 追加
    061        private String                  sql                     = null; // 4.2.4.0 (2008/06/23)
    062        private String                  dbid            = null; // 4.2.4.0 (2008/06/23)
    063        private ResourceManager resource        = null; // 4.3.7.4 (2009/07/01)
    064
    065        private int                     errCode         = ErrorMessage.OK;
    066        private ErrorMessage    errMessage      = null;
    067
    068        private final Map<String,String>  keysVals        = new HashMap<String,String>();
    069
    070        // 5.6.6.0 (2013/07/05) keys の整合性チェックを行います。
    071        protected final Map<String,String> keysMap = new LinkedHashMap<String,String>();
    072
    073        /**
    074         * デフォルトコンストラクター
    075         * ここでは、keys の整合性チェックを行うための初期設定を行う、init( Map&lt;String,String&gt; )
    076         * メソッドを呼び出します。
    077         * init( Map&lt;String,String&gt; ) メソッドは、各サブクラスで実装が必要です。
    078         *
    079         * @og.rev 5.6.6.1 (2013/07/12) keys の整合性チェック対応
    080         */
    081        public AbstractTableFilter() {
    082                init( keysMap );
    083        }
    084
    085        /**
    086         * keys の整合性チェックを行うための初期設定を行います。
    087         * ここでは何もしません。必要であれば、各サブクラスに実装しておきます。
    088         *
    089         * @og.rev 5.6.6.1 (2013/07/12) keys の整合性チェック対応
    090         *
    091         * @param       keysMap keys の整合性チェックを行うための Map
    092         */
    093        protected void init( final Map<String,String> keysMap ) {}
    094
    095        /**
    096         * DBTableModel をセットします。
    097         *
    098         * @param       table DBTableModelオブジェクト
    099         */
    100        public void setDBTableModel( final DBTableModel table ) {
    101                this.table = table;
    102        }
    103
    104        /**
    105         * DBTableModel を取得します。
    106         *
    107         * @og.rev 5.5.2.6 (2012/05/25) インターフェースにgetterメソッド追加
    108         *
    109         * @return      内部のDBTableModel
    110         */
    111        public DBTableModel getDBTableModel() {
    112                return table;
    113        }
    114
    115        /**
    116         * データ処理の方法(A:追加 C:更新 D:削除)を指定します。
    117         *
    118         * 通常は、DBTableModel に自動設定されている modifyType を元に、データ処理方法を
    119         * 選別します。(A:追加 C:更新 D:削除)
    120         * この場合、行単位で modifyType の値を取得して判別する必要がありますが、一般には
    121         * 処理対象は、全件おなじ modifyType である可能性が高いです。
    122         * また、selectedAll などで強制的に全件処理対象とする場合は、modifyType に値が
    123         * 設定さていません。その様な場合に外部より modifyType を指定します。
    124         * 初期値は、自動判定 です。
    125         *
    126         * @og.rev 5.5.2.6 (2012/05/25) 廃止
    127         *
    128         * @param  type データ処理の方法(A:追加 C:更新 D:削除)
    129         */
    130        public void setModifyType( final String type ) {
    131                modifyType = type;
    132        }
    133
    134        /**
    135         * データ処理の方法(A:追加 C:更新 D:削除)を取得します。
    136         *
    137         * 初期値は、自動判定 です。
    138         *
    139         * @og.rev 5.5.2.6 (2012/05/25) インターフェースにgetterメソッド追加
    140         *
    141         * @return  データ処理の方法(A:追加 C:更新 D:削除)
    142         */
    143        public String getModifyType() {
    144                return modifyType ;
    145        }
    146
    147        /**
    148         * キーと値のペアの変数配列を受け取ります。
    149         *
    150         * ここでは、この方式以外に、パラメーターMapを受け取る方法もあります。
    151         * この受け取る時に、キーを大文字化します。TableFilter の keys は、
    152         * 大文字のみで定義しておくことで、HTMLやWindows世代の曖昧な表記方法に
    153         * 対応しています。(unixやxmlのような厳格な方が好きですけど)
    154         *
    155         * keys,vals とパラメーターMapを同時に指定した場合は、両方とも有効です。
    156         * ただし、キーが重複した場合は、不定と考えてください。
    157         *
    158         * @og.rev 5.6.6.0 (2013/07/05) keys の整合性チェックを行います。
    159         *
    160         * @param   keys キー配列
    161         * @param   vals 値配列
    162         * @see         #setParamMap( Map  )
    163         */
    164        public void setKeysVals( final String[] keys,final String[] vals ) {
    165                if( keys != null && vals != null ) {
    166                        for( int i=0; i<keys.length; i++ ) {
    167                                // 5.6.6.0 (2013/07/05) 共通のセッターメソッド経由で登録します。
    168//                              keysVals.put( keys[i].toUpperCase(Locale.JAPAN),vals[i] );
    169                                setKeyVal( keys[i],vals[i] );
    170                        }
    171                }
    172        }
    173
    174        /**
    175         * キーと値のペアを受け取り、内部の keysVals マップに追加します。
    176         *
    177         * キーか値のどちらかが null の場合は、何もしません。つまり、val に
    178         * null をセットすることはできません。
    179         *
    180         * このメソッドは、setKeysVals( String[] ,String[] ) メソッドと、
    181         * setParamMap( Map<String,String> ) メソッドの両方から、使用します。
    182         * 処理を行うに当たり、下記の処理を行います。
    183         * １．キーを大文字化します。
    184         * ２．各クラスの keys と整合性チェックを行います。
    185         *
    186         * ただし、setKeysVals と setParamMap の登録順は、不定と考えてください。
    187         * 両方に同じキーを指定すると、どちらの値がセットされたかは、不定です。
    188         *
    189         * @og.rev 5.6.6.0 (2013/07/05) keys の整合性チェックを行います。
    190         *
    191         * @param   key キー文字列(null の場合は、処理しない)
    192         * @param   val 値文字列(null の場合は、処理しない)
    193         * @see         #setKeysVals( String[] ,String[] )
    194         * @see         #setParamMap( Map )
    195         */
    196        private void setKeyVal( final String key,final String val ) {
    197                // key か val かどちらかが null の場合は、処理を行わない。
    198                if( key == null || val == null ) { return; }
    199
    200                String upKey = key.toUpperCase(Locale.JAPAN);
    201
    202                if( keysMap.containsKey( upKey ) ) {            // keysMap は、各サブクラスで定義
    203                        keysVals.put( upKey,val );
    204                }
    205                else {
    206                        String BR = "<br />" + CR ;
    207                        StringBuilder errMsg = new StringBuilder();
    208                        errMsg.append( BR )
    209                                  .append( "指定のキーは、この tableFilter では、使用できません。" ).append( BR )
    210                                  .append( "  class=[" ).append( getClass().getName() ).append( "]" ).append( BR )
    211                                  .append( "  key  =[" ).append( key                              ).append( "]" ).append( BR )
    212                                  .append( "  ======== usage keys ======== " ).append( BR ) ;
    213                        for( Map.Entry<String, String> entry : keysMap.entrySet() ) {
    214                                errMsg.append( "  " ).append( entry.getKey() ).append( " : " )
    215                                                                         .append( entry.getValue() ).append( BR ) ;
    216                        }
    217                        errMsg.append( "  ============================ " ).append( BR );
    218
    219                        throw new HybsSystemException( errMsg.toString() );
    220                }
    221        }
    222
    223        /**
    224         * 選択された行番号の配列をセットします。
    225         *
    226         * 表示データの HybsSystem.ROW_SELECTED_KEY を元に、選ばれた 行を
    227         * 処理の対象とします。
    228         *
    229         * @param   rowNoTmp 行番号配列
    230         */
    231        public void setParameterRows( final int[] rowNoTmp ) {
    232                if( rowNoTmp != null ) {
    233                        int size = rowNoTmp.length ;
    234                        rowNo = new int[size];
    235                        System.arraycopy( rowNoTmp,0,rowNo,0,size );
    236                }
    237        }
    238
    239        /**
    240         * 選択された行番号の配列を取得します。
    241         *
    242         * 表示データの HybsSystem.ROW_SEL_KEY を元に、選ばれた 行を
    243         * 処理の対象とします。
    244         *
    245         * @og.rev 5.5.2.6 (2012/05/25) インターフェースにgetterメソッド追加
    246         *
    247         * @return   行番号の配列
    248         */
    249        public int[] getParameterRows() {
    250                return (rowNo != null ) ? rowNo.clone() : null ;
    251        }
    252
    253        /**
    254         * アクセスログ取得の為,ApplicationInfoオブジェクトを設定します。
    255         *
    256         * @og.rev 3.8.7.0 (2006/12/15) 新規追加
    257         * @og.rev 5.1.9.0 (2010/08/01) Transaction 対応 のため、廃止
    258         *
    259         * @param   appInfo ApplicationInfo
    260         */
    261//      public void setApplicationInfo( final ApplicationInfo appInfo ) {
    262//              this.appInfo = appInfo;
    263//      }
    264
    265        /**
    266         * アクセスログ取得の為,Transactionオブジェクトを設定します。
    267         *
    268         * @og.rev 5.1.9.0 (2010/08/01) Transaction 対応(新規追加)
    269         *
    270         * @param   tran Transactionオブジェクト
    271         */
    272        public void setTransaction( final Transaction tran ) {
    273                this.tran = tran;
    274        }
    275
    276        /**
    277         * アクセスログ取得の為,Transactionオブジェクトを取得します。
    278         *
    279         * @og.rev 5.1.9.0 (2010/08/01) Transaction 対応(新規追加)
    280         * @og.rev 5.5.2.6 (2012/05/25) インターフェースにgetterメソッド追加
    281         *
    282         * @return   Transactionオブジェクト
    283         */
    284        public Transaction getTransaction() {
    285                return tran;
    286        }
    287
    288        /**
    289         * DBIDを指定します。
    290         *
    291         * @og.rev 4.2.4.0 (2008/06/23) 新規追加
    292         *
    293         * @param dbid 接続先ID
    294         */
    295        public void setDbid( final String dbid ) {
    296                this.dbid = dbid;
    297        }
    298
    299        /**
    300         * DBIDを取得します。
    301         *
    302         * @og.rev 4.2.4.0 (2008/06/23) 新規追加
    303         * @og.rev 5.5.2.6 (2012/05/25) インターフェースにgetterメソッド追加
    304         *
    305         * @return DBID(接続先情報)
    306         */
    307        public String getDbid() {
    308                return dbid;
    309        }
    310
    311        /**
    312         * ボディー部分のSQLを指定します。
    313         *
    314         * @og.rev 4.2.4.0 (2008/06/23) 新規追加
    315         *
    316         * @param sql ボディー部分のSQL
    317         */
    318        public void setSql( final String sql ) {
    319                this.sql = sql;
    320        }
    321
    322        /**
    323         * ボディー部分のSQLを取得します。
    324         *
    325         * @og.rev 4.2.4.0 (2008/06/23) 新規追加
    326         * @og.rev 5.5.2.6 (2012/05/25) インターフェースにgetterメソッド追加
    327         *
    328         * @return ボディー部分のSQL
    329         */
    330        public String getSql() {
    331                return sql;
    332        }
    333
    334        /**
    335         * パラメーターMapを指定します。
    336         *
    337         * keys,vals と パラメーターMapを同時に指定した場合は、両方とも有効です。
    338         * ただし、キーが重複した場合は、不定と考えてください。
    339         *
    340         * この受け取る時に、キーを大文字化します。TableFilter の keys は、
    341         * 大文字のみで定義しておくことで、HTMLやWindows世代の曖昧な表記方法に
    342         * 対応しています。(unixやxmlのような厳格な方が好きですけど)
    343         *
    344         * @og.rev 5.6.5.2 (2013/06/21) 新規追加
    345         * @og.rev 5.6.6.0 (2013/07/05) keys の整合性チェックを行います。
    346         *
    347         * @param paramMap パラメーターMap
    348         * @see         #setKeysVals( String[] ,String[] )
    349         */
    350        public void setParamMap( final Map<String,String> paramMap ) {
    351                if( paramMap != null ) {
    352//                      keysVals.putAll( paramMap );
    353                        // 5.6.6.0 (2013/07/05) Map を一つづつ回して登録します。
    354                        for( Map.Entry<String, String> entry : paramMap.entrySet() ) {
    355                                setKeyVal( entry.getKey(),entry.getValue() );
    356                        }
    357                }
    358        }
    359
    360        /**
    361         * リソースオブジェクトを指定します。
    362         *
    363         * @og.rev 4.3.7.4 (2009/07/01) 新規追加
    364         *
    365         * @param resource リソースオブジェクト
    366         */
    367        public void setResource( final ResourceManager resource ) {
    368                this.resource = resource;
    369        }
    370
    371        /**
    372         * リソースオブジェクトを取得します。
    373         *
    374         * @og.rev 4.3.7.4 (2009/07/01) 新規追加
    375         * @og.rev 5.5.2.6 (2012/05/25) インターフェースにgetterメソッド追加
    376         *
    377         * @return リソースオブジェクト
    378         */
    379        public ResourceManager getResource() {
    380                return resource;
    381        }
    382
    383        /**
    384         * デバッグ情報を表示するかどうか[true/false]を指定します。
    385         * true でデバッグ情報を表示します。
    386         *
    387         * @param   flag  [true:出力する/それ以外:しない]
    388         */
    389        public void setDebug( final boolean flag ) {
    390                isDebug = flag;
    391        }
    392
    393        /**
    394         * デバッグ情報を表示するかどうかを取得します。
    395         * true でデバッグ情報を表示します。
    396         *
    397         * @og.rev 5.5.2.6 (2012/05/25) インターフェースにgetterメソッド追加
    398         *
    399         * @return  デバッグ情報(true:デバッグ情報を出力する)
    400         */
    401        public boolean isDebug() {
    402                return isDebug ;
    403        }
    404
    405        /**
    406         * エラーコード を取得します。
    407         * エラーコード は、ErrorMessage クラスで規定されているコードです。
    408         *
    409         * @return   エラーコード
    410         */
    411        public int getErrorCode() {
    412                return errCode;
    413        }
    414
    415        /**
    416         * エラーメッセージオブジェクト を取得します。
    417         *
    418         * @return   エラーメッセージオブジェクト
    419         */
    420        public ErrorMessage getErrorMessage() {
    421                return errMessage;
    422        }
    423
    424        /**
    425         * タイトルとエラーコードを指定して、エラーメッセージオブジェクト を作成します。
    426         * すでに、作成済みの場合は、作成済みのオブジェクトを、まだ、未作成の場合は、
    427         * 新規に作成します。
    428         *
    429         * @param       title   タイトル
    430         * @param       code    エラーコード
    431         *
    432         * @return      エラーメッセージオブジェクト
    433         */
    434        protected ErrorMessage makeErrorMessage( final String title,final int code ) {
    435                if( errMessage == null ) {
    436                        errMessage = new ErrorMessage( title );
    437                }
    438                if( errCode < code ) { errCode = code; }
    439                return errMessage;
    440        }
    441
    442        /**
    443         *  カラム名配列(String[])より、対応するカラムNo配列(int[])を作成します。
    444         *
    445         * @param       nameArray カラム名配列
    446         *
    447         * @return      カラムNo配列
    448         */
    449        protected int[] getTableColumnNo( final String[] nameArray ) {
    450                int[] clmNo = new int[ nameArray.length ];
    451                for( int i=0; i<clmNo.length; i++ ) {
    452                        clmNo[i] = table.getColumnNo( nameArray[i] );
    453                }
    454                return clmNo;
    455        }
    456
    457        /**
    458         *  設定されたパラメータキーに対する値を取得します。
    459         * 引数、および、パラメータが null の場合は、 null を返します。
    460         *
    461         * @param       key     パラメータキー
    462         *
    463         * @return      パラメータ値
    464         */
    465        protected String getValue( final String key ) {
    466                return keysVals.get( key );
    467        }
    468}