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;
019import java.util.Map;
020
021import org.opengion.hayabusa.db.AbstractTableFilter;
022import org.opengion.hayabusa.db.DBTableModel;
023
024import org.opengion.fukurou.util.ErrorMessage;
025import org.opengion.fukurou.util.StringUtil;
026
027/**
028 * TableFilter_UPPER は、TableFilter インターフェースを継承した、DBTableModel 処理用の
029 * 実装クラスです。
030 *
031 * ここでは、指定の カラム(KEY_CLMS) に対して、データを大文字化します。
032 * カラムは、CSV形式で指定する事とし、DBTableModel に指定のカラムがなければ無視します。
033 *
034 * パラメータは、tableFilterタグの keys, vals にそれぞれ記述するか、BODY 部にCSS形式で記述します。
035 * 【パラメータ】
036 *  {
037 *       KEY_CLMS : AA,BB,CC ;    データを大文字化したいカラム名を、CSV形式で指定します。
038 *  }
039 *
040 * @og.formSample
041 * ●形式:
042 *      @ <og:tableFilter classId="UPPER" keys="KEY_CLMS" vals='"TABLE_NAME,CLM"' />
043 *
044 *      A <og:tableFilter classId="UPPER" >
045 *               {
046 *                   KEY_CLMS : TABLE_NAME,CLM ;
047 *               }
048 *         </og:tableFilter>
049 *
050 * @og.rev 5.5.5.0 (2012/07/28) 新規追加
051 * @og.rev 5.6.6.0 (2013/07/05) keys の整合性チェックを追加
052 *
053 * @version  0.9.0  2000/10/17
054 * @author   Kazuhiko Hasegawa
055 * @since    JDK1.1,
056 */
057public class TableFilter_UPPER extends AbstractTableFilter {
058        //* このプログラムのVERSION文字列を設定します。   {@value} */
059        private static final String VERSION = "5.6.6.1 (2013/07/12)" ;
060
061        /**
062         * keys の整合性チェックを行うための初期設定を行います。
063         *
064         * @og.rev 5.6.6.1 (2013/07/12) keys の整合性チェック対応
065         *
066         * @param       keysMap keys の整合性チェックを行うための Map
067         */
068        @Override
069        protected void init( final Map<String,String> keysMap ) {
070                keysMap.put( "KEY_CLMS"  , "大文字化したいカラム名を、CSV形式で指定"      );
071        }
072
073        /**
074         * DBTableModel処理を実行します。
075         *
076         * @return 処理結果のDBTableModel
077         */
078        public DBTableModel execute() {
079                DBTableModel table = getDBTableModel();         // 5.5.2.6 (2012/05/25) インターフェースにgetterメソッド追加
080
081                String[] keyClms = StringUtil.csv2Array( getValue( "KEY_CLMS" ) );
082
083                if ( keyClms == null || keyClms.length == 0 ) { return table; }         // KEY_CLMSが、存在しなかった。
084
085                int[] keyNos = new int[keyClms.length];
086                int lastNo = 0;
087                for ( int i = 0; i < keyNos.length; i++ ) {
088                        int no = table.getColumnNo( keyClms[i], false );        // 存在しない場合は、-1 を返す。
089                        if( no >=0 ) { keyNos[lastNo++] = no; }                              // -1 でなければ、keyNos に設定する。(前づめ)
090                }
091
092                if( lastNo == 0 ) { return table; }             // 対象のカラムが、すべて存在しなかった。
093
094                int rowCnt = table.getRowCount();
095                for( int row=0; row<rowCnt; row++ ) {
096                        try {
097                                for( int j=0; j<lastNo; j++ ) {
098                                        int col = keyNos[j];
099                                        String val = table.getValue( row,col );
100                                        if( val != null ) {
101                                                val = val.toUpperCase( Locale.JAPAN );
102                                                table.setValueAt( val,row,col );
103                                        }
104                                }
105                        }
106                        catch( RuntimeException ex ) {
107                                ErrorMessage errMessage = makeErrorMessage( "TableFilter_UPPER Error",ErrorMessage.NG );
108                                errMessage.addMessage( row+1,ErrorMessage.NG,ex.getMessage() );
109                                errMessage.addMessage( row+1,ErrorMessage.NG,"KEY_CLMS=[" + StringUtil.array2csv( keyClms ) + "]" );
110                                errMessage.addMessage( row+1,ErrorMessage.NG,"row=[" + row + "]" );
111                        }
112                }
113
114                return table;
115        }
116}