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 java.math.BigDecimal;
019import java.text.NumberFormat;
020
021import org.opengion.fukurou.model.NativeType;
022import org.opengion.fukurou.util.ErrorMessage;
023import org.opengion.fukurou.util.StringUtil;
024import org.opengion.hayabusa.db.AbstractDBType;
025import org.opengion.hayabusa.db.DBTypeCheckUtil;
026
027/**
028 * 半角小数付き数字の NUMBER を扱う為の、カラム属性を定義します。
029 *
030 * '0' ~ '9'、'-'、'.'でのみ構成されている数字型カラム属性を定義します。
031 * さらに、カンマ(',')が含まれていても OK とします。ただし、データからは取り除きます。
032 *
033 * タイプチェックとして、以下の条件を判定します。
034 * ・0~9、マイナス(-)および小数点(.)を許可
035 * ・整数部 の 長さチェック
036 * ・小数部 の 長さチェック
037 * ・小数点 の 位置チェック
038 * ・符号 の 位置チェック
039 * ・文字パラメータ の 正規表現チェック
040 *
041 * @og.group データ属性
042 *
043 * @version     4.0
044 * @author      Kazuhiko Hasegawa
045 * @since       JDK5.0,
046 */
047public class DBType_R extends AbstractDBType {
048        /** このプログラムのVERSION文字列を設定します。   {@value} */
049        private static final String VERSION = "8.4.3.0 (2023/03/31)" ;
050
051        private static final String DEF_VALUE = "0.00" ;                // データのデフォルト値
052
053        /**
054         * デフォルトコンストラクター
055         *
056         * @og.rev 4.0.0.0 (2005/01/31) type 廃止
057         */
058        public DBType_R() {
059                super( DEF_VALUE );
060        }
061
062        /**
063         * NATIVEの型の識別コードを返します。
064         *
065         * @og.rev 3.5.4.7 (2004/02/06) 新規作成
066         * @og.rev 4.1.1.2 (2008/02/28) Enum型(fukurou.model.NativeType)に変更
067         *
068         * @return      NATIVEの型の識別コード(DBType で規定)
069         * @see org.opengion.fukurou.model.NativeType
070         */
071        @Override
072        public NativeType getNativeType() {
073                return NativeType.DOUBLE;
074        }
075
076        /**
077         * 半角0文字の固定長でFILL埋めされた文字列を返します。
078         * なお、エラーチェックは行われません。
079         * 実行前に、必ず valueCheck( String value ,int len ) が行われる必要があります。
080         *
081         * @og.rev 3.5.4.5 (2004/01/23) エンコード指定に変更します。
082         *
083         * @param       value   FILL埋めする文字列
084         * @param       sizeX   整数部分の文字列の長さ
085         * @param       sizeY   小数部分の文字列の長さ
086         * @param       encode  固定長で変換する文字エンコード
087         *
088         * @return      FILL埋めした新しい文字列
089         * @og.rtnNotNull
090         */
091        @Override
092        public String valueFill( final String value ,final int sizeX ,final int sizeY,final String encode ) {
093                final NumberFormat format = NumberFormat.getInstance();
094                format.setMinimumIntegerDigits( sizeX );
095                format.setMinimumFractionDigits( sizeY );
096
097                final double dd  = StringUtil.parseDouble( value );
098                return format.format( dd );                             // 6.1.1.0 (2015/01/17) refactoring
099        }
100
101        /**
102         * String引数の文字列を+1した文字列を返します。
103         * これは、英字の場合(A,B,C など)は、B,C,D のように、最終桁の文字コードを
104         * +1 します。
105         * 文字列が数字タイプの場合は、数字に変換して、+1 します。(桁上がりもあり)
106         * 混在タイプの場合は、最後の桁だけを確認して +1します。
107         * 引数が null の場合と、ゼロ文字列("")の場合は、物理的初期設定値(String getDefault())
108         * の値を返します。
109         *
110         * @og.rev 3.3.0.0 (2003/06/23) 値を+1していた箇所を、Double から、BigDecimal に変更。
111         *
112         * @param       value   String引数の文字列
113         *
114         * @return      String引数の文字列を+1した文字列
115         */
116        @Override
117        public String valueAdd( final String value ) {
118                // 6.4.1.1 (2016/01/16) PMD refactoring. A method should have only one exit point, and that should be the last statement in the method
119                return value == null || value.isEmpty() ? getDefault() : new BigDecimal( value ).add( BigDecimal.ONE ).toString();
120        }
121
122        /**
123         * String引数の文字列に、第2引数に指定の文字列(数字、日付等)を加算して返します。
124         *
125         * ここでは、小数文字列に、別の数字(小数も可)文字列を加算します。
126         * 内部処理に、BigDecimal を使用しています。
127         *
128         * @og.rev 5.6.0.3 (2012/01/24) ADD に、引数の値を加算する機能を追加します。
129         *
130         * @param       value   String引数
131         * @param       add             加算する数字文字列
132         *
133         * @return      引数の文字列に数字を加算します。
134         */
135        @Override
136        public String valueAdd( final String value,final String add ) {
137                if( value == null || value.isEmpty() ) { return getDefault(); }
138
139                BigDecimal addSu = BigDecimal.ONE;
140                if( add != null && !add.isEmpty() ) {
141                        addSu = new BigDecimal( add );
142                }
143
144                final BigDecimal val = new BigDecimal( value ).add( addSu );
145                return val.toString();
146        }
147
148        /**
149         * エディターで編集されたデータを登録する場合に、データそのものを
150         * 変換して、実登録データを作成します。
151         * 例えば、大文字のみのフィールドなら、大文字化します。
152         * 実登録データの作成は、DBType オブジェクトを利用しますので、
153         * これと Editor とがアンマッチの場合は、うまくデータ変換
154         * されない可能性がありますので、注意願います。
155         *
156         * @og.rev 3.3.3.0 (2003/07/09) 前後のスペースを取り除いておく。
157         * @og.rev 3.3.3.1 (2003/07/18) 後ろスペースを取り除く。(StringUtil#rTrim)
158         * @og.rev 8.4.3.0 (2023/03/31) 'R'(小数)の『.0』を削除(問合・トラブル 0200010411)
159         *
160         * @param       value   (一般に編集データとして登録されたデータ)
161         *
162         * @return      修正後の文字列(一般にデータベースに登録するデータ)
163         */
164        @Override
165        public String valueSet( final String value ) {
166//              return StringUtil.deleteChar( StringUtil.rTrim( value ),',' );
167                // 8.4.3.0 (2023/03/31) Oracle User_ARG対応
168                return StringUtil.toNumber( StringUtil.deleteChar( value ,',' ) );
169        }
170
171        /**
172         * データが登録可能かどうかをチェックします。
173         * データがエラーの場合は、そのエラー内容を返します。
174         *
175         * @og.rev 2.1.1.2 (2002/11/21) マイナス記号を含む場合の最大桁数の設定を考慮する。
176         * @og.rev 2.3.1.4 (2003/02/18) 属性チェックを強化した。
177         * @og.rev 3.6.0.0 (2004/09/22) dbType パラメータ(文字パラメータ)を引数に追加
178         * @og.rev 5.2.2.0 (2010/11/01) 厳密にチェック(isStrict=true)するフラグを追加
179         *
180         * @param       key                     キー
181         * @param       value           値
182         * @param       sizeX           整数部分の文字列の長さ
183         * @param       sizeY           小数部分の文字列の長さ
184         * @param       typeParam       dbType パラメータ(文字パラメータ)
185         * @param       isStrict        厳密にチェックするかどうか[true:する/false:標準的]
186         *
187         * @return      エラー内容
188         * @og.rtnNotNull
189         */
190        @Override
191        public ErrorMessage valueCheck( final String key ,final String value ,
192                                                                        final int sizeX ,final int sizeY ,final String typeParam ,final boolean isStrict) {
193
194                final ErrorMessage msg = new ErrorMessage();
195                if( value == null || value.isEmpty() ) { return msg; }
196
197                String check;
198
199                check = DBTypeCheckUtil.decimalFormatCheck( value );
200                if( check != null ) {
201                        // 指定の文字以外の文字が使われています。
202                        msg.addMessage( 0,ErrorMessage.NG,"ERR0009", key,check );
203                }
204
205                check = DBTypeCheckUtil.sizeXCheck( value ,sizeX ,sizeY );
206                if( check != null ) {
207                        // 整数部の長さが指定の長さよりも長いです。
208                        msg.addMessage( 0, ErrorMessage.NG, "ERR0021", key, value, check, String.valueOf( sizeX ) );
209                }
210
211                check = DBTypeCheckUtil.sizeYCheck( value ,sizeX ,sizeY );
212                if( check != null ) {
213                        // 小数部の長さが指定の長さよりも長いです。
214                        msg.addMessage( 0,ErrorMessage.NG,"ERR0022", key, value, check, String.valueOf( sizeY ) );
215                }
216
217                check = DBTypeCheckUtil.decimalPointCheck( value );
218                if( check != null ) {
219                        // 小数点の位置が不正です。
220                        msg.addMessage( 0, ErrorMessage.NG, "ERR0024", key, check );
221                }
222
223                check = DBTypeCheckUtil.decimalCodeCheck( value );
224                if( check != null ) {
225                        // 符号の位置が不正です。
226                        msg.addMessage( 0, ErrorMessage.NG, "ERR0023", key, check );
227                }
228
229                // 3.6.0.0 (2004/09/22) dbType パラメータ(文字パラメータ)を使用したマッチチェック
230                check = DBTypeCheckUtil.matcheCheck( value,typeParam );
231                if( check != null ) {
232                        // 指定の文字以外の文字が使われています。
233                        msg.addMessage( 0,ErrorMessage.NG,"ERR0009", key,check );
234                }
235
236                return msg;
237        }
238}