    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.util.ErrorMessage;
    019import org.opengion.fukurou.util.HybsDateUtil;
    020import org.opengion.hayabusa.db.DBTypeCheckUtil;
    021
    022/**
    023 * 文字列の日付属性(年/月)の半角の日付を扱う為の、カラム属性を定義します。
    024 *
    025 * yyyyMM に対応している必要があります。
    026 * "000000" と、"999999" は、常に許可になります。
    027 * ただし、日付の整合性チェックは行いませんが、valueAdd( String value )による
    028 * 日付(月)の加算時には、0000XX と 9999XX は、加算されず、それ以外は、
    029 * 正式な日付で加算されます。
    030 *
    031 * タイプチェックとして、以下の条件を判定します。
    032 * ・文字列長は、直接計算で文字数との比較
    033 * ・日付使用文字チェック「('0' &gt; c || '9' &lt; c)以外」エラー
    034 * ・文字パラメータの 正規表現チェック
    035 *
    036 * @og.rev 3.6.0.0 (2004/09/17) 新規作成
    037 * @og.group データ属性
    038 *
    039 * @version  4.0
    040 * @author   Kazuhiko Hasegawa
    041 * @since    JDK5.0,
    042 */
    043public class DBType_YM extends DBType_YMD {
    044        /** このプログラムのVERSION文字列を設定します。   {@value} */
    045        private static final String VERSION = "7.2.5.1 (2020/06/05)" ;
    046
    047        /**
    048         * デフォルトコンストラクター
    049         *
    050         * @og.rev 6.4.2.0 (2016/01/29) PMD refactoring. Each class should declare at least one constructor.
    051         */
    052        public DBType_YM() { super(); }         // これも、自動的に呼ばれるが、空のメソッドを作成すると警告されるので、明示的にしておきます。
    053
    054        /**
    055         * String引数の文字列を＋１した文字列を返します。
    056         * ここでは、yyyyMM 形式のデータに、＋１ するので、月を＋１します。
    057         *
    058         * 0000XX と、9999XX は、引数の値そのままを返します。
    059         * 引数が null の場合と、ゼロ文字列("")の場合は、物理的初期設定値(String getDefault())
    060         * の値を返します。
    061         * それ以外の場合は、日付計算を行い、月を加算します。よって、年月フォーマットに
    062         * 合わないデータを指定した場合は、エラーになりますので、ご注意ください。
    063         *
    064         * @og.rev 5.5.7.2 (2012/10/09) HybsDateUtil を利用するように修正します。
    065         *
    066         * @param       value   String引数の文字列
    067         *
    068         * @return  String引数の文字列を＋１した文字列
    069         */
    070        @Override
    071        public String valueAdd( final String value ) {
    072                // 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
    073                return value == null || value.isEmpty()
    074                                        ? getDefault()
    075                                        : value.startsWith( "0000" ) || value.startsWith( "9999" )
    076                                                ? value
    077                                                : HybsDateUtil.getMonthPlus( value , 1 );
    078        }
    079
    080        /**
    081         * String引数の文字列に、第２引数に指定の文字列(数字、日付等)を加算して返します。
    082         *
    083         * ここでは、yyyyMM 形式のデータに、月を加算します。
    084         * 0000XX と、9999XX は、引数の値そのままを返します。
    085         * 引数が null の場合と、ゼロ文字列("")の場合は、物理的初期設定値(String getDefault())
    086         * の値を返します。
    087         * それ以外の場合は、日付計算を行い、月を加算します。よって、年月フォーマットに
    088         * 合わないデータを指定した場合は、エラーになりますので、ご注意ください。
    089         *
    090         * @og.rev 5.6.0.3 (2012/01/24) ADD に、引数の値を加算する機能を追加します。
    091         *
    092         * @param   value  String引数
    093         * @param   add    加算する月文字列
    094         *
    095         * @return  引数の文字列に月を加算します。
    096         */
    097        @Override
    098        public String valueAdd( final String value,final String add ) {
    099                if( value == null || value.isEmpty() ) { return getDefault(); }
    100                if( value.startsWith( "0000" ) || value.startsWith( "9999" ) ) { return value; }        // 特別な値
    101
    102                // 6.3.9.1 (2015/11/27) Found 'DD'-anomaly for variable(PMD)
    103                // 6.4.1.1 (2016/01/16) PMD refactoring. Avoid if (x != y) ..; else ..;
    104                final int addSu = add == null || add.isEmpty() ? 1 : Integer.parseInt( add ) ;          // 6.3.9.1 (2015/11/27)
    105
    106                return HybsDateUtil.getMonthPlus( value , addSu );
    107        }
    108
    109        /**
    110         * エディターで編集されたデータを登録する場合に、データそのものを
    111         * 変換して、実登録データを作成します。
    112         * 例えば、大文字のみのフィールドなら、大文字化します。
    113         * 実登録データの作成は、DBType オブジェクトを利用しますので、
    114         * これと Editor とがアンマッチの場合は、うまくデータ変換
    115         * されない可能性がありますので、注意願います。
    116         *
    117         * @og.rev 5.5.7.2 (2012/10/09) HybsDateUtil を利用するように修正します。
    118         * @og.rev 5.6.6.0 (2013/07/05) parseDate を改造し、日付の桁数指定を厳密に判定します。
    119         *
    120         * @param       value   (一般に編集データとして登録されたデータ)
    121         * @return  修正後の文字列(一般にデータベースに登録するデータ)
    122         */
    123        @Override
    124        public String valueSet( final String value ) {
    125                // 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
    126                return value == null || value.isEmpty() ? getDefault() : HybsDateUtil.parseDate( value , 6 );
    127        }
    128
    129        /**
    130         * データが登録可能かどうかをチェックします。
    131         * データがエラーの場合は、そのエラー内容を返します。
    132         * "000000" と、"999999" は、常に許可になります。
    133         *
    134         * @og.rev 5.6.0.3 (2012/01/24) 日付チェックの整合性まで含めたチェックを入れる。
    135         * @og.rev 7.2.5.1 (2020/06/05) 数値変換エラーの前にチェックを入れます。
    136         *
    137         * @param   key         キー
    138         * @param   value       値
    139         * @param   sizeX       整数部分の文字列の長さ
    140         * @param   sizeY       小数部分の文字列の長さ
    141         * @param   typeParam   dbType パラメータ(文字パラメータ)
    142         * @param   isStrict    厳密にチェックするかどうか[true:する/false:標準的]
    143         *
    144         * @return  エラー内容
    145         * @og.rtnNotNull
    146         */
    147        @Override
    148        public ErrorMessage valueCheck( final String key ,final String value ,
    149                                                                        final int sizeX ,final int sizeY ,final String typeParam ,final boolean isStrict) {
    150
    151                final ErrorMessage msg = new ErrorMessage();
    152                if( value == null || value.isEmpty() ) { return msg; }
    153
    154                final int len = (sizeY == 0) ? sizeX : sizeX + sizeY + 1;
    155                // 厳密に一致しないとエラーとする。
    156                if( len != value.length() ) {
    157                        // 文字列の長さが指定の長さと異なります。
    158                        msg.addMessage( 0,ErrorMessage.NG,"ERR0011", key,value,
    159                                                                        String.valueOf( value.length() ), String.valueOf( len ) );
    160                }
    161
    162                // 7.2.5.1 (2020/06/05) 文字の範囲チェックは、ymdFormatCheck の中で行っている。
    163//              // 5.6.0.3 (2012/01/24) 文字の範囲チェック
    164//              String check = DBTypeCheckUtil.rangeCheck( value, '0', '9' );
    165//              if( check != null ) {
    166//                      // 指定の文字以外の文字が使われています。
    167//                      msg.addMessage( 0,ErrorMessage.NG,"ERR0009", key,check );
    168//              }
    169
    170                // 5.6.0.3 (2012/01/24) 日付文字の整合性チェック
    171                // "0000","9999" で始まる日付は未条件許可。
    172                String check = DBTypeCheckUtil.ymdFormatCheck( value );
    173                if( check != null ) {
    174                        // 指定の文字以外の文字が使われています。
    175                        msg.addMessage( 0,ErrorMessage.NG,"ERR0009", key,check );
    176                }
    177
    178                // 3.6.0.0 (2004/09/22) dbType パラメータ(文字パラメータ)を使用したマッチチェック
    179                check = DBTypeCheckUtil.matcheCheck( value,typeParam );
    180                if( check != null ) {
    181                        // 指定の文字以外の文字が使われています。
    182                        msg.addMessage( 0,ErrorMessage.NG,"ERR0009", key,check );
    183                }
    184
    185                return msg;
    186        }
    187}