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