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.text.DateFormat;
019// import java.text.SimpleDateFormat;
020// import java.util.Locale;
021import java.util.Calendar;
022
023import org.opengion.fukurou.model.NativeType;
024import org.opengion.fukurou.util.ErrorMessage;
025import org.opengion.fukurou.util.HybsDateUtil;
026import org.opengion.hayabusa.common.HybsSystemException;
027import org.opengion.hayabusa.db.AbstractDBType;
028import org.opengion.hayabusa.db.DBTypeCheckUtil;
029
030/**
031 * 文字列の日付属性(年/月/日)の半角の日付を扱う為の、カラム属性を定義します。
032 *
033 * yyyyMMdd に対応している必要があります。
034 * ただし、日付の整合性チェックは行いませんが、valueAdd( String value )による
035 * 日付の加算時には正式な日付で加算されます。
036 *
037 * タイプチェックとして、以下の条件を判定します。
038 * ・文字列長は、直接計算で文字数との比較
039 * ・日付使用文字チェック「('0' > c || '9' < c)以外」エラー
040 * ・文字パラメータの 正規表現チェック
041 *
042 * @og.group データ属性
043 *
044 * @version  4.0
045 * @author   Kazuhiko Hasegawa
046 * @since    JDK5.0,
047 */
048public class DBType_YMD extends AbstractDBType {
049        //* このプログラムのVERSION文字列を設定します。   {@value} */
050        private static final String VERSION = "5.6.6.0 (2013/07/05)" ;
051
052        /**
053         * NATIVEの型の識別コードを返します。
054         *
055         * @og.rev 3.5.4.7 (2004/02/06) 新規作成
056         * @og.rev 4.1.1.2 (2008/02/28) Enum型(fukurou.model.NativeType)に変更
057         *
058         * @return  NATIVEの型の識別コード(DBType で規定)
059         * @see org.opengion.fukurou.model.NativeType
060         */
061        @Override
062        public NativeType getNativeType() {
063                return NativeType.CALENDAR;
064        }
065
066        /**
067         * 半角スペースで固定長(半角換算の数)に変換した文字列を返します。
068         * なお、エラーチェックは行われません。
069         * 実行前に、必ず valueCheck( String value ,int len ) が行われる必要があります。
070         *
071         * @og.rev 3.5.4.5 (2004/01/23) エンコード指定に変更します。
072         *
073         * @param   value    FILL埋めする文字列
074         * @param   sizeX    整数部分の文字列の長さ
075         * @param   sizeY    少数部分の文字列の長さ
076         * @param   encode   固定長で変換する文字エンコード
077         *
078         * @return  FILL埋めした新しい文字列
079         */
080        @Override
081        public String valueFill( final String value ,final int sizeX ,final int sizeY,final String encode ) {
082                if( value != null && value.length() >= sizeX ) {
083                        return value.substring( 0, sizeX );
084                }
085
086                String errMsg = "指定文字が不正です。value=[" + value + "] length=[" + sizeX + "]";
087                throw new HybsSystemException( errMsg );
088        }
089
090        /**
091         * String引数の文字列を+1した文字列を返します。
092         * ここでは、yyyyMMdd 形式のデータに、+1 するので、日を+1します。
093         * 
094         * 引数が null の場合と、ゼロ文字列("")の場合は,物理的初期設定値(String getDefault())
095         * の値を返します。
096         * それ以外の場合は、日付計算を行い、日を加算します。よって、年月日フォーマットに
097         * 合わないデータを指定した場合は、エラーになりますので、ご注意ください。
098         *
099         * @og.rev 3.6.0.0 (2004/09/17) 日の加算ロジックの誤り修正。(roll ⇒ add)
100         * @og.rev 5.5.7.2 (2012/10/09) HybsDateUtil を利用するように修正します。
101         *
102         * @param       value   String引数の文字列
103         *
104         * @return  String引数の文字列を+1した文字列
105         */
106        @Override
107        public String valueAdd( final String value ) {
108                if( value == null || value.length() == 0 ) { return getDefault(); }
109
110                return HybsDateUtil.getDatePlus( value , 1 );
111
112//              Calendar cal = Calendar.getInstance();
113// 
114//              int year  = Integer.parseInt( value.substring( 0,4 ) );
115//              int month = Integer.parseInt( value.substring( 4,6 ) ) - 1;
116//              int date  = Integer.parseInt( value.substring( 6,8 ) );
117// 
118//              cal.set( year,month,date );
119//              cal.add( Calendar.DATE, 1 );            // 日にちを1日加算します。
120// 
121//              DateFormat formatter = new SimpleDateFormat( "yyyyMMdd",Locale.JAPAN );
122//              return formatter.format( cal.getTime() );
123        }
124
125        /**
126         * String引数の文字列に、第2引数に指定の文字列(数字、日付等)を加算して返します。
127         *
128         * ここでは、yyyyMMdd 形式のデータに、日付を加算します。
129         *
130         * この YMD は、引数に、日付単位を指定できます。単位は、yyyyMMdd 形式の
131         * 1文字を指定します。大文字、小文字も識別します。value="5M" とすれば、5か月、value="5d"
132         * とすれば、5日 追加します。
133         * 指定しない場合は、日を加算します。
134         * 
135         * 引数が null の場合と、ゼロ文字列("")の場合は,物理的初期設定値(String getDefault())
136         * の値を返します。
137         * それ以外の場合は、日付計算を行い、日を加算します。よって、年月日フォーマットに
138         * 合わないデータを指定した場合は、エラーになりますので、ご注意ください。
139         *
140         * @og.rev 5.6.0.3 (2012/01/24) ADD に、引数の値を加算する機能を追加します。
141         * @og.rev 5.6.1.0 (2013/02/01) 加算する引数に、日付単位('y','M','d')を指定可能にします。
142         *
143         * @param   value  String引数
144         * @param   add    加算する日付文字列(単位として、y,M,d を指定できます)
145         *
146         * @return  引数の文字列に、日付を加算します
147         */
148        @Override
149        public String valueAdd( final String value,final String add ) {
150                if( value == null || value.length() == 0 ) { return getDefault(); }
151
152                return HybsDateUtil.getDatePlus( value,add,Calendar.DATE,"yyyyMMdd" );
153
154//              int addSu = 1;  // 初期値(add が null や Empty の場合は、+1となる)
155//              if( add != null && !add.isEmpty() ) {
156//                      addSu = Integer.parseInt( add );
157//              }
158
159//              return HybsDateUtil.getDatePlus( value , addSu );
160        }
161
162        /**
163         * エディターで編集されたデータを登録する場合に、データそのものを
164         * 変換して、実登録データを作成します。
165         * このメソッドでは、sizeX と無関係に 8ケタの yyyyMMdd 形式の
166         * 日付データにフォーマットに統一します。
167         * 引数が null の場合と、ゼロ文字列("")の場合は,物理的初期設定値(String getDefault())
168         * の値を返します。
169         *
170         * @og.rev 5.5.7.2 (2012/10/09) HybsDateUtil を利用するように修正します。
171         * @og.rev 5.6.6.0 (2013/07/05) parseDate を改造し、日付の桁数指定を厳密に判定します。
172         *
173         * @param       value   (一般に編集データとして登録されたデータ)
174         * @return  修正後の文字列(一般にデータベースに登録するデータ)
175         */
176        @Override
177        public String valueSet( final String value ) {
178                if( value == null || value.length() == 0 ) { return getDefault(); }
179
180                return HybsDateUtil.parseDate( value , 8 );             // 不要な記号等を削除し、桁数をそろえる。
181
182//              String rtn = ( value == null ) ? "" : value.trim();
183// 
184//              if( rtn.length() == 6 ) { rtn = "20" + rtn ; }
185//              else if( rtn.length() > 8 ) { rtn = rtn.substring(0,8) ; }
186//              else if( rtn.startsWith( "0000" ) ) { rtn = "00000101"; }
187//              else if( rtn.startsWith( "9999" ) ) { rtn = "99991231"; }
188// 
189//              return rtn;
190        }
191
192        /**
193         * データが登録可能かどうかをチェックします。
194         * データがエラーの場合は、そのエラー内容を返します。
195         *
196         * @og.rev 3.6.0.0 (2004/09/22) dbType パラメータを引数に追加
197         * @og.rev 5.2.2.0 (2010/11/01) 厳密にチェック(isStrict=true)するフラグを追加
198         * @og.rev 5.6.0.3 (2012/01/24) 日付チェックの整合性まで含めたチェックを入れる。
199         *
200         * @param   key         キー
201         * @param   value       値
202         * @param   sizeX       整数部分の文字列の長さ
203         * @param   sizeY       少数部分の文字列の長さ
204         * @param   typeParam   dbType パラメータ
205         * @param   isStrict    厳密にチェックするかどうか[true:する/false:標準的]
206         *
207         * @return  エラー内容
208         */
209//      public ErrorMessage valueCheck( final String key ,final String value ,
210//                                                                      final int sizeX ,final int sizeY ,final String param ) {
211        @Override
212        public ErrorMessage valueCheck( final String key ,final String value ,
213                                                                        final int sizeX ,final int sizeY ,final String typeParam ,final boolean isStrict) {
214
215                ErrorMessage msg = new ErrorMessage();
216                if( value == null || value.length() == 0 ) { return msg; }
217
218                int len = (sizeY == 0) ? sizeX : sizeX + sizeY + 1;
219                // 5.2.2.0 (2010/11/01) 厳密にチェック(isStrict=true)するフラグを追加
220                if( isStrict ) {
221                        if( len != value.length() ) {
222                                // 文字列の長さが指定の長さと異なります。
223                                msg.addMessage( 0,ErrorMessage.NG,"ERR0011", key,value, 
224                                                                                String.valueOf( value.length() ), String.valueOf( len ) );
225                        }
226                }
227                else {
228                        if( len < value.length() ) {
229                                // 文字列の長さが指定の長さよりも長いです。
230                                msg.addMessage( 0,ErrorMessage.NG,"ERR0006",key,value,
231                                                                                String.valueOf( value.length() ),String.valueOf( len ) );
232                        }
233                }
234
235//              StringBuilder val = new StringBuilder();
236//              boolean isError = false;
237//              for( int i=0; i<value.length(); i++ ) {
238//                      char ch = value.charAt( i );
239//                      if( ('0' > ch || '9' < ch) ) {
240//                              val.append( "<span class=\"NG\">" ).append( ch ).append( "</span>" );
241//                              isError = true;
242//                      }
243//                      else {
244//                              val.append( ch );
245//                      }
246//              }
247//              if( isError ) {
248//                      // 指定の文字以外の文字が使われています。
249//                      msg.addMessage( 0,ErrorMessage.NG,"ERR0009", key,val.toString() );
250//              }
251
252                // 5.6.0.3 (2012/01/24) 文字の範囲チェック
253                String check = DBTypeCheckUtil.rangeCheck( value, '0', '9' );
254                if( check != null ) {
255                        // 指定の文字以外の文字が使われています。
256                        msg.addMessage( 0,ErrorMessage.NG,"ERR0009", key,check );
257                }
258
259                // 5.6.0.3 (2012/01/24) 日付文字の整合性チェック
260                // "0000","9999" で始まる日付は未条件許可。
261                check = DBTypeCheckUtil.ymdFormatCheck( value );
262                if( check != null ) {
263                        // 指定の文字以外の文字が使われています。
264                        msg.addMessage( 0,ErrorMessage.NG,"ERR0009", key,check );
265                }
266
267                // 3.6.0.0 (2004/09/22) dbType パラメータを使用したマッチチェック
268                check = DBTypeCheckUtil.matcheCheck( value,typeParam );
269                if( check != null ) {
270                        // 指定の文字以外の文字が使われています。
271                        msg.addMessage( 0,ErrorMessage.NG,"ERR0009", key,check );
272                }
273
274                return msg;
275        }
276}