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;
019
020/**
021 * 各データベースに対応するenum名を返します。
022 * 主に、各データベースにおける関数名の差異を吸収するためのenumです。
023 * 本来は、互換性のあるファンクション以外、使用しないようにしましょう。
024 * また、無ければ互換性パックなどで、ファンクションを定義してしまうのも
025 * 一つの方法です。
026 *
027 * <table border="1" frame="box" rules="all" >
028 *  <caption>各データベースにおける関数</caption>
029 *  <tr><th>データベース名 </th><th>連結</th><th>部分文字列</th></tr>
030 *  <tr><td>{&#064;DBF.XXX}</td><td>CON </td><td>SUBSTR    </td></tr>
031 *  <tr><td>ORACLE         </td><td>||  </td><td>SUBSTR    </td></tr>
032 *  <tr><td>HSQL           </td><td>||  </td><td>SUBSTR    </td></tr>
033 *  <tr><td>POSTGRES       </td><td>||  </td><td>SUBSTR    </td></tr>
034 *  <tr><td>MYSQL          </td><td>||  </td><td>SUBSTR    </td></tr>
035 *  <tr><td>SQLSERVER      </td><td>+   </td><td>SUBSTRING </td></tr>
036 *  <tr><td>FIREBIRD       </td><td>||  </td><td>SUBSTR    </td></tr>
037 * </table>
038 *
039 * @og.rev 5.1.4.0 (2010/03/01) 新規作成
040 *
041 * @version  5.0
042 * @author   Kazuhiko Hasegawa
043 * @since    JDK5.0,
044 */
045public enum DBFunctionName {
046        // 引数付きenum定義:ここに、必要な関数が増えるたびに、追加していきます。
047        //                        CON   SUBSTR
048          ORACLE        ( "||","SUBSTR" )
049        , HSQL          ( "||","SUBSTR" )
050        , POSTGRES      ( "||","SUBSTR" )
051        , MYSQL         ( "||","SUBSTR" )
052        , SQLSERVER     ( "+" ,"SUBSTRING" )
053        , FIREBIRD      ( "||","SUBSTR" ) ;
054
055        private final String dbfCON ;
056        private final String dbfSUBSTR ;
057
058        /**
059         * コンストラクター(enum の場合は、private宣言される)
060         *
061         * @og.rev 5.1.4.0 (2010/03/01) 新規作成
062         *
063         * @param       con     第一引数にて指定(CON)
064         * @param       substr  第一引数にて指定(SUBSTR)
065         */
066        private DBFunctionName( final String con , final String substr ) {
067                dbfCON    = con;
068                dbfSUBSTR = substr;
069        }
070
071        /**
072         * 共通ファンクションに対応するデータベース個別のファンクション名を返します。
073         *
074         * 現時点では、NAME,CON,SUBSTR のみ使用できます。
075         *
076         *
077         * @og.rev 5.1.4.0 (2010/03/01) 新規作成
078         *
079         * @param   func 共通ファンクション
080         *
081         * @return  ファンクション名
082         */
083        public String getFunctionName( final String func ) {
084                if( "NAME".equals(   func ) ) { return toString();      }
085                if( "CON".equals(    func ) ) { return dbfCON;          }
086                if( "SUBSTR".equals( func ) ) { return dbfSUBSTR;       }
087
088                return func;
089        }
090
091        /**
092         * シーケンス名よりシーケンスオブジェクトを検索し、次の値を取り出します。
093         * DBに対するシーケンスオブジェクトは予め作成されている必要があります。
094         *
095         * また、MySQLの場合は、シーケンスオブジェクトが実装されていないため、
096         * 内部的には、引数のシーケンス名と同じ名前のテーブルから、Integer型の
097         * "SEQID"という項目名を検索することにより、シーケンスをエミュレートしています。
098         *
099         * @og.rev 5.1.9.0 (2010/08/01) 新規追加
100         *
101         * @param seqName シーケンス名
102         * @param tran トランザクション
103         *
104         * @return シーケンス番号
105         */
106        public int getSequence( final String seqName, final Transaction tran ) {
107                String sql = null;
108                String[][] rtn = null;
109                switch ( this ) {
110                        case ORACLE:
111                                sql = "select " + seqName + ".nextval from dual";
112                                break;
113                        case HSQL:
114                                sql = "select next value for " + seqName + " from dual";
115                                break;
116                        case POSTGRES:
117                                sql = "select nextval('" + seqName + "')";
118                                break;
119                        case MYSQL:
120                                sql = "update " + seqName + " set SEQID = last_insert_id(SEQID+1)";
121                                DBUtil.dbExecute( sql, new String[0], tran );
122                                sql = "select last_insert_id()";
123                                break;
124                        case SQLSERVER:
125                                throw new RuntimeException( "現在、SQLSERVERではシーケンス機能はサポートされていません。" );
126                        case FIREBIRD:
127                                sql = "select gen_id(" + seqName + ", 1) from rdb$database";
128                                break;
129                        default:
130                                throw new RuntimeException( "現在、このデータベースではシーケンス機能はサポートされていません。" );
131                }
132
133                rtn = DBUtil.dbExecute( sql, new String[0], tran );
134                return Integer.valueOf( rtn[0][0] );
135        }
136
137        /**
138         * 各データベースに対応するenum名を返します。
139         *
140         * @og.rev 5.1.4.0 (2010/03/01) 新規作成
141         *
142         * @param   dbName データベース名
143         *
144         * @return  データベースに対応するenum名
145         */
146        public static DBFunctionName getDBName( final String dbName ) {
147                String dbn = dbName.toUpperCase( Locale.JAPAN );
148
149                if(      dbn.indexOf( "ORACLE"          ) >= 0 ) { return DBFunctionName.ORACLE;        }
150                else if( dbn.indexOf( "HSQL"            ) >= 0 ) { return DBFunctionName.HSQL;          }
151                else if( dbn.indexOf( "POSTGRES"        ) >= 0 ) { return DBFunctionName.POSTGRES;      }
152                else if( dbn.indexOf( "MYSQL"           ) >= 0 ) { return DBFunctionName.MYSQL;         }
153                else if( dbn.indexOf( "SQLSERVER"       ) >= 0 ) { return DBFunctionName.SQLSERVER;     }
154                else if( dbn.indexOf( "FIREBIRD"        ) >= 0 ) { return DBFunctionName.FIREBIRD;      }
155
156                final String errMsg = "初期化時に、指定の dbName キーが存在しません。"
157                                                + "[" + dbn + "]" ;
158
159                throw new RuntimeException( errMsg );
160        }
161
162        /**
163         * 各データベースに対応するファンクション名を返します。
164         *
165         * @og.rev 4.3.8.0 (2009/08/01) SUBSTRを追加
166         * @og.rev 5.1.2.0 (2010/01/01) MySQL対応,SUBSTRB廃止(帳票データの分割の内部処理化に伴う)
167         * @og.rev 5.1.4.0 (2010/03/01) データベース名 ではなく、dbid で判断するように変更
168         * @og.rev 5.7.7.2 (2014/06/20) DBF.NAME 時の処理の簡素化
169         *
170         * @param   func ファンクション名(定義文字)
171         * @param   dbid 接続先ID
172         *
173         * @return  実ファンクション名
174         */
175        public static String getFunctionName( final String func ,final String dbid ) {
176//              DBFunctionName dbName = DBFunctionName.getDBName( ConnectionFactory.getDBName( dbid ) );
177
178                // 5.7.7.2 (2014/06/20) DBF.NAME 時の処理の簡素化
179                String dbName = ConnectionFactory.getDBName( dbid );
180                if( "NAME".equals( func ) ) { return dbName; }
181                else {
182                        return getDBName( dbName ).getFunctionName( func );
183                }
184
185//              return dbName.getFunctionName( func );
186        }
187}