    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.DBTableModelUtil;
    022import org.opengion.hayabusa.db.DBColumn;
    023
    024import static org.opengion.fukurou.util.StringUtil.nval ;
    025
    026import java.util.prefs.Preferences;
    027import java.util.prefs.BackingStoreException;
    028import java.util.Locale ;
    029
    030/**
    031 * 指定の Windowsレジストリにアクセスするためのタグです(特殊な環境設定が必要です)。
    032 *
    033 * 検索した結果は、DBTableModel にセットされるため、
    034 * JDBCQuery と同様に、viewタグで表示させることが可能です。
    035 *
    036 * 注意１：
    037 *   通常であれば、以下の２つのルートパス以下のレジストリにアクセスできます。
    038 *     HKEY_CURRENT_USER/Software/JavaSoft/Prefs
    039 *     HKEY_LOCAL_MACHINE/Software/JavaSoft/Prefs
    040 *
    041 * 注意２：
    042 *   ルートパスを強制的に変更する為、java.util.prefs.WindowsPreferenceクラスを
    043 *   直接書き換えた、ogPreferences.jar を用意しています。
    044 *   これを、tomcat/endorsed フォルダにコピーして使います。
    045 *   その場合は、
    046 *     HKEY_CURRENT_USER/Software/Muratec
    047 *     HKEY_LOCAL_MACHINE/Software/Muratec
    048 *   以下の２つのルートパス以下のレジストリにアクセスできます。
    049 *
    050 * @og.formSample
    051 * ●形式：&lt;og:regQuery baseKey="･･･" ･･･ /&gt;
    052 * ●body：なし
    053 *
    054 * ●Tag定義：
    055 *   &lt;og:regQuery
    056 *       baseKey          ○【TAG】検索ベースキーを設定します(HKEY_CURRENT_USER/Software/XXXX の XXXX を指定します)(必須)。
    057 *       hkeyType           【TAG】HKEY_CURRENT_USER(="user") を読むか、HKEY_LOCAL_MACHINE(="system") を読むかを指定します(初期値:user)。
    058 *       key                【TAG】検索キーを設定します
    059 *       value              【TAG】検索バリューを設定します
    060 *       maxRowCount        【TAG】レジストリの最大検索件数をセットします(初期値:0[無制限])
    061 *       orderBy            【TAG】検索した結果を表示する表示順をファイル属性名で指定します
    062 *       maxLevel           【TAG】検索時の最大展開レベル(0は無制限)を指定します(初期値:1)
    063 *       like               【TAG】キーおよびバリューについて,like 検索を行うかどうか[true/false]を指定します(初期値:false)
    064 *       tableId            【TAG】(通常は使いません)結果をDBTableModelに書き込んで、sessionに登録するときのキーを指定します
    065 *       command            【TAG】コマンド(NEW,RENEW)をセットします(初期値:NEW)
    066 *       displayMsg         【TAG】検索結果を画面上に表示するメッセージIDを指定します(初期値:MSG0033[ 件検索しました])
    067 *       notfoundMsg        【TAG】検索結果がゼロ件の場合に表示するメッセージリソースIDを指定します(初期値:MSG0077[対象データはありませんでした])
    068 *       overflowMsg        【TAG】オーバーフロー時に画面上に表示するメッセージIDを指定します(初期値:MSG0007)
    069 *       scope              【TAG】キャッシュする場合のスコープ[request/page/session/applicaton]を指定します(初期値:session)
    070 *       mainTrans          【TAG】(通常使いません)タグで処理される処理がメインとなるトランザクション処理かどうかを指定します(初期値:false)
    071 *       debug              【TAG】デバッグ情報を出力するかどうか[true/false]を指定します(初期値:false)
    072 *   /&gt;
    073 *
    074 * ●使用例
    075 *    &lt;og:regQuery  debug=&quot;false&quot;
    076 *        command     = &quot;NEW&quot;                       NEW,RENEW が使用できます。
    077 *        baseKey     = &quot;/&quot;                         検索時のベースとなるレジストリキー名
    078 *        key         = &quot;driver&quot;                    検索したいレジストリキー名(初期値は全件)
    079 *        value       = &quot;Ne&quot;                        検索したいレジストリ値(初期値は全件)
    080 *        maxRowCount = &quot;0&quot;                         最大検索件数(0で無制限)
    081 *        maxLevel    = &quot;0&quot;                         最大検索階層レベル(0で無制限)
    082 *        like        = &quot;true&quot;                      true で曖昧検索/false は一致検索
    083 *    /&gt;
    084 *
    085 * like は、key / value を設定したときのみ有効です。また、key / value を両方同時に設定した場合は、
    086 * like 属性は両方に同時に適用されます。
    087 *
    088 * @og.rev 3.1.0.0 (2003/03/20) Windowsレジストリにアクセスできる、RegistryQueryTag.java を新規に作成。
    089 * @og.group その他入力
    090 *
    091 * @version  4.0
    092 * @author       Kazuhiko Hasegawa
    093 * @since    JDK5.0,
    094 */
    095public class RegistryQueryTag extends CommonTagSupport {
    096        //* このプログラムのVERSION文字列を設定します。   {@value} */
    097        private static final String VERSION = "5.6.8.2 (2013/09/20)" ;
    098
    099        private static final long serialVersionUID = 568220130920L ;
    100
    101        /** command 引数に渡す事の出来る コマンド  新規 {@value} */
    102        public static final String CMD_NEW       = "NEW" ;
    103        /** command 引数に渡す事の出来る コマンド  再検索 {@value} */
    104        public static final String CMD_RENEW = "RENEW" ;
    105        /** command 引数に渡す事の出来る コマンド リスト  */
    106        private static final String[] COMMAND_LIST = new String[] { CMD_NEW , CMD_RENEW };
    107
    108        private static final String[] COLUMN_KEY = new String[] { "LEBEL","KEY","VALUE","CHILD","PATH" };
    109
    110        private String  tableId                 = HybsSystem.TBL_MDL_KEY;                       // sessionｷｰ
    111        private String  command                 = CMD_NEW;                                                      // ｺﾏﾝﾄﾞ
    112        private String  baseKey                 = null;                                                         // 検索ベースｷｰ
    113        private String  key                             = null;                                                         // 検索キー
    114        private String  value                   = null;                                                         // 検索バリュー
    115        private int     maxRowCount             = 0;                                                            // 最大検索数(0は無制限)
    116        private String  orderBy                 = null;                                                         // ソート項目
    117        private String  displayMsg              = HybsSystem.sys( "VIEW_DISPLAY_MSG" );
    118        private String  overflowMsg             = "MSG0007";                                            // 検索結果が、制限行数を超えましたので、残りはカットされました。
    119        private String  notfoundMsg             = "MSG0077";                                            // 対象データはありませんでした。
    120        private int             maxLevel                = 1;                                                            // 下位層展開最大レベル(0は無制限)
    121        private boolean like                    = false;                                                        // あいまい検索ﾌﾗｸﾞ
    122
    123        private int             executeCount    = 0;                                                            // 検索/実行件数
    124        private boolean isMainTrans             = true;                                                         // 5.1.6.0 (2010/05/01) DBLastSqlの処理の見直し
    125        private int             hkeyType                = 0;                                                            // 5.6.8.2 (2013/09/20) 0:HKEY_CURRENT_USER(="user") , 1:HKEY_LOCAL_MACHINE(="system")
    126
    127        // 5.6.8.2 (2013/09/20) エラーメッセージ等に使う文字列
    128        private static final String[] HKEY_TYPE = new String[] { "HKEY_CURRENT_USER","HKEY_LOCAL_MACHINE" } ;
    129
    130        /**
    131         * Taglibの終了タグが見つかったときに処理する doEndTag() を オーバーライドします。
    132         *
    133         * @og.rev 3.1.1.2 (2003/04/04) Tomcat4.1 対応。release2() を doEndTag()で呼ぶ。
    134         * @og.rev 3.6.0.8 (2004/11/19) DBTableModel をセーブする時に、トランザクションチェックを行います。
    135         * @og.rev 4.0.0.0 (2007/10/18) メッセージリソース統合( getResource().getMessage ⇒ getResource().getLabel )
    136         * @og.rev 5.1.6.0 (2010/05/01) DBLastSqlの処理は、DBTableModelが新規作成された処理でのみ行う。
    137         *
    138         * @return      後続処理の指示
    139         */
    140        @Override
    141        public int doEndTag() {
    142                debugPrint();           // 4.0.0 (2005/02/28)
    143
    144                if( check( command, COMMAND_LIST ) ) {
    145                        useMainTrans( isMainTrans );                    // 5.1.6.0 (2010/05/01) DBLastSqlの処理の見直し
    146                        startQueryTransaction( tableId );               // 3.6.0.8 (2004/11/19)
    147
    148                        DBTableModel table = makeDBTable();
    149                        // 3.6.0.8 (2004/11/19) トランザクションチェックを行います。
    150                        if( ! commitTableObject( tableId, table ) ) {
    151                                jspPrint( "RegistryQueryTag Query処理が割り込まれました。DBTableModel は登録しません。" );
    152                                return SKIP_PAGE;
    153                        }
    154
    155                        StringBuilder buf = new StringBuilder( HybsSystem.BUFFER_SMALL );
    156
    157                        // 実行件数の表示 command="NEW" のときのみ、displayMsg を表示させます。
    158                        // 4.0.0 (2005/11/30) 出力順の変更。一番最初に出力します。
    159                        if( CMD_NEW.equals( command ) ) {
    160                                if( executeCount > 0 && displayMsg != null && displayMsg.length() > 0 ) {
    161                                        buf.append( executeCount );
    162                                        buf.append( getResource().getLabel( displayMsg ) );
    163                                        buf.append( HybsSystem.BR );
    164                                }
    165                                else if( executeCount == 0 && notfoundMsg != null && notfoundMsg.length() > 0 ) {
    166                                        buf.append( getResource().getLabel( notfoundMsg ) );
    167                                        buf.append( HybsSystem.BR );
    168                                }
    169                        }
    170
    171                        if( maxRowCount > 0 && maxRowCount <= executeCount ) {
    172                                buf.append( getResource().getLabel( overflowMsg ) );
    173                                buf.append( HybsSystem.BR );
    174                        }
    175
    176                        jspPrint( buf.toString() );
    177                }
    178
    179                return EVAL_PAGE ;
    180        }
    181
    182        /**
    183         * タグリブオブジェクトをリリースします。
    184         * キャッシュされて再利用されるので、フィールドの初期設定を行います。
    185         *
    186         * @og.rev 2.0.0.4 (2002/09/27) カスタムタグの release() メソッドを、追加
    187         * @og.rev 3.1.1.2 (2003/04/04) Tomcat4.1 対応。release2() を doEndTag()で呼ぶ。
    188         * @og.rev 5.1.6.0 (2010/05/01) DBLastSqlの処理は、DBTableModelが新規作成された処理でのみ行う。
    189         * @og.rev 5.6.8.2 (2013/09/20) hkeyType 追加
    190         *
    191         */
    192        @Override
    193        protected void release2() {
    194                super.release2();
    195
    196                tableId                 = HybsSystem.TBL_MDL_KEY;                       // sessionｷｰ
    197                orderBy                 = null;                                                         // ソート項目
    198                command                 = CMD_NEW;                                                      // ｺﾏﾝﾄﾞ
    199                baseKey                 = null;                                                         // 検索ベースｷｰ
    200                key                             = null;                                                         // 検索キー
    201                value                   = null;                                                         // 5.6.8.2 (2013/09/20) 検索バリュー 入れ忘れ
    202                executeCount    = 0;                                                            // 検索/実行件数
    203                maxRowCount             = 0;                                                            // 最大検索数(0は無制限)
    204                displayMsg              = HybsSystem.sys( "VIEW_DISPLAY_MSG" );
    205                overflowMsg             = "MSG0007";                                            // 検索結果が、制限行数を超えましたので、残りはカットされました。
    206                notfoundMsg             = "MSG0077";                                            // 対象データはありませんでした。
    207                maxLevel                = 1;                                                            // 下位層展開最大レベル(0は無制限)
    208                like                    = false;                                                        // あいまい検索ﾌﾗｸﾞ
    209                isMainTrans             = true;                                                         // 5.1.6.0 (2010/05/01) DBLastSqlの処理の見直し
    210                hkeyType                = 0;                                                            // 5.6.8.2 (2013/09/20) 0:HKEY_CURRENT_USER(="user") , 1:HKEY_LOCAL_MACHINE(="system")
    211        }
    212
    213        /**
    214         * レジストリ から、値を取り出し、DBTableModel を作成します。
    215         *
    216         * @og.rev 5.6.8.2 (2013/09/20) hkeyType 追加に伴う各種修正
    217         *
    218         * @return      テーブルモデル
    219         */
    220        private DBTableModel makeDBTable() {
    221                DBTableModel table = DBTableModelUtil.newDBTable();
    222                table.init( COLUMN_KEY.length );
    223                for( int i=0; i<COLUMN_KEY.length; i++ ) {
    224                        DBColumn dbColumn = getResource().makeDBColumn( COLUMN_KEY[i] );
    225                        table.setDBColumn( i,dbColumn );
    226                }
    227
    228                // 5.6.8.2 (2013/09/20) 0:HKEY_CURRENT_USER(="user") , 1:HKEY_LOCAL_MACHINE(="system")
    229                Preferences hayabusaRoot = ( hkeyType == 0 ) ? Preferences.userRoot() : Preferences.systemRoot();
    230
    231                try {
    232                        if( ! hayabusaRoot.nodeExists( baseKey ) ) {
    233                                String errMsg = "Preferences BaseKey が Windows Registry に存在しませんでした。"
    234                                                                + "[" + HKEY_TYPE[hkeyType] + "\\" + hayabusaRoot.absolutePath() + "]" ;
    235                                throw new HybsSystemException( errMsg );
    236                        }
    237
    238                        showChild( table,hayabusaRoot.node(baseKey),1 );
    239                }
    240                catch(BackingStoreException ex) {
    241                        String errMsg = "レジストリ から、値を取り出す事が出来ませんでした。"
    242                                                                + "[" + HKEY_TYPE[hkeyType] + "\\" + hayabusaRoot.absolutePath() + "]" ;
    243                        throw new HybsSystemException( errMsg,ex );             // 3.5.5.4 (2004/04/15) 引数の並び順変更
    244                }
    245
    246                return table ;
    247        }
    248
    249        /**
    250         * Preferences の子要素を検索します。
    251         *
    252         * この処理は、再帰定義により、階層を順次下がっていきます。
    253         * レベル制限、検索最大数制限のチェックを行っています。
    254         * addTableValue メソッドを呼び出して、検索結果を、DBTableModel に順次追加していきます。
    255         *
    256         * @og.rev 5.6.8.2 (2013/09/20) BackingStoreException を throwしない様に修正
    257         *
    258         * @param       table   DBTableModelオブジェクト
    259         * @param       prefs   Preferencesオブジェクト
    260         * @param       lvl             レベル制限
    261         */
    262        private void showChild( final DBTableModel table,
    263                                                        final Preferences prefs,
    264                                                        final int lvl ) {
    265
    266                if( maxRowCount > 0 && maxRowCount <= executeCount ) { return ; }
    267                if( maxLevel > 0 && lvl > maxLevel ) { return; }
    268
    269                String name = null;
    270                try {
    271                        String [] child = prefs.childrenNames();
    272
    273                        if( child != null && child.length > 0 ) {
    274                                for( int i = 0; i < child.length; i++) {
    275                                        name = child[i];
    276
    277                                        // name に全角文字が使われている場合、正常に処理できないので、Tableへの書き込みだけ行います。
    278                                        if( isZenkakuName( name ) ) {
    279                                                addTableValue( name,table,prefs,lvl,null,false );
    280                                        }
    281                                        else {
    282                                                Preferences childPrefs = prefs.node( name.toLowerCase(Locale.JAPAN) );
    283
    284                                                addTableValue( name,table,childPrefs,lvl,null,true );
    285                                                showChild( table,childPrefs,lvl+1 );
    286                                        }
    287                                }
    288                        }
    289                        else {
    290                                showPrefs( table,prefs,lvl );
    291                        }
    292                }
    293                // エラーが発生しても、処理は継続します。
    294                catch( BackingStoreException ex ) {
    295                        String errMsg = "BackingStoreエラーが発生しました。[" + (executeCount+1) + "]"
    296                                                + " key=[" + name + "] "
    297                                                + ex.getMessage() ;
    298                        System.out.println( errMsg );
    299                        addTableValue( name,table,prefs,lvl,errMsg,false );
    300                }
    301                // エラーが発生しても、処理は継続します。
    302                catch( RuntimeException ex ) {
    303                        String errMsg = "RuntimeExceptionエラーが発生しました。[" + (executeCount+1) + "]"
    304                                                + " key=[" + name + "] "
    305                                                + ex.getMessage() ;
    306                        System.out.println( errMsg );
    307                        addTableValue( name,table,prefs,lvl,errMsg,false );
    308                }
    309        }
    310
    311        /**
    312         * レジストリのキー情報が、全角文字を含むかかどうか判定します。(含むなら、true)。
    313         *
    314         * name に全角文字が使われている場合、正常に処理できないので、判定します。
    315         *
    316         * @param       name    レジストリのキー情報
    317         * @return      全角文字が使われている場合、true を返します。
    318         */
    319        private boolean isZenkakuName( final String name ) {
    320                boolean isZenkaku = false;
    321                for( int i=0; i<name.length(); i++ ) {
    322                        char ch =name.charAt(i);
    323                        if ( ch < 0x0020 || ch > 0x007f ) {
    324                                isZenkaku = true;
    325                                break;
    326                        }
    327                }
    328                return isZenkaku;
    329        }
    330
    331        /**
    332         * Preferences の属性を検索します。
    333         *
    334         * addTableValue メソッドを呼び出して、検索結果を、DBTableModel に順次追加していきます。
    335         *
    336         * @param       table   DBTableModelオブジェクト
    337         * @param       prefs   Preferencesオブジェクト
    338         * @param       lvl             レベル制限
    339         */
    340        private void showPrefs( final DBTableModel table,
    341                                                        final Preferences prefs,
    342                                                        final int lvl ) throws BackingStoreException {
    343
    344                String [] keys = prefs.keys();
    345
    346                if( keys != null ) {
    347                        for( int i = 0; i < keys.length; i++) {
    348                                String name = keys[i];
    349                                addTableValue( name,table,prefs,lvl,null,false );
    350                        }
    351                }
    352        }
    353
    354        /**
    355         * 検索された Preferencesを、DBTableModel に順次追加していきます。
    356         *
    357         * @param       name    検索キー
    358         * @param       table   DBTableModelオブジェクト
    359         * @param       prefs   Preferencesオブジェクト
    360         * @param       lvl             レベル制限
    361         * @param       msg             値にメッセージを書き込みたい場合(正常時ならnullでかまわない)。
    362         * @param       flag    true:値に空文字列/false:Preferencesから、検索キーを使用して値を取得
    363         */
    364        private void addTableValue( final String name,
    365                                                                final DBTableModel table,
    366                                                                final Preferences prefs,
    367                                                                final int lvl,
    368                                                                final String msg,
    369                                                                final boolean flag ) {
    370
    371                if( maxRowCount > 0 && maxRowCount <= executeCount ) { return ; }
    372
    373                String lowerName = name.toLowerCase(Locale.JAPAN);
    374                String val               = (msg != null) ? msg : ( flag ? "" : prefs.get(lowerName, "") );
    375
    376                if( key != null ) {
    377                        if( like ) {
    378                                if( lowerName.indexOf( key ) < 0 ) { return; }
    379                        }
    380                        else {
    381                                if( ! lowerName.equalsIgnoreCase( key ) ) { return; }
    382                        }
    383                }
    384                if( value != null ) {
    385                        if( like ) {
    386                                if( (val.toLowerCase(Locale.JAPAN)).indexOf( value ) < 0 ) { return; }
    387                        }
    388                        else {
    389                                if( ! val.equalsIgnoreCase( value ) ) { return; }
    390                        }
    391                }
    392
    393                String[] clmVals = new String[COLUMN_KEY.length];
    394                clmVals[0] = String.valueOf( lvl );                             // LEVEL
    395                clmVals[1] = name;                                                              // KEY
    396                clmVals[2] = val;                                                                       // VALUE
    397                clmVals[3] = String.valueOf( flag );                            // CHILD
    398                clmVals[4] = prefs.absolutePath() ;                             // PATH
    399
    400                table.addColumnValues( clmVals );
    401                executeCount++ ;
    402        }
    403
    404        /**
    405         * 【TAG】(通常は使いません)結果のDBTableModelを、sessionに登録するときのキーを指定します
    406         *              (初期値:HybsSystem#TBL_MDL_KEY[={@og.value org.opengion.hayabusa.common.HybsSystem#TBL_MDL_KEY}])。
    407         *
    408         * @og.tag
    409         * 検索結果より、DBTableModelオブジェクトを作成します。これを、下流のviewタグ等に
    410         * 渡す場合に、通常は、session を利用します。その場合の登録キーです。
    411         * query タグを同時に実行して、結果を求める場合、同一メモリに配置される為、
    412         * この tableId 属性を利用して、メモリ空間を分けます。
    413         *              (初期値:HybsSystem#TBL_MDL_KEY[={@og.value org.opengion.hayabusa.common.HybsSystem#TBL_MDL_KEY}])。
    414         *
    415         * @param       id sessionに登録する時の ID
    416         */
    417        public void setTableId( final String id ) {
    418                tableId = nval( getRequestParameter( id ), tableId );
    419        }
    420
    421        /**
    422         * 【TAG】検索した結果を表示する表示順をファイル属性名で指定します。
    423         *
    424         * @og.tag
    425         * 現仕様では、複数のキーを指定することは出来ません。
    426         *
    427         * @param       ordr    ソートキーを指定。
    428         */
    429        public void setOrderBy( final String ordr ) {
    430                orderBy = nval( getRequestParameter( ordr ),orderBy );
    431        }
    432
    433        /**
    434         * 【TAG】コマンド(NEW,RENEW)をセットします(初期値:NEW)。
    435         *
    436         * @og.tag
    437         * コマンドは,HTMLから(get/post)指定されますので,CMD_xxx で設定される
    438         * フィールド定数値のいづれかを、指定できます。
    439         * 何も設定されない、または、null の場合は、"NEW" が初期値にセットされます。
    440         *
    441         * @param       cmd コマンド(public static final 宣言されている文字列)
    442         * @see         <a href="../../../../constant-values.html#org.opengion.hayabusa.taglib.RegistryQueryTag.CMD_NEW">コマンド定数</a>
    443         */
    444        public void setCommand( final String cmd ) {
    445                String cmd2 = getRequestParameter( cmd );
    446                if( cmd2 != null && cmd2.length() > 0 ) { command = cmd2.toUpperCase(Locale.JAPAN); }
    447        }
    448
    449        /**
    450         * 【TAG】検索ベースキーを設定します(HKEY_CURRENT_USER/Software/XXX の XXX をベースとします)。
    451         *
    452         * @og.tag
    453         * レジストリの検索で、HKEY_CURRENT_USER か、HKEY_LOCAL_MACHINE の区別を、hkeyType 属性で付ける事が
    454         * できるようにしました。昔は、HKEY_CURRENT_USER/Software/ 以下の検索ができていましたが、
    455         * 今現在は、できなくなっているようです。（または、使い方が間違っているか）
    456         * そこで、標準(/JavaSoft/Prefs)、/Muratec、/Microsoft だけ、検索できるように、
    457         * XXXXPreferencesFactory を作成しました。
    458         * 詳細は、opengionV6/src/jdk170uXX_WindowsPreference を参照願います。
    459         * これにより、従来通りの方法で（制限はかかりますが）レジストリを検索できます。
    460         *
    461         * ベースキー に指定できるのは、"/Muratec" , "/Microsoft" で始まるキーだけです。
    462         * それに続く "/" で区切った階層構造も表現可能です。
    463         * 標準(/JavaSoft/Prefs) は、何も指定しないことで、標準であることを示します。
    464         *
    465         * @param       bkey 検索ベースキー
    466         */
    467        public void setBaseKey( final String bkey ) {
    468                baseKey = nval( getRequestParameter( bkey ),baseKey );
    469        }
    470
    471        /**
    472         * 【TAG】検索キーを設定します。
    473         *
    474         * @og.tag 検索キーを設定します。
    475         *
    476         * @param       ky 検索キー
    477         */
    478        public void setKey( final String ky ) {
    479                key = nval( getRequestParameter( ky ),key );
    480                if( key != null ) { key = key.toLowerCase(Locale.JAPAN); }
    481        }
    482
    483        /**
    484         * 【TAG】検索バリューを設定します。
    485         *
    486         * @og.tag 検索バリューを設定します。
    487         *
    488         * @param       val 検索バリュー
    489         */
    490        public void setValue( final String val ) {
    491                value = nval( getRequestParameter( val ),value );
    492                if( value != null ) { value = value.toLowerCase(Locale.JAPAN); }
    493        }
    494
    495        /**
    496         * 【TAG】レジストリの最大検索件数をセットします(初期値:0[無制限])。
    497         *
    498         * @og.tag
    499         * DBTableModelのデータとして登録する最大件数をこの値に設定します。
    500         * サーバーのメモリ資源と応答時間の確保の為です。
    501         * 初期値は、0 は、無制限です。
    502         *
    503         * @param       count レジストリの最大検索件数
    504         */
    505        public void setMaxRowCount( final String count ) {
    506                maxRowCount = nval( getRequestParameter( count ),maxRowCount );
    507        }
    508
    509        /**
    510         * 【TAG】検索結果を画面上に表示するメッセージIDを指定します(初期値:MSG0033[ 件検索しました])。
    511         *
    512         * @og.tag
    513         * ここでは、検索結果の件数や登録された件数をまず出力し、
    514         * その次に、ここで指定したメッセージをリソースから取得して
    515         * 表示します。
    516         * 表示させたくない場合は, displayMsg = "" をセットしてください。
    517         * 初期値は、検索件数を表示します。
    518         *
    519         * @param       id ディスプレイに表示させるメッセージ ID
    520         */
    521        public void setDisplayMsg( final String id ) {
    522                displayMsg = getRequestParameter( id );
    523        }
    524
    525        /**
    526         * 【TAG】検索結果がゼロ件の場合に表示するメッセージリソースIDを指定します(初期値:MSG0077[対象データはありませんでした])。
    527         *
    528         * @og.tag
    529         * ここでは、検索結果がゼロ件の場合のみ、特別なメッセージを表示させます。
    530         * 従来は、displayMsg と兼用で、『0　件検索しました』という表示でしたが、
    531         * displayMsg の初期表示は、OFF になりましたので、ゼロ件の場合のみ別に表示させます。
    532         * 表示させたくない場合は, notfoundMsg = "" をセットしてください。
    533         * 初期値は、MSG0077[対象データはありませんでした]です。
    534         *
    535         * @param       id ディスプレイに表示させるメッセージ ID
    536         */
    537        public void setNotfoundMsg( final String id ) {
    538                String ids = getRequestParameter( id );
    539                if( ids != null ) { notfoundMsg = ids; }
    540        }
    541
    542        /**
    543         * 【TAG】オーバーフロー時に画面上に表示するメッセージIDを指定します(初期値:MSG0007)。
    544         *
    545         * @og.tag
    546         * 表示させたくない場合は, overflowMsg = "" をセットしてください。
    547         *
    548         * @param       id ディスプレイに表示させるメッセージ ID
    549         */
    550        public void setOverflowMsg( final String id ) {
    551                overflowMsg = getRequestParameter( id );
    552        }
    553
    554        /**
    555         * 【TAG】検索時の最大展開レベル(0は無制限)を指定します(初期値:1)。
    556         *
    557         * @og.tag
    558         * ０を指定すると、無制限に階層を展開します。
    559         * 初期値は、１レベルです。
    560         *
    561         * @param       lvl 検索時の最大展開レベル
    562         */
    563        public void setMaxLevel( final String lvl ) {
    564                maxLevel = nval( getRequestParameter( lvl ),maxLevel );
    565        }
    566
    567        /**
    568         * 【TAG】キーおよびバリューについて,like 検索を行うかどうか[true/false]を指定します(初期値:false)。
    569         *
    570         * @og.tag
    571         * like検索とは、キーの一部の文字を含む場合にマッチしたとして、値を取り出します。
    572         * ここでの設定は、キーもバリューも同時に適用されます。また、大文字小文字の区別も行いません。
    573         *
    574         * @param       lik like 検索を行うかどうか
    575         */
    576        public void setLike( final String lik ) {
    577                like = nval( getRequestParameter( lik ),like );
    578        }
    579
    580        /**
    581         * 【TAG】レジストリの読み込むルートを(user/system)で指定します(初期値:user)。
    582         *
    583         * @og.tag
    584         * HKEY_CURRENT_USER/Software/XXXX を読む場合は、"user" を、HKEY_LOCAL_MACHINE/Software/XXXX
    585         * を読む場合は、"system" を指定します。それ以外の指定は、エラーにしています。
    586         * ここでの設定は、大文字小文字の区別は行いません。
    587         * 初期値は、"user"(HKEY_CURRENT_USER) です。
    588         *
    589         * @og.rev 5.6.8.2 (2013/09/20) 新規追加
    590         *
    591         * @param       type レジストリの読み込むルート(user/system)
    592         */
    593        public void setHkeyType( final String type ) {
    594                String temp = nval( getRequestParameter( type ),null );
    595                if( temp != null ) {
    596                        if(        "user".equalsIgnoreCase( temp ) ) { hkeyType = 0; }
    597                        else if( "system".equalsIgnoreCase( temp ) ) { hkeyType = 1; }
    598                        else {
    599                                String errMsg = "hkeyType は、[user] か、[system] のどちらかを指定してください。"
    600                                                        + " hkeyType[" + temp + "]" ;
    601                                throw new HybsSystemException( errMsg );
    602                        }
    603                }
    604        }
    605
    606        /**
    607         * タグの名称を、返します。
    608         * 自分自身のクラス名より、自動的に取り出せないため、このメソッドをオーバーライドします。
    609         *
    610         * @og.rev 4.0.0.0 (2005/01/31) 新規追加
    611         *
    612         * @return  タグの名称
    613         */
    614        @Override
    615        protected String getTagName() {
    616                return "regQuery" ;
    617        }
    618
    619        /**
    620         * 【TAG】(通常使いません)タグで処理される処理がメインとなるトランザクション処理かどうかを指定します(初期値:false)。
    621         *
    622         * @og.tag
    623         * この値は、ファイルダウンロード処理に影響します。この値がtrueに指定された時にcommitされたDBTableModelが
    624         * ファイルダウンロードの対象の表になります。
    625         *
    626         * このパラメーターは、通常、各タグにより実装され、ユーザーが指定する必要はありません。
    627         * 但し、1つのJSP内でDBTableModelが複数生成される場合に、前に処理したDBTableModelについてファイルダウンロードをさせたい
    628         * 場合は、後ろでDBTableModelを生成するタグで、明示的にこの値をfalseに指定することで、ファイルダウンロード処理の対象から
    629         * 除外することができます。
    630         *
    631         * @og.rev 5.1.6.0 (2010/05/01) 新規作成
    632         *
    633         * @param  flag メイントランザクションかどうか
    634         */
    635        public void setMainTrans( final String flag ) {
    636                isMainTrans = nval( getRequestParameter( flag ),isMainTrans );
    637        }
    638
    639        /**
    640         * このオブジェクトの文字列表現を返します。
    641         * 基本的にデバッグ目的に使用します。
    642         *
    643         * @return このクラスの文字列表現
    644         */
    645        @Override
    646        public String toString() {
    647                return org.opengion.fukurou.util.ToString.title( this.getClass().getName() )
    648                                .println( "VERSION"             ,VERSION                )
    649                                .println( "tableId"             ,tableId                )
    650                                .println( "command"             ,command                )
    651                                .println( "baseKey"             ,baseKey                )
    652                                .println( "key"                 ,key                    )
    653                                .println( "value"               ,value                  )
    654                                .println( "maxRowCount" ,maxRowCount    )
    655                                .println( "orderBy"             ,orderBy                )
    656                                .println( "displayMsg"  ,displayMsg             )
    657                                .println( "overflowMsg" ,overflowMsg    )
    658                                .println( "maxLevel"    ,maxLevel               )
    659                                .println( "like"                ,like                   )
    660                                .println( "executeCount",executeCount   )
    661                                .println( "COLUMN_KEY"  ,COLUMN_KEY             )
    662                                .println( "Other..."    ,getAttributes().getAttribute() )
    663                                .fixForm().toString() ;
    664        }
    665}