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