    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 class="plain">
    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     第１引数にて指定(CON)
    083         * @param       substr  第２引数にて指定(SUBSTR)
    084         * @param       sysdt   第３引数にて指定(SYSDATE)
    085         */
    086        DBFunctionName( final String con , final String substr , final String sysdt ) {
    087//      private DBFunctionName( final String con , final String substr , final String sysdt ) {
    088                dbfCON    = con;
    089                dbfSUBSTR = substr;
    090                dbfSYSDATE= sysdt;
    091        }
    092
    093        /**
    094         * 共通ファンクションに対応するデータベース個別のファンクション名を返します。
    095         *
    096         * 現時点では、NAME,CON,SUBSTR のみ使用できます。
    097         *
    098         * @og.rev 5.1.4.0 (2010/03/01) 新規作成
    099         * @og.rev 6.2.2.1 (2015/03/31) SYSDATE 項目追加
    100         * @og.rev 6.3.9.1 (2015/11/27) メソッドの出口は、最後の１か所にすべきです(PMD)。
    101         * @og.rev 5.9.19.1 (2017/04/14) DBF.TYPE追加
    102         *
    103         * @param   func 共通ファンクション
    104         *
    105         * @return  ファンクション名
    106         */
    107        public String getFunctionName( final String func ) {
    108
    109                final String rtn ;
    110                if(      "NAME"   .equalsIgnoreCase( func ) ) { rtn = toString();       }               // この、enum の NAME
    111                else if( "CON"    .equalsIgnoreCase( func ) ) { rtn = dbfCON;           }
    112                else if( "SUBSTR" .equalsIgnoreCase( func ) ) { rtn = dbfSUBSTR;        }
    113                else if( "SYSDATE".equalsIgnoreCase( func ) ) { rtn = dbfSYSDATE;       }
    114                else if( "TYPE"   .equalsIgnoreCase( func ) ) { rtn = toString().toLowerCase( Locale.JAPAN );   }               // 5.9.19.1 (2017/04/14)
    115                else {                                                                                  rtn = func;                     }
    116
    117                return rtn ;
    118        }
    119
    120        /**
    121         * 各データベースに対応するファンクション名を返します。
    122         *
    123         * @og.rev 4.3.8.0 (2009/08/01) SUBSTRを追加
    124         * @og.rev 5.1.2.0 (2010/01/01) MySQL対応,SUBSTRB廃止(帳票データの分割の内部処理化に伴う)
    125         * @og.rev 5.1.4.0 (2010/03/01) データベース名 ではなく、dbid で判断するように変更
    126         * @og.rev 5.7.7.2 (2014/06/20) DBF.NAME 時の処理の簡素化
    127         * @og.rev 6.2.1.0 (2015/03/13) NAME だけ特殊処理するのではなく、統一する。
    128         *
    129         * @param   func ファンクション名(定義文字)
    130         * @param   dbid 接続先ID
    131         *
    132         * @return  実ファンクション名
    133         */
    134        public static String getFunctionName( final String func ,final String dbid ) {
    135
    136                // 5.7.7.2 (2014/06/20) DBF.NAME 時の処理の簡素化
    137                final String dbName = ConnectionFactory.getDBName( dbid );
    138        // 6.2.1.0 (2015/03/13) NAME だけ特殊処理するのではなく、統一する。
    139        //      if( "NAME".equals( func ) ) { return dbName; }
    140        //      else {
    141                        return getDBName( dbName ).getFunctionName( func );
    142        //      }
    143        }
    144
    145        /**
    146         * シーケンス名よりシーケンスオブジェクトを検索し、次の値を取り出します。
    147         * DBに対するシーケンスオブジェクトは予め作成されている必要があります。
    148         *
    149         * また、MySQLの場合は、シーケンスオブジェクトが実装されていないため、
    150         * 内部的には、引数のシーケンス名と同じ名前のテーブルから、Integer型の
    151         * "SEQID"という項目名を検索することにより、シーケンスをエミュレートしています。
    152         *
    153         * @og.rev 5.1.9.0 (2010/08/01) 新規追加
    154         * @og.rev 5.8.5.0 (2015/03/06) CACHE追加
    155         * @og.rev 5.9.31.1 (2018/04/13) DBID追加対応
    156         *
    157         * @param seqName シーケンス名
    158         * @param tran トランザクション
    159         *
    160         * @return シーケンス番号
    161         */
    162        public int getSequence( final String seqName, final Transaction tran ) {
    163                return getSequence( seqName, tran, null );
    164        }
    165
    166        /**
    167         * シーケンス名よりシーケンスオブジェクトを検索し、次の値を取り出します。
    168         * DBに対するシーケンスオブジェクトは予め作成されている必要があります。
    169         *
    170         * また、MySQLの場合は、シーケンスオブジェクトが実装されていないため、
    171         * 内部的には、引数のシーケンス名と同じ名前のテーブルから、Integer型の
    172         * "SEQID"という項目名を検索することにより、シーケンスをエミュレートしています。
    173         *
    174         * @og.rev 5.1.9.0 (2010/08/01) 新規追加
    175         * @og.rev 5.8.5.0 (2015/03/06) CACHE追加
    176         * @og.rev 6.4.9.3 (2016/08/26) JavaDB(APACHE DERBY) の追加
    177         * @og.rev 5.9.31.1 (2018/04/13) DBID追加対応
    178         * @og.rev 6.9.8.0 (2018/05/28) DBID 対応漏れ,arg引数がないことを明確にするため、nullを渡します。
    179         *
    180         * @param seqName シーケンス名
    181         * @param tran トランザクション
    182         * @param DBID DBID
    183         *
    184         * @return シーケンス番号
    185         */
    186//      public int getSequence( final String seqName, final Transaction tran ) {
    187        public int getSequence( final String seqName, final Transaction tran, final String DBID ) {
    188                String sql = null;
    189                // 6.0.2.5 (2014/10/31) refactoring:無効な代入です。
    190                switch ( this ) {
    191                        case ORACLE:
    192                                sql = "select " + seqName + ".nextval from dual";
    193                                break;
    194                        case HSQL:
    195                                sql = "select next value for " + seqName + " from dual";
    196                                break;
    197                        case POSTGRES:
    198                                sql = "select nextval('" + seqName + "')";
    199                                break;
    200                        case MYSQL:
    201                                sql = "update " + seqName + " set SEQID = last_insert_id(SEQID+1)";
    202//                              DBUtil.dbExecute( sql, new String[0], tran );
    203                                DBUtil.dbExecute( sql, null, tran, DBID );              // 6.9.8.0 (2018/05/28) DBID 対応漏れ
    204                                sql = "select last_insert_id()";
    205                                break;
    206                        case SQLSERVER:
    207                                throw new OgRuntimeException( "現在、SQLSERVERではシーケンス機能はサポートされていません。" );
    208                        case FIREBIRD:
    209                                sql = "select gen_id(" + seqName + ", 1) from rdb$database";
    210                                break;
    211                        // 6.4.9.3 (2016/08/26)
    212                        case DERBY:
    213                                throw new OgRuntimeException( "現在、DERBYではシーケンス機能はサポートされていません。" );
    214                        // 5.8.5.0 (2015/03/06) CACHE追加
    215                        case CACHE:
    216                                throw new OgRuntimeException( "現在、CACHEではシーケンス機能はサポートされていません。" );
    217                        default:
    218                                throw new OgRuntimeException( "現在、このデータベースではシーケンス機能はサポートされていません。" );
    219                }
    220
    221                // 6.0.2.5 (2014/10/31) refactoring:無効な代入です。
    222//              final String[][] rtn = DBUtil.dbExecute( sql, new String[0], tran );
    223//              final String[][] rtn = DBUtil.dbExecute( sql, new String[0], tran, DBID );              // 5.9.31.1 (2018/04/13) DBID追加対応
    224                final String[][] rtn = DBUtil.dbExecute( sql, null, tran, DBID );                               // 6.9.8.0 (2018/05/28)
    225
    226                return Integer.parseInt( rtn[0][0] );           // 6.0.2.4 (2014/10/17) メソッド間違い
    227        }
    228
    229        /**
    230         * 各データベースに対応するenum名を返します。
    231         *
    232         * @og.rev 5.1.4.0 (2010/03/01) 新規作成
    233         * @og.rev 5.8.5.0 (2015/03/06) CACHE追加
    234         * @og.rev 6.3.9.1 (2015/11/27) メソッドの出口は、最後の１か所にすべきです(PMD)。
    235         * @og.rev 6.4.5.0 (2016/04/08) 規定以外のデータベースでも、動作するように、OTHER を用意する。
    236         * @og.rev 6.4.9.3 (2016/08/26) JavaDB(APACHE DERBY) の追加
    237         * @og.rev 6.8.3.0 (2017/11/27) H2 の追加
    238         *
    239         * @param   dbName データベース名(null不可)
    240         *
    241         * @return  データベースに対応するenum名
    242         * @og.rtnNotNull
    243         */
    244        public static DBFunctionName getDBName( final String dbName ) {
    245                final String dbn = dbName.toUpperCase( Locale.JAPAN );
    246
    247                final DBFunctionName rtn ;
    248                if(      dbn.contains( "ORACLE"         ) ) { rtn = DBFunctionName.ORACLE;              }
    249                else if( dbn.contains( "HSQL"           ) ) { rtn = DBFunctionName.HSQL;                }
    250                else if( dbn.contains( "POSTGRES"       ) ) { rtn = DBFunctionName.POSTGRES;    }
    251                else if( dbn.contains( "MYSQL"          ) ) { rtn = DBFunctionName.MYSQL;               }
    252                else if( dbn.contains( "SQLSERVER"      ) ) { rtn = DBFunctionName.SQLSERVER;   }
    253                else if( dbn.contains( "FIREBIRD"       ) ) { rtn = DBFunctionName.FIREBIRD;    }
    254                else if( dbn.contains( "DERBY"          ) ) { rtn = DBFunctionName.DERBY;               }       // 6.4.9.3 (2016/08/26)
    255                else if( dbn.contains( "CACHE"          ) ) { rtn = DBFunctionName.CACHE;               }       // 5.8.5.0 (2015/03/06)
    256                else if( dbn.contains( "H2"                     ) ) { rtn = DBFunctionName.H2;                  }       // 5.8.5.0 (2015/03/06)
    257                else {
    258                        rtn = DBFunctionName.OTHER;                     // 6.4.5.0 (2016/04/08)
    259                        final String errMsg = "初期化時に、指定の dbName キーが存在しません。"
    260                                                        + "[" + dbName + "] キーは、" + Arrays.toString( DBFunctionName.values() ) ;
    261                        System.out.println( errMsg );
    262                }
    263
    264                return rtn;
    265        }
    266}