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" };
100                                                        "NAME_JA","SNAME","LNAME","ROLES","RWMODE","TARGET","PARAM","KBLINK","DESCRIPTION","DYUPD" };
101
102        private static final int GUIKEY      = 0;
103        private static final int ADDRESS     = 1;
104        private static final int REALADDRESS = 2;
105        private static final int SEQNO       = 3;
106        private static final int GROUPS      = 4;
107        private static final int CLASSIFY    = 5;
108        private static final int LEVEL       = 6;
109        private static final int NAME_JA     = 7;
110        private static final int SNAME       = 8;
111        private static final int LNAME       = 9;
112        private static final int ROLES       = 10;
113        private static final int RWMODE      = 11;
114        private static final int TARGET      = 12;
115        private static final int PARAM       = 13;
116        private static final int KBLINK      = 14;
117        private static final int DESCRIPTION = 15;
118        private static final int DYUPD       = 16; // 5.3.3.0 (2011/03/01) 更新日時追加
119
120        /** command 引数に渡す事の出来る コマンド リスト  */
121//      private static final String[] COMMAND_LIST = new String[] { CMD_NEW , CMD_RENEW };
122
123        private String  roles           = null;
124        private String  level           = null;
125        private String  rwmode          = null;
126
127        /**
128         * Taglibの開始タグが見つかったときに処理する doStartTag() を オーバーライドします。
129         *
130         * 通常の QueryTagでは、Body を評価する(EVAL_BODY_BUFFERED)を返しますが、
131         * GuiQueryでは BODYを評価しない為、SKIP_BODY を返します。
132         *
133         * @return      後続処理の指示(SKIP_BODY)
134         */
135        @Override
136        public int doStartTag() {
137                super.doStartTag();
138
139                // DBTableModel の初期化
140                table = initDBTable();
141
142                // 実行
143                execute() ;
144
145                return(SKIP_BODY);                              // Body を評価しない
146        }
147
148        /**
149         * タグリブオブジェクトをリリースします。
150         * キャッシュされて再利用されるので、フィールドの初期設定を行います。
151         *
152         */
153        @Override
154        protected void release2() {
155                super.release2();
156                roles           = null;
157                level           = null;
158                rwmode          = null;
159        }
160
161        /**
162         * guiQuery を実行します。
163         *
164         */
165        protected void execute() {
166                UserInfo userInfo = new UserInfo( "XX","ja","DUMMY",roles,null,"GF","127.0.0.1",null );
167
168                getResource().makeGUIInfos( userInfo );
169
170                GUIInfo[] guiInfos = userInfo.getGUIInfos();
171
172                for( int i=0; i<guiInfos.length; i++ ) {
173                        addGUIInfo( guiInfos[i] );
174                }
175                executeCount = table.getRowCount();
176        }
177
178        /**
179         * 初期化された DBTableModel を返します。
180         *
181         * @return      テーブルモデル
182         */
183        private DBTableModel initDBTable() {
184                DBTableModel tbl = DBTableModelUtil.newDBTable();
185
186                tbl.init( SELECT.length );
187                for( int i=0; i<SELECT.length; i++ ) {
188                        DBColumn dbColumn = getDBColumn( SELECT[i] );
189                        tbl.setDBColumn( i,dbColumn );
190                }
191
192                return tbl ;
193        }
194
195        /**
196         * DBTableModel に、ファイル情報をセットします。
197         * ファイルの検索結果は、GUIKEY,ADDRESS,REALADDRESS,SEQNO,GROUPS,CLASSIFY,LEVEL,
198         * NAME_JA,SNAME,LNAME,ROLES,RWMODE,TARGET,PARAM,KBLINK,DESCRIPTION,DYUPD のカラムを持つ
199         * DBTableModel にセット されます。このカラムは、固定です。
200         *
201         * @og.rev 5.3.3.0 (2011/03/01) 更新日時追加、分類を名称でセット
202         *
203         * @param       guiInfo セットする画面リソース
204         */
205        private void addGUIInfo( final GUIInfo guiInfo ) {
206                String guiLevel = String.valueOf( guiInfo.getLevel() );
207                if( level != null && !level.equals( guiLevel ) ) { return; }
208
209                String guiMode  = guiInfo.getMode();
210                if( rwmode != null && guiMode != null && !guiMode.startsWith( rwmode ) ) { return; }
211
212                String[] data = new String[ SELECT.length ];
213
214                data[GUIKEY     ] = guiInfo.getKey();
215                data[ADDRESS    ] = guiInfo.getAddress();
216                data[REALADDRESS] = guiInfo.getRealAddress();
217                data[SEQNO      ] = String.valueOf( guiInfo.getSequence() );
218                data[GROUPS     ] = guiInfo.getGroups();
219//              data[CLASSIFY   ] = guiInfo.getClassify();
220                data[CLASSIFY   ] = getResource().getLabel( guiInfo.getClassify() );
221                data[LEVEL      ] = guiLevel;
222                data[NAME_JA    ] = guiInfo.getLabel();
223                data[SNAME      ] = guiInfo.getName();
224                data[LNAME      ] = guiInfo.getLongName();
225                data[ROLES      ] = guiInfo.getRoles();
226                data[RWMODE     ] = guiMode;
227                data[TARGET     ] = guiInfo.getTarget();
228                data[PARAM      ] = guiInfo.getParam();
229                data[KBLINK     ] = guiInfo.getKblink();
230                data[DESCRIPTION] = guiInfo.getDescription();
231                data[DYUPD      ] = guiInfo.getDyupd();
232
233                table.addColumnValues( data );
234        }
235
236        /**
237         * 【TAG】画面リソースの条件となるロールズを指定します。
238         *
239         * @og.tag
240         * ロールズ判定は、ダミーユーザーを作成して通常の処理と同様の判定方式で
241         * 有効な画面リソースをピックアップします。
242         *
243         * @param       rols    ロールズ
244         */
245        public void setRoles( final String rols ) {
246                roles = nval( getRequestParameter( rols ),roles );
247        }
248
249        /**
250         * 【TAG】画面リソースの条件となるレベルを指定します。
251         *
252         * @og.tag
253         * レベル判定は、文字列レベルの判定を行います。
254         * 画面リソースの階層番号(レベル)は、
255         *  0:グループ分類メニュー(class="GUI_GRP"のtdタグで囲われます)
256         *  1:トップ階層(【分類名称】)
257         *  2:選択階層(通常の折りたたみメニュー)
258         *  3:選択非表示(通常は、隠してあります)
259         * です。
260         *
261         * ロール等の他の条件でピックアップされたリソースと AND 処理されます。
262         * 何も指定しなければ、すべてを対象とします。
263         *
264         * @param       lvl     ロールズ
265         */
266        public void setLevel( final String lvl ) {
267                level = nval( getRequestParameter( lvl ),level );
268        }
269
270        /**
271         * 【TAG】画面リソースの条件となるRWモードを指定します。
272         *
273         * @og.tag
274         * RWモード判定は、文字列レベルの判定を行います。(通常のRW判定と異なります)
275         * RWモードの代表的な記述は、mw,mr,-w,-r です。ここでは、特殊な検索は出来ないため、
276         * 上記文字列そのままで、一致するか、m,- の前方一致で判断するかのどちらかです。
277         *
278         * ロール等の他の条件でピックアップされたリソースと AND 処理されます。
279         * 何も指定しなければ、すべてを対象とします。
280         *
281         * @param       mode    RWモード
282         */
283        public void setRwmode( final String mode ) {
284                rwmode = nval( getRequestParameter( mode ),rwmode );
285        }
286
287        /**
288         * シリアライズ用のカスタムシリアライズ書き込みメソッド
289         *
290         * @og.rev 4.0.0.0 (2006/09/31) 新規追加
291         * @serialData 一部のオブジェクトは、シリアライズされません。
292         *
293         * @param       strm    ObjectOutputStreamオブジェクト
294         * @throws IOException  入出力エラーが発生した場合
295         */
296        private void writeObject( final ObjectOutputStream strm ) throws IOException {
297                strm.defaultWriteObject();
298        }
299
300        /**
301         * シリアライズ用のカスタムシリアライズ読み込みメソッド
302         *
303         * ここでは、transient 宣言された内部変数の内、初期化が必要なフィールドのみ設定します。
304         *
305         * @og.rev 4.0.0.0 (2006/09/31) 新規追加
306         * @serialData 一部のオブジェクトは、シリアライズされません。
307         *
308         * @param       strm    ObjectInputStreamオブジェクト
309         * @see #release2()
310         * @throws IOException  シリアライズに関する入出力エラーが発生した場合
311         * @throws ClassNotFoundException       クラスを見つけることができなかった場合
312         */
313        private void readObject( final ObjectInputStream strm ) throws IOException , ClassNotFoundException {
314                strm.defaultReadObject();
315        }
316
317        /**
318         * このオブジェクトの文字列表現を返します。
319         * 基本的にデバッグ目的に使用します。
320         *
321         * @return このクラスの文字列表現
322         */
323        @Override
324        public String toString() {
325                return org.opengion.fukurou.util.ToString.title( this.getClass().getName() )
326                                .println( "VERSION"             ,VERSION        )
327                                .println( "roles"               ,roles  )
328                                .fixForm().toString()
329                        + HybsSystem.CR
330                        + super.toString() ;
331        }
332}