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