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