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 org.opengion.fukurou.util.StringUtil;
019import org.opengion.hayabusa.db.AbstractTableFilter;
020import org.opengion.hayabusa.db.DBColumn;
021import org.opengion.hayabusa.db.DBTableModel;
022import org.opengion.hayabusa.db.DBTableModelUtil;
023import org.opengion.hayabusa.resource.ResourceManager;
024
025import static org.opengion.plugin.table.StandardDeviation.ADD_CLMS;
026
027/**
028 * TableFilter_STDDEV2 は、TableFilter インターフェースを継承した、DBTableModel 処理用の
029 * 実装クラスです。
030 * 標準偏差等の対象カラムは、横持で、CLMNO属性で指定したカラム以降に指定します。
031 * よって、対象カラム以降に、自由にカラムを配置することはできません。
032 *
033 * 横持のカラムを、縦に再セットします。その際、キーワードを、CLMNAME で指定のカラムに
034 * セットします。CLMNAME のカラムは、予め、DBTableModel に用意しておいてください。
035 * CLMNO が未指定の場合は、CLMNAMEの次からと認識されます。
036 *
037 * ここではグループ単位に、平均、標準偏差等を求め、データの分布を示すデータを作成します。
038 * グループキーとなるカラムは、あらかじめソーティングしておく必要があります。(キーブレイク判断するため)
039 * グループキー以外の値は、参考情報として残し、CLMS属性に指定したカラムを削除し、カラムの最後に、
040 * CNT,SUM,AVG,(STDEVS or STDEVP),COEFF,M3S,M2S,M1S,M0S,P0S,P1S,P2S,P3S カラムを追加します。
041 *
042 * CNT(個数),SUM(合計),AVG(平均),
043 * STDEVS(標本標準偏差:n-1) または、STDEVP(母標準偏差:n) を、USE_TYPE で選択します。
044 * COEFF(変動係数) は、標準偏差(σ)を算術平均で、割ったものの百分率
045 * M3S(~-3σ),M2S(-3σ~-2σ),M1S(-2σ~-σ),M0S(-σ~0),P0S(0~σ),P1S(σ~2σ),P2S(2σ~3σ),P3S(3σ~)
046 * FILTERは、1:(-2σ~-σ or σ~2σ) , 2:(-3σ~-2σ or 2σ~3σ) , 3:(~-3σ or 3σ~) のみピックアップします。
047 * 初期値の 0 は、フィルターなしです。
048 *
049 * 6.9.9.2 (2018/09/18)
050 *   COEFF(変動係数)の最小値でフィルターするためのキーワード MIN_CV を追加します。
051 *   これは、単位(%)で、指定の値以下の変動係数のレコードを出力しません。
052 *
053 * パラメータは、tableFilterタグの keys, vals にそれぞれ記述するか、BODY 部にCSS形式で記述します。
054 * 【パラメータ】
055 *  {
056 *       GROUP_KEY  : グループカラム          (複数指定可)
057 *       CLMNAME    : 縦持キーとなるカラム名  (必須)
058 *       CLMNO      : 対象カラムの最初の番号
059 *       USE_TYPE   : P(母) or S(標本)        (初期値:P(母標準偏差))
060 *       FORMAT     : 数値のフォーマット      (初期値:%.3f ・・・ 小数第3位以下を、四捨五入する)
061 *       FILTER     : 1 , 2 , 3               (初期値:0)
062 *       MIN_CV     : 変動係数の最小除外値(%指定)  例:2.0
063 *  }
064 *
065 * @og.formSample
066 * ●形式:
067 *      ① <og:tableFilter classId="STDDEV2" selectedAll="true"
068 *                   keys="GROUP_KEY,CLMNO" vals='"GOKI,SID",7' />
069 *
070 *      ② <og:tableFilter classId="STDDEV2"  selectedAll="true" >
071 *               {
072 *                   GROUP_KEY : GOKI,SID ;
073 *                   CLMNO     : 7 ;
074 *               }
075 *         </og:tableFilter>
076 *
077 * @og.rev 6.7.1.0 (2017/01/05) 新規追加
078 * @og.rev 6.9.3.0 (2018/03/26) 標本標準偏差と母標準偏差は、一つだけにし、変動係数を追加します。
079 *
080 * @version  0.9.0  2000/10/17
081 * @author   Hiroki Nakamura
082 * @since    JDK1.1,
083 */
084public class TableFilter_STDDEV2 extends AbstractTableFilter {
085        // * このプログラムのVERSION文字列を設定します。 {@value} */
086        private static final String VERSION = "6.9.9.2 (2018/09/18)" ;
087
088        private DBTableModel    table   ;
089
090        /**
091         * デフォルトコンストラクター
092         *
093         * @og.rev 6.9.9.2 (2018/09/18) COEFF(変動係数)の最小値でフィルターするためのキーワード MIN_CV を追加。
094         */
095        public TableFilter_STDDEV2() {
096                super();
097                initSet( "GROUP_KEY"    , "グループカラム           (複数指定可)"           );
098                initSet( "CLMNAME"              , "縦持キーとなるカラム名   (必須)"                          );
099                initSet( "CLMNO"                , "対象カラムの最初の番号"                                         );
100                initSet( "USE_TYPE"             , "P(母) or S(標本)         (初期値:P)"                       );
101                initSet( "FORMAT"               , "数値のフォーマット       (初期値:%.3f ・・・ 小数代3位以下を、四捨五入する)"      );
102                initSet( "FILTER"               , "1 , 2 , 3                (初期値:0)"                    );
103                initSet( "MIN_CV"               , "変動係数の最小除外値(%)"                                               );              // 6.9.9.2 (2018/09/18)
104        }
105
106        /**
107         * DBTableModel処理を実行します。
108         *
109         * @og.rev 6.7.2.0 (2017/01/16) FILTERパラメータ追加。
110         * @og.rev 6.9.9.2 (2018/09/18) COEFF(変動係数)の最小値でフィルターするためのキーワード MIN_CV を追加。
111         *
112         * @return 処理結果のDBTableModel
113         */
114        public DBTableModel execute() {
115                table   = getDBTableModel();
116                final ResourceManager   resource = getResource();
117
118                final String[]  grpClm  = StringUtil.csv2Array( getValue( "GROUP_KEY" ) );
119                final String    devType = getValue( "USE_TYPE" );
120                final String    fmt             = getValue( "FORMAT" );
121                final int               ftype   = StringUtil.nval( getValue( "FILTER" ) , 0 );                  // 6.7.2.0 (2017/01/16)
122                final String    clmName = getValue( "CLMNAME" );
123                final int               nameNo  = table.getColumnNo( clmName );                                                 // 必須なので、無ければ、エラーにします。
124                final int               minNo   = StringUtil.nval( getValue( "CLMNO" ) , nameNo+1 );    // CLMNOが未指定の場合は、CLMNAME の次のカラムになります。
125                final String    minCV   = getValue( "MIN_CV" );                                                                 // 6.9.9.2 (2018/09/18)
126
127                final boolean   useDEVP = devType == null || devType.isEmpty() || "P".equals( devType ) ;       // 初期値が、"P" (母標準偏差)
128                final String    format  = fmt == null || fmt.isEmpty() ? "%.3f" : fmt ;                                         // 初期値が、"%.3f"
129
130                // グループカラムのカラム番号を求めます。
131                final int[] grpNos = new int[grpClm.length];
132                for( int i=0; i<grpNos.length; i++ ) {
133                        grpNos[i] = table.getColumnNo( grpClm[i] );                     // 無ければ、エラーにします。
134                }
135
136                final DBColumn[] orgClms = table.getDBColumns() ;               // 検索時のオリジナルのカラム
137
138                // 計算対象のカラムのカラム番号を求めます。
139                final int nSize = orgClms.length - minNo;                               // 全体カラム数から、対象カラム番号を引けば、残りが対象カラム数
140                final StandardDeviation[] stdDevs = new StandardDeviation[nSize];               // 追加カラム分
141                for( int i=0; i<nSize; i++ ) {
142//                      stdDevs[i] = new StandardDeviation( ftype,useDEVP,format );
143                        stdDevs[i] = new StandardDeviation( ftype,useDEVP,format,minCV );       // 6.9.9.2 (2018/09/18)
144                }
145
146                // 元のカラムの最小番号以降を、統計カラムに差し替えます。
147                final int ADD_CLM_LEN = ADD_CLMS.length;
148                final String names[] = new String[minNo + ADD_CLM_LEN];
149
150                final DBTableModel nTable = DBTableModelUtil.newDBTable();
151                nTable.init( names.length );
152                int no = 0;
153                for( ; no<minNo; no++ ) {
154                        nTable.setDBColumn( no, orgClms[no] );                          // 0 ~ minNo まで、順番にセット
155                }
156                for( int j=0; j<ADD_CLM_LEN; j++ ) {
157                        nTable.setDBColumn( no++, resource.makeDBColumn( ADD_CLMS[j] ) );
158                }
159
160                final int ROW_CNT = table.getRowCount();
161                String bkKey = getSeparatedValue( 0, grpNos );                  // ブレイクキー
162                String[] old = table.getValues( 0 );
163
164                // 後で、row==0で統合する。
165                for( int j=0; j<nSize; j++ ) {
166                        stdDevs[j].addData( old[j+minNo] );                                     // 集計対象カラム
167                }
168
169                // 1回目は初期設定しておく(row=1)。最後はキーブレイクしないので、1回余分に回す(row<=ROW_CNT)。
170                for( int row=1; row<=ROW_CNT; row++ ) {
171                        final String rowKey = row==ROW_CNT ? "" : getSeparatedValue( row, grpNos );     // 余分なループ時にブレイクさせる。
172                        if( bkKey.equals( rowKey ) ) {                                  // 前と同じ(継続)
173                                old = table.getValues( row );
174                                for( int j=0; j<nSize; j++ ) {
175                                        stdDevs[j].addData( old[j+minNo] );             // 集計対象カラム
176                                }
177                        }
178                        else {                                                                                  // キーブレイク
179                                for( int j=0; j<nSize; j++ ) {
180                                        final String[] rtnVals = stdDevs[j].getData();
181
182                                        if( rtnVals != null ) {                                 // 値が戻ってきた場合のみ、テーブルに追加します。
183                                                final String vals[] = new String[names.length];
184                                                no = 0;
185                                                for( ; no<minNo; no++ ) {
186                                                        vals[no] = old[no];
187                                                }
188                                                for( int k=0; k<ADD_CLM_LEN; k++ ) {
189                                                        vals[no++] = rtnVals[k];
190                                                }
191
192                                                vals[nameNo] = orgClms[j+minNo].getName();              // nameNo のカラムを置き換えます。
193
194                                                nTable.addColumnValues( vals );
195                                        }
196                                        stdDevs[j].clear();                                             // データを取り出した後、初期化します。
197                                }
198
199                                if( row==ROW_CNT ) { break; }                           // 最後のデータは強制終了
200
201                                old = table.getValues( row );
202                                for( int j=0; j<nSize; j++ ) {
203                                        stdDevs[j].addData( old[j+minNo] );             // 集計対象カラム
204                                }
205                                bkKey = rowKey;
206                        }
207                }
208
209                return nTable;
210        }
211
212        /**
213         * 各行のキーとなるキーカラムの値を連結した値を返します。
214         *
215         * @param       row             行番号
216         * @param       clmNo   カラム番号配列
217         *
218         * @return      各行のキーとなるキーカラムの値を連結した値
219         * @og.rtnNotNull
220         */
221        private String getSeparatedValue( final int row, final int[] clmNo ) {
222                final StringBuilder buf = new StringBuilder( BUFFER_MIDDLE );
223                for( int i=0; i<clmNo.length; i++ ) {
224                        if( clmNo[i] >= 0 ) {
225                                final String val = table.getValue( row, clmNo[i] );
226                                if( val != null && val.length() > 0 ) {
227                                        buf.append( val ).append( '_' );
228                                }
229                        }
230                }
231                return buf.toString();
232        }
233}