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.HybsDateUtil;
020import org.opengion.hayabusa.db.DBTypeCheckUtil;
021
022/**
023 * 文字列の日付属性(年/月)の半角の日付を扱う為の、カラム属性を定義します。
024 *
025 * yyyyMM に対応している必要があります。
026 * "000000" と、"999999" は、常に許可になります。
027 * ただし、日付の整合性チェックは行いませんが、valueAdd( String value )による
028 * 日付(月)の加算時には、0000XX と 9999XX は、加算されず、それ以外は、
029 * 正式な日付で加算されます。
030 *
031 * タイプチェックとして、以下の条件を判定します。
032 * ・文字列長は、直接計算で文字数との比較
033 * ・日付使用文字チェック「('0' > c || '9' < c)以外」エラー
034 * ・文字パラメータの 正規表現チェック
035 *
036 * @og.rev 3.6.0.0 (2004/09/17) 新規作成
037 * @og.group データ属性
038 *
039 * @version  4.0
040 * @author   Kazuhiko Hasegawa
041 * @since    JDK5.0,
042 */
043public class DBType_YM extends DBType_YMD {
044        //* このプログラムのVERSION文字列を設定します。   {@value} */
045        private static final String VERSION = "5.6.6.0 (2013/07/05)" ;
046
047        /**
048         * String引数の文字列を+1した文字列を返します。
049         * ここでは、yyyyMM 形式のデータに、+1 するので、月を+1します。
050         * 
051         * 0000XX と、9999XX は、引数の値そのままを返します。
052         * 引数が null の場合と、ゼロ文字列("")の場合は,物理的初期設定値(String getDefault())
053         * の値を返します。
054         * それ以外の場合は、日付計算を行い、月を加算します。よって、年月フォーマットに
055         * 合わないデータを指定した場合は、エラーになりますので、ご注意ください。
056         *
057         * @og.rev 5.5.7.2 (2012/10/09) HybsDateUtil を利用するように修正します。
058         *
059         * @param       value   String引数の文字列
060         *
061         * @return  String引数の文字列を+1した文字列
062         */
063        @Override
064        public String valueAdd( final String value ) {
065                if( value == null || value.length() == 0 ) { return getDefault(); }
066                if( value.startsWith( "0000" ) || value.startsWith( "9999" ) ) { return value; }        // 特別な値
067
068                return HybsDateUtil.getMonthPlus( value , 1 );          // 5.5.7.2 (2012/10/09) HybsDateUtil を利用
069        }
070
071        /**
072         * String引数の文字列に、第2引数に指定の文字列(数字、日付等)を加算して返します。
073         *
074         * ここでは、yyyyMM 形式のデータに、月を加算します。
075         * 0000XX と、9999XX は、引数の値そのままを返します。
076         * 引数が null の場合と、ゼロ文字列("")の場合は,物理的初期設定値(String getDefault())
077         * の値を返します。
078         * それ以外の場合は、日付計算を行い、月を加算します。よって、年月フォーマットに
079         * 合わないデータを指定した場合は、エラーになりますので、ご注意ください。
080         *
081         * @og.rev 5.6.0.3 (2012/01/24) ADD に、引数の値を加算する機能を追加します。
082         *
083         * @param   value  String引数
084         * @param   add    加算する月文字列
085         *
086         * @return  引数の文字列に月を加算します。
087         */
088        @Override
089        public String valueAdd( final String value,final String add ) {
090                if( value == null || value.length() == 0 ) { return getDefault(); }
091                if( value.startsWith( "0000" ) || value.startsWith( "9999" ) ) { return value; }        // 特別な値
092
093                int addSu = 1;
094                if( add != null && !add.isEmpty() ) {
095                        addSu = Integer.parseInt( add );
096                }
097
098                return HybsDateUtil.getMonthPlus( value , addSu );
099        }
100
101        /**
102         * エディターで編集されたデータを登録する場合に、データそのものを
103         * 変換して、実登録データを作成します。
104         * 例えば,大文字のみのフィールドなら、大文字化します。
105         * 実登録データの作成は、DBType オブジェクトを利用しますので,
106         * これと Editor とがアンマッチの場合は、うまくデータ変換
107         * されない可能性がありますので、注意願います。
108         *
109         * @og.rev 5.5.7.2 (2012/10/09) HybsDateUtil を利用するように修正します。
110         * @og.rev 5.6.6.0 (2013/07/05) parseDate を改造し、日付の桁数指定を厳密に判定します。
111         *
112         * @param       value   (一般に編集データとして登録されたデータ)
113         * @return  修正後の文字列(一般にデータベースに登録するデータ)
114         */
115        @Override
116        public String valueSet( final String value ) {
117                if( value == null || value.length() == 0 ) { return getDefault(); }
118
119                return HybsDateUtil.parseDate( value , 6 );             // 不要な記号等を削除し、桁数をそろえる。
120        }
121
122        /**
123         * データが登録可能かどうかをチェックします。
124         * データがエラーの場合は、そのエラー内容を返します。
125         * "000000" と、"999999" は、常に許可になります。
126         *
127         * @og.rev 5.6.0.3 (2012/01/24) 日付チェックの整合性まで含めたチェックを入れる。
128         *
129         * @param   key         キー
130         * @param   value       値
131         * @param   sizeX       整数部分の文字列の長さ
132         * @param   sizeY       少数部分の文字列の長さ
133         * @param   typeParam   dbType パラメータ
134         * @param   isStrict    厳密にチェックするかどうか[true:する/false:標準的]
135         *
136         * @return  エラー内容
137         */
138        @Override
139        public ErrorMessage valueCheck( final String key ,final String value ,
140                                                                        final int sizeX ,final int sizeY ,final String typeParam ,final boolean isStrict) {
141
142                ErrorMessage msg = new ErrorMessage();
143                if( value == null || value.length() == 0 ) { return msg; }
144
145                int len = (sizeY == 0) ? sizeX : sizeX + sizeY + 1;
146                // 厳密に一致しないとエラーとする。
147                if( len != value.length() ) {
148                        // 文字列の長さが指定の長さと異なります。
149                        msg.addMessage( 0,ErrorMessage.NG,"ERR0011", key,value, 
150                                                                        String.valueOf( value.length() ), String.valueOf( len ) );
151                }
152
153                // 5.6.0.3 (2012/01/24) 文字の範囲チェック
154                String check = DBTypeCheckUtil.rangeCheck( value, '0', '9' );
155                if( check != null ) {
156                        // 指定の文字以外の文字が使われています。
157                        msg.addMessage( 0,ErrorMessage.NG,"ERR0009", key,check );
158                }
159
160                // 5.6.0.3 (2012/01/24) 日付文字の整合性チェック
161                // "0000","9999" で始まる日付は未条件許可。
162                check = DBTypeCheckUtil.ymdFormatCheck( value );
163                if( check != null ) {
164                        // 指定の文字以外の文字が使われています。
165                        msg.addMessage( 0,ErrorMessage.NG,"ERR0009", key,check );
166                }
167
168                // 3.6.0.0 (2004/09/22) dbType パラメータを使用したマッチチェック
169                check = DBTypeCheckUtil.matcheCheck( value,typeParam );
170                if( check != null ) {
171                        // 指定の文字以外の文字が使われています。
172                        msg.addMessage( 0,ErrorMessage.NG,"ERR0009", key,check );
173                }
174
175                return msg;
176        }
177}