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.fukurou.db;
017
018import java.util.Locale;
019import java.util.Arrays;                                        // 6.3.9.1 (2015/11/27)
020import org.opengion.fukurou.system.OgRuntimeException ;         // 6.4.2.0 (2016/01/29)
021
022/**
023 * 各データベースに対応するenum名を返します。
024 * 主に、各データベースにおける関数名の差異を吸収するためのenumです。
025 * 本来は、互換性のあるファンクション以外、使用しないようにしましょう。
026 * また、無ければ互換性パックなどで、ファンクションを定義してしまうのも
027 * 一つの方法です。
028 *
029 * <table border="1" frame="box" rules="all" >
030 *  <caption>各データベースにおける関数</caption>
031 *  <tr><th>データベース名 </th><th>連結</th><th>部分文字列</th><th>日付関数         </th></tr>
032 *  <tr><td>{&#064;DBF.XXX}</td><td>CON </td><td>SUBSTR    </td><td>SYSDATE          </td></tr>
033 *  <tr><td>ORACLE         </td><td>||  </td><td>SUBSTR    </td><td>SYSDATE          </td></tr>
034 *  <tr><td>HSQL           </td><td>||  </td><td>SUBSTR    </td><td>CURRENT_TIMESTAMP</td></tr>
035 *  <tr><td>POSTGRES       </td><td>||  </td><td>SUBSTR    </td><td>CURRENT_DATE     </td></tr>
036 *  <tr><td>MYSQL          </td><td>||  </td><td>SUBSTR    </td><td>now()            </td></tr>
037 *  <tr><td>SQLSERVER      </td><td>+   </td><td>SUBSTRING </td><td>GETDATE()        </td></tr>
038 *  <tr><td>FIREBIRD       </td><td>||  </td><td>SUBSTR    </td><td>CURRENT_DATE     </td></tr>
039 *  <tr><td>DERBY          </td><td>||  </td><td>SUBSTR    </td><td>CURRENT_TIMESTAMP</td></tr>
040 *  <tr><td>CACHE          </td><td>||  </td><td>SUBSTRING </td><td>SYSDATE          </td></tr>
041 *  <tr><td>H2             </td><td>||  </td><td>SUBSTR    </td><td>SYSDATE          </td></tr>
042 *  <tr><td>OTHER          </td><td>||  </td><td>SUBSTR    </td><td>SYSDATE          </td></tr>
043 * </table>
044 *
045 * ※ MySQLでは、通常文字列連結は、CONCAT関数を使います。パイプ(||)で結合するには、
046 * SET sql_mode='PIPES_AS_CONCAT' しておく必要があります。
047 * JDBCで設定する場合は、jdbc:mysql://《サーバー》/《DB名》?sessionVariables=sql_mode='PIPES_AS_CONCAT'
048 * と指定します。
049 *
050 * @og.rev 5.1.4.0 (2010/03/01) 新規作成
051 * @og.rev 5.8.5.0 (2015/03/06) CACHE追加
052 *
053 * @version  5.0
054 * @author   Kazuhiko Hasegawa
055 * @since    JDK5.0,
056 */
057public enum DBFunctionName {
058        // 引数付きenum定義:ここに、必要な関数が増えるたびに、追加していきます。
059        // 6.2.2.1 (2015/03/31) SYSDATE 項目追加
060        //                        CON   SUBSTR            SYSDATE
061          ORACLE        ( "||" , "SUBSTR"               , "SYSDATE" )
062        , HSQL          ( "||" , "SUBSTR"               , "CURRENT_TIMESTAMP" )         // 良く判らん
063        , POSTGRES      ( "||" , "SUBSTR"               , "CURRENT_DATE" )
064        , MYSQL         ( "||" , "SUBSTR"               , "now()" )                                     // SYSDATE() でもほとんど同じ
065        , SQLSERVER     ( "+"  , "SUBSTRING"    , "GETDATE()" )
066        , FIREBIRD      ( "||" , "SUBSTR"               , "CURRENT_DATE" )
067        , DERBY         ( "||" , "SUBSTR"               , "CURRENT_TIMESTAMP" )         // 6.4.9.3 (2016/08/26)
068        , CACHE         ( "||" , "SUBSTRING"    , "SYSDATE" )                           // 良く判らん
069        , H2            ( "||" , "SUBSTR"               , "SYSDATE" )                           // 6.8.3.0 (2017/11/27) 追加
070        , OTHER         ( "||" , "SUBSTR"               , "SYSDATE" ) ;                         // 6.4.5.0 (2016/04/08) 適当
071
072        private final String dbfCON ;
073        private final String dbfSUBSTR ;
074        private final String dbfSYSDATE ;                                                       // 6.2.2.1 (2015/03/31) SYSDATE 項目追加
075
076        /**
077         * コンストラクター(enum の場合は、private宣言される)
078         *
079         * @og.rev 5.1.4.0 (2010/03/01) 新規作成
080         * @og.rev 6.2.2.1 (2015/03/31) SYSDATE 項目追加
081         *
082         * @param       con     第1引数にて指定(CON)
083         * @param       substr  第2引数にて指定(SUBSTR)
084         * @param       sysdt   第3引数にて指定(SYSDATE)
085         */
086        private DBFunctionName( final String con , final String substr , final String sysdt ) {
087                dbfCON    = con;
088                dbfSUBSTR = substr;
089                dbfSYSDATE= sysdt;
090        }
091
092        /**
093         * 共通ファンクションに対応するデータベース個別のファンクション名を返します。
094         *
095         * 現時点では、NAME,CON,SUBSTR のみ使用できます。
096         *
097         * @og.rev 5.1.4.0 (2010/03/01) 新規作成
098         * @og.rev 6.2.2.1 (2015/03/31) SYSDATE 項目追加
099         * @og.rev 6.3.9.1 (2015/11/27) メソッドの出口は、最後の1か所にすべきです(PMD)。
100         * @og.rev 5.9.19.1 (2017/04/14) DBF.TYPE追加
101         *
102         * @param   func 共通ファンクション
103         *
104         * @return  ファンクション名
105         */
106        public String getFunctionName( final String func ) {
107
108                final String rtn ;
109                if(      "NAME"   .equalsIgnoreCase( func ) ) { rtn = toString();       }               // この、enum の NAME
110                else if( "CON"    .equalsIgnoreCase( func ) ) { rtn = dbfCON;           }
111                else if( "SUBSTR" .equalsIgnoreCase( func ) ) { rtn = dbfSUBSTR;        }
112                else if( "SYSDATE".equalsIgnoreCase( func ) ) { rtn = dbfSYSDATE;       }
113                else if( "TYPE"   .equalsIgnoreCase( func ) ) { rtn = toString().toLowerCase( Locale.JAPAN );   }               // 5.9.19.1 (2017/04/14)
114                else {                                                                                  rtn = func;                     }
115
116                return rtn ;
117        }
118
119        /**
120         * 各データベースに対応するファンクション名を返します。
121         *
122         * @og.rev 4.3.8.0 (2009/08/01) SUBSTRを追加
123         * @og.rev 5.1.2.0 (2010/01/01) MySQL対応,SUBSTRB廃止(帳票データの分割の内部処理化に伴う)
124         * @og.rev 5.1.4.0 (2010/03/01) データベース名 ではなく、dbid で判断するように変更
125         * @og.rev 5.7.7.2 (2014/06/20) DBF.NAME 時の処理の簡素化
126         * @og.rev 6.2.1.0 (2015/03/13) NAME だけ特殊処理するのではなく、統一する。
127         *
128         * @param   func ファンクション名(定義文字)
129         * @param   dbid 接続先ID
130         *
131         * @return  実ファンクション名
132         */
133        public static String getFunctionName( final String func ,final String dbid ) {
134
135                // 5.7.7.2 (2014/06/20) DBF.NAME 時の処理の簡素化
136                final String dbName = ConnectionFactory.getDBName( dbid );
137        // 6.2.1.0 (2015/03/13) NAME だけ特殊処理するのではなく、統一する。
138        //      if( "NAME".equals( func ) ) { return dbName; }
139        //      else {
140                        return getDBName( dbName ).getFunctionName( func );
141        //      }
142        }
143
144        /**
145         * シーケンス名よりシーケンスオブジェクトを検索し、次の値を取り出します。
146         * DBに対するシーケンスオブジェクトは予め作成されている必要があります。
147         *
148         * また、MySQLの場合は、シーケンスオブジェクトが実装されていないため、
149         * 内部的には、引数のシーケンス名と同じ名前のテーブルから、Integer型の
150         * "SEQID"という項目名を検索することにより、シーケンスをエミュレートしています。
151         *
152         * @og.rev 5.1.9.0 (2010/08/01) 新規追加
153         * @og.rev 5.8.5.0 (2015/03/06) CACHE追加
154         * @og.rev 5.9.31.1 (2018/04/13) DBID追加対応
155         *
156         * @param seqName シーケンス名
157         * @param tran トランザクション
158         *
159         * @return シーケンス番号
160         */
161        public int getSequence( final String seqName, final Transaction tran ) {
162                return getSequence( seqName, tran, null );
163        }
164
165        /**
166         * シーケンス名よりシーケンスオブジェクトを検索し、次の値を取り出します。
167         * DBに対するシーケンスオブジェクトは予め作成されている必要があります。
168         *
169         * また、MySQLの場合は、シーケンスオブジェクトが実装されていないため、
170         * 内部的には、引数のシーケンス名と同じ名前のテーブルから、Integer型の
171         * "SEQID"という項目名を検索することにより、シーケンスをエミュレートしています。
172         *
173         * @og.rev 5.1.9.0 (2010/08/01) 新規追加
174         * @og.rev 5.8.5.0 (2015/03/06) CACHE追加
175         * @og.rev 6.4.9.3 (2016/08/26) JavaDB(APACHE DERBY) の追加
176         * @og.rev 5.9.31.1 (2018/04/13) DBID追加対応
177         * @og.rev 6.9.8.0 (2018/05/28) DBID 対応漏れ,arg引数がないことを明確にするため、nullを渡します。
178         *
179         * @param seqName シーケンス名
180         * @param tran トランザクション
181         * @param DBID DBID
182         *
183         * @return シーケンス番号
184         */
185//      public int getSequence( final String seqName, final Transaction tran ) {
186        public int getSequence( final String seqName, final Transaction tran, final String DBID ) {
187                String sql = null;
188                // 6.0.2.5 (2014/10/31) refactoring:無効な代入です。
189                switch ( this ) {
190                        case ORACLE:
191                                sql = "select " + seqName + ".nextval from dual";
192                                break;
193                        case HSQL:
194                                sql = "select next value for " + seqName + " from dual";
195                                break;
196                        case POSTGRES:
197                                sql = "select nextval('" + seqName + "')";
198                                break;
199                        case MYSQL:
200                                sql = "update " + seqName + " set SEQID = last_insert_id(SEQID+1)";
201//                              DBUtil.dbExecute( sql, new String[0], tran );
202                                DBUtil.dbExecute( sql, null, tran, DBID );              // 6.9.8.0 (2018/05/28) DBID 対応漏れ
203                                sql = "select last_insert_id()";
204                                break;
205                        case SQLSERVER:
206                                throw new OgRuntimeException( "現在、SQLSERVERではシーケンス機能はサポートされていません。" );
207                        case FIREBIRD:
208                                sql = "select gen_id(" + seqName + ", 1) from rdb$database";
209                                break;
210                        // 6.4.9.3 (2016/08/26)
211                        case DERBY:
212                                throw new OgRuntimeException( "現在、DERBYではシーケンス機能はサポートされていません。" );
213                        // 5.8.5.0 (2015/03/06) CACHE追加
214                        case CACHE:
215                                throw new OgRuntimeException( "現在、CACHEではシーケンス機能はサポートされていません。" );
216                        default:
217                                throw new OgRuntimeException( "現在、このデータベースではシーケンス機能はサポートされていません。" );
218                }
219
220                // 6.0.2.5 (2014/10/31) refactoring:無効な代入です。
221//              final String[][] rtn = DBUtil.dbExecute( sql, new String[0], tran );
222//              final String[][] rtn = DBUtil.dbExecute( sql, new String[0], tran, DBID );              // 5.9.31.1 (2018/04/13) DBID追加対応
223                final String[][] rtn = DBUtil.dbExecute( sql, null, tran, DBID );                               // 6.9.8.0 (2018/05/28)
224
225                return Integer.parseInt( rtn[0][0] );           // 6.0.2.4 (2014/10/17) メソッド間違い
226        }
227
228        /**
229         * 各データベースに対応するenum名を返します。
230         *
231         * @og.rev 5.1.4.0 (2010/03/01) 新規作成
232         * @og.rev 5.8.5.0 (2015/03/06) CACHE追加
233         * @og.rev 6.3.9.1 (2015/11/27) メソッドの出口は、最後の1か所にすべきです(PMD)。
234         * @og.rev 6.4.5.0 (2016/04/08) 規定以外のデータベースでも、動作するように、OTHER を用意する。
235         * @og.rev 6.4.9.3 (2016/08/26) JavaDB(APACHE DERBY) の追加
236         * @og.rev 6.8.3.0 (2017/11/27) H2 の追加
237         *
238         * @param   dbName データベース名(null不可)
239         *
240         * @return  データベースに対応するenum名
241         * @og.rtnNotNull
242         */
243        public static DBFunctionName getDBName( final String dbName ) {
244                final String dbn = dbName.toUpperCase( Locale.JAPAN );
245
246                final DBFunctionName rtn ;
247                if(      dbn.contains( "ORACLE"         ) ) { rtn = DBFunctionName.ORACLE;              }
248                else if( dbn.contains( "HSQL"           ) ) { rtn = DBFunctionName.HSQL;                }
249                else if( dbn.contains( "POSTGRES"       ) ) { rtn = DBFunctionName.POSTGRES;    }
250                else if( dbn.contains( "MYSQL"          ) ) { rtn = DBFunctionName.MYSQL;               }
251                else if( dbn.contains( "SQLSERVER"      ) ) { rtn = DBFunctionName.SQLSERVER;   }
252                else if( dbn.contains( "FIREBIRD"       ) ) { rtn = DBFunctionName.FIREBIRD;    }
253                else if( dbn.contains( "DERBY"          ) ) { rtn = DBFunctionName.DERBY;               }       // 6.4.9.3 (2016/08/26)
254                else if( dbn.contains( "CACHE"          ) ) { rtn = DBFunctionName.CACHE;               }       // 5.8.5.0 (2015/03/06)
255                else if( dbn.contains( "H2"                     ) ) { rtn = DBFunctionName.H2;                  }       // 5.8.5.0 (2015/03/06)
256                else {
257                        rtn = DBFunctionName.OTHER;                     // 6.4.5.0 (2016/04/08)
258                        final String errMsg = "初期化時に、指定の dbName キーが存在しません。"
259                                                        + "[" + dbName + "] キーは、" + Arrays.toString( DBFunctionName.values() ) ;
260                        System.out.println( errMsg );
261                }
262
263                return rtn;
264        }
265}