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.table;
017
018import java.util.HashMap;
019import java.util.Map;
020
021import org.opengion.fukurou.util.StringUtil;
022import org.opengion.hayabusa.common.HybsSystem;                                 // 8.0.0.0 (2021/09/30)
023import org.opengion.hayabusa.db.AbstractTableFilter;
024import org.opengion.hayabusa.db.DBColumn;
025import org.opengion.hayabusa.db.DBColumnConfig;
026import org.opengion.hayabusa.db.DBTableModel;
027import org.opengion.hayabusa.db.DBTableModelUtil;
028import org.opengion.hayabusa.resource.ResourceManager;
029import org.opengion.hayabusa.html.ViewMarker;                                   // 8.0.0.0 (2021/09/30)
030
031/**
032 * TableFilter_ROTATE は、TableFilter インターフェースを継承した、DBTableModel 処理用の
033 * 実装クラスです。
034 *
035 * ここではテーブルの回転<del>及びその逆回転</del>を行います。
036 *   8.0.0.0 (2021/07/31) 逆回転 廃止
037 *
038 * パラメータは、tableFilterタグの keys, vals にそれぞれ記述するか、BODY 部にCSS形式で記述します。
039 * 【パラメータ】
040 *  {
041 *       KEY_CLM    : キーカラム(複数指定可)    (必須)
042 *       ROTATE_CLM : 回転するカラム            (必須)
043 *       VALUE_CLM  : 回転カラムの値            (必須)
044 *       USE_LABEL  : 値ラベルのカラムを生成するか (任意指定 初期値:false) 8.0.0.0 (2021/07/31)
045 *       USE_RENDERER: 値の表示に、renndererを使用するか (任意指定 初期値:false) 8.0.0.0 (2021/07/31)
046 *       USE_MARKER : 値の表示に、viewMarkerを使用するか (任意指定 初期値:false) 8.0.0.0 (2021/09/30)
047 *  <del>REVERSE    : 回転(false)・逆回転(true) (任意指定 初期値:false)</del> 8.0.0.0 (2021/07/31) 廃止
048 *       MUST_CLM   : 必須属性を定義するカラム  (任意指定 初期値:false)
049 *       DEF_CLM    : 初期値を定義するカラム    (任意指定)
050 *  }
051 *
052 *  ※ それぞれに指定されたカラム名が存在しない場合は、処理されませんのでご注意下さい。
053 *
054 * ①回転
055 *  キーカラムに指定された値が同じN行を1行として回転します。
056 *  (キーカラムの値がブレイクしたタイミングで、行を変更します)
057 *  このN行に含まれる回転カラムの値がカラム名に、回転カラム値が各カラムの値になります。
058 *  キーカラムは、CSV形式で複数指定可能です。
059 *
060 *  生成されたテーブルモデルのカラムは、始めのMカラムがキーカラムに、その後ろのNカラムが
061 *  回転されたカラムになります。
062 *
063 *  また、元テーブルにMUST_CLMにより、各カラムの必須属性を定義することが
064 *  できます。(MUST属性は、'1'又は'true'の場合に必須になります。)
065 *
066 * 8.0.0.0 (2021/07/31)
067 *  USE_LABEL="true" を指定した場合、VALUE_CLM のラベルを、キーカラムと回転カラムの間に
068 *  追加します。これは、VALUE_CLM を 複数指定できる機能追加に伴う処置です。
069 *
070 * 8.0.0.0 (2021/07/31) 逆回転 廃止
071 * <del>②逆回転
072 *  回転時の逆の挙動になります。
073 *  "キーカラムに指定されたカラム以外"を回転カラムで指定されたカラムの値として分解します。
074 *  各回転カラムの値は、回転カラム値に指定されたカラムに格納されます。
075 *
076 *  分解後のカラム数は、キーカラム数 + 2 (回転カラム、回転カラム値)になります。
077 *  また、行数は、(分解前の行数) x (回転カラム数)になります。
078 *</del>
079 *
080 * @og.formSample
081 * ●形式:
082 *      ① &lt;og:tableFilter classId="ROTATE" selectedAll="true"
083 *                   keys="KEY_CLM,ROTATE_CLM,VALUE_CLM" vals='"GOKI,MAX_SID,MAX_TM_RPS",TOKEN,X_VAL' /&gt;
084 *
085 *      ② &lt;og:tableFilter classId="ROTATE"  selectedAll="true" &gt;
086 *               {
087 *                   KEY_CLM    : GOKI,MAX_SID,MAX_TM_RPS ;
088 *                   ROTATE_CLM : TOKEN ;
089 *                   VALUE_CLM  : X_VAL ;
090 *               }
091 *         &lt;/og:tableFilter&gt;
092 *
093 * @og.rev 5.6.6.0 (2013/07/05) keys の整合性チェックを追加
094 * @og.rev 8.0.0.0 (2021/07/31) VALUE_CLMの複数指定対応と、USE_LABEL属性の追加
095 *
096 * @version  0.9.0  2000/10/17
097 * @author   Hiroki Nakamura
098 * @since    JDK1.1,
099 */
100public class TableFilter_ROTATE extends AbstractTableFilter {
101        // * このプログラムのVERSION文字列を設定します。 {@value} */
102        private static final String VERSION = "8.0.0.0 (2021/07/31)" ;
103
104        private DBTableModel    table    ;                      // 5.5.2.6 (2012/05/25) 共通に使うため、変数定義
105        private ResourceManager resource ;                      // 5.5.2.6 (2012/05/25) 共通に使うため、変数定義
106
107        /**
108         * デフォルトコンストラクター
109         *
110         * @og.rev 6.4.1.1 (2016/01/16) keysMap を、サブクラスから設定させるように変更。
111         */
112        public TableFilter_ROTATE() {
113                super();
114                initSet( "KEY_CLM"      , "キーカラム(複数指定可)"                                        );
115                initSet( "ROTATE_CLM"   , "回転するカラム"                                                     );
116                initSet( "VALUE_CLM"    , "回転カラムの値(複数指定可)"                              );
117                initSet( "USE_LABEL"    , "値ラベルのカラムを生成するか(初期値:false)"   );      // 8.0.0.0 (2021/07/31)
118                initSet( "USE_RENDERER" , "値の表示にrenndererを使用するか(初期値:false)" );  // 8.0.0.0 (2021/07/31)
119                initSet( "USE_MARKER"   , "値の表示にviewMarkerを使用するか(初期値:false)" ); // 8.0.0.0 (2021/09/30)
120//              initSet( "REVERSE"              , "回転(false)/逆回転(true) (初期値:false)"     );      // 8.0.0.0 (2021/07/31) 廃止
121                initSet( "MUST_CLM"             , "必須属性を定義するカラム (初期値:false)"    );
122                initSet( "DEF_CLM"              , "初期値を定義するカラム"                                 );
123        }
124
125        /**
126         * DBTableModel処理を実行します。
127         *
128         * @og.rev 4.3.7.4 (2009/07/01) 新規追加
129         * @og.rev 5.5.2.6 (2012/05/25) protected変数を、private化したため、getterメソッドで取得するように変更
130         *
131         * @return 処理結果のDBTableModel
132         */
133        public DBTableModel execute() {
134                table    = getDBTableModel();           // 5.5.2.6 (2012/05/25) インターフェースにgetterメソッド追加
135                resource = getResource();                       // 5.5.2.6 (2012/05/25) インターフェースにgetterメソッド追加
136
137                return getRotateTable();
138        }
139
140        /**
141         * 回転後のDBTableModelを返します。
142         *
143         * @og.rev 5.1.8.0 (2010/07/01) メソッド名変更(setDefValue ⇒ setDefault)
144         * @og.rev 6.4.3.4 (2016/03/11) forループを、forEach メソッドに置き換えます。
145         * @og.rev 8.0.0.0 (2021/07/31) VALUE_CLMの複数指定対応と、USE_LABEL属性の追加
146         *
147         * @return 回転後のDBTableModel
148         */
149        private DBTableModel getRotateTable() {
150                // 8.0.0.0 (2021/07/31) VALUE_CLMの複数指定対応と、USE_LABEL属性の追加
151                // エラー時の原因表示を入れておきます。
152
153                final String tmpKeyClm  = getValue( "KEY_CLM" );
154                final String[] keyClm   = StringUtil.csv2Array( tmpKeyClm );
155                if( keyClm.length == 0 ) { System.out.println( "KEY_CLM is none[" + tmpKeyClm + "]" ); }
156
157                final String tmpRotClm  = getValue( "ROTATE_CLM" );
158                final int rotateNo              = table.getColumnNo( tmpRotClm );               // 8.0.0.0 (2021/09/30) エラーにします。
159
160                final String tmpValClm  = getValue( "VALUE_CLM" );
161                final String[] valClm   = StringUtil.csv2Array( tmpValClm );
162                if( valClm.length == 0 ) { System.out.println( "VALUE_CLM is none[" + tmpValClm + "]" ); }
163
164                int clmCount = 0; // 回転後のカラム数
165                // キーカラムのカラム番号を求め、カラム数としてカウントします。
166                final Map<String, Integer> clmMap = new HashMap<>();
167                final int[] keyNos = new int[keyClm.length];
168                for( int i=0; i<keyNos.length; i++ ) {
169                        keyNos[i] = table.getColumnNo( keyClm[i] );                                     // 8.0.0.0 (2021/09/30) エラーにします。
170                        clmMap.put( keyClm[i], clmCount++ );            // 固定カラム
171                }
172
173                // 8.0.0.0 (2021/07/31) USE_LABEL属性の追加
174                final boolean useValLbl = StringUtil.nval( getValue( "USE_LABEL" ), false );
175                if( useValLbl ) {
176                        clmMap.put( "LABEL", clmCount++ );                      // ラベルカラム
177                }
178
179                final int valStartNo = clmCount ;                               // 値カラム(回転カラム)の開始アドレス
180
181                // 8.0.0.0 (2021/07/31) USE_RENDERER属性の追加
182                final boolean useValRend = StringUtil.nval( getValue( "USE_RENDERER" ), false );
183                // 8.0.0.0 (2021/09/30) USE_MARKER属性の追加
184                final boolean useMarker = StringUtil.nval( getValue( "USE_MARKER" ), false );
185                final ViewMarker viewMarker = useMarker ? getViewMarker() : null;
186
187                // 値カラムのカラム番号を求める。(カラム数としてカウントしない=行が増える)
188                final int[] valNos = new int[valClm.length];
189                final DBColumn[] valClmns = new DBColumn[valClm.length];
190                for( int i=0; i<valNos.length; i++ ) {
191                        valNos[i] = table.getColumnNo( valClm[i] );                                     // 8.0.0.0 (2021/09/30) エラーにします。
192                        if( useValRend ) {
193                                valClmns[i] = table.getDBColumn( valNos[i] );
194                        }
195                }
196
197                int rowCount = 0; // 回転後の行数(KEY_CLMで指定したユニークになる行数で、実際の行数は、VALUE_CLM 倍になる)
198                // 回転カラムの値から回転後のカラム数を求めます。
199                // また同時に、キーカラムの値のブレイク数により行数を求めます。
200                final Map<String, Integer> rowMap               = new HashMap<>();
201                final Map<String, Boolean> mustMap              = new HashMap<>();
202                final Map<String, String>  defaultMap   = new HashMap<>();
203                final int mustNo = table.getColumnNo( getValue( "MUST_CLM"), false );   // 任意なので
204                final int defNo  = table.getColumnNo( getValue( "DEF_CLM" ), false );   // 任意なので
205                for( int i=0; i<table.getRowCount(); i++ ) {
206                        final String clmKey = table.getValue( i, rotateNo );
207                        if( clmMap.get( clmKey ) == null ) {
208                                clmMap.put( clmKey, clmCount++ );                       // 回転カラム
209                        }
210                        // 必須カラム抜き出し
211                        if( mustNo > -1 && StringUtil.nval( table.getValue( i, mustNo ), false ) ) {
212                                mustMap.put( clmKey, true );
213                        }
214                        // デフォルト値を書き換えるカラムの抜き出し
215                        if( defNo > -1 && table.getValue( i, defNo ) != null && table.getValue( i, defNo ).length() > 0 ) {
216                                defaultMap.put( clmKey, table.getValue( i, defNo ) );
217                        }
218
219                        final String rowKey = getSeparatedValue( i, keyNos );
220                        // 6.0.0.1 (2014/04/25) These nested if statements could be combined
221                        if( rowKey != null && rowKey.length() > 0 && rowMap.get( rowKey ) == null ) {
222                                rowMap.put( rowKey, rowCount++ );
223                        }
224                }
225
226                // 回転後のカラム一覧よりDBTableModelを初期化します。
227                // 6.3.9.1 (2015/11/27) Found 'DD'-anomaly for variable(PMD)
228                final String names[] = new String[clmMap.size()];
229                // 6.4.3.4 (2016/03/11) forループを、forEach メソッドに置き換えます。
230                clmMap.forEach( (k,v) -> names[v] = k );
231
232                final DBTableModel nTable = DBTableModelUtil.newDBTable();
233                nTable.init( names.length );
234                for( int i=0; i<names.length; i++ ) {
235                        if( mustMap.get( names[i] ) != null ) {
236                                table.addMustType( i, "must" );
237                        }
238                        DBColumn column = resource.makeDBColumn( names[i] );
239                        // 8.0.0.0 (2021/07/31) オリジナルが数字タイプだと、エラーになる可能性があるため
240                        final DBColumnConfig dbConfig = column.getConfig();                     // 固定カラムより値カラムの方が多いので、処理速度は気にしないことにする。
241                        if( valStartNo <= i ) {                 // 値カラム(回転カラム)
242                                dbConfig.setRenderer( "LABEL" );                                                //
243                        }
244
245                        if( defaultMap.get( names[i] ) != null ) {
246                                dbConfig.setDefault( defaultMap.get( names[i] ) );              // 5.1.8.0 (2010/07/01)
247                        }
248                        column = new DBColumn( dbConfig );                                                      // 8.0.0.0 (2021/07/31)
249                        nTable.setDBColumn( i, column );                                                        // 5.1.8.0 (2010/07/01)
250                }
251
252                // 値の一覧を作成し、DBTableModelに値をセットします。
253                if( rowCount > 0 ) {
254                        // 6.3.9.1 (2015/11/27) Found 'DD'-anomaly for variable(PMD)
255                        final String[][] vals = new String[rowCount*valClm.length][names.length];       // 行数は、valClm.length 倍になる
256                        for( int i=0; i<table.getRowCount(); i++ ) {
257                                final int row = rowMap.get( getSeparatedValue( i, keyNos ) );
258                                final int clm = clmMap.get( table.getValue( i, rotateNo ) );
259
260                                final int nrow = row * valClm.length ;
261                                // 8.0.0.0 (2021/07/31) VALUE_CLM が複数存在した場合の処理
262                                for( int k=0; k<valNos.length; k++ ) {
263                                        for( int j=0; j<keyNos.length; j++ ) {
264                                                vals[nrow+k][j] = table.getValue( i, keyNos[j] );
265                                        }
266                                        if( useValLbl ) {
267                                                // 実際は、上のループの最後の j ( = keyNos.length )
268                                                vals[nrow+k][keyNos.length] = table.getColumnLabel( valNos[k] );
269                                        }
270
271                                        String val = table.getValue( i, valNos[k] );
272                                        if( useValRend ) { val = valClmns[k].getRendererValue( val ); }         // Rndererを使用
273                                        if( viewMarker != null ) {
274                                                val = viewMarker.getMarkerString( i,valNos[k],val );                    // ViewMarkerを使用
275                                        }
276                                        vals[nrow+k][clm] = val;
277                                }
278                        }
279                        for( int i=0; i<vals.length; i++ ) {
280                                nTable.addColumnValues( vals[i] );
281                        }
282                }
283
284                return nTable;
285        }
286
287        /**
288         * 各行のキーとなるキーカラムの値を連結した値を返します。
289         *
290         * @param       row             行番号
291         * @param       clmNo   カラム番号配列(可変長引数)
292         *
293         * @return      各行のキーとなるキーカラムの値を連結した値
294         * @og.rtnNotNull
295         */
296        private String getSeparatedValue( final int row, final int... clmNo ) {
297                final StringBuilder buf = new StringBuilder( BUFFER_MIDDLE );
298                for( int i=0; i<clmNo.length; i++ ) {
299                        final String val = table.getValue( row, clmNo[i] );
300                        if( val != null && val.length() > 0 ) {
301                                if( i > 0 ) {
302                                        buf.append( "__" );
303                                }
304                                buf.append( val );
305                        }
306                }
307                return buf.toString();
308        }
309}