    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 org.opengion.fukurou.model.NativeType;
    019import org.opengion.fukurou.util.ErrorMessage;
    020import org.opengion.fukurou.util.HybsDateUtil;
    021import org.opengion.hayabusa.common.HybsSystemException;
    022import org.opengion.hayabusa.db.AbstractDBType;
    023import org.opengion.hayabusa.db.DBTypeCheckUtil;
    024
    025/**
    026 * 文字列の開始日付属性を規定する半角文字列を扱う為の、カラム属性を定義します。
    027 * 登録時に0000XXXXは00000101、9999XXXXは99991231、それ以外はYYYYMM01と変換します。
    028 *
    029 * YYYYMM01 または、00000XXXX , 9999XXXX を許可します。
    030 * また、入力データとして, YYYYMM 形式 は、許可しません。あらかじめ,
    031 * valueSet( String ) でデータを変換しておく必要があります。
    032 * ただし、日付としての整合性チェックは行いません。
    033 *
    034 * タイプチェックとして、以下の条件を判定します。
    035 * ・文字列長は、直接計算で文字数との比較
    036 * ・日付使用文字チェック「('0' &gt; c || '9' &lt; c)以外」エラー
    037 * ・文字パラメータの 正規表現チェック
    038 *
    039 * @og.rev 5.4.3.6 (2012/01/19) コメント修正
    040 * @og.group データ属性
    041 *
    042 * @version  4.0
    043 * @author   Kazuhiko Hasegawa
    044 * @since    JDK5.0,
    045 */
    046public class DBType_YM01 extends AbstractDBType {
    047        /** このプログラムのVERSION文字列を設定します。   {@value} */
    048        private static final String VERSION = "7.2.5.1 (2020/06/05)" ;
    049
    050        private static final String DEF_VALUE = "00000000" ;    // データのデフォルト値
    051
    052        /**
    053         * デフォルトコンストラクター
    054         *
    055         * @og.rev 4.0.0.0 (2005/01/31) type 廃止
    056         */
    057        public DBType_YM01() {
    058                super( DEF_VALUE );
    059        }
    060
    061        /**
    062         * NATIVEの型の識別コードを返します。
    063         *
    064         * @og.rev 3.8.5.3 (2006/08/07) 新規作成
    065         * @og.rev 4.1.1.2 (2008/02/28) Enum型(fukurou.model.NativeType)に変更
    066         *
    067         * @return  NATIVEの型の識別コード(DBType で規定)
    068         * @og.rtnNotNull
    069         * @see org.opengion.fukurou.model.NativeType
    070         */
    071        @Override
    072        public NativeType getNativeType() {
    073                return NativeType.CALENDAR;
    074        }
    075
    076        /**
    077         * 半角スペースで固定長(半角換算の数)に変換した文字列を返します。
    078         * なお、エラーチェックは行われません。
    079         * 実行前に、必ず valueCheck( String value ,int len ) が行われる必要があります。
    080         *
    081         * @og.rev 3.5.4.5 (2004/01/23) エンコード指定に変更します。
    082         *
    083         * @param   value    ＦＩＬＬ埋めする文字列
    084         * @param   sizeX    整数部分の文字列の長さ
    085         * @param   sizeY    小数部分の文字列の長さ
    086         * @param   encode   固定長で変換する文字エンコード
    087         *
    088         * @return  ＦＩＬＬ埋めした新しい文字列
    089         * @og.rtnNotNull
    090         */
    091        @Override
    092        public String valueFill( final String value ,final int sizeX ,final int sizeY,final String encode ) {
    093                if( value != null && value.length() >= sizeX ) {
    094                        return value.substring( 0, sizeX );
    095                }
    096
    097                final String errMsg = "指定文字が不正です。value=[" + value + "] length=[" + sizeX + "]";
    098                throw new HybsSystemException( errMsg );
    099        }
    100
    101        /**
    102         * String引数の文字列を＋１した文字列を返します。
    103         * ここでは、YYYYMM 形式のデータに、＋１ するので、月を＋１します。
    104         *
    105         * 0000XX と、9999XX は、引数の値そのままを返します。
    106         * 引数が null の場合と、ゼロ文字列("")の場合は,物理的初期設定値(String getDefault())
    107         * の値を返します。
    108         * それ以外の場合は、日付計算を行い、月を加算します。よって、年月フォーマットに
    109         * 合わないデータを指定した場合は、エラーになりますので、ご注意ください。
    110         *
    111         * @og.rev 3.6.0.0 (2004/09/17) 月の加算ロジックの誤り修正。(roll ⇒ add)
    112         * @og.rev 5.5.7.2 (2012/10/09) HybsDateUtil を利用するように修正します。
    113         *
    114         * @param       value   String引数の文字列
    115         *
    116         * @return  String引数の文字列を＋１した文字列
    117         */
    118        @Override
    119        public String valueAdd( final String value ) {
    120                // 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
    121                return value == null || value.isEmpty()
    122                                        ? getDefault()
    123                                        : value.startsWith( "0000" ) || value.startsWith( "9999" )
    124                                                ? value
    125                                                : HybsDateUtil.getMonthPlus( value , 1 ) + "01";
    126        }
    127
    128        /**
    129         * 入力データの整合性を合わせた結果を返します。
    130         * ここでは、日付データに含まれるフォーマット文字列を削除し、数字だけの
    131         * 文字列を作成し、YYYYMM 形式の先頭６文字 ＋ "01" のデータを作成します。
    132         * このメソッドでは、日付欄は、必ず "01" になります。
    133         * 実登録データの作成は、DBType オブジェクトを利用しますので,
    134         * これと Editor とがアンマッチの場合は、うまくデータ変換
    135         * されない可能性がありますので、注意願います。
    136         *
    137         * @og.rev 3.3.3.0 (2003/07/09) 前後のスペースを取り除いておく。
    138         * @og.rev 4.3.3.4 (2008/12/01) 0000 or 9999 時のバグ修正
    139         * @og.rev 5.5.7.2 (2012/10/09) HybsDateUtil を利用するように修正します。
    140         * @og.rev 5.6.6.0 (2013/07/05) parseDate を改造し、日付の桁数指定を厳密に判定します。
    141         *
    142         * @param       value   (一般に編集データとして登録されたデータ)
    143         *
    144         * @return  修正後の文字列(一般にデータベースに登録するデータ)
    145         */
    146        @Override
    147        public String valueSet( final String value ) {
    148                // 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
    149                return value == null || value.isEmpty() ? getDefault() : HybsDateUtil.parseDate( value , 6 ) + "01";
    150        }
    151
    152        /**
    153         * データが登録可能かどうかをチェックします。
    154         * データがエラーの場合は、そのエラー内容を返します。
    155         * valueSet( String ) する以前の文字については,整合性は保証していません。
    156         *
    157         * @og.rev 3.6.0.0 (2004/09/22) dbType パラメータ(文字パラメータ)を引数に追加
    158         * @og.rev 5.2.2.0 (2010/11/01) 厳密にチェック(isStrict=true)するフラグを追加
    159         * @og.rev 5.6.0.3 (2012/01/24) 日付チェックの整合性まで含めたチェックを入れる。
    160         * @og.rev 7.2.5.1 (2020/06/05) 数値変換エラーの前にチェックを入れます。
    161         *
    162         * @param   key         タグのキー(カラムID)
    163         * @param   value       チェックする値
    164         * @param   sizeX       整数部分の文字列の長さ
    165         * @param   sizeY       小数部分の文字列の長さ
    166         * @param   typeParam   dbType パラメータ(文字パラメータ)
    167         * @param   isStrict    厳密にチェックするかどうか[true:する/false:標準的]
    168         *
    169         * @return  エラー内容
    170         * @og.rtnNotNull
    171         */
    172        @Override
    173        public ErrorMessage valueCheck( final String key ,final String value ,
    174                                                                        final int sizeX ,final int sizeY ,final String typeParam ,final boolean isStrict) {
    175
    176                final ErrorMessage msg = new ErrorMessage();
    177                if( value == null || value.isEmpty() ) { return msg; }
    178
    179                final int len = (sizeY == 0) ? sizeX : sizeX + sizeY + 1;
    180                // 5.2.2.0 (2010/11/01) 厳密にチェック(isStrict=true)するフラグを追加
    181                if( isStrict ) {
    182                        if( len != value.length() ) {
    183                                // 文字列の長さが指定の長さと異なります。
    184                                msg.addMessage( 0,ErrorMessage.NG,"ERR0011", key,value, String.valueOf( value.length() ), String.valueOf( len ) );
    185                        }
    186                }
    187                else {
    188                        if( len < value.length() ) {
    189                                // 文字列の長さが指定の長さよりも長いです。
    190                                msg.addMessage( 0,ErrorMessage.NG,"ERR0006",key,value,
    191                                                                                String.valueOf( value.length() ),String.valueOf( len ) );
    192                        }
    193                }
    194
    195                // 7.2.5.1 (2020/06/05) 文字の範囲チェックは、ymdFormatCheck の中で行っている。
    196//              // 5.6.0.3 (2012/01/24) 文字の範囲チェック
    197//              String check = DBTypeCheckUtil.rangeCheck( value, '0', '9' );
    198//              if( check != null ) {
    199//                      // 指定の文字以外の文字が使われています。
    200//                      msg.addMessage( 0,ErrorMessage.NG,"ERR0009", key,check );
    201//              }
    202
    203                // 5.6.0.3 (2012/01/24) 日付文字の整合性チェック
    204                // "0000","9999" で始まる日付は未条件許可。
    205                String check = DBTypeCheckUtil.ymdFormatCheck( value );
    206                if( check != null ) {
    207                        // 指定の文字以外の文字が使われています。
    208                        msg.addMessage( 0,ErrorMessage.NG,"ERR0009", key,check );
    209                }
    210
    211                // 3.6.0.0 (2004/09/22) dbType パラメータ(文字パラメータ)を使用したマッチチェック
    212                check = DBTypeCheckUtil.matcheCheck( value,typeParam );
    213                if( check != null ) {
    214                        // 指定の文字以外の文字が使われています。
    215                        msg.addMessage( 0,ErrorMessage.NG,"ERR0009", key,check );
    216                }
    217
    218                return msg;
    219        }
    220}