    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.fukurou.business;
    017
    018import org.opengion.fukurou.model.DataModel;
    019import org.opengion.fukurou.model.NativeType;
    020import static org.opengion.fukurou.system.HybsConst.CR;                         // 6.1.0.0 (2014/12/26) refactoring
    021import static org.opengion.fukurou.system.HybsConst.BUFFER_MIDDLE;      // 6.1.0.0 (2014/12/26) refactoring
    022
    023import java.util.concurrent.ConcurrentMap;                                                      // 6.4.3.3 (2016/03/04)
    024import java.util.concurrent.ConcurrentHashMap;                                          // 6.4.3.1 (2016/02/12) refactoring
    025import java.util.Arrays;
    026
    027/**
    028 * 業務ロジックを処理するためのテーブルモデルです。
    029 *
    030 * このテーブルモデルでは、オブジェクト生成時に、カラム配列、値配列を元に、内部データを生成し、
    031 * その後は、行の追加や値の変更はできません。
    032 *
    033 * @og.rev 5.1.1.0 (2009/12/01) 新規作成
    034 * @og.group 業務ロジック
    035 *
    036 * @version 5.0
    037 * @author Hiroki Nakamura
    038 * @since JDK1.6,
    039 */
    040public class ArrayTableModel implements DataModel<String> {
    041
    042        private final String[] names;
    043        private final String[][] vals;
    044        private final String[] modTypes;
    045
    046        /** 6.4.3.1 (2016/02/12) PMD refactoring. HashMap → ConcurrentHashMap に置き換え。  */
    047        private final ConcurrentMap<Integer,String[]> rtnMap = new ConcurrentHashMap<>() ;      // 6.4.3.3 (2016/03/04) final化で、初期から作成しておきます。
    048
    049        /**
    050         * 引数に名前配列、値配列を指定したコンストラクター
    051         *
    052         * @param       nms     名前配列
    053         * @param       vs      値２重配列
    054         * @throws  IllegalArgumentException 引数の配列が不正な場合
    055         */
    056        public ArrayTableModel( final String[] nms, final String[][] vs ) {
    057                this( nms, vs, null );
    058        }
    059
    060        /**
    061         * 引数に名前配列、値配列、変更区分配列を指定したコンストラクター
    062         *
    063         * @og.rev 5.6.7.0 (2013/07/27) エラーメッセージを判りやすくする。
    064         * @og.rev 5.7.2.3 (2014/01/31) vsのチェック条件を戻す
    065         * @og.rev 5.7.3.1 (2014/02/14) nmsのチェック条件も戻す
    066         *
    067         * @param       nms     名前配列
    068         * @param       vs      値２重配列
    069         * @param       ms      変更区分の配列
    070         * @throws  IllegalArgumentException 引数の配列が不正な場合
    071         */
    072        public ArrayTableModel( final String[] nms, final String[][] vs, final String[] ms ) {
    073                if( nms == null || nms.length == 0 ) {
    074                        final String errMsg = "引数の名前配列に、null は設定できません。";
    075                        throw new IllegalArgumentException( errMsg );
    076                }
    077                // 5.6.7.0 (2013/07/27) エラーメッセージを判りやすくする。
    078                // 5.7.2.3 (2014/01/31) 結果０行でlength=0で通るようなのでvsのエラーチェック条件を戻す。
    079                if( vs == null ) {
    080                        final String errMsg = "引数の値配列に、null は設定できません。";
    081                        throw new IllegalArgumentException( errMsg );
    082                }
    083                // 5.7.3.1 (2014/02/14) 5.7.2.3での戻しでは不十分だったのでこちらも戻す
    084                // 6.0.0.1 (2014/04/25) These nested if statements could be combined
    085                if( vs.length > 0 && ( vs[0] == null || vs[0].length == 0 || nms.length != vs[0].length ) ) {
    086                        final String errMsg = "名前配列と値配列のカラム数が異なります。"    + CR
    087                                                        + "   nms   =" + Arrays.toString( nms   )                       + CR
    088                                                        + "   vs[0] =" + Arrays.toString( vs[0] ) ;
    089                        throw new IllegalArgumentException( errMsg );
    090                }
    091
    092                final int cols = nms.length;
    093                names = new String[cols];
    094                System.arraycopy( nms, 0, names, 0, cols );
    095
    096                final int rows = vs.length;
    097                vals = new String[rows][cols];
    098                for( int i=0; i<rows; i++ ) {
    099                        System.arraycopy( vs[i], 0, vals[i], 0, cols );
    100                }
    101
    102                if( ms != null && ms.length > 0 ) {
    103                        if( vs.length == ms.length ) {
    104                                modTypes = new String[rows];
    105                                System.arraycopy( ms, 0, modTypes, 0, rows );
    106                        }
    107                        else {
    108                                // 5.6.7.0 (2013/07/27) エラーメッセージを判りやすくする。
    109                                final String errMsg = "変更区分を指定する場合、値配列の行数と一致する必要があります。" + CR
    110                                                                        + "   変更区分 行数 =" + ms.length            + CR
    111                                                                        + "   値配列   行数 =" + vs.length ;
    112                                throw new IllegalArgumentException( errMsg );
    113                        }
    114                }
    115                else {
    116                        modTypes = null;
    117                }
    118        }
    119
    120        /**
    121         * rowで指定された行番号(インデックス番号)に行を追加します。
    122         *
    123         * 値配列をセットする場合は、以下の条件を満たす必要があります。
    124         *   １．行番号は、0～(rowCount-1) の範囲
    125         *   ２．値配列は、not null、 かつ １件以上
    126         *   ３．値配列の個数は、内部カラム数と同じ
    127         *
    128         * ここで登録した値は、内部の値配列と別管理されますので、セット後に、再びゲットしても
    129         * ここでセットした値を取り出すことはできません。
    130         * また、同じ行番号でセットした場合は、後でセットした値が有効です。
    131         *
    132         * ※ ここでの更新時に、modifyType は、設定されません。
    133         * 必要であれば、setModifyType メソッドで個別に設定してください。
    134         *
    135         * ※ インデックス(row)とは、このArrayTableModel に持つ vals 配列の行のインデックスです。
    136         * よって、オリジナルのDBTableModelの行番号ではありません。
    137         *
    138         * @og.rev 5.6.0.3 (2012/01/24) 変更された値を、書き戻す機能を追加します。
    139         * @og.rev 6.4.3.1 (2016/02/12) PMD refactoring. HashMap → ConcurrentHashMap に置き換え。
    140         *
    141         * @param   inVals  配列値
    142         * @param   rowNo   追加するインデックス
    143         * @throws      IllegalArgumentException 引数が１，２，３の条件を満たさない場合。
    144         */
    145        public void setValues( final String[] inVals, final int rowNo ) {
    146                if( rowNo < 0 || rowNo > getRowCount() ) {
    147                        final String errMsg = "引数のインデックスは、0～" + (getRowCount()-1) + " の間で指定してください。index=[" + rowNo + "]";
    148                        throw new IllegalArgumentException( errMsg );
    149                }
    150                else if( inVals == null || inVals.length == 0 ) {
    151                        final String errMsg = "引数の値配列に、null、または 0件配列は指定できません。index=[" + rowNo + "]";
    152                        throw new IllegalArgumentException( errMsg );
    153                }
    154                else if( inVals.length != names.length ) {
    155                        final String errMsg = "引数の値配列の個数と、内部カラム数が一致しません。"
    156                                                        + " index=[" + rowNo + "] : 引数個数=[" + inVals.length + "] != 内部カラム数=[" + names.length + "]";
    157                        throw new IllegalArgumentException( errMsg );
    158                }
    159
    160                // 6.4.3.1 (2016/02/12) PMD refactoring. HashMap → ConcurrentHashMap に置き換え。
    161
    162                final int cols = names.length;
    163                final String[] newVals = new String[cols];
    164                System.arraycopy( inVals, 0, newVals, 0, cols );
    165
    166                // 6.4.3.1 (2016/02/12) PMD refactoring. HashMap → ConcurrentHashMap に置き換え。初期化処理の場所も移動。
    167                rtnMap.put( Integer.valueOf( rowNo ) , newVals );
    168        }
    169
    170        /**
    171         * BizLogicで、データが変更された場合は、このMapで値の配列を返します。
    172         * Mapのキーは、インデックス(row)のIntegerオブジェクトです。値は、設定された String配列です。
    173         * なにも変更がされていなければ、空のConcurrentMapを返しましす。
    174         *
    175         * ※ インデックス(row)とは、このArrayTableModel に持つ vals 配列の行のインデックスです。
    176         * よって、オリジナルのDBTableModelの行番号ではありません。
    177         *
    178         * @og.rev 5.6.0.3 (2012/01/24) 変更された値を、書き戻すためのMap&lt;インデックス,値配列&gt; を返します。
    179         * @og.rev 6.4.3.1 (2016/02/12) PMD refactoring. HashMap → ConcurrentHashMap に置き換え。
    180         * @og.rev 6.4.3.3 (2016/03/04) 変更が無い場合は、nulllではなく、空のConcurrentMapを返しましす。
    181         *
    182         * @return      書き戻すためのMap＜インデックス,値配列＞
    183         * @see AbstractBizLogic#isRequireTable()
    184         * @og.rtnNotNull
    185         */
    186        public ConcurrentMap<Integer,String[]> getModifyVals() {
    187                return rtnMap;
    188        }
    189
    190        /**
    191         * カラム名に対応する カラム番号を返します。
    192         *
    193         * 特殊なカラムが指定された場合は、負の値を返します。
    194         * 例えば、[KEY.カラム名]、[I]、[ROW.ID] など、特定の負の値を返します。
    195         * また、カラム名が元のデータモデルに存在しない場合も、負の値か、
    196         * Exception を返します。負の値なのか、Exception なのかは、
    197         * 実装に依存します。
    198         *
    199         * @param       columnName      値が参照されるカラム名
    200         *
    201         * @return  指定されたセルのカラム番号。存在しなければ、-1
    202         * @throws  IllegalArgumentException 引数のカラム名が null の場合
    203         */
    204        public int getColumnNo( final String columnName ) {
    205                if( columnName == null ) {
    206                        final String errMsg = "引数のカラム名に、null は設定できません。";
    207                        throw new IllegalArgumentException( errMsg );
    208                }
    209
    210                int address = -1;
    211                for( int i=0; i<names.length; i++ ) {
    212                        if( columnName.equalsIgnoreCase( names[i] ) ) {
    213                                address = i;
    214                                break;
    215                        }
    216                }
    217
    218                return address;
    219        }
    220
    221        /**
    222         * カラム名配列に対応する カラム番号配列を返します。
    223         *
    224         * これは、#getColumnNo( String ) に対する 複数のカラム名を検索した
    225         * 場合と同じです。
    226         *
    227         * @og.rev 6.8.6.0 (2018/01/19) 可変長引数から、通常配列に変更。
    228         *
    229         * @param       clmNms  値が参照されるカラム名配列(可変長引数)
    230         *
    231         * @return  指定されたセルのカラム番号配列。
    232         * @og.rtnNotNull
    233         */
    234//      public int[] getColumnNos( final String... clmNms ) {
    235        public int[] getColumnNos( final String[] clmNms ) {
    236                if( clmNms == null || clmNms.length == 0 ) { return new int[0]; }       // 6.1.1.0 (2015/01/17) 可変長引数でもnullは来る。
    237
    238                int[] clmNos = new int[clmNms.length];
    239                for( int j=0; j<clmNms.length; j++ ) {
    240                        int address = -1;
    241                        for( int i=0; i<names.length; i++ ) {
    242                                if( clmNms[j].equalsIgnoreCase( names[i] ) ) {
    243                                        address = i;
    244                                        break;
    245                                }
    246                        }
    247                        clmNos[j] = address;
    248                }
    249
    250                return clmNos;
    251        }
    252
    253        /**
    254         * カラム名配列を返します。
    255         *
    256         * @return      カラム名配列
    257         * @og.rtnNotNull
    258         */
    259        public String[] getNames() {
    260                return names.clone();
    261        }
    262
    263        /**
    264         * 指定のカラム名引数に相当するデータを２重配列で返します。
    265         *
    266         * @og.rev 6.8.5.0 (2018/01/09) 新規追加
    267         *
    268         * @param       clmNms  値が参照されるカラム名配列(可変長引数)
    269         *
    270         * @return  指定された名引数に相当するデータの２重配列
    271         * @og.rtnNotNull
    272         */
    273        protected String[][] getValues( final String... clmNms ) {
    274                final int[] clmNos = getColumnNos( clmNms );
    275
    276                final String[][] rtns = new String[vals.length][clmNos.length];
    277
    278                for( int row=0; row<vals.length; row++ ) {
    279                        for( int j=0; j<clmNos.length; j++ ) {
    280                                final int col = clmNos[j];
    281                                rtns[row][col] = vals[row][col];
    282                        }
    283                }
    284
    285                return rtns;
    286        }
    287
    288        /**
    289         * row にあるセルの属性値を配列で返します。
    290         *
    291         * @param   row     値が参照される行
    292         *
    293         * @return  指定されたセルの属性値配列
    294         * @og.rtnNotNull
    295         */
    296        public String[] getValues( final int row ) {
    297                return vals[row].clone();
    298        }
    299
    300        /**
    301         * row および clm にあるセルの属性値をStringに変換して返します。
    302         *
    303         * @param   row     値が参照される行
    304         * @param   clm     値が参照される列
    305         *
    306         * @return  指定されたセルの値
    307         */
    308        public String getValue( final int row, final int clm ) {
    309                return vals[row][clm];
    310        }
    311
    312        /**
    313         * row および clm にあるセルの属性値をStringに変換して返します。
    314         *
    315         * @param   row     値が参照される行
    316         * @param   clm     値が参照される列(キー)
    317         *
    318         * @return  指定されたセルの値
    319         *
    320         */
    321        public String getValue( final int row, final String clm ) {
    322                return vals[row][getColumnNo( clm )];
    323        }
    324
    325        /**
    326         * データテーブル内の行の数を返します。
    327         *
    328         * @return  モデルの行数
    329         *
    330         */
    331        public int getRowCount() {
    332                return vals.length;
    333        }
    334
    335        /**
    336         * row 単位に変更されたタイプ(追加/変更/削除)を返します。
    337         * タイプは始めに一度登録するとそれ以降に変更はかかりません。
    338         * つまり、始めに 追加で作成したデータは、その後変更があっても追加のままです。
    339         * なにも変更されていない場合は, ""(ゼロストリング)を返します。
    340         *
    341         * @param   row     値が参照される行
    342         *
    343         * @return  変更されたタイプの値
    344         */
    345        public String getModifyType( final int row ) {
    346                return modTypes == null ? "" : modTypes[row];
    347        }
    348
    349        /**
    350         * row 単位に変更タイプ(追加/変更/削除)をセットします。
    351         * このメソッドでは、データのバックアップは取りません。
    352         * タイプは始めに一度登録するとそれ以降に変更はかかりません。
    353         * なにも変更されていない場合は, ""(ゼロストリング)の状態です。
    354         *
    355         * @og.rev 6.7.9.1 (2017/05/19) インターフェースの見直しにより、追加
    356         *
    357         * @param   row      値が参照される行
    358         * @param   modType  変更タイプ(追加/変更/削除)
    359         *
    360         */
    361        public void setModifyType( final int row , final String modType ) {
    362                if( modTypes[row].isEmpty() ) { modTypes[row] = modType; }
    363        }
    364
    365        /**
    366         * clm のNativeタイプを返します。
    367         * Nativeタイプはorg.opengion.fukurou.model.NativeTypeで定義されています。
    368         *
    369         * @og.rev 5.1.8.0 (2010/07/01) NativeType#getType(String) のメソッドを使用するように変更。
    370         *
    371         * @param  clm      値が参照される列
    372         *
    373         * @return Nativeタイプ
    374         * @see org.opengion.fukurou.model.NativeType
    375         */
    376        public NativeType getNativeType( final int clm ) {
    377                return NativeType.getType( vals[0][clm] );
    378        }
    379
    380        /**
    381         * このオブジェクトの文字列表記を返します。
    382         * デバッグ用です。
    383         *
    384         * @og.rev 5.6.7.0 (2013/07/27) 新規追加
    385         *
    386         * @return 文字列表現
    387         * @og.rtnNotNull
    388         * @see java.lang.Object#toString()
    389         */
    390        @Override
    391        public String toString() {
    392                final StringBuilder buf = new StringBuilder( BUFFER_MIDDLE );
    393
    394                buf.append( "NAMES=" ).append( Arrays.toString( names ) ).append( CR )
    395                        // 6.4.1.1 (2016/01/16) PMD refactoring. Avoid if (x != y) ..; else ..;
    396                        .append( " COL_LEN=" ).append( names == null ? -1 : names.length ).append( CR )
    397                        .append( " ROW_LEN=" ).append( vals  == null ? -1 : vals.length  ).append( CR ) ;
    398
    399                return buf.toString();
    400        }
    401}