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        public void init( final String table, final String user, final String gamen ) {
088                if( isUseClm( table ) ) {
089                        final String userID  = "'" + user + "'";
090                        final String gamenID = "'" + gamen + "'";
091                        final String timestamp = "'" + DateSet.getDate( "yyyyMMddHHmmss" ) + "'" ;              // 6.4.2.0 (2016/01/29)
092
093                        insKeys = MSTR_INSKEYS;
094                        insVals = new String[] {
095                                                         timestamp              // DYSET
096                                                        ,gamenID                // PGSET
097                                                        ,gamenID                // PGPSET
098                                                        ,userID                 // USRSET
099                                                        ,timestamp              // DYUPD
100                                                        ,gamenID                // PGUPD
101                                                        ,gamenID                // PGPUPD
102                                                        ,userID                 // USRUPD
103                        };
104
105                        updKeys = MSTR_UPDKEYS;
106                        updVals = new String[] {
107                                                         timestamp              // DYUPD
108                                                        ,gamenID                // PGUPD
109                                                        ,gamenID                // PGPUPD
110                                                        ,userID                 // USRUPD
111                        };
112                }
113        }
114
115        /**
116         * インサートする場合のキー配列を返します。
117         *
118         * 指定の値がなければ、長さゼロ配列を返します。
119         *
120         * @return      インサートする場合のキー配列(非null)
121         * @og.rtnNotNull
122         */
123        public String[] getInsertKeys() {
124                return insKeys.clone();
125        }
126
127        /**
128         * インサートする場合の値配列を返します。
129         *
130         * 指定の値がなければ、長さゼロ配列を返します。
131         *
132         * @return      インサートする場合のキー配列(非null)
133         * @og.rtnNotNull
134         */
135        public String[] getInsertVals() {
136                return insVals.clone();
137        }
138
139        /**
140         * アップデートする場合のキー配列を返します。
141         *
142         * 指定の値がなければ、長さゼロ配列を返します。
143         *
144         * @return      アップデートする場合のキー配列(非null)
145         * @og.rtnNotNull
146         */
147        public String[] getUpdateKeys() {
148                return updKeys.clone();
149        }
150
151        /**
152         * アップデートする場合の値配列を返します。
153         *
154         * 指定の値がなければ、長さゼロ配列を返します。
155         *
156         * @return      アップデートする場合のキー配列(非null)
157         * @og.rtnNotNull
158         */
159        public String[] getUpdateVals() {
160                return updVals.clone();
161        }
162
163        /**
164         * デリート(論理削除) する場合のキー配列を返します。
165         *
166         * 指定の値がなければ、長さゼロ配列を返します。
167         *
168         * @og.rev 6.3.9.0 (2015/11/06) Returning 'ZERO' may expose an internal array.(PMD)
169         *
170         * @return      デリートする場合のキー配列(非null)
171         * @og.rtnNotNull
172         */
173        public String[] getLogicalDeleteKeys() {
174                return ZERO.clone();            // 6.3.9.0 (2015/11/06) Returning 'ZERO' may expose an internal array.(PMD)
175        }
176
177        /**
178         * デリート(論理削除) する場合の値配列を返します。
179         *
180         * 指定の値がなければ、長さゼロ配列を返します。
181         *
182         * @og.rev 6.3.9.0 (2015/11/06) Returning 'ZERO' may expose an internal array.(PMD)
183         *
184         * @return      デリートする場合のキー配列(非null)
185         * @og.rtnNotNull
186         */
187        public String[] getLogicalDeleteVals() {
188                return ZERO.clone();            // 6.3.9.0 (2015/11/06) Returning 'ZERO' may expose an internal array.(PMD)
189        }
190
191        /**
192         * カラムを返すかどうかを決めるロジック
193         *
194         * テーブル名が存在していれば、利用可能と判断します。
195         * これは、履歴テーブルなど、この処理を使わない場合に、
196         * テーブル名から判定する場合に使います。現時点では、履歴テーブルは
197         * フレームワーク側で変更するのではなく、トリガ等による自動収集と
198         * しますので、判定対象としていません。
199         *
200         * @param       table   テーブル名
201         *
202         * @return      カラムを返すかどうか(true:カラムを生成/false:カラムは生成しない)
203         */
204        private boolean isUseClm( final String table ) {
205                final boolean flag = table != null && table.length() > 0 ;
206
207                return flag ;
208        }
209}