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.column;
017
018import org.opengion.fukurou.util.ErrorMessage;
019import org.opengion.fukurou.util.StringUtil;
020import org.opengion.hayabusa.db.AbstractDBType;
021import org.opengion.hayabusa.db.DBTypeCheckUtil;
022
023/**
024 * 半角数字の NUMBER を扱う為の、カラム属性を定義します。
025 *
026 * '0' ~ '9' ,'-' ,'.',',' でのみ構成されている文字型カラム属性を定義します。
027 * S9 と異なり、カンマ','が含まれていても OK とし、データからも取り除きません。
028 *
029 * タイプチェックとして、以下の条件を判定します。
030 * ・0~9、マイナス(-)、小数点(.)およびカンマ(,)を許可
031 * ・文字列の長さチェック
032 * ・小数点の位置チェック
033 * ・符号の位置チェック
034 * ・文字パラメータの 正規表現チェック
035 *
036 * @og.group データ属性
037 *
038 * @version  4.0
039 * @author       Kazuhiko Hasegawa
040 * @since    JDK5.0,
041 */
042public class DBType_X9 extends AbstractDBType {
043        //* このプログラムのVERSION文字列を設定します。   {@value} */
044        private static final String VERSION = "5.2.2.0 (2010/11/01)" ;
045
046        /**
047         * 半角0文字の固定長でFILL埋めされた文字列を返します。
048         * なお、エラーチェックは行われません。
049         * 実行前に、必ず valueCheck( String value ,int len ) が行われる必要があります。
050         *
051         * @og.rev 3.5.4.5 (2004/01/23) エンコード指定に変更します。
052         *
053         * @param       value    FILL埋めする文字列
054         * @param       sizeX    整数部分の文字列の長さ
055         * @param       sizeY    少数部分の文字列の長さ
056         * @param       encode   エンコード指定
057         *
058         * @return      FILL埋めした新しい文字列
059         */
060        @Override
061        public String valueFill( final String value ,final int sizeX ,final int sizeY,final String encode ) {
062                int len = (sizeY == 0) ? sizeX : sizeX + sizeY + 1;
063
064                // 注意 マイナス記号の処理がまだです。
065                return StringUtil.intFill( value,len );
066        }
067
068        /**
069         * String引数の文字列を+1した文字列を返します。
070         * これは、文字型数字タイプの場合は, マイナス、カンマ、ピリオドを避けて、
071         * +1 します。(桁上がりもあり)
072         * データの値が、マイナスの場合は、結果的にマイナスしていきます。
073         * カンマ編集(12,345,678 など)がある場合に、桁上がりしても、カンマは追加されません。
074         * マイナス時の桁上がりには、対応しています。
075         * 引数が null の場合と、ゼロ文字列("")の場合は,物理的初期設定値(String getDefault())
076         * の値を返します。
077         *
078         * @param       value   String引数の文字列
079         *
080         * @return      String引数の文字列を+1した文字列
081         */
082        @Override
083        public String valueAdd( final String value ) {
084                if( value == null || value.length() == 0 ) { return getDefault(); }
085                char[] chs = value.toCharArray() ;
086                boolean over = false;
087                for( int i=chs.length-1; i>=0; i-- ) {
088                        if( chs[i] == '-' || chs[i] == '.' || chs[i] == ',' ) { continue; }
089                        if( chs[i] == '9' ) { chs[i] = '0'; over = true; }
090                        else { chs[i]++; over = false; break; }
091                }
092                if( over ) {
093                        char[] chs2 = new char[ chs.length + 1 ];
094                        System.arraycopy( chs,0,chs2,1,chs.length );
095                        if( chs[0] == '-' ) {
096                                chs2[0] = '-';
097                                chs2[1] = '1';
098                        }
099                        else {
100                                chs2[0] = '1';
101                        }
102                        chs = chs2;
103                }
104                return new String( chs );
105        }
106
107        /**
108         * エディターで編集されたデータを登録する場合に、データそのものを
109         * 変換して、実登録データを作成します。
110         * 例えば,大文字のみのフィールドなら、大文字化します。
111         * 実登録データの作成は、DBType オブジェクトを利用しますので,
112         * これと Editor とがアンマッチの場合は、うまくデータ変換
113         * されない可能性がありますので、注意願います。
114         *
115         * @og.rev 3.3.3.0 (2003/07/09) 前後のスペースを取り除いておく。
116         * @og.rev 3.3.3.1 (2003/07/18) 後ろスペースを取り除く。(StringUtil#rTrim)
117         *
118         * @param       value   (一般に編集データとして登録されたデータ)
119         *
120         * @return      修正後の文字列(一般にデータベースに登録するデータ)
121         */
122        @Override
123        public String valueSet( final String value ) {
124                return StringUtil.rTrim( value ) ;
125        }
126
127        /**
128         * データが登録可能かどうかをチェックします。
129         * データがエラーの場合は、そのエラー内容を返します。
130         * 許可する文字は、0-9 の数字、マイナス(-) 、小数点(.)です。
131         * 小数点の位置チェックは行いません。
132         *
133         * @og.rev 2.3.1.4 (2003/02/18) 属性チェックを強化した。
134         * @og.rev 3.6.0.0 (2004/09/22) チェック項目は、数字を許可する文字列とする。
135         * @og.rev 3.6.0.0 (2004/09/22) dbType パラメータを引数に追加
136         * @og.rev 5.2.2.0 (2010/11/01) 厳密にチェック(isStrict=true)するフラグを追加
137         *
138         * @param   key         キー
139         * @param   value       値
140         * @param   sizeX       整数部分の文字列の長さ
141         * @param   sizeY       少数部分の文字列の長さ
142         * @param   typeParam   dbType パラメータ
143         * @param   isStrict    厳密にチェックするかどうか[true:する/false:標準的]
144         *
145         * @return  エラー内容
146         */
147        @Override
148        public ErrorMessage valueCheck( final String key ,final String value ,
149                                                                        final int sizeX ,final int sizeY ,final String typeParam ,final boolean isStrict) {
150
151                ErrorMessage msg = new ErrorMessage();
152                if( value == null || value.length() == 0 ) { return msg; }
153
154                // チェック用のvalue を用意します。カンマ(,)を取り除いておく為です。
155                String tmpValue = StringUtil.deleteChar(value,',' );
156                String check;
157
158                // 3.6.0.0 (2004/09/22) チェック内容変更
159                check = DBTypeCheckUtil.decimalFormatCheck( tmpValue );
160                if( check != null ) {
161                        // 指定の文字以外の文字が使われています。
162                        msg.addMessage( 0,ErrorMessage.NG,"ERR0009", key,check );
163                }
164
165                check = DBTypeCheckUtil.decimalCodeCheck( tmpValue );
166                if( check != null ) {
167                        // 符号の位置が不正です。
168                        msg.addMessage( 0, ErrorMessage.NG, "ERR0023", key, check );
169                }
170
171                // 3.6.0.0 (2004/09/22) 追加
172                check = DBTypeCheckUtil.decimalPointCheck( tmpValue );
173                if( check != null ) {
174                        // 小数点の位置が不正です。
175                        msg.addMessage( 0, ErrorMessage.NG, "ERR0024", key, check );
176                }
177
178                // 3.6.0.0 (2004/09/22) dbType パラメータを使用したマッチチェック
179                check = DBTypeCheckUtil.matcheCheck( tmpValue,typeParam );
180                if( check != null ) {
181                        // 指定の文字以外の文字が使われています。
182                        msg.addMessage( 0,ErrorMessage.NG,"ERR0009", key,check );
183                }
184
185                return msg;
186        }
187}