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 * String引数の文字列に、第2引数に指定の文字列(数字、日付等)を加算して返します。 119 * 120 * ここでは、yyyyMMdd 形式のデータに、日付を加算します。 121 * 122 * この YMD は、引数に、日付単位を指定できます。単位は、yyyyMMdd 形式の 123 * 1文字を指定します。大文字、小文字も識別します。value="5M" とすれば、5か月、value="5d" 124 * とすれば、5日 追加します。 125 * 指定しない場合は、日を加算します。 126 * 127 * 引数が null の場合と、ゼロ文字列("")の場合は,物理的初期設定値(String getDefault()) 128 * の値を返します。 129 * それ以外の場合は、日付計算を行い、日を加算します。よって、年月日フォーマットに 130 * 合わないデータを指定した場合は、エラーになりますので、ご注意ください。 131 * 132 * @og.rev 5.6.0.3 (2012/01/24) ADD に、引数の値を加算する機能を追加します。 133 * @og.rev 5.6.1.0 (2013/02/01) 加算する引数に、日付単位('y','M','d')を指定可能にします。 134 * 135 * @param value String引数 136 * @param add 加算する日付文字列(単位として、y,M,d を指定できます) 137 * 138 * @return 引数の文字列に、日付を加算します 139 */ 140 @Override 141 public String valueAdd( final String value,final String add ) { 142 // 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 143 return value == null || value.isEmpty() ? getDefault() : HybsDateUtil.getDatePlus( value,add,Calendar.DATE,"yyyyMMdd" ); 144 } 145 146 /** 147 * エディターで編集されたデータを登録する場合に、データそのものを 148 * 変換して、実登録データを作成します。 149 * このメソッドでは、sizeX と無関係に 8ケタの yyyyMMdd 形式の 150 * 日付データにフォーマットに統一します。 151 * 引数が null の場合と、ゼロ文字列("")の場合は,物理的初期設定値(String getDefault()) 152 * の値を返します。 153 * 154 * @og.rev 5.5.7.2 (2012/10/09) HybsDateUtil を利用するように修正します。 155 * @og.rev 5.6.6.0 (2013/07/05) parseDate を改造し、日付の桁数指定を厳密に判定します。 156 * 157 * @param value (一般に編集データとして登録されたデータ) 158 * @return 修正後の文字列(一般にデータベースに登録するデータ) 159 */ 160 @Override 161 public String valueSet( final String value ) { 162 // 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 163 return value == null || value.isEmpty() ? getDefault() : HybsDateUtil.parseDate( value , 8 ); // 不要な記号等を削除し、桁数をそろえる。 164 } 165 166 /** 167 * データが登録可能かどうかをチェックします。 168 * データがエラーの場合は、そのエラー内容を返します。 169 * 170 * @og.rev 3.6.0.0 (2004/09/22) dbType パラメータ(文字パラメータ)を引数に追加 171 * @og.rev 5.2.2.0 (2010/11/01) 厳密にチェック(isStrict=true)するフラグを追加 172 * @og.rev 5.6.0.3 (2012/01/24) 日付チェックの整合性まで含めたチェックを入れる。 173 * 174 * @param key キー 175 * @param value 値 176 * @param sizeX 整数部分の文字列の長さ 177 * @param sizeY 小数部分の文字列の長さ 178 * @param typeParam dbType パラメータ(文字パラメータ) 179 * @param isStrict 厳密にチェックするかどうか[true:する/false:標準的] 180 * 181 * @return エラー内容 182 * @og.rtnNotNull 183 */ 184 @Override 185 public ErrorMessage valueCheck( final String key ,final String value , 186 final int sizeX ,final int sizeY ,final String typeParam ,final boolean isStrict) { 187 188 final ErrorMessage msg = new ErrorMessage(); 189 if( value == null || value.isEmpty() ) { return msg; } 190 191 final int len = (sizeY == 0) ? sizeX : sizeX + sizeY + 1; 192 // 5.2.2.0 (2010/11/01) 厳密にチェック(isStrict=true)するフラグを追加 193 if( isStrict ) { 194 if( len != value.length() ) { 195 // 文字列の長さが指定の長さと異なります。 196 msg.addMessage( 0,ErrorMessage.NG,"ERR0011", key,value, 197 String.valueOf( value.length() ), String.valueOf( len ) ); 198 } 199 } 200 else { 201 if( len < value.length() ) { 202 // 文字列の長さが指定の長さよりも長いです。 203 msg.addMessage( 0,ErrorMessage.NG,"ERR0006",key,value, 204 String.valueOf( value.length() ),String.valueOf( len ) ); 205 } 206 } 207 208 // 5.6.0.3 (2012/01/24) 文字の範囲チェック 209 String check = DBTypeCheckUtil.rangeCheck( value, '0', '9' ); 210 if( check != null ) { 211 // 指定の文字以外の文字が使われています。 212 msg.addMessage( 0,ErrorMessage.NG,"ERR0009", key,check ); 213 } 214 215 // 5.6.0.3 (2012/01/24) 日付文字の整合性チェック 216 // "0000","9999" で始まる日付は未条件許可。 217 check = DBTypeCheckUtil.ymdFormatCheck( value ); 218 if( check != null ) { 219 // 指定の文字以外の文字が使われています。 220 msg.addMessage( 0,ErrorMessage.NG,"ERR0009", key,check ); 221 } 222 223 // 3.6.0.0 (2004/09/22) dbType パラメータ(文字パラメータ)を使用したマッチチェック 224 check = DBTypeCheckUtil.matcheCheck( value,typeParam ); 225 if( check != null ) { 226 // 指定の文字以外の文字が使われています。 227 msg.addMessage( 0,ErrorMessage.NG,"ERR0009", key,check ); 228 } 229 230 return msg; 231 } 232}