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