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