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
022import java.util.Calendar;
023
024/**
025 * 文字列の日付属性(年/月/日 時:分:秒)の半角の日付を扱う為の、カラム属性を定義します。
026 *
027 * yyyyMMddHHmmss に対応している必要があります。
028 * ただし、日付の整合性チェックは行いませんが、valueAdd( String value )での
029 * 日付の加算時には、正式な日付データにて加算します。
030 *
031 * タイプチェックとして、以下の条件を判定します。
032 * ・文字列長は、直接計算で文字数との比較
033 * ・日付使用文字チェック「('0' > c || '9' < c)以外」エラー
034 * ・文字パラメータの 正規表現チェック
035 *
036 * @og.group データ属性
037 *
038 * @version  4.0
039 * @author   Kazuhiko Hasegawa
040 * @since    JDK5.0,
041 */
042public class DBType_YMDH extends DBType_YMD {
043        //* このプログラムのVERSION文字列を設定します。   {@value} */
044        private static final String VERSION = "5.6.6.0 (2013/07/05)" ;
045
046        /**
047         * String引数の文字列を+1した文字列を返します。
048         * ここでは、yyyyMMddHHmmss 形式のデータに、日を+1します。
049         * 
050         * 引数が null の場合と、ゼロ文字列("")の場合は,物理的初期設定値(String getDefault())
051         * の値を返します。
052         * それ以外の場合は、日付計算を行い、日を加算します。よって、年月日フォーマットに
053         * 合わないデータを指定した場合は、エラーになりますので、ご注意ください。
054         *
055         * @og.rev 3.6.0.0 (2004/09/17) 日の加算ロジックの誤り修正。(roll ⇒ add)
056         * @og.rev 5.5.7.2 (2012/10/09) HybsDateUtil を利用するように修正します。
057         *
058         * @param       value   String引数の文字列
059         *
060         * @return      String引数の文字列を+1した文字列
061         */
062        @Override
063        public String valueAdd( final String value ) {
064                if( value == null || value.length() == 0 ) { return getDefault(); }
065
066                Calendar cal = HybsDateUtil.getCalendar( value );
067                cal.add( Calendar.DATE, 1 );            // 日にちを1日加算します。
068
069                return HybsDateUtil.getDate( cal.getTimeInMillis() , "yyyyMMddHHmmss" );
070        }
071
072        /**
073         * String引数の文字列に、第2引数に指定の文字列(数字、日付等)を加算して返します。
074         *
075         * ここでは、yyyyMMddHHmmss 形式のデータに、引数文の日を加算します。
076         *
077         * この YMDH は、引数に、日付単位を指定できます。単位は、yyyyMMddHHmmss 形式の
078         * 1文字を指定します。大文字、小文字も識別します。value="5M" とすれば、5か月、value="5m"
079         * とすれば、5分 追加します。
080         * 指定しない場合は、日を加算します。
081         * 
082         * 引数が null の場合と、ゼロ文字列("")の場合は,物理的初期設定値(String getDefault())
083         * の値を返します。
084         * それ以外の場合は、日付計算を行い、日を加算します。よって、年月日フォーマットに
085         * 合わないデータを指定した場合は、エラーになりますので、ご注意ください。
086         *
087         * @og.rev 5.6.0.3 (2012/01/24) ADD に、引数の値を加算する機能を追加します。
088         * @og.rev 5.6.1.0 (2013/02/01) 加算する引数に、日付単位('y','M','d')を指定可能にします。
089         *
090         * @param   value  String引数
091         * @param   add    加算する日付文字列
092         *
093         * @return  引数の文字列に、日付を加算します
094         */
095        @Override
096        public String valueAdd( final String value,final String add ) {
097                if( value == null || value.length() == 0 ) { return getDefault(); }
098
099                return HybsDateUtil.getDatePlus( value,add,Calendar.DATE,"yyyyMMddHHmmss" );
100        }
101
102        /**
103         * エディターで編集されたデータを登録する場合に、データそのものを
104         * 変換して、実登録データを作成します。
105         * このメソッドでは、sizeX と無関係に 14ケタの YYYYMMDDHHMMS 形式の
106         * 日付データにフォーマットに統一します。
107         * 引数が null の場合と、ゼロ文字列("")の場合は,物理的初期設定値(String getDefault())
108         * の値を返します。
109         *
110         * @og.rev 5.5.7.2 (2012/10/09) HybsDateUtil を利用するように修正します。
111         * @og.rev 5.6.6.0 (2013/07/05) 日付の桁数範囲を、8-14 桁とします。
112         *
113         * @param       value   (一般に編集データとして登録されたデータ)
114         * @return  修正後の文字列(一般にデータベースに登録するデータ)
115         */
116        @Override
117        public String valueSet( final String value ) {
118                if( value == null || value.length() == 0 ) { return getDefault(); }
119
120                return HybsDateUtil.parseDate( value,8,14 );
121        }
122
123        /**
124         * データが登録可能かどうかをチェックします。
125         * データがエラーの場合は、そのエラー内容を返します。
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                // 5.2.2.0 (2010/11/01) 厳密にチェック(isStrict=true)するフラグを追加
147                if( isStrict ) {
148                        if( len != value.length() ) {
149                                // 文字列の長さが指定の長さと異なります。
150                                msg.addMessage( 0,ErrorMessage.NG,"ERR0011", key,value, 
151                                                                                String.valueOf( value.length() ), String.valueOf( len ) );
152                        }
153                }
154                else {
155                        if( len < value.length() ) {
156                                // 文字列の長さが指定の長さよりも長いです。
157                                msg.addMessage( 0,ErrorMessage.NG,"ERR0006",key,value,
158                                                                                String.valueOf( value.length() ),String.valueOf( len ) );
159                        }
160                }
161
162                // 5.6.0.3 (2012/01/24) 文字の範囲チェック
163                String check = DBTypeCheckUtil.rangeCheck( value, '0', '9' );
164                if( check != null ) {
165                        // 指定の文字以外の文字が使われています。
166                        msg.addMessage( 0,ErrorMessage.NG,"ERR0009", key,check );
167                }
168
169                // 5.6.0.3 (2012/01/24) 日付文字の整合性チェック
170                // "0000","9999" で始まる日付は未条件許可。
171                check = DBTypeCheckUtil.ymdFormatCheck( value );
172                if( check != null ) {
173                        // 指定の文字以外の文字が使われています。
174                        msg.addMessage( 0,ErrorMessage.NG,"ERR0009", key,check );
175                }
176
177                // 3.6.0.0 (2004/09/22) dbType パラメータを使用したマッチチェック
178                check = DBTypeCheckUtil.matcheCheck( value,typeParam );
179                if( check != null ) {
180                        // 指定の文字以外の文字が使われています。
181                        msg.addMessage( 0,ErrorMessage.NG,"ERR0009", key,check );
182                }
183
184                return msg;
185        }
186}