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.util.ErrorMessage;
021import org.opengion.fukurou.util.StringUtil;
022import org.opengion.hayabusa.db.AbstractDBType;
023import org.opengion.hayabusa.db.DBTypeCheckUtil;
024import org.opengion.fukurou.util.HybsDateUtil;
025
026/**
027 * 文字列の時間属性(時:分:秒)の半角の時間を扱う為の、カラム属性を定義します。
028 *
029 * HHmmss に対応している必要があります。
030 * (HHmmのデータでも利用可能です)
031 * ただし、日付の整合性チェックは行いませんが、valueAdd( String value )での
032 * 日付の加算時には、正式な日付データにて加算します。
033 *
034 * タイプチェックとして、以下の条件を判定します。
035 * ・文字列長は、直接計算で文字数との比較
036 * ・日付使用文字チェック「('0' > c || '9' < c)以外」エラー
037 * ・文字パラメータの 正規表現チェック
038 *
039 * @og.group データ属性
040 * @og.rev 5.4.3.6 (2012/01/20)  タイプチェックが抜けているので追加
041 *
042 * @version  4.0
043 * @author   Kazuhiko Hasegawa
044 * @since    JDK5.0,
045 */
046public class DBType_HMS extends AbstractDBType {
047        //* このプログラムのVERSION文字列を設定します。   {@value} */
048        private static final String VERSION = "5.6.1.0 (2013/02/01)" ;
049
050        /**
051         * String引数の文字列を+1した文字列を返します。
052         * これは、英字の場合(A,B,C など)は、B,C,D のように,最終桁の文字コードを
053         * +1 します。
054         * 文字列が数字タイプの場合は, 数字に変換して、+1 します。(桁上がりもあり)
055         * 混在タイプの場合は,最後の桁だけを確認して +1します。
056         * 引数が null の場合と、ゼロ文字列("")の場合は,物理的初期設定値(String getDefault())
057         * の値を返します。
058         * 
059         * @og.rev 5.8.6.1 (2015/04/17)
060         *
061         * @param       value   String引数の文字列
062         *
063         * @return  String引数の文字列を+1した文字列
064         */
065        @Override
066        public String valueAdd( final String value ) {
067                if( value == null || value.length() == 0 ) { return getDefault(); }
068
069//              int hour = Integer.parseInt( value.substring( 0,2 ) );
070//
071//              // 先頭に 00 を付加する為に、数字の 100 を加算している。
072//              if( hour < 24 ) { hour = 101 + hour; }
073//              else                    { hour = 100; }
074//
075//              String rtn = hour + value.substring( 2 );
076//
077//              return rtn.substring( 1 );
078                
079                // 5.8.6.1 (2015/04/10) 4桁より小さいとHHmm、それ以外は、HHmmss
080                final boolean isHM = value.length() <= 4 ;
081
082                //                        HHmm    HHmmss
083                final int hms = ( isHM ? 10100 : 1010000 ) + Integer.parseInt( value );
084
085                // 元の形式に準拠して返す。
086                return String.valueOf( hms ).substring( 1 );
087        }
088
089        /**
090         * String引数の文字列に、第2引数に指定の文字列(数字、日付等)を加算して返します。
091         *
092         * ここでは、HHmmss 形式のデータに、時間を加算します。
093         *
094         * この HMS は、引数に、日付単位を指定できます。単位は、HHmmss 形式の
095         * 1文字を指定します。大文字、小文字も識別します。value="5H" とすれば、5時間、value="5m"
096         * とすれば、5分 追加します。
097         * 指定しない場合は、時を加算します。
098         *
099         * ここのデータは、時間が繰り越しても、日付に影響しません。
100         * また、24時間を超えた場合は、00 時に戻ります。
101         *
102         * @og.rev 5.6.0.3 (2012/01/24) ADD に、引数の値を加算する機能を追加します。
103         * @og.rev 5.6.1.0 (2013/02/01) 加算する引数に、日付単位('H','m','s')を指定可能にします。
104         * @og.rev 5.8.6.1 (2015/04/17) 桁数可変対応
105         *
106         * @param   value  String引数
107         * @param   add    加算する時間文字列(単位付き:['H','m','s'])
108         *
109         * @return  引数の文字列に時間を加算します。
110         */
111        @Override
112        public String valueAdd( final String value,final String add ) {
113                if( value == null || value.length() == 0 ) { return getDefault(); }
114
115                // 日付文字列にダミーの年月日を追加しておく。
116//              return HybsDateUtil.getDatePlus( ("20100101" + value),add,Calendar.HOUR_OF_DAY,"HHmmss" );
117
118//              int addSu = 1;
119//              if( add != null && !add.isEmpty() ) {
120//                      addSu = Integer.parseInt( add );
121//              }
122
123//              int hour = Integer.parseInt( value.substring( 0,2 ) ) + addSu;
124
125                // 先頭に 00 を付加する為に、数字の 100 を加算している。また、24時間を超える場合は、00 に戻る。
126//              String rtn = ( 100 + ( hour % 24 ) ) + value.substring( 2 );            // 後ろは、MMSSの分
127                //           ~~~~~~~~~~~~~~~~~~~~~~~   ~~~~~~~~~~~~~~~~~~~~
128                //           数字部分                  MMSSの文字列部分
129
130                // 先頭文字列を削除する。
131//              return rtn.substring( 1 );
132                
133                // 5.8.6.1 (2015/04/10) 4桁より小さいとHHmm、それ以外は、HHmmss
134                final boolean isHM = value.length() <= 4 ;
135
136                // ※ yyyymmd + 1HHmmss で、日付データのダミーの年月日を追加
137                final int hms = 1000000 + Integer.parseInt( isHM ? value + "00" : value );
138
139                // 元の形式に準拠して返す。
140                return HybsDateUtil.getDatePlus( ( "2010010" + hms ),add,Calendar.HOUR_OF_DAY, isHM ? "HHmm" : "HHmmss" );
141        }
142
143        /**
144         * エディターで編集されたデータを登録する場合に、データそのものを
145         * 変換して、実登録データを作成します。
146         * 例えば,大文字のみのフィールドなら、大文字化します。
147         * 実登録データの作成は、DBType オブジェクトを利用しますので,
148         * これと Editor とがアンマッチの場合は、うまくデータ変換
149         * されない可能性がありますので、注意願います。
150         * 
151         * 5.8.6.1 (2015/04/17) 桁数可変対応
152         *
153         * @param       value   (一般に編集データとして登録されたデータ)
154         *
155         * @return  修正後の文字列(一般にデータベースに登録するデータ)
156         */
157        @Override
158        public String valueSet( final String value ) {
159                if( value == null || value.length() == 0 ) { return ""; }
160//              return StringUtil.lTrim0( StringUtil.deleteChar( value,':' ) );
161                // 5.8.6. (2015/04/03) 4桁より小さいとHHmm、それ以外は、HHmmss
162                final String val = StringUtil.deleteChar( value,':' );
163                final boolean isHM = val.length() <= 4 ;
164
165                // 5.8.6.1 (2015/04/17) try-catch
166                try{
167                        //                        HHmm    HHmmss
168                        final int hms = ( isHM ? 10000 : 1000000 ) + Integer.parseInt( val );
169        
170                        // 元の形式に準拠して返す。
171                        return String.valueOf( hms ).substring( 1 );
172                }
173                catch( NumberFormatException ex ) {
174                        return val;             
175                }
176        }
177
178        /**
179         * データが登録可能かどうかをチェックします。
180         * データがエラーの場合は、そのエラー内容を返します。
181         *
182         * @og.rev 5.2.3.6 (2012/01/20) 数値のみに限定するために追加
183         * @og.rev 5.6.0.3 (2012/01/24) ADD に、引数の値を加算する機能を追加します。
184         *
185         * @param   key         キー
186         * @param   value       値
187         * @param   sizeX       整数部分の文字列の長さ
188         * @param   sizeY       少数部分の文字列の長さ
189         * @param   typeParam   dbType パラメータ
190         * @param   isStrict    厳密にチェックするかどうか[true:する/false:標準的]
191         *
192         * @return  エラー内容
193         */
194        @Override
195        public ErrorMessage valueCheck( final String key ,final String value ,
196                                                                        final int sizeX ,final int sizeY ,final String typeParam ,final boolean isStrict) {
197                String checkVal = valueSet(value); // :は念のため外しておく
198
199                ErrorMessage msg = new ErrorMessage();
200                if( checkVal == null || checkVal.length() == 0 ) { return msg; }
201
202                int len = (sizeY == 0) ? sizeX : sizeX + sizeY + 1;
203                if( isStrict ) {
204                        if( len != checkVal.length() ) {
205                                // 文字列の長さが指定の長さと異なります。
206                                msg.addMessage( 0,ErrorMessage.NG,"ERR0011", key,value, String.valueOf( value.length() ), String.valueOf( len ) );
207                        }
208                }
209                else {
210                        if( len < checkVal.length() ) {
211                                // 文字列の長さが指定の長さよりも長いです。
212                                msg.addMessage( 0,ErrorMessage.NG,"ERR0006",key,value,
213                                                                                String.valueOf( value.length() ),String.valueOf( len ) );
214                        }
215                }
216
217//              StringBuilder val = new StringBuilder();
218//              boolean isError = false;
219//              for( int i=0; i<checkVal.length(); i++ ) {
220//                      char ch = checkVal.charAt( i );
221//                      if( ('0' > ch || '9' < ch) ) {
222//                              val.append( "<span class=\"NG\">" ).append( ch ).append( "</span>" );
223//                              isError = true;
224//                      }
225//                      else {
226//                              val.append( ch );
227//                      }
228//              }
229//              if( isError ) {
230//                      // 指定の文字以外の文字が使われています。
231//                      msg.addMessage( 0,ErrorMessage.NG,"ERR0009", key,val.toString() );
232//              }
233
234                // 5.6.0.3 (2012/01/24) 文字の範囲チェック
235                String check = DBTypeCheckUtil.rangeCheck( checkVal, '0', '9' );
236                if( check != null ) {
237                        // 指定の文字以外の文字が使われています。
238                        msg.addMessage( 0,ErrorMessage.NG,"ERR0009", key,check );
239                }
240
241                // 5.6.0.3 (2012/01/24) 時分秒の整合性チェック
242                check = DBTypeCheckUtil.hmsFormatCheck( checkVal );
243                if( check != null ) {
244                        // 指定の文字以外の文字が使われています。
245                        msg.addMessage( 0,ErrorMessage.NG,"ERR0009", key,check );
246                }
247
248                // 3.6.0.0 (2004/09/22) dbType パラメータを使用したマッチチェック
249                check = DBTypeCheckUtil.matcheCheck( checkVal,typeParam );
250                if( check != null ) {
251                        // 指定の文字以外の文字が使われています。
252                        msg.addMessage( 0,ErrorMessage.NG,"ERR0009", key,check );
253                }
254
255                return msg;
256        }
257}