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