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 * このクラスは、MICS系の管理クラスです。
024 * 具体的には、
025 *     削除フラグ     DeleteFlg   0:通常 1:削除
026 *     登録日時     EntryDate
027 *     更新日時     RenewDate
028 * などの情報を、INSERT、UPDATE の状況に応じて提供します。
029 * INSERT には、登録日時、更新日時にも値をセットします。
030 * これは、UPDATE された日付や時刻で、一覧検索できるようにする為で、
031 * null にしておくと、IS NULL で問い合わせる必要があります。
032 * INSERT データだけ取出す場合は、WHERE EntryDate = RenewDate とします。
033 *
034 * コンストラクターでは、テーブル名、ユーザーID,画面ID を受け取ります。
035 * 登録時刻は、このオブジェクトが生成された時間を通常は使用します。
036 * テーブル名を渡すのは、ワークなど、テーブル単位に処理するカラムが
037 * 異なるので、それへの対応です。
038 * 処理が簡素化できるように、ルールを規定すべきです。
039 *
040 * @og.rev 5.6.2.1 (2013/03/08) 新規追加
041 * @og.group データ登録
042 *
043 * @version  4.0
044 * @author   Kazuhiko Hasegawa
045 * @since    JDK5.0,
046 */
047public class DBConstValue_MICS implements DBConstValue {
048        //* このプログラムのVERSION文字列を設定します。   {@value} */
049        private static final String VERSION = "6.4.2.0 (2016/01/29)" ;
050
051        private static final String[] MSTR_INSKEYS =
052                new String[] { "DELETEFLG","ENTRYDATE","RENEWDATE" };
053
054        private static final String[] MSTR_UPDKEYS =
055                new String[] { "RENEWDATE" };
056
057        private static final String[] MSTR_LOGDELKEYS = // 4.3.7.0 (2009/06/01)
058                new String[] { "DELETEFLG","RENEWDATE" };
059
060        private static final String[] ZERO = new String[0] ;
061
062        private String[] insKeys = ZERO;
063        private String[] insVals = ZERO;
064
065        private String[] updKeys = ZERO;
066        private String[] updVals = ZERO;
067
068        private String[] logDelKeys = ZERO; // 4.3.7.0 (2009/06/01)
069        private String[] logDelVals = ZERO; // 4.3.7.0 (2009/06/01)
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_MICS() { super(); }         // これも、自動的に呼ばれるが、空のメソッドを作成すると警告されるので、明示的にしておきます。
077
078        /**
079         * 初期化情報を設定します。
080         *
081         * @param       table   テーブル名
082         * @param       user    ユーザーID
083         * @param       gamen   画面ID
084         */
085        public void init( final String table, final String user, final String gamen ) {
086                init( table, user, gamen, "" );
087        }
088
089        /**
090         * 初期化情報を設定します。
091         *
092         * @og.rev 6.4.2.0 (2016/01/29) DateSet.getDate( String ) を利用するように修正します。
093         *
094         * @param       table   テーブル名
095         * @param       user    ユーザーID
096         * @param       gamen   画面ID
097         * @param       pgamen  親画面ID
098         */
099        public void init( final String table, final String user, final String gamen, final String pgamen ) {
100                if( isUseClm( table ) ) {
101                                                                        // TIMESTAMP型なので '2009-12-22 16:06:32' 形式にする。
102                        final String timestamp = "'" + DateSet.getDate( "yyyy-MM-dd HH:mm:ss" ) + "'" ;         // 6.4.2.0 (2016/01/29)
103
104                        insKeys = MSTR_INSKEYS;
105                        insVals = new String[] {
106                                                         "'0'"                  // DeleteFlg
107                                                        ,timestamp              // EntryDate
108                                                        ,timestamp              // RenewDate
109                        };
110
111                        updKeys = MSTR_UPDKEYS;
112                        updVals = new String[] {
113                                                         timestamp              // RenewDate
114                        };
115
116                        // 4.3.7.0 (2009/06/01)
117                        logDelKeys = MSTR_LOGDELKEYS;
118                        logDelVals = new String[] {
119                                                         "'1'"                  // DeleteFlg
120                                                        ,timestamp              // RenewDate
121                        };
122                }
123        }
124
125        /**
126         * インサートする場合のキー配列を返します。
127         *
128         * 指定の値がなければ、長さゼロ配列を返します。
129         *
130         * @return      インサートする場合の値配列(非null)
131         */
132        public String[] getInsertKeys() {
133                return insKeys.clone();
134        }
135
136        /**
137         * インサートする場合の値配列を返します。
138         *
139         * 指定の値がなければ、長さゼロ配列を返します。
140         *
141         * @return      インサートする場合の値配列(非null)
142         */
143        public String[] getInsertVals() {
144                return insVals.clone();
145        }
146
147        /**
148         *アップデートする場合のキー配列を返します。
149         *
150         * 指定の値がなければ、長さゼロ配列を返します。
151         *
152         * @return      アップデートする場合のキー配列(非null)
153         */
154        public String[] getUpdateKeys() {
155                return updKeys.clone();
156        }
157
158        /**
159         * アップデートする場合の値配列を返します。
160         *
161         * 指定の値がなければ、長さゼロ配列を返します。
162         *
163         * @return      アップデートする場合のキー配列(非null)
164         */
165        public String[] getUpdateVals() {
166                return updVals.clone();
167        }
168
169        /**
170         * デリート(論理削除) する場合のキー配列を返します。
171         *
172         * 指定の値がなければ、長さゼロ配列を返します。
173         *
174         * @return      デリートする場合のキー配列(非null)
175         */
176        public String[] getLogicalDeleteKeys() {
177                return logDelKeys.clone();
178        }
179
180        /**
181         * デリート(論理削除) する場合の値配列を返します。
182         *
183         * 指定の値がなければ、長さゼロ配列を返します。
184         *
185         * @return      デリートする場合のキー配列(非null)
186         */
187        public String[] getLogicalDeleteVals() {
188                return logDelVals.clone();
189        }
190
191        /**
192         * カラムを返すかどうかを決めるロジック
193         *
194         * テーブル名より、ロジック的に導き出します。
195         *
196         * @param       table   テーブル名
197         *
198         * @return      カラムを返すかどうか(true:カラムを生成/false:カラムは生成しない)
199         */
200        private boolean isUseClm( final String table ) {
201                return table != null ;                                                  // 6.4.2.0 (2016/01/29) PMD refactoring.
202        }
203}