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.hayabusa.common.HybsSystem;                                                                 // 8.0.2.0 (2021/11/30) Add
019import org.opengion.hayabusa.db.AbstractEditor;
020import org.opengion.hayabusa.db.CellEditor;
021import org.opengion.hayabusa.db.DBColumn;
022import org.opengion.fukurou.util.TagBuffer;                                                                             // 8.0.2.0 (2021/11/30) Add
023import org.opengion.fukurou.util.StringUtil;                                                                    // 8.0.2.0 (2021/11/30) Add
024import org.opengion.fukurou.util.XHTMLTag;
025
026import static org.opengion.fukurou.util.StringUtil.isNull;                                              // 8.0.2.0 (2021/11/30) Add
027
028/**
029 * YM エディターは、カラムのデータを日付(年/月)編集する場合に使用するクラスです。
030 * 元の値が8桁の場合は先頭6桁にsubstringされます。
031 *
032 *  カラムの表示に必要な属性は, DBColumn オブジェクト より取り出します。
033 * このクラスは、DBColumn オブジェクト毎に1つ作成されます。
034 *
035 * 8.0.2.0 (2021/11/30)
036 * カラムのパラメータの情報より、日付送り戻しの機能が使えます。
037 * 例:M-1,M0,M+1 or M-1,M0,M+1,true
038 *
039 * 第一引数は、日付戻しを指定します。
040 * 第二引数は、初期化します。
041 * 第三引数は、日付送りを指定します。
042 * 第四引数は、検索ボタンを押すか押さないか[true/false]を指定します。 (初期値:false)
043 *
044 * 日付についての加減算処理を行うためのコマンドを指定します。
045 *  ・SYXX :年の最初の日付を指定の分だけ進めます。(SY-1なら先年の1月1日、SY1なら翌年の1月1日)
046 *  ・SDXX :月の最初の日付を指定の分だけ進めます。(SD-1なら先月の1日、SD1なら翌月の1日)
047 *  ・SWXX :週初め(月曜日)を指定の分だけ進めます。(SW-1なら先週の月曜日、SW1なら翌週の月曜日)
048 *  ・EYXX :年の最後の日付を指定の分だけ進めます。(EY-1なら先年の年末、EY1なら翌年の年末)
049 *  ・EDXX :月の最後の日付を指定の分だけ進めます。(ED-1なら先月の月末、ED1なら翌月の月末)
050 *  ・EWXX :週末(日曜日)を指定の分だけ進めます。(EW-1なら先週の日曜日、EW1なら翌週の日曜日)
051 *  ・YXX  :年を指定の分だけ進めます。(Y-1なら1年前、Y1なら1年後)
052 *  ・MXX  :月を指定の分だけ進めます。(M-1なら1月前、M1なら1月後)
053 *  ・DXX  :日を指定の分だけ進めます。(D-1なら1日前、D1なら1日後)
054 *  ※ 数字がゼロのコマンドは初期化します。
055 *  ※ 数字がないコマンドはサーバー上のシステム日付をセットします。
056 *
057 * @og.rev 5.4.3.6 (2012/01/19) コメント修正
058 * @og.rev 8.0.2.0 (2021/11/30) 日付送り戻し対応
059 *
060 * @og.group データ編集
061 *
062 * @version  4.0
063 * @author   Kazuhiko Hasegawa
064 * @since    JDK5.0,
065 */
066public class Editor_YM extends AbstractEditor {
067        /** このプログラムのVERSION文字列を設定します。   {@value} */
068        private static final String VERSION = "8.0.3.0 (2021/12/17)" ;
069
070        // 8.0.2.0 (2021/11/30) 日付送り戻し対応
071        private static final int CNT_ARY                = 3;
072        private static final String JSP_ICON    = HybsSystem.sys( "JSP_ICON" ) ;
073        private static final String FR_STR              = "<a href=\"#\" onClick=\"dateFeedRtn('%1$s','%2$s','%3$s','%4$s','%5$s');\" style=\"margin:0 5px 0 3px\" >";
074        private static final String FR_END              = "<img src=\"" + JSP_ICON + "/%6$s\" alt=\"%4$s\" title=\"%4$s\" /></a>";
075        private static final String[] FR_IMG    = { "FR_PREV.png", "FR_CIRCLE.png", "FR_NEXT.png" };
076
077        private String isSubm                                   = "false";                                                              // 検索ボタンを押すか押さないか
078        private String errMsg;                                                                                                                  // エラーメッセージ
079        private String[] prmAry;                                                                                                                // 編集パラメータ
080
081        private final boolean hidden;
082
083        /**
084         * デフォルトコンストラクター。
085         * このコンストラクターで、基本オブジェクトを作成します。
086         *
087         * @og.rev 3.1.1.1 (2003/04/03) 各オブジェクトから自分のインスタンスを返すファクトリメソッドを追加。
088         * @og.rev 8.0.2.0 (2021/11/30) 日付送り戻し対応
089         *
090         */
091//      public Editor_YM() { super(); }         // これも、自動的に呼ばれるが、空のメソッドを作成すると警告されるので、明示的にしておきます。
092        // 8.0.2.0 (2021/11/30) Modify
093        public Editor_YM() {
094                super();
095                isSubm  = "false";
096                errMsg  = null;
097                prmAry  = null;
098                hidden  = true;
099        }
100
101        /**
102         * DBColumnオブジェクトを指定したprivateコンストラクター。
103         *
104         * @og.rev 3.1.1.1 (2003/04/03) 各オブジェクトから自分のインスタンスを返すファクトリメソッドを追加。
105         * @og.rev 3.5.6.0 (2004/06/18) XHTMLTag の 内部配列 INPUT_KEY を隠蔽します。
106         * @og.rev 8.0.2.0 (2021/11/30) 日付送り戻し対応
107         *
108         * @param       clm     DBColumnオブジェクト
109         */
110        private Editor_YM( final DBColumn clm ) {
111                super( clm );
112                tagBuffer.add( XHTMLTag.inputAttri( attributes ) );
113
114                final boolean disabled = "disabled".equalsIgnoreCase( attributes.get( "disabled" ) );
115                final boolean readonly = "readonly".equalsIgnoreCase( attributes.get( "readonly" ) );   // 8.0.2.0 (2021/11/30)
116
117                // 8.0.2.0 (2021/11/30) Add 日付送り戻し対応
118                hidden = disabled || readonly ;
119                if( !hidden ) {
120                        // 例:M-1,M0,M+1 or M-1,M0,M+1,true
121                        final String prmStr = clm.getEditorParam();
122                        if( prmStr != null ) {
123                                prmAry = StringUtil.csv2Array( prmStr );
124                                // パラメータの第四引数がある場合
125                                if( prmAry.length > CNT_ARY ) {
126                                        isSubm = prmAry[CNT_ARY];
127                                } else if( prmAry.length < CNT_ARY ) {
128                                        errMsg = "editorParam の設定が不足です。"
129                                                                                + " name="  + name
130                                                                                + " label=" + clm.getLabel()
131                                                                                + " editorParam=" + clm.getEditorParam();
132                                        System.out.println( errMsg );
133                                }
134                        }
135                }
136        }
137
138        /**
139         * 各オブジェクトから自分のインスタンスを返します。
140         * 自分自身をキャッシュするのか、新たに作成するのかは、各サブクラスの実装に
141         * まかされます。
142         *
143         * @og.rev 3.1.1.1 (2003/04/03) 各オブジェクトから自分のインスタンスを返すファクトリメソッドを追加。
144         * @og.rev 3.1.2.1 (2003/04/10) synchronized を、削除します。
145         *
146         * @param       clm     DBColumnオブジェクト
147         *
148         * @return      CellEditorオブジェクト
149         * @og.rtnNotNull
150         */
151        public CellEditor newInstance( final DBColumn clm ) {
152                return new Editor_YM( clm );
153        }
154
155        /**
156         * データの編集用文字列を返します。
157         *
158         * @og.rev 8.0.2.0 (2021/11/30) 日付送り戻し対応
159         * @og.rev 8.0.3.0 (2021/12/17) イメージにname属性を付けるため、spanタグで囲います。
160         *
161         * @param       value 入力値
162         *
163         * @return      データの編集用文字列
164         */
165        @Override
166        public String getValue( final String value ) {
167                // 8.0.2.0 (2021/11/30) Add
168                if( prmAry != null && prmAry.length < CNT_ARY ) {
169                        return "<span class=\"error\">" + errMsg + "</span>";
170                }
171
172                // 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
173                // 8.0.2.0 (2021/11/30) Delete
174//              return value != null && value.length() == 8
175//                                      ? super.getValue( value.substring( 0,6 ) )
176//                                      : super.getValue( value );
177
178                // 8.0.2.0 (2021/11/30) Modify
179                final String val = ( value != null && value.length() == 8 ) ? value.substring( 0,6 ) : value ;
180
181                final String tag = new TagBuffer( "input" )
182                                                .add( "name"    , name )
183                                                .add( "id"              , name , isNull( attributes.get( "id" ) ) )
184                                                .add( "value"   , val )
185                                                .add( "size"    , size1 )
186                                                .add( tagBuffer.makeTag() )
187                                                .makeTag();
188
189                if( hidden ) {
190                        return tag;
191                } else {
192                        final StringBuilder buf = new StringBuilder(BUFFER_MIDDLE)
193                                .append( tag );
194
195                        // 日付送り戻し対応
196                        if( prmAry != null && prmAry.length > 0 ) {
197                                final String nmid = isNull( attributes.get( "id" ) ) ? name : attributes.get( "id" );
198                                // 第一回目の処理は、日付戻しを指定します。
199                                // 第二回目の処理は、初期化します。
200                                // 第三回目の処理は、日付送りを指定します。
201                                buf.append( "<span name=\"img" ).append( name ).append( "\">" );        // 8.0.3.0 (2021/12/17)
202                                for( int i=0; i<CNT_ARY; i++ ) {
203                                        buf.append( String.format( FR_STR + FR_END, "YM", nmid, val, prmAry[i], isSubm, FR_IMG[i] ) );
204                                }
205                                buf.append( "</span>" );        // 8.0.3.0 (2021/12/17)
206                        }
207                        return buf.toString();
208                }
209        }
210
211        /**
212         * name属性を変えた、データ表示/編集用のHTML文字列を作成します。
213         * テーブル上の name に 行番号を付加して、名前_行番号 で登録するキーを作成し,
214         * リクエスト情報を1つ毎のフィールドで処理できます。
215         *
216         * @og.rev 7.2.9.4 (2020/11/20) spotbugs:メソッド呼び出しは非 null パラメータに null を渡している
217         * @og.rev 8.0.2.0 (2021/11/30) 日付送り戻し対応
218         * @og.rev 8.0.3.0 (2021/12/17) イメージにname属性を付けるため、spanタグで囲います。
219         *
220         * @param       row             行番号
221         * @param       value   入力値
222         *
223         * @return  データ表示/編集用の文字列
224         */
225        @Override
226        public String getValue( final int row,final String value ) {
227                // 8.0.2.0 (2021/11/30) Add
228                if( prmAry != null && prmAry.length < CNT_ARY ) {
229                        return "<span class=\"error\">" + errMsg + " row=" + row + "</span>";
230                }
231
232                // 7.2.9.4 (2020/11/20) spotbugs:メソッド呼び出しは非 null パラメータに null を渡している
233                final String val = value == null ? ""
234                                                                                 : value.length() > 6 ? value.substring( 0,6 )
235                                                                                                                          : value ;
236
237//              return super.getValue( row,val );                                                                               // 8.0.2.0 (2021/11/30) Delete
238
239//              // 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
240//              return value != null && value.length() == 8
241//                                      ? super.getValue( row,value.substring( 0,6 ) )
242//                                      : super.getValue( row,value );
243
244                // 8.0.2.0 (2021/11/30) Modify
245                final String name2 = name + HybsSystem.JOINT_STRING + row ;
246
247                final String tag = new TagBuffer( "input" )
248                                                .add( "name"    , name2 )
249                                                .add( "id"              , name2 , isNull( attributes.get( "id" ) ) )
250                                                .add( "value"   , val )
251                                                .add( "size"    , size2 )
252                                                .add( tagBuffer.makeTag() )
253                                                .makeTag( row,val );
254
255                if( hidden ) {
256                        return tag;
257                } else {
258                        final StringBuilder buf = new StringBuilder(BUFFER_MIDDLE)
259                                .append( tag );
260
261                        // 日付送り戻し対応
262                        if( prmAry != null && prmAry.length > 0 ) {
263                                final String nmid = isNull( attributes.get( "id" ) ) ? name2 : attributes.get( "id" );
264                                // 第一回目の処理は、日付戻しを指定します。
265                                // 第二回目の処理は、初期化します。
266                                // 第三回目の処理は、日付送りを指定します。
267                                buf.append( "<span name=\"img" ).append( name2 ).append( "\">" );       // 8.0.3.0 (2021/12/17)
268                                for( int i=0; i<CNT_ARY; i++ ) {
269                                        buf.append( String.format( FR_STR + FR_END, "YM", nmid, val, prmAry[i], isSubm, FR_IMG[i] ) );
270                                }
271                                buf.append( "</span>" );        // 8.0.3.0 (2021/12/17)
272                        }
273                        return buf.toString();
274                }
275        }
276}