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 = "6.4.8.1 (2016/07/02)" ;
102        private static final long serialVersionUID = 648120160702L ;
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         *
169         * @return      後続処理の指示(SKIP_BODY)
170         */
171        @Override
172        public int doAfterBody() {
173                // 3.7.1.0 (2005/04/26) DBTableModel がすでにセットされている場合は、SQL処理不要。
174                if( table != null ) { return SKIP_BODY ; }
175
176                // 4.0.0 (2005/08/31) useQuotCheck() によるSQLインジェクション対策
177                useQuotCheck( quotCheck );
178                // 5.0.0.2 (2009/09/15) XSS対策
179
180                sql    = getBodyString();                       // 6.3.1.1 (2015/07/10)
181                rawSql = getBodyRawString();            // 6.3.1.1 (2015/07/10)
182
183                // 6.3.6.1 (2015/08/28) Transaction でAutoCloseableを使用したtry-with-resources構築に対応。
184                try( final Transaction tran = getTransaction() ) {
185                        final Query query = QueryFactory.newInstance();         // 4.0.0 (2005/01/31)
186                        query.setConnection( tran.getConnection( dbid ) );                      // 6.3.6.1 (2015/08/28)
187                        query.setResourceManager( getResource() );      // 4.0.0 (2005/01/31)
188                        query.setStatement( sql );
189                        query.execute();
190
191                        table = query.getDBTableModel();
192
193                        tran.commit();                          // 6.3.6.1 (2015/08/28)
194                }
195                return SKIP_BODY ;
196        }
197
198        /**
199         * Taglibの終了タグが見つかったときに処理する doEndTag() を オーバーライドします。
200         *
201         * @og.rev 3.1.1.2 (2003/04/04) Tomcat4.1 対応。release2() を doEndTag()で呼ぶ。
202         * @og.rev 3.3.2.0 (2003/07/07) defaultVal 属性の追加。
203         * @og.rev 3.5.4.0 (2003/11/25) selVal 属性を追加。
204         * @og.rev 5.0.2.0 (2009/11/01) 複数パラメーターの選択に対応
205         * @og.rev 5.1.7.0 (2010/06/01) 動的プルダウン実装見直し
206         * @og.rev 5.2.2.0 (2010/11/01) caseKey 、caseVal 属性対応
207         * @og.rev 5.7.1.0 (2013/12/06) SelectTag ⇒ OptionAncestorIF に変更して、DatalistTag にも対応。
208         *
209         * @return      後続処理の指示
210         */
211        @Override
212        public int doEndTag() {
213                debugPrint();           // 4.0.0 (2005/02/28)
214                // 5.2.2.0 (2010/11/01) caseKey 、caseVal 属性対応
215                if( useTag() ) {
216                        final OptionAncestorIF select = (OptionAncestorIF)findAncestorWithClass( this,OptionAncestorIF.class );
217                        if( select == null ) {
218                                final String errMsg = "<b>" + getTagName() + "タグは、SelectTag または、DatalistTag のBODY に記述する必要があります。</b>";
219                                throw new HybsSystemException( errMsg );
220                        }
221                        final String selVal = nval( select.getValue(),defaultVal );     // 3.5.4.0 (2003/11/25)
222        //              selValue = nval( selValue,selVal );                                             // 3.5.4.0 (2003/11/25)
223                        selValue = "|" + nval( selValue,selVal ) + "|";                 // 5.0.2.0 (2009/11/01)
224                        makeLabel( select );
225
226                        // 5.1.7.0 (2010/06/01) 動的プルダウン実装見直し
227                        select.setRawParam( rawSql );
228                }
229                return EVAL_PAGE ;
230        }
231
232        /**
233         * タグリブオブジェクトをリリースします。
234         * キャッシュされて再利用されるので、フィールドの初期設定を行います。
235         *
236         * @og.rev 2.0.0.4 (2002/09/27) カスタムタグの release() メソッドを、追加
237         * @og.rev 3.0.1.0 (2003/03/03) セパレーターを指定できる様に変更。
238         * @og.rev 3.1.1.2 (2003/04/04) Tomcat4.1 対応。release2() を doEndTag()で呼ぶ。
239         * @og.rev 3.3.2.0 (2003/07/07) defaultVal 属性の追加。
240         * @og.rev 3.8.5.2 (2006/06/09) classUseNo , groupUseNo 属性の追加。
241         * @og.rev 4.0.0.0 (2005/08/31) quotCheck , addKey 属性の追加
242         * @og.rev 4.0.0.0 (2007/10/10) dbid の初期値を、"DEFAULT" から null に変更
243         * @og.rev 5.1.7.0 (2010/06/01) 動的プルダウン実装見直し
244         * @og.rev 6.2.0.0 (2015/02/27) コードリソースのパラメータの指定方法を変更します。styleUseNo,disabledUseNo 属性追加
245         *
246         */
247        @Override
248        protected void release2() {
249                super.release2();
250                table           = null;
251                selValue        = null;
252                defaultVal      = null;
253                dbid            = null;
254                sql                     = null;
255                separator       = " ";
256                classUseNo      = -1;           // 3.8.5.2 (2006/06/09) オプションに追加するクラス属性
257                styleUseNo      = -1;           // 6.2.0.0 (2015/02/27) コードリソースのパラメータの指定方法を変更します。
258                disabledUseNo   = -1;   // 6.2.0.0 (2015/02/27) コードリソースのパラメータの指定方法を変更します。
259                groupUseNo      = -1;           // 3.8.5.2 (2006/06/09) キーブレイク時に追加するグループ文字
260                quotCheck       = HybsSystem.sysBool( "USE_SQL_INJECTION_CHECK" );      // 4.0.0 (2005/08/31)
261                addKey          = false;                // 4.0.0 (2006/11/15) 項目一つのときにラベルリソース表示時にキーも付加する。
262                titleUseNo              = -1;
263                xssCheck        = HybsSystem.sysBool( "USE_XSS_CHECK" );        // 5.0.0.2 (2009/09/15)
264                rawSql          = null; // 5.1.7.0 (2010/06/01) 動的プルダウン実装見直し
265        }
266
267        /**
268         * DBTableModelをセットします。
269         *
270         * サブクラスより、DBTableModelをセットするのに使います。
271         *
272         * @og.rev 3.7.1.0 (2005/04/26) 新規追加
273         *
274         * @param       table   DBTableModelオブジェクト
275         */
276        protected void setTableModel( final DBTableModel table ) {
277                this.table = table ;
278        }
279
280        /**
281         * オプションを作成します。
282         *
283         * DBTableModel の1番目の値を "value" に、それ以降を文字列を連結させて
284         * BODY属性 に登録するOptionを作成します。
285         *
286         * @og.rev 3.0.1.0 (2003/03/03) 『SELECT KEY FROM TABLE ・・・』形式の場合は、LABEL に KEY を使用。
287         * @og.rev 3.8.0.9 (2005/10/17) 複数選択可能時に全選択を設定する。
288         * @og.rev 3.8.5.2 (2006/06/09) classUseNo 属性と groupUseNo 属性を追加
289         * @og.rev 3.8.9.2 (2007/07/28) グループと、クラスの設定方法のバグ修正
290         * @og.rev 4.3.8.0 (2009/08/01) titleUseNo属性追加
291         * @og.rev 5.0.2.0 (2009/11/01) 複数パラメーターの選択に対応
292         * @og.rev 5.7.1.0 (2013/12/06) SelectTag ⇒ OptionAncestorIF に変更して、DatalistTag にも対応。
293         * @og.rev 6.0.4.0 (2014/11/28) キー:ラベル形式で表示するかどうかの、addKeyLabel 属性対応
294         * @og.rev 6.2.0.0 (2015/02/27) コードリソースのパラメータの指定方法を変更します。
295         *
296         * @param   select SelectTagオブジェクト
297         */
298        private void makeLabel( final OptionAncestorIF select ) {
299                final boolean multipleAll = select.isMultipleAll();     // 3.8.0.9 (2005/10/17)
300                final int rowCnt = table.getRowCount();         // 3.5.5.7 (2004/05/10)
301
302                // 6.0.4.0 (2014/11/28) キー:ラベル形式で表示するかどうか[true:キー:ラベル形式/false:ラベルのみ/null:指定通り]
303                final String addKeyLabel = select.getAddKeyLabel();
304
305                // 6.2.0.0 (2015/02/27) 2番目以降の groupUseNo,classUseNo,styleUseNo,disabledUseNo,titleUseNo 以外のカラムは連結対象
306                // 0:キー、1:ラベル、以降、特殊カラム以外は連結します。先に連結するカラム番号をピックアップしておきます。
307                final int clmSize = table.getColumnCount();
308                int[] tmpClms = new int[clmSize];                       // 実際には、clmSize-2 が最大だが、カラム数=1 もあり得る。
309                int cnt = 0;                                                            // 実際
310                for( int clm=2; clm<clmSize; clm++ ) {          // カラムの2番目以降
311                        if( clm != groupUseNo && clm != classUseNo && 
312                                clm != styleUseNo && clm != disabledUseNo && clm != titleUseNo ) {
313                                        tmpClms[cnt++] = clm;
314                        }
315                }
316
317                String bkGroupKey = "";
318                String grpLabel ;
319                final StringBuilder buf = new StringBuilder( BUFFER_MIDDLE );   // 6.1.0.0 (2014/12/26) refactoring
320                for( int row=0; row<rowCnt; row++ ) {
321                        // 3.8.5.2 (2006/06/09) groupUseNo 属性
322                        if( groupUseNo >= 0 ) {
323                                final String groupKey = table.getValue( row,groupUseNo );
324                                grpLabel = getRendererValue( row,groupUseNo );
325                                if( !bkGroupKey.equals( groupKey ) ) {          // キーブレイク
326                                        // 3.8.9.2 (2007/07/28) グループと、クラスの設定方法のバグ修正
327                                        if( ! "".equals( bkGroupKey ) ) {
328                                                select.addOption( "</optgroup>" );
329                                        }
330                                        if( ! "".equals( groupKey ) ) {
331                                                select.addOption( "<optgroup label=\"" + grpLabel + "\">" );
332                                        }
333                                        bkGroupKey = groupKey;
334                                }
335                        }
336
337                        final Attributes attri = new Attributes();
338                        final String value = table.getValue( row,0 );
339                        attri.set( "value", value );
340
341                        // 5.0.2.0 (2009/11/01)
342                        // selValue は、makeLabel( OptionAncestorIF ) が呼ばれる前に、必ずセットされている。
343                        if( multipleAll || selValue.indexOf( "|" + value + "|" ) >= 0 ) {
344                                attri.set( "selected", "selected" );
345                        }
346
347                        // 3.8.5.2 (2006/06/09) classUseNo 属性
348                        if( classUseNo >= 0 ) {
349                                attri.add( "class", table.getValue( row,classUseNo ) );
350                        }
351
352                        // 6.2.0.0 (2015/02/27) コードリソースのパラメータの指定方法を変更します。
353                        if( styleUseNo >= 0 ) {
354                                attri.add( "style", table.getValue( row,styleUseNo ) );
355                        }
356
357                        if( disabledUseNo >= 0 ) {
358                                final String val = table.getValue( row,disabledUseNo );
359                                if( "true".equalsIgnoreCase( val ) || "disabled".equalsIgnoreCase( val ) ) {
360                                        attri.add( "disabled","disabled" );
361                                }
362                        }
363
364                        buf.setLength(0);                       // 6.1.0.0 (2014/12/26) refactoring
365                        boolean titleFlg = false;       // 4.3.8.0 (2009/08/01) title属性を付けるかどうか
366                        if( clmSize == 1 ) {            // 6.2.0.0 (2015/02/27) 変数化
367                                // 項目が一つの queryOption では、ラベルリソースが使用されます。
368                                if( addKey ) { buf.append( value ).append( ':' ); }             // 6.0.2.5 (2014/10/31) char を append する。
369                                final String label = getResource().getLabel( value );   // 6.2.0.0 (2015/02/27) 変数使用
370                                buf.append( label );
371
372                                // 4.3.8.0 (2009/08/01) titleUseNo 属性 セットされている場合かつラベルと異なる場合はtitle属性に追加
373                                if( titleUseNo >= 0 && !label.equals( table.getValue( row,titleUseNo ) )) {
374                                        titleFlg = true;
375                                }
376                        }
377                        else {
378        //                      if( groupUseNo >= 0 ) {
379        //                              buf.append( grpLabel );
380        //                              buf.append( separator );
381        //                      }
382                                final String label = getRendererValue( row,1 );
383                                buf.append( label );
384        //                      attri.set( "label", label );
385                                // 6.2.0.0 (2015/02/27) 2番目以降の連結対象
386                                for( int i=0; i<cnt; i++ ) {    // 注意:tmpClms.length ではなく、実際の設定済み数 cnt を使う。
387                                        buf.append( separator ).append( getRendererValue( row,tmpClms[i] ) );
388                                }
389
390                                // 4.3.8.0 (2009/08/01) titleUseNo 属性 セットされている場合かつラベルと異なる場合はtitle属性に追加
391                                if( titleUseNo >= 0 && !label.equals( table.getValue( row,titleUseNo ) )) {
392                                        titleFlg = true;
393                                }
394                        }
395
396                        // 4.3.7.2 (2009/06/22) タイトル属性セット
397                        if( titleFlg ){
398                                attri.add( "title", table.getValue( row,titleUseNo ) );
399                        }
400
401                        attri.set( "body", buf.toString() );
402                        select.addOption( XHTMLTag.option( attri , addKeyLabel ) );
403                }
404                if( groupUseNo >= 0 && ! "".equals( bkGroupKey ) ) {    // 3.8.9.2 (2007/07/28)
405                        select.addOption( "</optgroup>" );
406                }
407        }
408
409        /**
410         * 【TAG】Optionの初期値で選ばれる値を指定します。
411         *
412         * @og.tag Optionの初期値で選ばれる値を指定します。
413         *
414         * @param   val Optionの初期値で選ばれる値
415         */
416        public void setValue( final String val ) {
417                selValue = getRequestParameter( val );
418        }
419
420        /**
421         * 【TAG】value属性に値がセットされていないとき使用する、初期値を指定します。
422         *
423         * @og.tag
424         * value属性に値がセットされていないときに、この初期値を使用します。
425         *
426         * @og.rev 3.3.2.0 (2003/07/07) defaultVal 属性の追加。(新規作成)
427         *
428         * @param       val 初期値
429         */
430        public void setDefaultVal( final String val ) {
431                defaultVal = getRequestParameter( val );
432        }
433
434        /**
435         * 【TAG】複数のラベルを合成するときに使用する項目区切り文字をセットします(初期値:スペース)。
436         *
437         * @og.tag
438         * 初期値は、スペースです。
439         *
440         * @og.rev 3.0.1.0 (2003/03/03) セパレーターを指定できる様に変更。
441         *
442         * @param   sep 項目区切り文字
443         */
444        public void setSeparator( final String sep ) {
445                separator = nval( getRequestParameter( sep ),separator );
446        }
447
448        /**
449         * 【TAG】オプションに追加する class 属性の カラム番号を指定します(初期値:使用しない(-1))。
450         *
451         * @og.tag
452         * オプションは、データベースを検索して作成されますが、そのSQL文のカラム情報を
453         * 使用して オプションに class 属性を追加します。
454         * 各オプションに色をつける場合は、この class 属性に対応する CSS ファイルを用意します。
455         * ここでは、class 属性に使用する SQL文の カラム番号( 先頭が 0 ) を指定します。
456         * 通常、カラム番号=0 は キー情報、=1 はラベル情報 です。2 か 3 を指定します。
457         * 初期値は、使用しない(-1)です。
458         *
459         * @og.rev 3.8.5.2 (2006/06/09) 新規追加
460         *
461         * @param   no オプションに追加するクラス属性
462         */
463        public void setClassUseNo( final String no ) {
464                classUseNo = nval( getRequestParameter( no ),classUseNo );
465                if( classUseNo == 0 || classUseNo == 1 ) {
466                        throw new HybsSystemException( ERR_ARG_NO );    // 6.4.2.1 (2016/02/05) PMD refactoring.
467                }
468        }
469
470        /**
471         * 【TAG】オプションに追加する style 属性の カラム番号を指定します(初期値:使用しない(-1))。
472         *
473         * @og.tag
474         * オプションは、データベースを検索して作成されますが、そのSQL文のカラム情報を
475         * 使用して オプションタグにstyle 属性を追加します。
476         * 通常、カラム番号=0 は キー情報、=1 はラベル情報 です。2 か 3 を指定します。
477         * 初期値は、使用しない(-1)です。
478         *
479         * @og.rev 6.2.0.0 (2015/02/27) コードリソースのパラメータの指定方法を変更します。
480         *
481         * @param   no オプションに追加するstyle 属性
482         */
483        public void setStyleUseNo( final String no ) {
484                styleUseNo = nval( getRequestParameter( no ),styleUseNo );
485                if( styleUseNo == 0 || styleUseNo == 1 ) {
486                        throw new HybsSystemException( ERR_ARG_NO );    // 6.4.2.1 (2016/02/05) PMD refactoring.
487                }
488        }
489
490        /**
491         * 【TAG】オプションに追加する disabled 属性の カラム番号を指定します(初期値:使用しない(-1))。
492         *
493         * @og.tag
494         * オプションは、データベースを検索して作成されますが、そのSQL文のカラム情報を
495         * 使用して オプションタグにdisabled 属性を追加します。
496         *
497         * 設定する値は、"true" か、"disabled" の場合のみ、disabled になります。
498         *
499         * 通常、カラム番号=0 は キー情報、=1 はラベル情報 です。2 か 3 を指定します。
500         * 初期値は、使用しない(-1)です。
501         *
502         * @og.rev 6.2.0.0 (2015/02/27) コードリソースのパラメータの指定方法を変更します。
503         *
504         * @param   no オプションに追加するdisabled 属性
505         */
506        public void setDisabledUseNo( final String no ) {
507                disabledUseNo = nval( getRequestParameter( no ),disabledUseNo );
508                if( disabledUseNo == 0 || disabledUseNo == 1 ) {
509                        throw new HybsSystemException( ERR_ARG_NO );    // 6.4.2.1 (2016/02/05) PMD refactoring.
510                }
511        }
512
513        /**
514         * 【TAG】オプションのグループ化を行うカラム番号を指定します(初期値:使用しない(-1))。
515         *
516         * @og.tag
517         * オプションは、データベースを検索して作成されますが、そのSQL文のカラム情報を
518         * 使用して オプションをグループ化します。グループ化は optgroup要素をブレイク時に
519         * 出力する事で対応します。
520         * ここでは、グループ化に使用する SQL文の カラム番号( 先頭が 0 ) を指定します。
521         * 通常、カラム番号=0 は キー情報、=1 はラベル情報 です。2 か 3 を指定します。
522         * 初期値は、使用しない(-1)です。
523         *
524         * @og.rev 3.8.5.2 (2006/06/09) 新規追加
525         *
526         * @param   no キーブレイク時に追加するグループ文字
527         */
528        public void setGroupUseNo( final String no ) {
529                groupUseNo = nval( getRequestParameter( no ),groupUseNo );
530                if( groupUseNo == 0 || groupUseNo == 1 ) {
531                        throw new HybsSystemException( ERR_ARG_NO );    // 6.4.2.1 (2016/02/05) PMD refactoring.
532                }
533        }
534
535        /**
536         * 【TAG】リクエスト情報の シングルクォート(') 存在チェックを実施するかどうか[true/false]を設定します
537         *              (初期値:USE_SQL_INJECTION_CHECK[={@og.value SystemData#USE_SQL_INJECTION_CHECK}])。
538         *
539         * @og.tag
540         * SQLインジェクション対策の一つとして、暫定的ではありますが、SQLのパラメータに
541         * 渡す文字列にシングルクォート(') を許さない設定にすれば、ある程度は防止できます。
542         * 数字タイプの引数には、 or 5=5 などのシングルクォートを使用しないコードを埋めても、
543         * 数字チェックで検出可能です。文字タイプの場合は、必ず (')をはずして、
544         * ' or 'A' like 'A のような形式になる為、(')チェックだけでも有効です。
545         * (') が含まれていたエラーにする(true)/かノーチェックか(false)を指定します。
546         * (初期値:システム定数のUSE_SQL_INJECTION_CHECK[={@og.value SystemData#USE_SQL_INJECTION_CHECK}])。
547         *
548         * @og.rev 4.0.0.0 (2005/08/31) 新規追加
549         *
550         * @param   flag クォートチェック [true:する/それ以外:しない]
551         * @see         org.opengion.hayabusa.common.SystemData#USE_SQL_INJECTION_CHECK
552         */
553        public void setQuotCheck( final String flag ) {
554                quotCheck = nval( getRequestParameter( flag ),quotCheck );
555        }
556
557        /**
558         * 【TAG】(通常は使いません)Queryオブジェクトを作成する時のDB接続IDを指定します(初期値:null)。
559         *
560         * @og.tag
561         * Queryオブジェクトを作成する時のDB接続IDを指定します。
562         * これは、システムリソースで、DEFAULT_DB_URL 等で指定している データベース接続先
563         * 情報に、XX_DB_URL を定義することで、 dbid="XX" とすると、この 接続先を使用して
564         * データベースにアクセスできます。
565         *
566         * @param       id データベース接続ID
567         */
568        public void setDbid( final String id ) {
569                dbid = nval( getRequestParameter( id ),dbid );
570        }
571
572        /**
573         * 【TAG】項目が一つだけの場合のラベルリソースに、キー情報を追加するかどうかを指定します(初期値:false)。
574         *
575         * @og.tag
576         * Queryオブジェクトの項目が一つの場合、ラベル部には、ラベルリソースを使用します。
577         * この時、ラベル無しの場合は、キーが表示されますが、ラベルありの場合は、キーは表示されず
578         * ラベルのみ表示されます。
579         * 都合によっては、キーも表示したい場合がありますので、その様なケースでは、
580         * addKey = "true を設定する事で、キー:ラベル のセットをラベルとして扱います。
581         * 初期値はfalse(キーは付加しない)です。
582         *
583         * @param       id データベース接続ID
584         */
585        public void setAddKey( final String id ) {
586                addKey = nval( getRequestParameter( id ),addKey );
587        }
588
589        /**
590         * 【TAG】リクエスト情報の HTMLTag開始/終了文字(&gt;&lt;) 存在チェックを実施するかどうか[true/false]を設定します
591         *              (初期値:USE_XSS_CHECK[={@og.value SystemData#USE_XSS_CHECK}])。
592         *
593         * @og.tag
594         * クロスサイトスクリプティング(XSS)対策の一環としてless/greater than signについてのチェックを行います。
595         * (&gt;&lt;) が含まれていたエラーにする(true)/かノーチェックか(false)を指定します。
596         * (初期値:システム定数のUSE_XSS_CHECK[={@og.value SystemData#USE_XSS_CHECK}])。
597         *
598         * @og.rev 5.0.0.2 (2009/09/15) 新規追加
599         *
600         * @param       flag    XSSチェック [true:する/false:しない]
601         * @see         org.opengion.hayabusa.common.SystemData#USE_XSS_CHECK
602         */
603        public void setXssCheck( final String flag ) {
604                xssCheck = nval( getRequestParameter( flag ),xssCheck );
605        }
606
607        /**
608         * row行,colum列 のデータの値を返します。
609         *
610         * これは、データの値そのものではなく、その値のラベル文字を返します。
611         *
612         * @param   row         行番号
613         * @param   column      カラム番号
614         *
615         * @return  row行,colum列 のデータの値
616         */
617        private String getRendererValue( final int row,final int column ) {
618                final String val = table.getValue( row,column );
619                final DBColumn clm = table.getDBColumn( column );
620                return clm.getRendererValue( val );
621        }
622
623        /**
624         * 【TAG】オプションに追加する title 属性の カラム番号を指定します。
625         *
626         * @og.tag
627         * オプションは、データベースを検索して作成されますが、そのSQL文のカラム情報を
628         * 使用して オプションに title 属性を追加します。
629         * title属性はマウスオーバー時にツールチップとして表示されるため、
630         * プルダウンの横幅を短くしたい場合に有効です。
631         * 通常、カラム番号=0 は キー情報、=1 はラベル情報 です。2 か 3 を指定します。
632         * 初期値は、使用しない(-1)です。
633         *
634         * @og.rev 4.3.8.0 (2009/08/01) 新規追加
635         *
636         * @param   no オプションに追加するtitle属性
637         */
638        public void setTitleUseNo( final String no ) {
639                titleUseNo = nval( getRequestParameter( no ),titleUseNo );
640                if( titleUseNo == 0 || titleUseNo == 1 ) {
641                        throw new HybsSystemException( ERR_ARG_NO );    // 6.4.2.1 (2016/02/05) PMD refactoring.
642                }
643        }
644
645        /**
646         * このオブジェクトの文字列表現を返します。
647         * 基本的にデバッグ目的に使用します。
648         *
649         * @return このクラスの文字列表現
650         * @og.rtnNotNull
651         */
652        @Override
653        public String toString() {
654                return ToString.title( this.getClass().getName() )
655                                .println( "VERSION"             ,VERSION        )
656                                .println( "selValue"    ,selValue       )
657                                .println( "defaultVal"  ,defaultVal     )
658                                .println( "dbid"                ,dbid           )
659                                .println( "sql"                 ,sql            )
660                                .println( "separator"   ,separator      )
661                                .println( "quotCheck"   ,quotCheck      )
662                                .println( "Other..."    ,getAttributes().getAttribute() )
663                                .fixForm().toString() ;
664        }
665}