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.plugin.query;
017
018import org.opengion.fukurou.system.DateSet;                                             // 6.4.2.0 (2016/01/29)
019import org.opengion.hayabusa.db.DBConstValue;
020
021/**
022 * データベース登録時に、固定値カラムの設定を行う情報を管理するクラスです。
023 * このクラスは、GrowingMIS Ver6用の管理クラスです。
024 * 具体的には、
025 *     作成日時    DYSET
026 *     作成PG    PGSET
027 *     作成親PG  PGPSET
028 *     作成社員    USRSET
029 *     更新日時    DYUPD
030 *     更新PG    PGUPD
031 *     更新親PG  PGPUPD
032 *     更新社員    USRUPD
033 * などの情報を、INSERT、UPDATE の状況に応じて提供します。
034 * INSERT には、すべての情報(XXUPD)にも値をセットします。
035 * これは、UPDATE された日付や時刻で、一覧検索できるようにする為で、
036 * null にしておくと、IS NULL で問い合わせる必要があります。
037 * INSERT データだけ取出す場合は、WHERE DYSET = DYUPD とします。
038 * また、 物理SEQは、SEQxxxx(xxxxはテーブル名)形式のカラム名とし、
039 * 値は、SEQxxxxS01.NEXTVAL とします。
040 *
041 * コンストラクターでは、テーブル名、ユーザーID,画面ID を受け取ります。
042 * 登録時刻は、このオブジェクトが生成された時間を通常は使用します。
043 * テーブル名を渡すのは、ワークなど、テーブル単位に処理するカラムが
044 * 異なるので、それへの対応です。
045 * 処理が簡素化できるように、ルールを規定すべきです。
046 *
047 * @og.rev 5.5.1.8 (2012/04/17) 新規追加
048 * @og.rev 6.9.9.0 (2018/08/20) GJ → NOFGJ に変更
049 * @og.group データ登録
050 *
051 * @version  5.5
052 * @author   Kazuhiko Hasegawa
053 * @since    JDK7.0,
054 */
055public class DBConstValue_NOFGJ implements DBConstValue {
056        /** このプログラムのVERSION文字列を設定します。   {@value} */
057        private static final String VERSION = "6.9.9.0 (2018/08/20)" ;
058
059        private static final String[] MSTR_INSKEYS = { "DYSET","PGSET","PGPSET","USRSET","DYUPD","PGUPD","PGPUPD","USRUPD" };
060
061        private static final String[] MSTR_UPDKEYS = { "DYUPD","PGUPD","PGPUPD","USRUPD" };
062
063        private static final String[] ZERO = new String[0] ;
064
065        private String[] insKeys = ZERO;
066        private String[] insVals = ZERO;
067
068        private String[] updKeys = ZERO;
069        private String[] updVals = ZERO;
070
071        /**
072         * デフォルトコンストラクター
073         *
074         * @og.rev 6.4.2.0 (2016/01/29) PMD refactoring. Each class should declare at least one constructor.
075         */
076        public DBConstValue_NOFGJ() { super(); }                // これも、自動的に呼ばれるが、空のメソッドを作成すると警告されるので、明示的にしておきます。
077
078        /**
079         * 初期化情報を設定します。
080         *
081         * @og.rev 6.4.2.0 (2016/01/29) DateSet.getDate( String ) を利用するように修正します。
082         *
083         * @param       table   テーブル名
084         * @param       user    ユーザーID
085         * @param       gamen   画面ID
086         */
087        @Override       // DBConstValue
088        public void init( final String table, final String user, final String gamen ) {
089                if( isUseClm( table ) ) {
090                        final String userID  = "'" + user + "'";
091                        final String gamenID = "'" + gamen + "'";
092                        final String timestamp = "'" + DateSet.getDate( "yyyyMMddHHmmss" ) + "'" ;              // 6.4.2.0 (2016/01/29)
093
094                        insKeys = MSTR_INSKEYS;
095                        insVals = new String[] {
096                                                         timestamp              // DYSET
097                                                        ,gamenID                // PGSET
098                                                        ,gamenID                // PGPSET
099                                                        ,userID                 // USRSET
100                                                        ,timestamp              // DYUPD
101                                                        ,gamenID                // PGUPD
102                                                        ,gamenID                // PGPUPD
103                                                        ,userID                 // USRUPD
104                        };
105
106                        updKeys = MSTR_UPDKEYS;
107                        updVals = new String[] {
108                                                         timestamp              // DYUPD
109                                                        ,gamenID                // PGUPD
110                                                        ,gamenID                // PGPUPD
111                                                        ,userID                 // USRUPD
112                        };
113                }
114        }
115
116        /**
117         * インサートする場合のキー配列を返します。
118         *
119         * 指定の値がなければ、長さゼロ配列を返します。
120         *
121         * @return      インサートする場合のキー配列(非null)
122         * @og.rtnNotNull
123         */
124        @Override       // DBConstValue
125        public String[] getInsertKeys() {
126                return insKeys.clone();
127        }
128
129        /**
130         * インサートする場合の値配列を返します。
131         *
132         * 指定の値がなければ、長さゼロ配列を返します。
133         *
134         * @return      インサートする場合のキー配列(非null)
135         * @og.rtnNotNull
136         */
137        @Override       // DBConstValue
138        public String[] getInsertVals() {
139                return insVals.clone();
140        }
141
142        /**
143         * アップデートする場合のキー配列を返します。
144         *
145         * 指定の値がなければ、長さゼロ配列を返します。
146         *
147         * @return      アップデートする場合のキー配列(非null)
148         * @og.rtnNotNull
149         */
150        @Override       // DBConstValue
151        public String[] getUpdateKeys() {
152                return updKeys.clone();
153        }
154
155        /**
156         * アップデートする場合の値配列を返します。
157         *
158         * 指定の値がなければ、長さゼロ配列を返します。
159         *
160         * @return      アップデートする場合のキー配列(非null)
161         * @og.rtnNotNull
162         */
163        @Override       // DBConstValue
164        public String[] getUpdateVals() {
165                return updVals.clone();
166        }
167
168        /**
169         * デリート(論理削除) する場合のキー配列を返します。
170         *
171         * 指定の値がなければ、長さゼロ配列を返します。
172         *
173         * @og.rev 6.3.9.0 (2015/11/06) Returning 'ZERO' may expose an internal array.(PMD)
174         *
175         * @return      デリートする場合のキー配列(非null)
176         * @og.rtnNotNull
177         */
178        @Override       // DBConstValue
179        public String[] getLogicalDeleteKeys() {
180                return ZERO.clone();            // 6.3.9.0 (2015/11/06) Returning 'ZERO' may expose an internal array.(PMD)
181        }
182
183        /**
184         * デリート(論理削除) する場合の値配列を返します。
185         *
186         * 指定の値がなければ、長さゼロ配列を返します。
187         *
188         * @og.rev 6.3.9.0 (2015/11/06) Returning 'ZERO' may expose an internal array.(PMD)
189         *
190         * @return      デリートする場合のキー配列(非null)
191         * @og.rtnNotNull
192         */
193        @Override       // DBConstValue
194        public String[] getLogicalDeleteVals() {
195                return ZERO.clone();            // 6.3.9.0 (2015/11/06) Returning 'ZERO' may expose an internal array.(PMD)
196        }
197
198        /**
199         * カラムを返すかどうかを決めるロジック
200         *
201         * テーブル名が存在していれば、利用可能と判断します。
202         * これは、履歴テーブルなど、この処理を使わない場合に、
203         * テーブル名から判定する場合に使います。現時点では、履歴テーブルは
204         * フレームワーク側で変更するのではなく、トリガ等による自動収集と
205         * しますので、判定対象としていません。
206         *
207         * @param       table   テーブル名
208         *
209         * @return      カラムを返すかどうか(true:カラムを生成/false:カラムは生成しない)
210         */
211        private boolean isUseClm( final String table ) {
212                // 7.2.9.5 (2020/11/28) PMD:Consider simply returning the value vs storing it in local variable 'XXXX'
213                return table != null && table.length() > 0 ;
214//              final boolean flag = table != null && table.length() > 0 ;
215
216//              return flag ;
217        }
218}