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.hayabusa.taglib;
017
018import org.opengion.hayabusa.common.HybsSystem;
019import org.opengion.hayabusa.common.HybsSystemException;
020import org.opengion.hayabusa.db.DBTableModel;
021import org.opengion.hayabusa.db.TableFilter;
022import org.opengion.fukurou.db.Transaction;
023import org.opengion.fukurou.util.ErrorMessage;
024import org.opengion.fukurou.util.StringUtil;
025import org.opengion.fukurou.util.ToString;                                              // 6.1.1.0 (2015/01/17)
026
027import static org.opengion.fukurou.util.StringUtil.nval ;
028
029import java.util.concurrent.ConcurrentMap;                                              // 6.4.3.3 (2016/03/04)
030import java.util.Map;                                                                                   // 7.4.0.1 (2021/04/16)
031
032/**
033 * TableFilter のサブクラスをCALLしてDBTableModelにアクセスするタグです。
034 *
035 * DBTableModel を TableFilter のサブクラス(classIdで指定)に渡して処理を実行します。
036 * クラスを作成する場合は、org.opengion.hayabusa.db.TableFilter インターフェースを継承した
037 * クラスにする必要があります。また、classId 属性には、システムリソース で
038 * 設定した TableFilter.XXXX の XXXX を指定します。
039 *
040 * BODY部分は、SQLを記述する為だけに使っていましたが、CSS定義形式の書式で、keys,vals を記述
041 * できるようにします。
042 * これは、下記のようなパラメータを、keys="KEY,KEY2,KEY3" vals='AAAA,"BB,CC,DD",EE' のような記述形式と
043 *   {
044 *        KEY1 : AAAA ;
045 *        KEY2 : BB,CC,DD ;
046 *        KEY3 : EE ;
047 *        ・・・・・・
048 *   }
049 * のような、CSS形式に類似の形式でも記述できるようにしました。
050 * keys,vals と CSS定義形式パラメータを同時に指定した場合は、両方とも有効です。
051 * ただし、キーが重複した場合は、不定と考えてください。
052 * 現時点では、CSS定義形式パラメータが優先されますが、これは、単に内部パラメータMapへの
053 * 登録順が、CSS定義形式パラメータが後の為、上書きされるためです。
054 *
055 * ※ このタグは、Transaction タグの対象です。
056 *
057 * @og.formSample
058 * ●形式:<og:tableFilter classId="…" />
059 * ●body:あり(EVAL_BODY_BUFFERED:BODYを評価し、{@XXXX} を解析します)
060 *
061 * ●Tag定義:
062 *   <og:tableFilter
063 *       classId          ○【TAG】データベース処理を実行するクラスパスを指定します(必須)。
064 *       tableId            【TAG】(通常は使いません)DBTableModel sessionに登録されているキーを指定します
065 *       modifyType         【TAG】データ処理の方法(A:追加 C:更新 D:削除)を指定します
066 *       keys               【TAG】リンク先に渡すキーを指定します
067 *       vals               【TAG】keys属性に対応する値をCSV形式で複数指定します
068 *       selectedAll        【TAG】データを全件選択済みとして処理するかどうか[true/false]を指定します(初期値:false)
069 *       stopZero           【TAG】検索結果が0件のとき処理を続行するかどうか[true/false]を指定します(初期値:false[続行する])
070 *       scope              【TAG】キャッシュする場合のスコープ[request/page/session/application]を指定します(初期値:session)
071 *       dbid               【TAG】(通常は使いません)Queryオブジェクトを作成する時のDB接続IDを指定します
072 *       useSLabel          【TAG】7.0.7.0 (2019/12/13) エラーメッセージにSLABELを利用するかどうか[true/false]を指定します(初期値:false)
073 *       caseKey            【TAG】このタグ自体を利用するかどうかの条件キーを指定します(初期値:null) 5.7.7.2 (2014/06/20)
074 *       caseVal            【TAG】このタグ自体を利用するかどうかの条件値を指定します(初期値:null) 5.7.7.2 (2014/06/20)
075 *       caseNN             【TAG】指定の値が、null/ゼロ文字列 でない場合(Not Null=NN)は、このタグは使用されます(初期値:判定しない) 5.7.7.2 (2014/06/20)
076 *       caseNull           【TAG】指定の値が、null/ゼロ文字列 の場合は、このタグは使用されます(初期値:判定しない) 5.7.7.2 (2014/06/20)
077 *       caseIf             【TAG】指定の値が、true/TRUE文字列の場合は、このタグは使用されます(初期値:判定しない)
078 *       debug              【TAG】デバッグ情報を出力するかどうか[true/false]を指定します(初期値:false)
079 *   >   ... Body ...
080 *   </og:tableFilter>
081 *
082 * ●使用例
083 *    ・引数/プロシジャーを直接書く場合
084 *    【entry.jsp】
085 *        <og:tableFilter
086 *            classId     = "WL_LOGICSET"         :TableFilter のサブクラス(実行クラス)
087 *            tableId     = "WL0000"              :登録元のDBTableModelのsession/request変数内の取得キー
088 *            keys        = "AA,BB,CC"            :実行クラスへの引数のキー
089 *            vals        = "{@AA},{@BB},{@CC}"   :実行クラスへの引数の値
090 *            selectedAll = "false/true"          :処理対象の行を全行選択するかどうか(初期値:false)
091 *            modifyType  = "A/C/D"               :処理の方法(A:追加 C:更新 D:削除)を指定します。初期値は自動です。
092 *        />
093 *
094 *    ・BODY部分に、CSS形式のパラメータ(keys,vals)を記述する例
095 *
096 *        <og:tableFilter
097 *            classId     = "WL_LOGICSET"         :TableFilter のサブクラス(実行クラス)
098 *            tableId     = "WL0000"              :登録元のDBTableModelのsession/request変数内の取得キー
099 *            selectedAll = "false/true"          :処理対象の行を全行選択するかどうか(初期値:false)
100 *            modifyType  = "A/C/D"               :処理の方法(A:追加 C:更新 D:削除)を指定します。初期値は自動です。
101 *        >
102 *               {
103 *                   AA    :  {@AA}
104 *                   BB    :  {@BB}
105 *                   CC    :  {@CC}
106 *               }
107 *        </og:tableFilter>
108 *
109 * @og.group その他
110 * @og.rev 3.8.5.0 (2006/03/20) 新規作成
111 *
112 * @version  0.9.0  2000/10/17
113 * @author   Kazuhiko Hasegawa
114 * @since    JDK1.1,
115 */
116public class TableFilterTag extends CommonTagSupport {
117        /** このプログラムのVERSION文字列を設定します。   {@value} */
118        private static final String VERSION = "7.0.7.0 (2019/12/13)" ;
119        private static final long serialVersionUID = 707020191213L ;
120
121        private static final String ERR_MSG_ID  = HybsSystem.ERR_MSG_KEY;               // 6.4.1.1 (2016/01/16) errMsgId  → ERR_MSG_ID  refactoring
122        private transient DBTableModel  table   ;
123
124        private String          tableId         = HybsSystem.TBL_MDL_KEY;
125        private String          classId         ;
126        private String          modifyType      ;
127        private String[]        keys            ;
128        private String[]        vals            ;
129
130        private   String        dbid            ;       // 4.2.4.0 (2008/06/23)
131        private   String        sql                     ;       // 5.6.5.2 (2013/06/21) bodyからSQL文のみを切り出す。
132        /** 6.4.3.1 (2016/02/12) PMD refactoring. 取り出し元を HashMap → ConcurrentHashMap に置き換え。  */
133        private   ConcurrentMap<String,String>  paramMap;       // 5.6.5.2 (2013/06/21) bodyからparamMapを取りだし。
134
135        private boolean         selectedAll     ;
136        private boolean         stopZero        ;       // 5.7.6.2 (2014/05/16) stopZero属性追加
137        private boolean         useSLabel       ;       // 7.0.7.0 (2019/12/13) エラーメッセージにSLABELを利用するかどうか[true/false]を指定します(初期値:false)
138
139        /**
140         * デフォルトコンストラクター
141         *
142         * @og.rev 6.4.2.0 (2016/01/29) PMD refactoring. Each class should declare at least one constructor.
143         */
144        public TableFilterTag() { super(); }            // これも、自動的に呼ばれるが、空のメソッドを作成すると警告されるので、明示的にしておきます。
145
146        /**
147         * Taglibの開始タグが見つかったときに処理する doStartTag() を オーバーライドします。
148         *
149         * @og.rev 5.7.7.2 (2014/06/20) caseKey,caseVal,caseNN,caseNull 属性を追加
150         *
151         * @return      後続処理の指示( EVAL_BODY_BUFFERED )
152         */
153        @Override
154        public int doStartTag() {
155                // 5.7.7.2 (2014/06/20) caseKey,caseVal,caseNN,caseNull 属性を追加
156                if( !useTag() ) { return SKIP_BODY ; }
157
158                table = (DBTableModel)getObject( tableId );
159
160                if( keys != null && vals != null && keys.length != vals.length ) {
161                        final String errMsg = "keys と vals の設定値の数が異なります。: " + CR
162                                                + "keys.length=[" + keys.length + "] , "
163                                                + "keys.length=[" + StringUtil.array2line( keys,"," ) + "]"
164                                                + CR
165                                                + "vals.length=[" + vals.length + "] , "
166                                                + "vals.length=[" + StringUtil.array2line( vals,"," ) + "]";
167                        throw new HybsSystemException( errMsg );
168                }
169
170                startQueryTransaction( tableId );
171                return EVAL_BODY_BUFFERED ;             // Body を評価する
172        }
173
174        /**
175         * Taglibのタグ本体を処理する doAfterBody() を オーバーライドします。
176         *
177         * @og.rev 5.6.5.2 (2013/06/21) bodyローカル化、sql、paramMap 追加
178         *
179         * @return      後続処理の指示(SKIP_BODY)
180         */
181        @Override
182        public int doAfterBody() {
183                final String body = nval( getBodyString(),null );
184
185                // paramMapの取り出し
186                paramMap = StringUtil.cssParse( body );
187
188                // SQL文の切り出し classId="DBSELECT" の場合のみの処理
189                if( "DBSELECT".equalsIgnoreCase( classId ) && body != null ) {
190                        final int ad1 = body.indexOf( '{' );
191                        final int ad2 = body.indexOf( '}' );
192
193                        if( ad1 >= 0 && ad2 >= 0 ) {
194                                sql = body.substring( 0,ad1 ).trim() + body.substring( ad2+1 ).trim();
195                        }
196                        else {
197                                sql = body.trim();
198                        }
199                }
200
201                return SKIP_BODY ;
202        }
203
204        /**
205         * Taglibの終了タグが見つかったときに処理する doEndTag() を オーバーライドします。
206         *
207         * @og.rev 3.8.7.0 (2006/12/15) アクセスログ取得の為,ApplicationInfoオブジェクトを設定
208         * @og.rev 4.2.3.0 (2008/06/23) DBIDとボディー部分の記述を下位クラスに渡す用に修正
209         * @og.rev 4.3.7.4 (2009/07/01) Resouceオブジェクトを下位クラスに渡す用に修正
210         * @og.rev 5.1.9.0 (2010/08/01) Transaction 対応
211         * @og.rev 5.2.1.0 (2010/10/01) debugPrint() メソッドの処理条件見直し
212         * @og.rev 5.3.7.0 (2011/07/01) TransactionReal の引数変更 、Transaction対応で、close処理を入れる。
213         * @og.rev 5.6.5.2 (2013/06/21) bodyローカル化、sql、paramMap 追加
214         * @og.rev 5.7.6.2 (2014/05/16) table件数が変わる場合、"DB.COUNT" キーでリクエストに再セットする。
215         * @og.rev 5.7.7.2 (2014/06/20) caseKey,caseVal,caseNN,caseNull 属性を追加
216         * @og.rev 6.0.4.0 (2014/11/28) NullPointerException が発生するので、事前にチェックします。
217         * @og.rev 6.3.6.1 (2015/08/28) Transaction でAutoCloseableを使用したtry-with-resources構築に対応。
218         * @og.rev 6.4.3.3 (2016/03/04) HybsSystem.newInstance(String,String) への置き換え。
219         * @og.rev 7.0.7.0 (2019/12/13) useSLabel 属性を追加。
220         *
221         * @return      後続処理の指示
222         */
223        @Override
224        public int doEndTag() {
225                // デバッグ時には、オブジェクト内部情報を表示する。
226                debugPrint();   // 5.2.1.0 (2010/10/01) debugPrint() メソッド自体に、isDebug() が組み込まれている。
227
228                // 5.7.7.2 (2014/06/20) caseKey,caseVal,caseNN,caseNull 属性を追加
229                if( !useTag() ) { return EVAL_PAGE ; }
230
231                int rtnCode = EVAL_PAGE;        // try ~ finally の関係で、変数化しておく
232
233                final int[] rowNo = getParameterRows();
234
235                // 5.1.9.0 (2010/08/01) Transaction 対応
236                // 5.3.7.0 (2011/07/01) Transaction対応で、close処理を入れる。
237
238                // 6.3.6.1 (2015/08/28) Transaction でAutoCloseableを使用したtry-with-resources構築に対応。
239                try( Transaction tran = getTransaction() ) {
240
241                        final TableFilter filter = HybsSystem.newInstance( "TableFilter_" , classId );
242
243                        filter.setDBTableModel( table );
244                        filter.setParameterRows( rowNo );
245                        filter.setModifyType( modifyType );
246                        filter.setKeysVals( keys,vals );
247        //              filter.setApplicationInfo( getApplicationInfo() );      // 3.8.7.0 (2006/12/15)
248                        filter.setTransaction( tran );                                          // 5.1.9.0 (2010/08/01) Transaction 対応
249                        filter.setDebug( isDebug() );
250                        filter.setDbid( dbid );                                 // 4.2.4.0 (2008/06/23)
251                        filter.setSql( sql );                                   // 5.6.5.2 (2013/06/21) sql 追加
252                        filter.setParamMap( paramMap );                 // 5.6.5.2 (2013/06/21) paramMap 追加
253                        filter.setResource( getResource() );    // 4.3.7.4 (2009/07/01)
254
255                        // 6.4.1.1 (2016/01/16) PMD refactoring. Avoid declaring a variable if it is unreferenced before a possible exit point.
256                        final int rowCnt1 = table == null ? -1 : table.getRowCount();   // filter 処理の前の行件数をチェック
257
258                        table = filter.execute();
259
260                        // 7.4.0.1 (2021/04/16) filterからの値の戻し
261                        for( final Map.Entry<String,String> entry : filter.getReturnMap().entrySet() ) {
262                                setRequestAttribute( entry.getKey() , entry.getValue() );
263                        }
264
265                        // 5.7.6.2 (2014/05/16) table件数が変わる場合、"DB.COUNT" キーでリクエストに再セットする。
266                        final int rowCnt2 = table == null ? -1 : table.getRowCount();
267                        if( rowCnt1 != rowCnt2 ) {
268                                setRequestAttribute( "DB.COUNT" , String.valueOf( rowCnt2 ) );
269                        }
270
271                        final int errCode = filter.getErrorCode();
272
273                        if( errCode >= ErrorMessage.NG )  {     // 異常
274                                rtnCode = SKIP_PAGE;
275                        }
276
277                        // 5.7.6.2 (2014/05/16) 件数0件(または、table==null)かつ stopZero = true
278                        if( rowCnt2 <= 0 && stopZero ) { return SKIP_PAGE; }
279
280                        // 6.4.1.1 (2016/01/16) PMD refactoring. Avoid declaring a variable if it is unreferenced before a possible exit point.
281                        final ErrorMessage errMessage = filter.getErrorMessage();
282//                      final String err = TaglibUtil.makeHTMLErrorTable( errMessage,getResource() );
283                        final String err = TaglibUtil.makeHTMLErrorTable( errMessage,getResource(),useSLabel );         // 7.0.7.0 (2019/12/13)
284                        if( err != null && err.length() > 0 ) {
285                                jspPrint( err );
286                                setSessionAttribute( ERR_MSG_ID,errMessage );
287                        }
288                        else {
289                                removeSessionAttribute( ERR_MSG_ID );
290                        }
291                        tran.commit();                          // 6.3.6.1 (2015/08/28)
292                }
293
294                if( table != null && ! commitTableObject( tableId, table ) ) {
295                        rtnCode = SKIP_PAGE ;
296                }
297
298                return rtnCode ;
299        }
300
301        /**
302         * タグリブオブジェクトをリリースします。
303         * キャッシュされて再利用されるので、フィールドの初期設定を行います。
304         *
305         * @og.rev 5.6.5.2 (2013/06/21) body廃止、sql、paramMap 追加
306         * @og.rev 5.7.6.2 (2014/05/16) stopZero属性追加
307         * @og.rev 7.0.7.0 (2019/12/13) useSLabel 属性を追加。
308         */
309        @Override
310        protected void release2() {
311                super.release2();
312                table           = null;
313                tableId         = HybsSystem.TBL_MDL_KEY;
314                classId         = null;
315                modifyType      = null;
316                keys            = null;
317                vals            = null;
318                selectedAll     = false;
319                stopZero        = false;        // 5.7.6.2 (2014/05/16) stopZero属性追加
320                dbid            = null;         // 4.2.4.0 (2008/06/23)
321                sql                     = null;         // 5.6.5.2 (2013/06/21) bodyからSQL文のみを切り出す。
322                paramMap        = null;         // 5.6.5.2 (2013/06/21) bodyからparamMapを取りだす。
323                useSLabel       = false;        // 7.0.7.0 (2019/12/13) エラーメッセージにSLABELを利用するかどうか[true/false]を指定します(初期値:false)
324        }
325
326        /**
327         * 表示データの HybsSystem.ROW_SEL_KEY を元に、選ばれた 行を処理の対象とします。
328         *
329         * @og.rev 6.3.9.0 (2015/11/06) コンストラクタで初期化されていないフィールドを null チェックなしで利用している(findbugs)
330         *
331         * @return      選択行の配列
332         * @og.rtnNotNull
333         */
334        @Override
335        protected int[] getParameterRows() {
336                final int[] rowNo ;
337                // 6.3.9.0 (2015/11/06) コンストラクタで初期化されていないフィールドを null チェックなしで利用している(findbugs)
338                if( selectedAll && table != null ) {
339                        final int rowCnt = table.getRowCount();
340                        rowNo = new int[rowCnt];
341                        for( int i=0; i<rowCnt; i++ ) {
342                                rowNo[i] = i;
343                        }
344                } else {
345                        rowNo = super.getParameterRows();               // 4.0.0 (2005/01/31)
346                }
347                return rowNo;
348        }
349
350        /**
351         * 【TAG】データベース処理を実行するテーブルフィルターのクラスIDを指定します。
352         *
353         * @og.tag
354         * ここで指定するクラスIDは、システムリソース にて TableFilter の
355         * サブクラス(インターフェース継承)として指定する必要があります。
356         *
357         * クラス自身は、org.opengion.hayabusa.db.TableFilter インターフェースを継承している必要があります。
358         * {@og.doc03Link tableFilter TableFilter_**** クラス}
359         *
360         * @param       id 実行クラスID
361         * @see         org.opengion.hayabusa.db.TableFilter  TableFilter インターフェース
362         */
363        public void setClassId( final String id ) {
364                classId = nval( getRequestParameter( id ),classId );
365        }
366
367        /**
368         * 【TAG】(通常は使いません)結果のDBTableModelを、sessionに登録するときのキーを指定します
369         *              (初期値:HybsSystem#TBL_MDL_KEY[={@og.value HybsSystem#TBL_MDL_KEY}])。
370         *
371         * @og.tag
372         * 検索結果より、DBTableModelオブジェクトを作成します。これを、下流のviewタグ等に
373         * 渡す場合に、通常は、session を利用します。その場合の登録キーです。
374         * query タグを同時に実行して、結果を求める場合、同一メモリに配置される為、
375         * この tableId 属性を利用して、メモリ空間を分けます。
376         *              (初期値:HybsSystem#TBL_MDL_KEY[={@og.value HybsSystem#TBL_MDL_KEY}])。
377         *
378         * @param       id テーブルID (sessionに登録する時のID)
379         */
380        public void setTableId( final String id ) {
381                tableId = nval( getRequestParameter( id ),tableId );
382        }
383
384        /**
385         * 【TAG】データを全件選択済みとして処理するかどうか[true/false]を指定します(初期値:false)。
386         *
387         * @og.tag
388         * 全てのデータを選択済みデータとして扱って処理します。
389         * 全件処理する場合に、指定します。(true/false)
390         * デフォルト false です。
391         *
392         * @param  all 全件選択済み [true:全件選択済み/false:通常]
393         */
394        public void setSelectedAll( final String all ) {
395                selectedAll = nval( getRequestParameter( all ),selectedAll );
396        }
397
398        /**
399         * 【TAG】検索結果が0件のとき処理を停止するかどうか[true/false]を指定します(初期値:false[続行する])。
400         *
401         * @og.tag
402         * 初期値は、false(続行する)です。
403         *
404         * @og.rev 5.7.6.2 (2014/05/16) 新規追加
405         *
406         * @param  cmd 0件時停止可否 [true:処理を中止する/false:続行する]
407         */
408        public void setStopZero( final String cmd ) {
409                stopZero = nval( getRequestParameter( cmd ),stopZero );
410        }
411
412        /**
413         * 【TAG】データ処理の方法[A:追加/C:更新/D:削除]を指定します(初期値:自動判定)。
414         *
415         * @og.tag
416         * 通常は、DBTableModel に自動設定されている modifyType を元に、データ処理方法を
417         * 選別します。(A:追加 C:更新 D:削除)
418         * この場合、行単位で modifyType の値を取得して判別する必要がありますが、一般には
419         * 処理対象は、全件おなじ modifyType である可能性が高いです。
420         * また、selectedAll などで強制的に全件処理対象とする場合は、modifyType に値が
421         * 設定さていません。その様な場合に外部より modifyType を指定します。
422         * 初期値は、自動判定 です。
423         *
424         * @param  type 処理方法 [A:追加/C:更新/D:削除]
425         */
426        public void setModifyType( final String type ) {
427                modifyType = nval( getRequestParameter( type ),modifyType );
428
429                if( modifyType != null && !"A".equals( modifyType ) && !"C".equals( modifyType ) && !"D".equals( modifyType ) ) {
430                        final String errMsg = "modifyType は A:追加 C:更新 D:削除 のどれかを指定してください。: " + CR
431                                                + "modifyType=[" + modifyType + "]";
432                        throw new HybsSystemException( errMsg );
433                }
434        }
435
436        /**
437         * 【TAG】リンク先に渡すキーを指定します。
438         *
439         * @og.tag
440         * 戻る時に、検索時のキャッシュに指定した引数以外に指定したり、別の値に置き換えたり
441         * する場合のキーを設定できます。CSV形式で複数指定できます。
442         * vals 属性には、キーに対応する値を、設定してください。
443         * 分解方法は、CSV変数を先に分解してから、getRequestParameter で値を取得します。
444         * こうしないとデータ自身にカンマを持っている場合に分解をミスる為です。
445         *
446         * @param       key リンク先に渡すキー
447         */
448        public void setKeys( final String key ) {
449                keys = getCSVParameter( key );
450        }
451
452        /**
453         * 【TAG】names属性に対応する値をCSV形式で複数指定します。
454         *
455         * @og.tag
456         * キーに設定した値を、CSV形式で複数して出来ます。
457         * 指定順序は、キーと同じにしておいて下さい。
458         * 分解方法は、CSV変数を先に分解してから、getRequestParameter で値を取得します。
459         * こうしないとデータ自身にカンマを持っている場合に分解をミスる為です。
460         *
461         * @param       val names属性に対応する値 (CSV形式)
462         */
463        public void setVals( final String val ) {
464                vals = getCSVParameter( val );
465        }
466
467        /**
468         * 【TAG】(通常は使いません)Queryオブジェクトを作成する時のDB接続IDを指定します。
469         *
470         * @og.tag
471         * Queryオブジェクトを作成する時のDB接続IDを指定します。
472         * これは、システムリソースで、DEFAULT_DB_URL 等で指定している データベース接続先
473         * 情報に、XX_DB_URL を定義することで、 dbid="XX" とすると、この 接続先を使用して
474         * データベースにアクセスできます。
475         *
476         * @param       id データベース接続ID
477         */
478        public void setDbid( final String id ) {
479                dbid = nval( getRequestParameter( id ),dbid );
480        }
481
482        /**
483         * 【TAG】エラーメッセージにSLABELを利用するかどうか[true/false]を指定します(初期値:false)。
484         *
485         * @og.tag
486         * 通常のエラーメッセージは、ラベル(長)が使われますが、これをラベル(短)を使いたい場合に、true にセットします。
487         * ここでのラベル(短)は、タグ修飾なしの、ラベル(短)です。
488         * 標準はfalse:利用しない=ラベル(長)です。
489         * true/false以外を指定した場合はfalse扱いとします。
490         *
491         * ラベルリソースの概要説明があれば表示しますが、useSLabel="true" 時は、概要説明を表示しません。
492         *
493         * @og.rev 7.0.7.0 (2019/12/13) 新規追加
494         *
495         * @param prm SLABEL利用 [true:利用する/false:利用しない]
496         */
497        public void setUseSLabel( final String prm ) {
498                useSLabel = nval( getRequestParameter( prm ),useSLabel );
499        }
500
501        /**
502         * このオブジェクトの文字列表現を返します。
503         * 基本的にデバッグ目的に使用します。
504         *
505         * @return このクラスの文字列表現
506         * @og.rtnNotNull
507         */
508        @Override
509        public String toString() {
510                return ToString.title( this.getClass().getName() )
511                                .println( "VERSION"                     ,VERSION                )
512                                .println( "tableId"                     ,tableId                )
513                                .println( "classId"                     ,classId                )
514                                .println( "modifyType"          ,modifyType             )
515                                .println( "selectedAll"         ,selectedAll    )
516                                .println( "keys"                        ,keys                   )
517                                .println( "vals"                        ,vals                   )
518                                .println( "dbid"                        ,dbid                   ) // 4.2.4.0 (2008/06/23)
519                                .println( "sql"                         ,sql                    ) // 5.6.5.2 (2013/06/21)
520                                .fixForm().toString() ;
521        }
522}