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.resource.GUIInfo;
020import org.opengion.hayabusa.resource.UserInfo;
021import org.opengion.hayabusa.db.DBTableModel;
022import org.opengion.hayabusa.db.DBColumn;
023import org.opengion.hayabusa.db.DBTableModelUtil;
024
025import static org.opengion.fukurou.util.StringUtil.nval ;
026
027import java.io.ObjectOutputStream;
028import java.io.ObjectInputStream;
029import java.io.IOException;
030
031/**
032 * 画面リソースのオブジェクトを検索し、DBTableModel にセットするタグです。
033 *
034 * ファイルの検索結果は、GUIKEY,ADDRESS,REALADDRESS,SEQNO,GROUPS,CLASSIFY,LEVEL,
035 * NAME_JA,SNAME,LNAME,ROLES,RWMODE,TARGET,PARAM,KBLINK,DESCRIPTION,DYUPD のカラムを持つ
036 * DBTableModel にセット されます。このカラムは、固定です。
037 * 並び替え、および、画面リソースの選別(where 条件)は、固定で、指定できません。
038 *
039 * [カラム名]      検索するオブジェクトの属性は、以下のカラム名で作成されます。(固定)
040 *     GUIKEY        画面ID
041 *     ADDRESS       実行アドレス
042 *     REALADDRESS   実行実アドレス
043 *     SEQNO         表示順
044 *     GROUPS        メニュグループ
045 *     CLASSIFY      メニュ分類
046 *     LEVEL         メニュ階層番号
047 *     NAME_JA       画面名称
048 *     SNAME         画面名称(short)
049 *     LNAME         画面名称(long)
050 *     ROLES         ロールズ
051 *     MODE          アクセスモード列(mr,mw,-r,-w の羅列)
052 *     TARGET        ターゲット
053 *     PARAM         設定値(パラメータ)
054 *     KBLINK        リンク区分
055 *     DESCRIPTION   概要説明
056 *     DYUPD         更新日時
057 *
058 * [roles 属性]      画面リソースの選別となる、ROLES 属性
059 *
060 * @og.formSample
061 * ●形式:<og:guiQuery command="…" roles="…" />
062 * ●body:なし
063 *
064 * ●Tag定義:
065 *   <og:guiQuery
066 *       roles              【TAG】画面リソースの条件となるロールズを指定します
067 *       level              【TAG】画面リソースの条件となるレベルを指定します
068 *       rwmode             【TAG】画面リソースの条件となるRWモードを指定します
069 *       command            【TAG】コマンド(NEW,RENEW)をセットします(PlsqlUpdateTag,UpdateTag の場合は、ENTRY)
070 *       scope              【TAG】キャッシュする場合のスコープ[request/page/session/applicaton]を指定します(初期値:session)
071 *       displayMsg         【TAG】検索結果を画面上に表示するメッセージリソースIDを指定します (初期値:VIEW_DISPLAY_MSG[=])
072 *       notfoundMsg        【TAG】検索結果がゼロ件の場合に表示するメッセージリソースIDを指定します(初期値:MSG0077[対象データはありませんでした])
073 *       tableId            【TAG】(通常は使いません)結果のDBTableModelを、sessionに登録するときのキーを指定します
074 *       debug              【TAG】デバッグ情報を出力するかどうか[true/false]を指定します(初期値:false)
075 *   >   ... Body ...
076 *   </og:guiQuery>
077 *
078 * ●使用例
079 *         <og:guiQuery
080 *                command = "NEW"
081 *                roles   = "AA|BB|CC"
082 *         />
083 *
084 * @og.rev 5.2.2.0 (2010/11/01) 新規追加
085 * @og.group その他入力
086 *
087 * @version  4.0
088 * @author       Kazuhiko Hasegawa
089 * @since    JDK5.0,
090 */
091public class GuiQueryTag extends QueryTag {
092        //* このプログラムのVERSION文字列を設定します。   {@value} */
093        private static final String VERSION = "5.3.3.0 (2011/03/01)" ;
094
095        private static final long serialVersionUID = 533020110301L ;
096
097        private static final String[] SELECT =
098                                new String[] { "GUIKEY","ADDRESS","REALADDRESS","SEQNO","GROUPS","CLASSIFY","LEVEL",
099                                                        "NAME_JA","SNAME","LNAME","ROLES","RWMODE","TARGET","PARAM","KBLINK","DESCRIPTION","DYUPD" };
100
101        private static final int GUIKEY      = 0;
102        private static final int ADDRESS     = 1;
103        private static final int REALADDRESS = 2;
104        private static final int SEQNO       = 3;
105        private static final int GROUPS      = 4;
106        private static final int CLASSIFY    = 5;
107        private static final int LEVEL       = 6;
108        private static final int NAME_JA     = 7;
109        private static final int SNAME       = 8;
110        private static final int LNAME       = 9;
111        private static final int ROLES       = 10;
112        private static final int RWMODE      = 11;
113        private static final int TARGET      = 12;
114        private static final int PARAM       = 13;
115        private static final int KBLINK      = 14;
116        private static final int DESCRIPTION = 15;
117        private static final int DYUPD       = 16; // 5.3.3.0 (2011/03/01) 更新日時追加
118
119        private String  roles           = null;
120        private String  level           = null;
121        private String  rwmode          = null;
122
123        /**
124         * Taglibの開始タグが見つかったときに処理する doStartTag() を オーバーライドします。
125         *
126         * 通常の QueryTagでは、Body を評価する(EVAL_BODY_BUFFERED)を返しますが、
127         * GuiQueryでは BODYを評価しない為、SKIP_BODY を返します。
128         *
129         * @return      後続処理の指示(SKIP_BODY)
130         */
131        @Override
132        public int doStartTag() {
133                super.doStartTag();
134
135                // DBTableModel の初期化
136                table = initDBTable();
137
138                // 実行
139                execute() ;
140
141                return SKIP_BODY ;                              // Body を評価しない
142        }
143
144        /**
145         * タグリブオブジェクトをリリースします。
146         * キャッシュされて再利用されるので、フィールドの初期設定を行います。
147         *
148         */
149        @Override
150        protected void release2() {
151                super.release2();
152                roles           = null;
153                level           = null;
154                rwmode          = null;
155        }
156
157        /**
158         * guiQuery を実行します。
159         *
160         */
161        protected void execute() {
162                UserInfo userInfo = new UserInfo( "XX","ja","DUMMY",roles,null,"GF","127.0.0.1",null );
163
164                getResource().makeGUIInfos( userInfo );
165
166                GUIInfo[] guiInfos = userInfo.getGUIInfos();
167
168                for( int i=0; i<guiInfos.length; i++ ) {
169                        addGUIInfo( guiInfos[i] );
170                }
171                executeCount = table.getRowCount();
172        }
173
174        /**
175         * 初期化された DBTableModel を返します。
176         *
177         * @return      テーブルモデル
178         */
179        private DBTableModel initDBTable() {
180                DBTableModel tbl = DBTableModelUtil.newDBTable();
181
182                tbl.init( SELECT.length );
183                for( int i=0; i<SELECT.length; i++ ) {
184                        DBColumn dbColumn = getDBColumn( SELECT[i] );
185                        tbl.setDBColumn( i,dbColumn );
186                }
187
188                return tbl ;
189        }
190
191        /**
192         * DBTableModel に、ファイル情報をセットします。
193         * ファイルの検索結果は、GUIKEY,ADDRESS,REALADDRESS,SEQNO,GROUPS,CLASSIFY,LEVEL,
194         * NAME_JA,SNAME,LNAME,ROLES,RWMODE,TARGET,PARAM,KBLINK,DESCRIPTION,DYUPD のカラムを持つ
195         * DBTableModel にセット されます。このカラムは、固定です。
196         *
197         * @og.rev 5.3.3.0 (2011/03/01) 更新日時追加、分類を名称でセット
198         *
199         * @param       guiInfo セットする画面リソース
200         */
201        private void addGUIInfo( final GUIInfo guiInfo ) {
202                String guiLevel = String.valueOf( guiInfo.getLevel() );
203                if( level != null && !level.equals( guiLevel ) ) { return; }
204
205                String guiMode  = guiInfo.getMode();
206                if( rwmode != null && guiMode != null && !guiMode.startsWith( rwmode ) ) { return; }
207
208                String[] data = new String[ SELECT.length ];
209
210                data[GUIKEY     ] = guiInfo.getKey();
211                data[ADDRESS    ] = guiInfo.getAddress();
212                data[REALADDRESS] = guiInfo.getRealAddress();
213                data[SEQNO      ] = String.valueOf( guiInfo.getSequence() );
214                data[GROUPS     ] = guiInfo.getGroups();
215                data[CLASSIFY   ] = getResource().getLabel( guiInfo.getClassify() );
216                data[LEVEL      ] = guiLevel;
217                data[NAME_JA    ] = guiInfo.getLabel();
218                data[SNAME      ] = guiInfo.getName();
219                data[LNAME      ] = guiInfo.getLongName();
220                data[ROLES      ] = guiInfo.getRoles();
221                data[RWMODE     ] = guiMode;
222                data[TARGET     ] = guiInfo.getTarget();
223                data[PARAM      ] = guiInfo.getParam();
224                data[KBLINK     ] = guiInfo.getKblink();
225                data[DESCRIPTION] = guiInfo.getDescription();
226                data[DYUPD      ] = guiInfo.getDyupd();
227
228                table.addColumnValues( data );
229        }
230
231        /**
232         * 【TAG】画面リソースの条件となるロールズを指定します。
233         *
234         * @og.tag
235         * ロールズ判定は、ダミーユーザーを作成して通常の処理と同様の判定方式で
236         * 有効な画面リソースをピックアップします。
237         *
238         * @param       rols    ロールズ
239         */
240        public void setRoles( final String rols ) {
241                roles = nval( getRequestParameter( rols ),roles );
242        }
243
244        /**
245         * 【TAG】画面リソースの条件となるレベルを指定します。
246         *
247         * @og.tag
248         * レベル判定は、文字列レベルの判定を行います。
249         * 画面リソースの階層番号(レベル)は、
250         *  0:グループ分類メニュー(class="GUI_GRP"のtdタグで囲われます)
251         *  1:トップ階層(【分類名称】)
252         *  2:選択階層(通常の折りたたみメニュー)
253         *  3:選択非表示(通常は、隠してあります)
254         * です。
255         *
256         * ロール等の他の条件でピックアップされたリソースと AND 処理されます。
257         * 何も指定しなければ、すべてを対象とします。
258         *
259         * @param       lvl     ロールズ
260         */
261        public void setLevel( final String lvl ) {
262                level = nval( getRequestParameter( lvl ),level );
263        }
264
265        /**
266         * 【TAG】画面リソースの条件となるRWモードを指定します。
267         *
268         * @og.tag
269         * RWモード判定は、文字列レベルの判定を行います。(通常のRW判定と異なります)
270         * RWモードの代表的な記述は、mw,mr,-w,-r です。ここでは、特殊な検索は出来ないため、
271         * 上記文字列そのままで、一致するか、m,- の前方一致で判断するかのどちらかです。
272         *
273         * ロール等の他の条件でピックアップされたリソースと AND 処理されます。
274         * 何も指定しなければ、すべてを対象とします。
275         *
276         * @param       mode    RWモード
277         */
278        public void setRwmode( final String mode ) {
279                rwmode = nval( getRequestParameter( mode ),rwmode );
280        }
281
282        /**
283         * シリアライズ用のカスタムシリアライズ書き込みメソッド
284         *
285         * @og.rev 4.0.0.0 (2006/09/31) 新規追加
286         * @serialData 一部のオブジェクトは、シリアライズされません。
287         *
288         * @param       strm    ObjectOutputStreamオブジェクト
289         * @throws IOException  入出力エラーが発生した場合
290         */
291        private void writeObject( final ObjectOutputStream strm ) throws IOException {
292                strm.defaultWriteObject();
293        }
294
295        /**
296         * シリアライズ用のカスタムシリアライズ読み込みメソッド
297         *
298         * ここでは、transient 宣言された内部変数の内、初期化が必要なフィールドのみ設定します。
299         *
300         * @og.rev 4.0.0.0 (2006/09/31) 新規追加
301         * @serialData 一部のオブジェクトは、シリアライズされません。
302         *
303         * @param       strm    ObjectInputStreamオブジェクト
304         * @see #release2()
305         * @throws IOException  シリアライズに関する入出力エラーが発生した場合
306         * @throws ClassNotFoundException       クラスを見つけることができなかった場合
307         */
308        private void readObject( final ObjectInputStream strm ) throws IOException , ClassNotFoundException {
309                strm.defaultReadObject();
310        }
311
312        /**
313         * このオブジェクトの文字列表現を返します。
314         * 基本的にデバッグ目的に使用します。
315         *
316         * @return このクラスの文字列表現
317         */
318        @Override
319        public String toString() {
320                return org.opengion.fukurou.util.ToString.title( this.getClass().getName() )
321                                .println( "VERSION"             ,VERSION        )
322                                .println( "roles"               ,roles  )
323                                .fixForm().toString()
324                        + HybsSystem.CR
325                        + super.toString() ;
326        }
327}