    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.Calendar;                                                                      // 7.0.1.3 (2018/11/12)
    019
    020import org.opengion.hayabusa.db.AbstractTableFilter;
    021import org.opengion.hayabusa.db.DBTableModel;
    022
    023import org.opengion.fukurou.util.ErrorMessage;
    024import org.opengion.fukurou.util.StringUtil;
    025import org.opengion.fukurou.util.HybsDateUtil;                          // 7.0.1.3 (2018/11/12)
    026import org.opengion.fukurou.system.DateSet;                                     // 7.0.1.3 (2018/11/12)
    027
    028/**
    029 * TableFilter_KEY_BREAK は、TableFilter インターフェースを継承した、DBTableModel 処理用の
    030 * 実装クラスです。
    031 *
    032 * ここでは、指定のカラムに対して、キーブレイクが発生したときのデータ処理方法を指定できます。
    033 * 主として、グルーピング処理を行うのですが、ソートされデータの並び順で、キーブレイクするため、
    034 * 同一キーが存在していても、並び順が離れている場合、別のキーとしてブレイクします。
    035 *
    036 * GROUP_KEY  : キーブレイクの判定を行うカラムを、CSV形式で設定します。
    037 * OUT_TYPE   : 出力するデータのタイプを指定します。
    038 *                first : 最初のデータ(ブレイク直後のデータ)を出力します。(初期値)
    039 *                last  : 最後のデータ(ブレイク直前のデータ)を出力します。
    040 *                range : 最初のデータと最後のデータを出力します。
    041 *
    042 * firstは、キーブレイク時のデータを残します。つまり、キーの最初に現れたデータです。
    043 * lastは、キーブレイクの直前のデータを残します。これは、同一キーの最後のデータということになります。
    044 * rangeは、firstと、last つまり、同値キーの最初と最後のデータを残します。
    045 *
    046 * もし、キーが、1行だけの場合、firstも、lastも、同じ行を指すことになります。
    047 * その場合、rangeは、その1行だけになります(2行出力されません)。
    048 *
    049 * 例：機種と日付と、状況Fがあったとして、日付、機種、状況F でソートし、機種をグループキー、
    050 * 状況Fをブレイクキーとすれば、日付の順に、機種の中で、状況Fがブレークしたときのみ、
    051 * データを残す、ということが可能になります。7.0.0.1 (2018/10/09) Delete
    052 *
    053 * OUT_TYPE に、lastか、range を指定した場合のみ、最大、最小、平均、中間、個数の集計処理が行えます。
    054 * これらの設定は、指定のカラムのデータに反映されます。
    055 * MIN_CLM  : キーブレイク時に、指定のカラムの最小値をデータに書き込みます。
    056 * MAX_CLM  : キーブレイク時に、指定のカラムの最大値をデータに書き込みます。
    057 * AVG_CLM  : キーブレイク時に、指定のカラムの平均値をデータに書き込みます。
    058 * MID_CLM  : キーブレイク時に、指定のカラムの最小値と最大値の中間の値をデータに書き込みます。
    059 * CNT_CLM  : キーブレイク時に、指定のカラムのデータ件数をデータに書き込みます。
    060 *
    061 * これらのカラムの値は、数値で表現できるもので無ければなりません。
    062 * 例えば、20180101000000 のような、日付でも数字のみなら、OKです。
    063 *
    064 * パラメータは、tableFilterタグの keys, vals にそれぞれ記述するか、BODY 部にCSS形式で記述します。
    065 *
    066 * @og.formSample
    067 * ●形式：
    068 *              ① &lt;og:tableFilter classId="KEY_BREAK"
    069 *                              keys="GROUP_KEY,OUT_TYPE"
    070 *                              vals='"CLM5,CLM6....",first' /&gt;
    071 *
    072 *              ② &lt;og:tableFilter classId="KEY_BREAK" &gt;
    073 *                               {
    074 *                                       GROUP_KEY  : CLM5,CLM6....     ;
    075 *                                       OUT_TYPE : first                       ;
    076 *                               }
    077 *                 &lt;/og:tableFilter&gt;
    078 *
    079 * @og.rev 6.7.9.1 (2017/05/19) 新規追加
    080 * @og.rev 7.0.0.1 (2018/10/09) ｸﾞﾙｰﾌﾟで、まとめる処理を止めます。
    081 * @og.rev 7.0.1.1 (2018/10/22) ﾛｼﾞｯｸ見直し
    082 *
    083 * @version  6.7  2017/05/19
    084 * @author   Kazuhiko Hasegawa
    085 * @since    JDK1.8,
    086 */
    087public class TableFilter_KEY_BREAK extends AbstractTableFilter {
    088        /** このプログラムのVERSION文字列を設定します。   {@value} */
    089        private static final String VERSION = "7.0.1.3 (2018/11/12)" ;
    090
    091        /**
    092         * デフォルトコンストラクター
    093         *
    094         * @og.rev 6.7.9.1 (2017/05/19) 新規追加
    095         * @og.rev 7.0.0.1 (2018/10/09) 最小,最大,平均,件数 を集計するためのｷｰﾜｰﾄﾞ追加
    096         * @og.rev 7.0.1.3 (2018/11/12) MID_CLM(最小値と最大値の中間の値)のｷｰﾜｰﾄﾞ追加
    097         */
    098        public TableFilter_KEY_BREAK() {
    099                super();
    100                initSet( "GROUP_KEY"    , "キーブレイクの判定を行うカラムを、CSV形式で設定します。" );
    101                initSet( "OUT_TYPE"     , "出力するデータのタイプを指定[first/last/range]を指定します。(初期値:first 最初のデータ)"   );
    102                initSet( "MIN_CLM"      , "キーブレイク時に、指定のカラムの最小値をデータに書き込みます。"     );
    103                initSet( "MAX_CLM"      , "キーブレイク時に、指定のカラムの最大値をデータに書き込みます。"     );
    104                initSet( "AVG_CLM"      , "キーブレイク時に、指定のカラムの平均値をデータに書き込みます。"     );
    105                initSet( "MID_CLM"      , "キーブレイク時に、指定のカラムの最小値と最大値の中間の値をデータに書き込みます。"    );
    106                initSet( "CNT_CLM"      , "キーブレイク時に、指定のカラムのデータ件数をデータに書き込みます。"   );
    107        }
    108
    109        /**
    110         * DBTableModel処理を実行します。
    111         *
    112         * @og.rev 6.7.9.1 (2017/05/19) 新規追加
    113         * @og.rev 7.0.0.1 (2018/10/09) 最小,最大,平均,件数 を集計するためのｷｰﾜｰﾄﾞ追加
    114         * @og.rev 7.0.1.1 (2018/10/22) ﾛｼﾞｯｸ見直し
    115         * @og.rev 7.0.1.3 (2018/11/12) MID_CLM(最小値と最大値の中間の値)のｷｰﾜｰﾄﾞ追加
    116         *
    117         * @return 処理結果のDBTableModel
    118         */
    119        public DBTableModel execute() {
    120                final DBTableModel table  = getDBTableModel();
    121                final DBTableModel rtnTbl = table.newModel();                           // 削除ではなく、追加していきます。
    122                final int rowCnt = table.getRowCount();
    123                if( rowCnt == 0 ) { return rtnTbl; }                                            // 7.0.1.3 (2018/11/12) row<=rowCnt を追加したので、0件なら即終了
    124
    125                final String[]  brkClms = StringUtil.csv2Array( getValue( "GROUP_KEY" ) );
    126
    127                // 7.0.0.1 (2018/10/09) 最小,最大,平均,件数 を集計するためのｷｰﾜｰﾄﾞ追加
    128                final String    outType = StringUtil.nval( getValue( "OUT_TYPE"  ), "first" ) ;
    129
    130                final boolean   useFirst = "first".equalsIgnoreCase( outType ) || "range".equalsIgnoreCase( outType );  // firstかrange時に使用
    131                final boolean   useLast  = "last".equalsIgnoreCase( outType )  || "range".equalsIgnoreCase( outType ) ; // lastかrange 時に使用
    132
    133                // 7.0.0.1 (2018/10/09) 最小,最大,平均,件数 を集計するためのｷｰﾜｰﾄﾞ追加(useLast=true のときのみ使用)
    134                final int       minClmNo = table.getColumnNo( getValue( "MIN_CLM"  ), false ) ; // カラムが存在しなければ、-1
    135                final int       maxClmNo = table.getColumnNo( getValue( "MAX_CLM"  ), false ) ; // カラムが存在しなければ、-1
    136                final int       avgClmNo = table.getColumnNo( getValue( "AVG_CLM"  ), false ) ; // カラムが存在しなければ、-1
    137                final int       midClmNo = table.getColumnNo( getValue( "MID_CLM"  ), false ) ; // 7.0.1.3 (2018/11/12) カラムが存在しなければ、-1
    138                final int       cntClmNo = table.getColumnNo( getValue( "CNT_CLM"  ), false ) ; // カラムが存在しなければ、-1
    139
    140                final int[]    brkClmNo = new int[brkClms.length];                      // ブレイクキーカラムの番号
    141
    142                for( int i=0; i<brkClms.length; i++ ) {
    143                        brkClmNo[i] = table.getColumnNo( brkClms[i],false );    // カラムが存在しなければ、-1
    144                }
    145
    146                // 7.0.0.1 (2018/10/09) 最小,最大,平均,件数 を集計するためのｷｰﾜｰﾄﾞ追加(useLast=true のときのみ使用)
    147                double  minData  = Double.POSITIVE_INFINITY ;           // 仮数部の桁数の限界は15桁なので、日付型(14桁)は、処理できる。
    148                double  maxData  = Double.NEGATIVE_INFINITY ;
    149                double  total    = 0.0 ;
    150                int             cntData  = 0 ;          //
    151                boolean isLong   = true;        // データに、少数点以下をつけるかどうかの判定です。
    152                double  midMin   = Double.POSITIVE_INFINITY ;
    153                double  midMax   = Double.NEGATIVE_INFINITY ;
    154
    155                String oldBlkKeys = null;       // 前回ブレイクキーの値
    156
    157//              final int rowCnt = table.getRowCount();
    158
    159                String[] oldData = null;
    160                // 7.0.1.3 (2018/11/12) 最後のデータの処理を行うために、row<=rowCnt と1回余計に回します。
    161                for( int row=0; row<=rowCnt; row++ ) {
    162                        final String[] data = row == rowCnt ? null : table.getValues( row );            // row<=rowCnt の影響
    163                        try {
    164                                final String brkKeys = getKeys( brkClmNo , data );              // ブレークキー(data==nullの場合、ゼロ文字列)
    165                                if( !brkKeys.equalsIgnoreCase( oldBlkKeys ) ) {                 // キーブレイク
    166                                        if( row>0 ) {
    167                                                if( minClmNo >= 0 ) { oldData[minClmNo] = isLong ? String.valueOf( Math.round( minData ) ) : String.valueOf( minData ) ; }
    168                                                if( maxClmNo >= 0 ) { oldData[maxClmNo] = isLong ? String.valueOf( Math.round( maxData ) ) : String.valueOf( maxData ) ; }
    169                                                if( avgClmNo >= 0 ) { oldData[avgClmNo] = String.format( "%.3f", total/cntData ); }
    170                                                if( midClmNo >= 0 ) { oldData[midClmNo] = getMiddle( midMin,midMax ); }
    171                                                if( cntClmNo >= 0 ) { oldData[cntClmNo] = String.valueOf( cntData ); }
    172
    173                                                minData = Double.POSITIVE_INFINITY  ;
    174                                                maxData = Double.NEGATIVE_INFINITY  ;
    175                                                total   = 0.0 ;
    176                                                midMin  = Double.POSITIVE_INFINITY  ;
    177                                                midMax  = Double.NEGATIVE_INFINITY  ;
    178
    179                                                if( useLast ) {
    180                                                        // useFirst=true で、cntData == 1 の場合は、First行は削除します(1件を2件に増やさない)。
    181                                                        if( useFirst ) {
    182                                                                final int rCnt = rtnTbl.getRowCount();
    183                                                                if( cntData == 1 ) {                                            // 1行しかない場合は、First行は削除します(1件を2件に増やさない)
    184                                                                        rtnTbl.removeValue( rCnt-1 );
    185                                                                }
    186                                                                else {
    187                                                                        final String[] fstData = rtnTbl.getValues( rCnt-1 );    // 前のデータ=First行に、最大、最小等のデータを反映させます。
    188                                                                        if( minClmNo >= 0 ) { fstData[minClmNo] = oldData[minClmNo]; }
    189                                                                        if( maxClmNo >= 0 ) { fstData[maxClmNo] = oldData[maxClmNo]; }
    190                                                                        if( avgClmNo >= 0 ) { fstData[avgClmNo] = oldData[avgClmNo]; }
    191                                                                        if( midClmNo >= 0 ) { fstData[midClmNo] = oldData[midClmNo]; }
    192                                                                        if( cntClmNo >= 0 ) { fstData[cntClmNo] = oldData[cntClmNo]; }
    193                                                                }
    194                                                        }
    195
    196                                                        rtnTbl.addColumnValues( oldData );                      // ブレイクした一つ前＝最後のデータ
    197                                                }
    198                                                if( row == rowCnt ) { break; }                                  // 最後のデータの処理を行うために、row<=rowCnt と1回余計に回します。
    199                                        }
    200
    201                                        if( useFirst ) {                                                                        // useLast=true で、cntData == 1 の場合は、登録しません
    202                                                rtnTbl.addColumnValues( data );                                 // ブレイク時のデータを登録します。
    203                                        }
    204
    205                                        oldBlkKeys = brkKeys;
    206                                        cntData    = 0 ;
    207                                }
    208                                oldData = data;                                                                                 // 一つ前のデータ
    209                                cntData++;                              // 毎回、カラムのある無しを判定するより、早そうなので常にカウントしておきます。
    210
    211                                // ブレイク時も集計処理は行います。
    212//                              if( useLast ) {
    213                                        if( minClmNo >= 0 && !StringUtil.isNull( data[minClmNo] ) ) {
    214                                                if( isLong && data[minClmNo].indexOf( '.' ) >= 0 ) { isLong = false; }                  // 一度、false になると、戻らない。
    215                                                minData = Math.min( minData, Double.parseDouble( data[minClmNo] ) );
    216                                        }
    217                                        if( maxClmNo >= 0 && !StringUtil.isNull( data[maxClmNo] ) ) {
    218                                                if( isLong && data[maxClmNo].indexOf( '.' ) >= 0 ) { isLong = false; }                  // 一度、false になると、戻らない。
    219                                                maxData = Math.max( maxData, Double.parseDouble( data[maxClmNo] ) );
    220                                        }
    221                                        if( avgClmNo >= 0 && !StringUtil.isNull( data[avgClmNo] ) ) {
    222                                                total += Double.parseDouble( data[avgClmNo] );
    223                                        }
    224                                        if( midClmNo >= 0 && !StringUtil.isNull( data[midClmNo] ) ) {
    225                                                final double mid = Double.parseDouble( data[midClmNo] );
    226                                                midMin = Math.min( midMin, mid );
    227                                                midMax = Math.max( midMax, mid );
    228                                        }
    229//                              }
    230                        }
    231                        catch( final RuntimeException ex ) {    // そのまま、継続して処理を行う。
    232                                // 6.5.0.1 (2016/10/21) ErrorMessage をまとめるのと、直接 Throwable を渡します。
    233                                makeErrorMessage( "TableFilter_KEY_BREAK Error",ErrorMessage.NG )
    234                                        .addMessage( row+1,ErrorMessage.NG,"KEY_BREAK" , StringUtil.array2csv( data ) )
    235                                        .addMessage( ex );
    236                        }
    237                }
    238//              // 一番最後に書込みが行われないので。
    239//              if( useLast ) {
    240//                      if( minClmNo >= 0 ) { oldData[minClmNo] = isLong ? String.valueOf( Math.round( minData ) ) : String.valueOf( minData ) ; }
    241//                      if( maxClmNo >= 0 ) { oldData[maxClmNo] = isLong ? String.valueOf( Math.round( maxData ) ) : String.valueOf( maxData ) ; }
    242//                      if( avgClmNo >= 0 ) { oldData[avgClmNo] = String.format( "%.3f", total/cntData ); }
    243//                      if( midClmNo >= 0 ) { oldData[midClmNo] = getMiddle( midMin,midMax ); }
    244//                      if( cntClmNo >= 0 ) { oldData[cntClmNo] = String.valueOf( cntData ); }
    245//
    246//                      rtnTbl.addColumnValues( oldData );
    247//              }
    248
    249                return rtnTbl;
    250        }
    251
    252        /**
    253         * 最小値と最大値の中間の値の文字列を作成します。
    254         *
    255         * 特殊系で、8桁か、14桁の場合、日付文字として中間の日付を求めます。
    256         *
    257         * @og.rev 7.0.1.3 (2018/11/12) MID_CLM(最小値と最大値の中間の値)のｷｰﾜｰﾄﾞ追加
    258         *
    259         * @param min 最小値
    260         * @param max 最大値
    261         * @return 中間の値の文字列
    262         */
    263        private String getMiddle( final double min , final double max ) {
    264                final String minStr = String.valueOf( Math.round( min ) );              // 14桁の場合、2.0181103000000E13 見たいな表記になるため。
    265                final String maxStr = String.valueOf( Math.round( max ) );
    266                final int minLen = minStr.length();
    267
    268                final String midStr ;
    269                if( minLen == maxStr.length() && ( minLen == 8 || minLen == 14 ) ) {
    270                        final Calendar minCal = HybsDateUtil.getCalendar( minStr );
    271                        final Calendar maxCal = HybsDateUtil.getCalendar( maxStr );
    272                        final long     midTim = ( maxCal.getTimeInMillis() + minCal.getTimeInMillis() ) / 2 ;
    273
    274                        if( minLen == 8 ) {
    275                                midStr = DateSet.getDate( midTim , "yyyyMMdd" );
    276                        }
    277                        else {  // 14桁しかありえない
    278                                midStr = DateSet.getDate( midTim , "yyyyMMddHHmmss" );
    279                        }
    280                }
    281                else {
    282                        midStr = String.format( "%.3f", ( max + min ) / 2.0 );          // 日付型でなければ、minStr,maxStr は使わないので。
    283                }
    284
    285                return midStr;
    286        }
    287
    288        /**
    289         * キーの配列ｱﾄﾞﾚｽと、１行分のデータ配列から、キーとなる文字列を作成します。
    290         *
    291         * @og.rev 6.7.9.1 (2017/05/19) 新規追加
    292         * @og.rev 7.0.1.3 (2018/11/12) 最後のデータの処理を行うために、row<=rowCnt と1回余計に回す対応
    293         *
    294         * @param clms キーの配列ｱﾄﾞﾚｽ
    295         * @param rowData １行分のデータ配列
    296         * @return キーとなる文字列
    297         */
    298        private String getKeys( final int[] clms , final String[] rowData ) {
    299                if( rowData == null ) { return ""; }                                    // rowData がnull の場合は、キーブレイクとなる
    300
    301                final StringBuilder buf = new StringBuilder();
    302                for( int i=0; i<clms.length; i++ ) {
    303                        if( clms[i] >= 0 ) {
    304                                buf.append( rowData[clms[i]] ).append( ':' );
    305                        }
    306                }
    307                return buf.toString();
    308        }
    309}