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.Locale;
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;
025
026/**
027 * TableFilter_UPPER は、TableFilter インターフェースを継承した、DBTableModel 処理用の
028 * 実装クラスです。
029 *
030 * ここでは、指定の カラム(KEY_CLMS) に対して、データを大文字化します。
031 * カラムは、CSV形式で指定する事とし、DBTableModel に指定のカラムがなければ無視します。
032 *
033 * パラメータは、tableFilterタグの keys, vals にそれぞれ記述するか、BODY 部にCSS形式で記述します。
034 * 【パラメータ】
035 *  {
036 *       KEY_CLMS : AA,BB,CC ;    データを大文字化したいカラム名を、CSV形式で指定します。
037 *  }
038 *
039 * @og.formSample
040 * ●形式:
041 *      ① <og:tableFilter classId="UPPER" keys="KEY_CLMS" vals='"TABLE_NAME,CLM"' />
042 *
043 *      ② <og:tableFilter classId="UPPER" >
044 *               {
045 *                   KEY_CLMS : TABLE_NAME,CLM ;
046 *               }
047 *         </og:tableFilter>
048 *
049 * @og.rev 5.5.5.0 (2012/07/28) 新規追加
050 * @og.rev 5.6.6.0 (2013/07/05) keys の整合性チェックを追加
051 *
052 * @version  0.9.0  2000/10/17
053 * @author   Kazuhiko Hasegawa
054 * @since    JDK1.1,
055 */
056public class TableFilter_UPPER extends AbstractTableFilter {
057        /** このプログラムのVERSION文字列を設定します。   {@value} */
058        private static final String VERSION = "6.5.0.1 (2016/10/21)" ;
059
060        /**
061         * デフォルトコンストラクター
062         *
063         * @og.rev 6.4.1.1 (2016/01/16) keysMap を、サブクラスから設定させるように変更。
064         */
065        public TableFilter_UPPER() {
066                super();
067                initSet( "KEY_CLMS"  , "大文字化したいカラム名を、CSV形式で指定"  );
068        }
069
070        /**
071         * DBTableModel処理を実行します。
072         *
073         * @og.rev 6.5.0.1 (2016/10/21) ErrorMessage をまとめるのと、直接 Throwable を渡します。
074         *
075         * @return 処理結果のDBTableModel
076         */
077        public DBTableModel execute() {
078                // 6.3.9.1 (2015/11/27) A method should have only one exit point, and that should be the last statement in the method.(PMD)
079                final DBTableModel table = getDBTableModel();           // 5.5.2.6 (2012/05/25) インターフェースにgetterメソッド追加
080
081                final String[] keyClms = StringUtil.csv2Array( getValue( "KEY_CLMS" ) );
082                if( keyClms != null && keyClms.length > 0 ) {
083                        final int[] keyNos = new int[keyClms.length];
084                        int lastNo = 0;
085                        for( int i=0; i<keyNos.length; i++ ) {
086                                final int no = table.getColumnNo( keyClms[i], false );  // 存在しない場合は、-1 を返す。
087                                if( no >=0 ) { keyNos[lastNo++] = no; }                                 // -1 でなければ、keyNos に設定する。(前づめ)
088                        }
089                        if( lastNo > 0 ) {
090                                final int rowCnt = table.getRowCount();
091                                for( int row=0; row<rowCnt; row++ ) {
092                                        try {
093                                                for( int j=0; j<lastNo; j++ ) {
094                                                        final int col = keyNos[j];
095                                                        String val = table.getValue( row,col );
096                                                        if( val != null ) {
097                                                                val = val.toUpperCase( Locale.JAPAN );
098                                                                table.setValueAt( val,row,col );
099                                                        }
100                                                }
101                                        }
102                                        catch( final RuntimeException ex ) {
103                                                // 6.5.0.1 (2016/10/21) ErrorMessage をまとめるのと、直接 Throwable を渡します。
104                                                makeErrorMessage( "TableFilter_UPPER Error",ErrorMessage.NG )
105                                                        .addMessage( row+1,ErrorMessage.NG,"UPPER"
106                                                                , "KEY_CLMS=[" + StringUtil.array2csv( keyClms ) + "]" )
107                                                        .addMessage( ex );
108                                        }
109                                }
110                        }
111                }
112                return table;
113        }
114}