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.group データ登録
049 *
050 * @version  5.5
051 * @author   Kazuhiko Hasegawa
052 * @since    JDK7.0,
053 */
054public class DBConstValue_GJ implements DBConstValue {
055        /** このプログラムのVERSION文字列を設定します。   {@value} */
056        private static final String VERSION = "6.4.2.0 (2016/01/29)" ;
057
058        private static final String[] MSTR_INSKEYS = {"DYSET","PGSET","PGPSET","USRSET","DYUPD","PGUPD","PGPUPD","USRUPD" };
059
060        private static final String[] MSTR_UPDKEYS = { "DYUPD","PGUPD","PGPUPD","USRUPD" };
061
062        private static final String[] ZERO = new String[0] ;
063
064        private String[] insKeys = ZERO;
065        private String[] insVals = ZERO;
066
067        private String[] updKeys = ZERO;
068        private String[] updVals = ZERO;
069
070        /**
071         * デフォルトコンストラクター
072         *
073         * @og.rev 6.4.2.0 (2016/01/29) PMD refactoring. Each class should declare at least one constructor.
074         */
075        public DBConstValue_GJ() { super(); }           // これも、自動的に呼ばれるが、空のメソッドを作成すると警告されるので、明示的にしておきます。
076
077        /**
078         * 初期化情報を設定します。
079         *
080         * @og.rev 6.4.2.0 (2016/01/29) DateSet.getDate( String ) を利用するように修正します。
081         *
082         * @param       table   テーブル名
083         * @param       user    ユーザーID
084         * @param       gamen   画面ID
085         */
086        public void init( final String table, final String user, final String gamen ) {
087                if( isUseClm( table ) ) {
088                        final String userID  = "'" + user + "'";
089                        final String gamenID = "'" + gamen + "'";
090                        final String timestamp = "'" + DateSet.getDate( "yyyyMMddHHmmss" ) + "'" ;              // 6.4.2.0 (2016/01/29)
091
092                        insKeys = MSTR_INSKEYS;
093                        insVals = new String[] {
094                                                         timestamp              // DYSET
095                                                        ,gamenID                // PGSET
096                                                        ,gamenID                // PGPSET
097                                                        ,userID                 // USRSET
098                                                        ,timestamp              // DYUPD
099                                                        ,gamenID                // PGUPD
100                                                        ,gamenID                // PGPUPD
101                                                        ,userID                 // USRUPD
102                        };
103
104                        updKeys = MSTR_UPDKEYS;
105                        updVals = new String[] {
106                                                         timestamp              // DYUPD
107                                                        ,gamenID                // PGUPD
108                                                        ,gamenID                // PGPUPD
109                                                        ,userID                 // USRUPD
110                        };
111                }
112        }
113
114        /**
115         * インサートする場合のキー配列を返します。
116         *
117         * 指定の値がなければ、長さゼロ配列を返します。
118         *
119         * @return      インサートする場合のキー配列(非null)
120         * @og.rtnNotNull
121         */
122        public String[] getInsertKeys() {
123                return insKeys.clone();
124        }
125
126        /**
127         * インサートする場合の値配列を返します。
128         *
129         * 指定の値がなければ、長さゼロ配列を返します。
130         *
131         * @return      インサートする場合のキー配列(非null)
132         * @og.rtnNotNull
133         */
134        public String[] getInsertVals() {
135                return insVals.clone();
136        }
137
138        /**
139         * アップデートする場合のキー配列を返します。
140         *
141         * 指定の値がなければ、長さゼロ配列を返します。
142         *
143         * @return      アップデートする場合のキー配列(非null)
144         * @og.rtnNotNull
145         */
146        public String[] getUpdateKeys() {
147                return updKeys.clone();
148        }
149
150        /**
151         * アップデートする場合の値配列を返します。
152         *
153         * 指定の値がなければ、長さゼロ配列を返します。
154         *
155         * @return      アップデートする場合のキー配列(非null)
156         * @og.rtnNotNull
157         */
158        public String[] getUpdateVals() {
159                return updVals.clone();
160        }
161
162        /**
163         * デリート(論理削除) する場合のキー配列を返します。
164         *
165         * 指定の値がなければ、長さゼロ配列を返します。
166         *
167         * @og.rev 6.3.9.0 (2015/11/06) Returning 'ZERO' may expose an internal array.(PMD)
168         *
169         * @return      デリートする場合のキー配列(非null)
170         * @og.rtnNotNull
171         */
172        public String[] getLogicalDeleteKeys() {
173                return ZERO.clone();            // 6.3.9.0 (2015/11/06) Returning 'ZERO' may expose an internal array.(PMD)
174        }
175
176        /**
177         * デリート(論理削除) する場合の値配列を返します。
178         *
179         * 指定の値がなければ、長さゼロ配列を返します。
180         *
181         * @og.rev 6.3.9.0 (2015/11/06) Returning 'ZERO' may expose an internal array.(PMD)
182         *
183         * @return      デリートする場合のキー配列(非null)
184         * @og.rtnNotNull
185         */
186        public String[] getLogicalDeleteVals() {
187                return ZERO.clone();            // 6.3.9.0 (2015/11/06) Returning 'ZERO' may expose an internal array.(PMD)
188        }
189
190        /**
191         * カラムを返すかどうかを決めるロジック
192         *
193         * テーブル名が存在していれば、利用可能と判断します。
194         * これは、履歴テーブルなど、この処理を使わない場合に、
195         * テーブル名から判定する場合に使います。現時点では、履歴テーブルは
196         * フレームワーク側で変更するのではなく、トリガ等による自動収集と
197         * しますので、判定対象としていません。
198         *
199         * @param       table   テーブル名
200         *
201         * @return      カラムを返すかどうか(true:カラムを生成/false:カラムは生成しない)
202         */
203        private boolean isUseClm( final String table ) {
204                final boolean flag = table != null && table.length() > 0 ;
205
206                return flag ;
207        }
208}