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.DBColumn;
022import org.opengion.hayabusa.db.Query;
023import org.opengion.hayabusa.db.QueryFactory;
024import org.opengion.fukurou.util.XHTMLTag;
025import org.opengion.fukurou.util.Attributes;
026import org.opengion.fukurou.util.ToString;                                              // 6.1.1.0 (2015/01/17)
027import org.opengion.fukurou.db.Transaction;
028
029import static org.opengion.fukurou.util.StringUtil.nval ;
030
031/**
032 * プルダウンメニューの選択項目をSELECT文の結果から作成するタグです。
033 *
034 * 基本的には、queryタグと同じ使い方をします。
035 * このオブジェクトに、 queryId を与えることにより、queryId に対応した Queryオブジェクト
036 * (のサブクラスのオブジェクト)が作成されます。
037 * ここで指定するSELECT文は、『SELECT KEY、LABEL1、LABEL2、・・・ FROM TABLE ・・・』形式 を
038 * している必要があります。特別なケースとして、『SELECT KEY FROM TABLE ・・・』形式の場合は、
039 * LABEL に KEY が 使用されます。
040 * SystemData の USE_SQL_INJECTION_CHECK が true か、quotCheck 属性が true の場合は、
041 * SQLインジェクション対策用のシングルクォートチェックを行います。リクエスト引数に
042 * シングルクォート(')が含まれると、エラーになります。
043 * 同様にUSE_XSS_CHECKがtrueか、xssCheck属性がtrueの場合は、
044 * クロスサイトススクリプティング(XSS)対策のためless/greater than signのチェックを行います。
045 *
046 * ※ このタグは、Transaction タグの対象です。
047 *
048 * @og.formSample
049 * ●形式:
050 *     <og:queryOption >
051 *          SELECT文
052 *     </og:queryOption >
053 * ●body:あり(EVAL_BODY_BUFFERED:BODYを評価し、{@XXXX} を解析します)
054 *
055 * ●Tag定義:
056 *   <og:queryOption
057 *       value              【TAG】Optionの初期値で選ばれる値を指定します
058 *       separator          【TAG】複数のラベルを合成するときに使用する項目区切り文字をセットします(初期値:スペース)
059 *       defaultVal         【TAG】value値がNULLの場合に使用される初期値を設定します
060 *       language           【TAG】タグ内部で使用する言語コード[ja/en/zh/…]を指定します
061 *       quotCheck          【TAG】リクエスト情報の シングルクォート(') 存在チェックを実施するかどうか[true/false]を設定します (初期値:USE_SQL_INJECTION_CHECK[=true])
062 *       dbid               【TAG】(通常は使いません)Queryオブジェクトを作成する時のDB接続IDを指定します(初期値:null)
063 *       addKey             【TAG】項目が一つだけの場合のラベルリソースに、キー情報を追加するかどうかを指定します(初期値:false)
064 *       classUseNo         【TAG】オプションに追加する class 属性の カラム番号を指定します
065 *       styleUseNo         【TAG】オプションに追加する style 属性の カラム番号を指定します
066 *       disabledUseNo      【TAG】オプションに追加する disabled 属性の カラム番号を指定します
067 *       groupUseNo         【TAG】オプションのグループ化を行うカラム番号を指定します
068 *       titleUseNo         【TAG】オプションに追加する title 属性の カラム番号を指定します
069 *       xssCheck           【TAG】リクエスト情報の HTMLTag開始/終了文字(><) 存在チェックを実施するかどうか[true/false]を設定します (初期値:USE_XSS_CHECK[=true])
070 *       caseKey            【TAG】このタグ自体を利用するかどうかの条件キーを指定します(初期値:null)
071 *       caseVal            【TAG】このタグ自体を利用するかどうかの条件値を指定します(初期値:null)
072 *       caseNN             【TAG】指定の値が、null/ゼロ文字列 でない場合(Not Null=NN)は、このタグは使用されます(初期値:判定しない)
073 *       caseNull           【TAG】指定の値が、null/ゼロ文字列 の場合は、このタグは使用されます(初期値:判定しない)
074 *       caseIf             【TAG】指定の値が、true/TRUE文字列の場合は、このタグは使用されます(初期値:判定しない)
075 *       debug              【TAG】デバッグ情報を出力するかどうか[true/false]を指定します(初期値:false)
076 *   >   ... Body ...
077 *   </og:queryOption>
078 *
079 * ●使用例
080 *     <og:select name="CDC" >
081 *         <og:queryOption>
082 *                 select NOSYN,NOSYN,NMSYN from DB01 ORDER BY 1
083 *         </og:queryOption>
084 *     </og:select>
085 *
086 *     <og:select name="CDC" >                選択項目の一番上に空白をセットしたいときoptionタグを組合せることも可能です。
087 *         <og:option lbl="" />               初期値を設定したいときはvalue属性を使います。
088 *         <og:queryOption value="61200" separator=":" >
089 *                 select CDBK,CDBK,NMBK from DB02 ORDER BY 1
090 *         </og:queryOption>
091 *     </og:select>
092 *
093 * @og.group 選択データ制御
094 *
095 * @version  4.0
096 * @author   Kazuhiko Hasegawa
097 * @since    JDK5.0,
098 */
099public class QueryOptionTag extends CommonTagSupport {
100        /** このプログラムのVERSION文字列を設定します。   {@value} */
101        private static final String VERSION = "8.0.2.0 (2021/11/30)" ;
102        private static final long serialVersionUID = 802020211130L ;
103
104        private static final String ERR_ARG_NO = "通常、カラム番号=0 は キー情報、=1 はラベル情報 です。2 か 3 を指定して下さい。";              // 6.4.2.1 (2016/02/05) PMD refactoring.
105
106        private transient DBTableModel  table   ;
107        private String  selValue                ;
108        private String  defaultVal              ;
109        // 4.0.0.0 (2007/10/10) dbid の初期値を、"DEFAULT" から null に変更
110        private String  dbid            ;
111        private String  sql                     ;
112        private String  separator       = " ";          // 項目区切り文字
113        private boolean quotCheck       = HybsSystem.sysBool( "USE_SQL_INJECTION_CHECK" );      // 4.0.0 (2005/08/31)
114        private int             classUseNo      = -1;           // 3.8.5.2 (2006/06/09) オプションに追加するクラス属性
115        private int             styleUseNo      = -1;           // 6.2.0.0 (2015/02/27) コードリソースのパラメータの指定方法を変更します。
116        private int             disabledUseNo= -1;              // 6.2.0.0 (2015/02/27) コードリソースのパラメータの指定方法を変更します。
117        private int             groupUseNo      = -1;           // 3.8.5.2 (2006/06/09) キーブレイク時に追加するグループ文字
118        private boolean addKey          ;                       // 4.0.0 (2006/11/15) 項目一つのときにラベルリソース表示時にキーも付加する。
119        private int             titleUseNo      = -1;           // 4.3.8.0 (2009/08/01) オプションのtitle属性
120        private boolean xssCheck        = HybsSystem.sysBool( "USE_XSS_CHECK" );        // 5.0.0.2 (2009/09/15)
121        private String  rawSql          ;                       // 5.1.7.0 (2010/06/01) 動的プルダウン実装見直し
122
123        /**
124         * デフォルトコンストラクター
125         *
126         * @og.rev 6.4.2.0 (2016/01/29) PMD refactoring. Each class should declare at least one constructor.
127         */
128        public QueryOptionTag() { super(); }            // これも、自動的に呼ばれるが、空のメソッドを作成すると警告されるので、明示的にしておきます。
129
130        /**
131         * Taglibの開始タグが見つかったときに処理する doStartTag() を オーバーライドします。
132         *
133         * @og.rev 5.2.2.0 (2010/11/01) caseKey 、caseVal 属性対応
134         * @og.rev 6.4.8.1 (2016/07/02) xssCheckを、doStartTag に移動
135         *
136         * @return      後続処理の指示( EVAL_BODY_BUFFERED )
137         */
138        @Override
139        public int doStartTag() {
140                useXssCheck( xssCheck );                        // 6.4.8.1 (2016/07/02)
141
142                // 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
143                return useTag()
144                                        ? EVAL_BODY_BUFFERED    // Body を評価する。( extends BodyTagSupport 時)
145                                        : SKIP_BODY ;                   // Body を評価しない
146        }
147
148        /**
149         * Taglibのタグ本体を処理する doAfterBody() を オーバーライドします。
150         *
151         * @og.rev 3.1.1.0 (2003/03/28) ボディの内容を取得する処理を、CommonTagSupport で行う。
152         * @og.rev 3.6.0.8 (2004/11/19) エラー発生時に確実にリリースされるように try finally 追加
153         * @og.rev 3.7.1.0 (2005/04/26) DBTableModel がすでにセットされている場合は、SQL処理不要。
154         * @og.rev 4.0.0.0 (2005/01/31) lang ⇒ ResourceManager へ変更
155         * @og.rev 4.0.0.0 (2005/08/31) useQuotCheck() によるSQLインジェクション対策
156         * @og.rev 3.8.6.3 (2006/11/30) SQL 文の前後のスペースを取り除きます。
157         * @og.rev 3.8.7.0 (2006/12/15) アクセスログ取得の為,ApplicationInfoオブジェクトを設定
158         * @og.rev 4.3.6.0 (2009/04/01) EventColumn対応
159         * @og.rev 5.0.0.5 (2009/08/28) XSS対策
160         * @og.rev 5.1.7.0 (2010/06/01) 動的プルダウン実装見直し
161         * @og.rev 5.1.9.0 (2010/08/01) TransactionTag 対応。上位に TransactionTag があれば、そこからConnection をもらう。
162         * @og.rev 5.3.7.0 (2011/07/01) TransactionReal の引数変更
163         * @og.rev 5.3.8.0 (2011/08/01) Transaction発生箇所でclose()
164         * @og.rev 6.3.1.1 (2015/07/10) BodyString,BodyRawStringは、CommonTagSupport で、trim() します。
165         * @og.rev 6.3.6.1 (2015/08/28) Transaction でAutoCloseableを使用したtry-with-resources構築に対応。
166         * @og.rev 6.3.6.1 (2015/08/28) QueryFactory.close( Query ) 廃止。Queryはキャッシュしません。
167         * @og.rev 6.4.8.1 (2016/07/02) xssCheckを、doStartTag に移動
168         * @og.rev 8.0.2.0 (2021/11/30) 検索実行前に、SQL文字をdebugPrint出来るように修正
169         *
170         * @return      後続処理の指示(SKIP_BODY)
171         */
172        @Override
173        public int doAfterBody() {
174                // 3.7.1.0 (2005/04/26) DBTableModel がすでにセットされている場合は、SQL処理不要。
175                if( table != null ) { return SKIP_BODY ; }
176
177                // 4.0.0 (2005/08/31) useQuotCheck() によるSQLインジェクション対策
178                useQuotCheck( quotCheck );
179                // 5.0.0.2 (2009/09/15) XSS対策
180
181                sql    = getBodyString();                       // 6.3.1.1 (2015/07/10)
182                rawSql = getBodyRawString();            // 6.3.1.1 (2015/07/10)
183                debugPrint( sql );                                      // 8.0.2.0 (2021/11/30)
184
185                // 6.3.6.1 (2015/08/28) Transaction でAutoCloseableを使用したtry-with-resources構築に対応。
186                try( Transaction tran = getTransaction() ) {
187                        final Query query = QueryFactory.newInstance();         // 4.0.0 (2005/01/31)
188                        query.setConnection( tran.getConnection( dbid ) );                      // 6.3.6.1 (2015/08/28)
189                        query.setResourceManager( getResource() );      // 4.0.0 (2005/01/31)
190                        query.setStatement( sql );
191                        query.execute();
192
193                        table = query.getDBTableModel();
194
195                        tran.commit();                          // 6.3.6.1 (2015/08/28)
196                }
197                return SKIP_BODY ;
198        }
199
200        /**
201         * Taglibの終了タグが見つかったときに処理する doEndTag() を オーバーライドします。
202         *
203         * @og.rev 3.1.1.2 (2003/04/04) Tomcat4.1 対応。release2() を doEndTag()で呼ぶ。
204         * @og.rev 3.3.2.0 (2003/07/07) defaultVal 属性の追加。
205         * @og.rev 3.5.4.0 (2003/11/25) selVal 属性を追加。
206         * @og.rev 5.0.2.0 (2009/11/01) 複数パラメーターの選択に対応
207         * @og.rev 5.1.7.0 (2010/06/01) 動的プルダウン実装見直し
208         * @og.rev 5.2.2.0 (2010/11/01) caseKey 、caseVal 属性対応
209         * @og.rev 5.7.1.0 (2013/12/06) SelectTag ⇒ OptionAncestorIF に変更して、DatalistTag にも対応。
210         *
211         * @return      後続処理の指示
212         */
213        @Override
214        public int doEndTag() {
215                debugPrint();           // 4.0.0 (2005/02/28)
216                // 5.2.2.0 (2010/11/01) caseKey 、caseVal 属性対応
217                if( useTag() ) {
218                        final OptionAncestorIF select = (OptionAncestorIF)findAncestorWithClass( this,OptionAncestorIF.class );
219                        if( select == null ) {
220                                final String errMsg = "<b>" + getTagName() + "タグは、SelectTag または、DatalistTag のBODY に記述する必要があります。</b>";
221                                throw new HybsSystemException( errMsg );
222                        }
223                        final String selVal = nval( select.getValue(),defaultVal );     // 3.5.4.0 (2003/11/25)
224        //              selValue = nval( selValue,selVal );                                             // 3.5.4.0 (2003/11/25)
225                        selValue = "|" + nval( selValue,selVal ) + "|";                 // 5.0.2.0 (2009/11/01)
226                        makeLabel( select );
227
228                        // 5.1.7.0 (2010/06/01) 動的プルダウン実装見直し
229                        select.setRawParam( rawSql );
230                }
231                return EVAL_PAGE ;
232        }
233
234        /**
235         * タグリブオブジェクトをリリースします。
236         * キャッシュされて再利用されるので、フィールドの初期設定を行います。
237         *
238         * @og.rev 2.0.0.4 (2002/09/27) カスタムタグの release() メソッドを、追加
239         * @og.rev 3.0.1.0 (2003/03/03) セパレーターを指定できる様に変更。
240         * @og.rev 3.1.1.2 (2003/04/04) Tomcat4.1 対応。release2() を doEndTag()で呼ぶ。
241         * @og.rev 3.3.2.0 (2003/07/07) defaultVal 属性の追加。
242         * @og.rev 3.8.5.2 (2006/06/09) classUseNo , groupUseNo 属性の追加。
243         * @og.rev 4.0.0.0 (2005/08/31) quotCheck , addKey 属性の追加
244         * @og.rev 4.0.0.0 (2007/10/10) dbid の初期値を、"DEFAULT" から null に変更
245         * @og.rev 5.1.7.0 (2010/06/01) 動的プルダウン実装見直し
246         * @og.rev 6.2.0.0 (2015/02/27) コードリソースのパラメータの指定方法を変更します。styleUseNo,disabledUseNo 属性追加
247         *
248         */
249        @Override
250        protected void release2() {
251                super.release2();
252                table           = null;
253                selValue        = null;
254                defaultVal      = null;
255                dbid            = null;
256                sql                     = null;
257                separator       = " ";
258                classUseNo      = -1;           // 3.8.5.2 (2006/06/09) オプションに追加するクラス属性
259                styleUseNo      = -1;           // 6.2.0.0 (2015/02/27) コードリソースのパラメータの指定方法を変更します。
260                disabledUseNo   = -1;   // 6.2.0.0 (2015/02/27) コードリソースのパラメータの指定方法を変更します。
261                groupUseNo      = -1;           // 3.8.5.2 (2006/06/09) キーブレイク時に追加するグループ文字
262                quotCheck       = HybsSystem.sysBool( "USE_SQL_INJECTION_CHECK" );      // 4.0.0 (2005/08/31)
263                addKey          = false;                // 4.0.0 (2006/11/15) 項目一つのときにラベルリソース表示時にキーも付加する。
264                titleUseNo              = -1;
265                xssCheck        = HybsSystem.sysBool( "USE_XSS_CHECK" );        // 5.0.0.2 (2009/09/15)
266                rawSql          = null; // 5.1.7.0 (2010/06/01) 動的プルダウン実装見直し
267        }
268
269        /**
270         * DBTableModelをセットします。
271         *
272         * サブクラスより、DBTableModelをセットするのに使います。
273         *
274         * @og.rev 3.7.1.0 (2005/04/26) 新規追加
275         *
276         * @param       table   DBTableModelオブジェクト
277         */
278        protected void setTableModel( final DBTableModel table ) {
279                this.table = table ;
280        }
281
282        /**
283         * オプションを作成します。
284         *
285         * DBTableModel の1番目の値を "value" に、それ以降を文字列を連結させて
286         * BODY属性 に登録するOptionを作成します。
287         *
288         * @og.rev 3.0.1.0 (2003/03/03) 『SELECT KEY FROM TABLE ・・・』形式の場合は、LABEL に KEY を使用。
289         * @og.rev 3.8.0.9 (2005/10/17) 複数選択可能時に全選択を設定する。
290         * @og.rev 3.8.5.2 (2006/06/09) classUseNo 属性と groupUseNo 属性を追加
291         * @og.rev 3.8.9.2 (2007/07/28) グループと、クラスの設定方法のバグ修正
292         * @og.rev 4.3.8.0 (2009/08/01) titleUseNo属性追加
293         * @og.rev 5.0.2.0 (2009/11/01) 複数パラメーターの選択に対応
294         * @og.rev 5.7.1.0 (2013/12/06) SelectTag ⇒ OptionAncestorIF に変更して、DatalistTag にも対応。
295         * @og.rev 6.0.4.0 (2014/11/28) キー:ラベル形式で表示するかどうかの、addKeyLabel 属性対応
296         * @og.rev 6.2.0.0 (2015/02/27) コードリソースのパラメータの指定方法を変更します。
297         *
298         * @param   select SelectTagオブジェクト
299         */
300        private void makeLabel( final OptionAncestorIF select ) {
301                final boolean multipleAll = select.isMultipleAll();     // 3.8.0.9 (2005/10/17)
302                final int rowCnt = table.getRowCount();         // 3.5.5.7 (2004/05/10)
303
304                // 6.0.4.0 (2014/11/28) キー:ラベル形式で表示するかどうか[true:キー:ラベル形式/false:ラベルのみ/null:指定通り]
305                final String addKeyLabel = select.getAddKeyLabel();
306
307                // 6.2.0.0 (2015/02/27) 2番目以降の groupUseNo,classUseNo,styleUseNo,disabledUseNo,titleUseNo 以外のカラムは連結対象
308                // 0:キー、1:ラベル、以降、特殊カラム以外は連結します。先に連結するカラム番号をピックアップしておきます。
309                final int clmSize = table.getColumnCount();
310                int[] tmpClms = new int[clmSize];                       // 実際には、clmSize-2 が最大だが、カラム数=1 もあり得る。
311                int cnt = 0;                                                            // 実際
312                for( int clm=2; clm<clmSize; clm++ ) {          // カラムの2番目以降
313                        if( clm != groupUseNo && clm != classUseNo &&
314                                clm != styleUseNo && clm != disabledUseNo && clm != titleUseNo ) {
315                                        tmpClms[cnt++] = clm;
316                        }
317                }
318
319                String bkGroupKey = "";
320                String grpLabel ;
321                final StringBuilder buf = new StringBuilder( BUFFER_MIDDLE );   // 6.1.0.0 (2014/12/26) refactoring
322                for( int row=0; row<rowCnt; row++ ) {
323                        // 3.8.5.2 (2006/06/09) groupUseNo 属性
324                        if( groupUseNo >= 0 ) {
325                                final String groupKey = table.getValue( row,groupUseNo );
326                                grpLabel = getRendererValue( row,groupUseNo );
327                                if( !bkGroupKey.equals( groupKey ) ) {          // キーブレイク
328                                        // 3.8.9.2 (2007/07/28) グループと、クラスの設定方法のバグ修正
329                                        if( ! "".equals( bkGroupKey ) ) {
330                                                select.addOption( "</optgroup>" );
331                                        }
332                                        if( ! "".equals( groupKey ) ) {
333                                                select.addOption( "<optgroup label=\"" + grpLabel + "\">" );
334                                        }
335                                        bkGroupKey = groupKey;
336                                }
337                        }
338
339                        final Attributes attri = new Attributes();
340                        final String value = table.getValue( row,0 );
341                        attri.set( "value", value );
342
343                        // 5.0.2.0 (2009/11/01)
344                        // selValue は、makeLabel( OptionAncestorIF ) が呼ばれる前に、必ずセットされている。
345                        if( multipleAll || selValue.indexOf( "|" + value + "|" ) >= 0 ) {
346                                attri.set( "selected", "selected" );
347                        }
348
349                        // 3.8.5.2 (2006/06/09) classUseNo 属性
350                        if( classUseNo >= 0 ) {
351                                attri.add( "class", table.getValue( row,classUseNo ) );
352                        }
353
354                        // 6.2.0.0 (2015/02/27) コードリソースのパラメータの指定方法を変更します。
355                        if( styleUseNo >= 0 ) {
356                                attri.add( "style", table.getValue( row,styleUseNo ) );
357                        }
358
359                        if( disabledUseNo >= 0 ) {
360                                final String val = table.getValue( row,disabledUseNo );
361                                if( "true".equalsIgnoreCase( val ) || "disabled".equalsIgnoreCase( val ) ) {
362                                        attri.add( "disabled","disabled" );
363                                }
364                        }
365
366                        buf.setLength(0);                       // 6.1.0.0 (2014/12/26) refactoring
367                        boolean titleFlg = false;       // 4.3.8.0 (2009/08/01) title属性を付けるかどうか
368                        if( clmSize == 1 ) {            // 6.2.0.0 (2015/02/27) 変数化
369                                // 項目が一つの queryOption では、ラベルリソースが使用されます。
370                                if( addKey ) { buf.append( value ).append( ':' ); }             // 6.0.2.5 (2014/10/31) char を append する。
371                                final String label = getResource().getLabel( value );   // 6.2.0.0 (2015/02/27) 変数使用
372                                buf.append( label );
373
374                                // 4.3.8.0 (2009/08/01) titleUseNo 属性 セットされている場合かつラベルと異なる場合はtitle属性に追加
375                                if( titleUseNo >= 0 && !label.equals( table.getValue( row,titleUseNo ) )) {
376                                        titleFlg = true;
377                                }
378                        }
379                        else {
380        //                      if( groupUseNo >= 0 ) {
381        //                              buf.append( grpLabel );
382        //                              buf.append( separator );
383        //                      }
384                                final String label = getRendererValue( row,1 );
385                                buf.append( label );
386        //                      attri.set( "label", label );
387                                // 6.2.0.0 (2015/02/27) 2番目以降の連結対象
388                                for( int i=0; i<cnt; i++ ) {    // 注意:tmpClms.length ではなく、実際の設定済み数 cnt を使う。
389                                        buf.append( separator ).append( getRendererValue( row,tmpClms[i] ) );
390                                }
391
392                                // 4.3.8.0 (2009/08/01) titleUseNo 属性 セットされている場合かつラベルと異なる場合はtitle属性に追加
393                                if( titleUseNo >= 0 && !label.equals( table.getValue( row,titleUseNo ) )) {
394                                        titleFlg = true;
395                                }
396                        }
397
398                        // 4.3.7.2 (2009/06/22) タイトル属性セット
399                        if( titleFlg ){
400                                attri.add( "title", table.getValue( row,titleUseNo ) );
401                        }
402
403                        attri.set( "body", buf.toString() );
404                        select.addOption( XHTMLTag.option( attri , addKeyLabel ) );
405                }
406                if( groupUseNo >= 0 && ! "".equals( bkGroupKey ) ) {    // 3.8.9.2 (2007/07/28)
407                        select.addOption( "</optgroup>" );
408                }
409        }
410
411        /**
412         * 【TAG】Optionの初期値で選ばれる値を指定します。
413         *
414         * @og.tag Optionの初期値で選ばれる値を指定します。
415         *
416         * @param   val Optionの初期値で選ばれる値
417         */
418        public void setValue( final String val ) {
419                selValue = getRequestParameter( val );
420        }
421
422        /**
423         * 【TAG】value属性に値がセットされていないとき使用する、初期値を指定します。
424         *
425         * @og.tag
426         * value属性に値がセットされていないときに、この初期値を使用します。
427         *
428         * 8.4.3.0 (2023/03/31) defaultVal の設定値の取り扱い(変更なし)
429         *   {&#064;XXXX} は、リクエスト変数 ⇒ valueタグセット値 を確認
430         *     値がなければ、""(空文字列) となる。
431         *   通常の固定値は、そのまま使用される(""(空文字列)も有効
432         *   defaultVal属性を使用しない場合は、
433         *     null のままで、初期値として適用されるので、BODY部のSQL文は必須です。
434         *
435         * @og.rev 3.3.2.0 (2003/07/07) defaultVal 属性の追加。(新規作成)
436         *
437         * @param       val 初期値
438         */
439        public void setDefaultVal( final String val ) {
440                defaultVal = getRequestParameter( val );
441        }
442
443        /**
444         * 【TAG】複数のラベルを合成するときに使用する項目区切り文字をセットします(初期値:スペース)。
445         *
446         * @og.tag
447         * 初期値は、スペースです。
448         *
449         * @og.rev 3.0.1.0 (2003/03/03) セパレーターを指定できる様に変更。
450         *
451         * @param   sep 項目区切り文字
452         */
453        public void setSeparator( final String sep ) {
454                separator = nval( getRequestParameter( sep ),separator );
455        }
456
457        /**
458         * 【TAG】オプションに追加する class 属性の カラム番号を指定します(初期値:使用しない(-1))。
459         *
460         * @og.tag
461         * オプションは、データベースを検索して作成されますが、そのSQL文のカラム情報を
462         * 使用して オプションに class 属性を追加します。
463         * 各オプションに色をつける場合は、この class 属性に対応する CSS ファイルを用意します。
464         * ここでは、class 属性に使用する SQL文の カラム番号( 先頭が 0 ) を指定します。
465         * 通常、カラム番号=0 は キー情報、=1 はラベル情報 です。2 か 3 を指定します。
466         * 初期値は、使用しない(-1)です。
467         *
468         * @og.rev 3.8.5.2 (2006/06/09) 新規追加
469         *
470         * @param   no オプションに追加するクラス属性
471         */
472        public void setClassUseNo( final String no ) {
473                classUseNo = nval( getRequestParameter( no ),classUseNo );
474                if( classUseNo == 0 || classUseNo == 1 ) {
475                        throw new HybsSystemException( ERR_ARG_NO );    // 6.4.2.1 (2016/02/05) PMD refactoring.
476                }
477        }
478
479        /**
480         * 【TAG】オプションに追加する style 属性の カラム番号を指定します(初期値:使用しない(-1))。
481         *
482         * @og.tag
483         * オプションは、データベースを検索して作成されますが、そのSQL文のカラム情報を
484         * 使用して オプションタグにstyle 属性を追加します。
485         * 通常、カラム番号=0 は キー情報、=1 はラベル情報 です。2 か 3 を指定します。
486         * 初期値は、使用しない(-1)です。
487         *
488         * @og.rev 6.2.0.0 (2015/02/27) コードリソースのパラメータの指定方法を変更します。
489         *
490         * @param   no オプションに追加するstyle 属性
491         */
492        public void setStyleUseNo( final String no ) {
493                styleUseNo = nval( getRequestParameter( no ),styleUseNo );
494                if( styleUseNo == 0 || styleUseNo == 1 ) {
495                        throw new HybsSystemException( ERR_ARG_NO );    // 6.4.2.1 (2016/02/05) PMD refactoring.
496                }
497        }
498
499        /**
500         * 【TAG】オプションに追加する disabled 属性の カラム番号を指定します(初期値:使用しない(-1))。
501         *
502         * @og.tag
503         * オプションは、データベースを検索して作成されますが、そのSQL文のカラム情報を
504         * 使用して オプションタグにdisabled 属性を追加します。
505         *
506         * 設定する値は、"true" か、"disabled" の場合のみ、disabled になります。
507         *
508         * 通常、カラム番号=0 は キー情報、=1 はラベル情報 です。2 か 3 を指定します。
509         * 初期値は、使用しない(-1)です。
510         *
511         * @og.rev 6.2.0.0 (2015/02/27) コードリソースのパラメータの指定方法を変更します。
512         *
513         * @param   no オプションに追加するdisabled 属性
514         */
515        public void setDisabledUseNo( final String no ) {
516                disabledUseNo = nval( getRequestParameter( no ),disabledUseNo );
517                if( disabledUseNo == 0 || disabledUseNo == 1 ) {
518                        throw new HybsSystemException( ERR_ARG_NO );    // 6.4.2.1 (2016/02/05) PMD refactoring.
519                }
520        }
521
522        /**
523         * 【TAG】オプションのグループ化を行うカラム番号を指定します(初期値:使用しない(-1))。
524         *
525         * @og.tag
526         * オプションは、データベースを検索して作成されますが、そのSQL文のカラム情報を
527         * 使用して オプションをグループ化します。グループ化は optgroup要素をブレイク時に
528         * 出力する事で対応します。
529         * ここでは、グループ化に使用する SQL文の カラム番号( 先頭が 0 ) を指定します。
530         * 通常、カラム番号=0 は キー情報、=1 はラベル情報 です。2 か 3 を指定します。
531         * 初期値は、使用しない(-1)です。
532         *
533         * @og.rev 3.8.5.2 (2006/06/09) 新規追加
534         *
535         * @param   no キーブレイク時に追加するグループ文字
536         */
537        public void setGroupUseNo( final String no ) {
538                groupUseNo = nval( getRequestParameter( no ),groupUseNo );
539                if( groupUseNo == 0 || groupUseNo == 1 ) {
540                        throw new HybsSystemException( ERR_ARG_NO );    // 6.4.2.1 (2016/02/05) PMD refactoring.
541                }
542        }
543
544        /**
545         * 【TAG】リクエスト情報の シングルクォート(') 存在チェックを実施するかどうか[true/false]を設定します
546         *              (初期値:USE_SQL_INJECTION_CHECK[={@og.value SystemData#USE_SQL_INJECTION_CHECK}])。
547         *
548         * @og.tag
549         * SQLインジェクション対策の一つとして、暫定的ではありますが、SQLのパラメータに
550         * 渡す文字列にシングルクォート(') を許さない設定にすれば、ある程度は防止できます。
551         * 数字タイプの引数には、 or 5=5 などのシングルクォートを使用しないコードを埋めても、
552         * 数字チェックで検出可能です。文字タイプの場合は、必ず (')をはずして、
553         * ' or 'A' like 'A のような形式になる為、(')チェックだけでも有効です。
554         * (') が含まれていたエラーにする(true)/かノーチェックか(false)を指定します。
555         * (初期値:システム定数のUSE_SQL_INJECTION_CHECK[={@og.value SystemData#USE_SQL_INJECTION_CHECK}])。
556         *
557         * @og.rev 4.0.0.0 (2005/08/31) 新規追加
558         *
559         * @param   flag クォートチェック [true:する/それ以外:しない]
560         * @see         org.opengion.hayabusa.common.SystemData#USE_SQL_INJECTION_CHECK
561         */
562        public void setQuotCheck( final String flag ) {
563                quotCheck = nval( getRequestParameter( flag ),quotCheck );
564        }
565
566        /**
567         * 【TAG】(通常は使いません)Queryオブジェクトを作成する時のDB接続IDを指定します(初期値:null)。
568         *
569         * @og.tag
570         * Queryオブジェクトを作成する時のDB接続IDを指定します。
571         * これは、システムリソースで、DEFAULT_DB_URL 等で指定している データベース接続先
572         * 情報に、XX_DB_URL を定義することで、 dbid="XX" とすると、この 接続先を使用して
573         * データベースにアクセスできます。
574         *
575         * @param       id データベース接続ID
576         */
577        public void setDbid( final String id ) {
578                dbid = nval( getRequestParameter( id ),dbid );
579        }
580
581        /**
582         * 【TAG】項目が一つだけの場合のラベルリソースに、キー情報を追加するかどうかを指定します(初期値:false)。
583         *
584         * @og.tag
585         * Queryオブジェクトの項目が一つの場合、ラベル部には、ラベルリソースを使用します。
586         * この時、ラベル無しの場合は、キーが表示されますが、ラベルありの場合は、キーは表示されず
587         * ラベルのみ表示されます。
588         * 都合によっては、キーも表示したい場合がありますので、その様なケースでは、
589         * addKey = "true を設定する事で、キー:ラベル のセットをラベルとして扱います。
590         * 初期値はfalse(キーは付加しない)です。
591         *
592         * @param       id データベース接続ID
593         */
594        public void setAddKey( final String id ) {
595                addKey = nval( getRequestParameter( id ),addKey );
596        }
597
598        /**
599         * 【TAG】リクエスト情報の HTMLTag開始/終了文字(&gt;&lt;) 存在チェックを実施するかどうか[true/false]を設定します
600         *              (初期値:USE_XSS_CHECK[={@og.value SystemData#USE_XSS_CHECK}])。
601         *
602         * @og.tag
603         * クロスサイトスクリプティング(XSS)対策の一環としてless/greater than signについてのチェックを行います。
604         * (&gt;&lt;) が含まれていたエラーにする(true)/かノーチェックか(false)を指定します。
605         * (初期値:システム定数のUSE_XSS_CHECK[={@og.value SystemData#USE_XSS_CHECK}])。
606         *
607         * @og.rev 5.0.0.2 (2009/09/15) 新規追加
608         *
609         * @param       flag    XSSチェック [true:する/false:しない]
610         * @see         org.opengion.hayabusa.common.SystemData#USE_XSS_CHECK
611         */
612        public void setXssCheck( final String flag ) {
613                xssCheck = nval( getRequestParameter( flag ),xssCheck );
614        }
615
616        /**
617         * row行,colum列 のデータの値を返します。
618         *
619         * これは、データの値そのものではなく、その値のラベル文字を返します。
620         *
621         * @param   row         行番号
622         * @param   column      カラム番号
623         *
624         * @return  row行,colum列 のデータの値
625         */
626        private String getRendererValue( final int row,final int column ) {
627                final String val = table.getValue( row,column );
628                final DBColumn clm = table.getDBColumn( column );
629                return clm.getRendererValue( val );
630        }
631
632        /**
633         * 【TAG】オプションに追加する title 属性の カラム番号を指定します。
634         *
635         * @og.tag
636         * オプションは、データベースを検索して作成されますが、そのSQL文のカラム情報を
637         * 使用して オプションに title 属性を追加します。
638         * title属性はマウスオーバー時にツールチップとして表示されるため、
639         * プルダウンの横幅を短くしたい場合に有効です。
640         * 通常、カラム番号=0 は キー情報、=1 はラベル情報 です。2 か 3 を指定します。
641         * 初期値は、使用しない(-1)です。
642         *
643         * @og.rev 4.3.8.0 (2009/08/01) 新規追加
644         *
645         * @param   no オプションに追加するtitle属性
646         */
647        public void setTitleUseNo( final String no ) {
648                titleUseNo = nval( getRequestParameter( no ),titleUseNo );
649                if( titleUseNo == 0 || titleUseNo == 1 ) {
650                        throw new HybsSystemException( ERR_ARG_NO );    // 6.4.2.1 (2016/02/05) PMD refactoring.
651                }
652        }
653
654        /**
655         * このオブジェクトの文字列表現を返します。
656         * 基本的にデバッグ目的に使用します。
657         *
658         * @return このクラスの文字列表現
659         * @og.rtnNotNull
660         */
661        @Override
662        public String toString() {
663                return ToString.title( this.getClass().getName() )
664                                .println( "VERSION"             ,VERSION        )
665                                .println( "selValue"    ,selValue       )
666                                .println( "defaultVal"  ,defaultVal     )
667                                .println( "dbid"                ,dbid           )
668//                              .println( "sql"                 ,sql            )       // 8.0.2.0 (2021/11/30) 先にdebugPrintしているため、削除
669                                .println( "rawSql"              ,rawSql         )       // 8.0.2.0 (2021/11/30) 代わりに、rawSql を出力する。
670                                .println( "separator"   ,separator      )
671                                .println( "quotCheck"   ,quotCheck      )
672                                .println( "Other..."    ,getAttributes().getAttribute() )
673                                .fixForm().toString() ;
674        }
675}