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.table;
017
018/**
019 * TableFilter_INDEX_DERBY は、TableUpda インターフェースを継承した、DBTableModel 処理用の
020 * 実装クラスです。とくに、MySQL用のインデックス作成スクリプトを作成します。
021 *
022 * ここでは、テーブル一覧の検索結果より、GF07 のインデックスカラム定義テーブルから
023 * 必要な情報を取得し、テーブル作成スクリプトを作成します。
024 * 出力ファイルは、テーブル名+"I.sql" という命名規則で作成します。
025 * 検索では、(SYSTEM_ID,TBLSYU,TABLE_NAME,TABLE_LABEL,INDEX_NAME,NAME_JA,INDTYPE,TABLESPACE_NAME,INITIAL_EXTENT)
026 * の項目を取得する必要があります。
027 *
028 * @og.rev 6.4.5.0 (2016/04/08) 新規作成
029 * @og.rev 6.8.1.0 (2017/07/14) JAVADB → DERBY に変更
030 *
031 * @version  0.9.0  2000/10/17
032 * @author   Kazuhiko Hasegawa
033 * @since    JDK1.1,
034 */
035public class TableFilter_INDEX_DERBY extends TableFilter_INDEX {
036        /** このプログラムのVERSION文字列を設定します。   {@value} */
037        private static final String VERSION = "7.3.0.0 (2021/01/06)" ;
038
039        /**
040         * デフォルトコンストラクター
041         *
042         * @og.rev 6.4.2.0 (2016/01/29) PMD refactoring. Each class should declare at least one constructor.
043         * @og.rev 6.8.1.0 (2017/07/14) JAVADB → DERBY に変更
044         */
045        public TableFilter_INDEX_DERBY() { super(); }           // これも、自動的に呼ばれるが、空のメソッドを作成すると警告されるので、明示的にしておきます。
046
047        /**
048         * インデックス作成の処理を実行します。
049         *
050         * @og.rev 6.4.0.5 (2016/01/09) AUTO_INCREMENT 使用時は、PRIMARY KEY 制約を、TABLE 側に入れる必要がある。
051         *
052         * @param       clmNo   カラム番号配列
053         * @param       data    1行分のデータ配列
054         * @param   clms        カラム名(CSV形式)
055         *
056         * @return      作成された1行分の文字列
057         * @og.rtnNotNull
058         */
059        @Override
060        protected String makeLineList( final int[] clmNo,final String[] data,final String clms ) {
061                final String idxtype   = data[clmNo[INDTYPE]];
062
063                // 0:プライマリキー で、UNIQ か、UNIQSEQ の場合は、インデックスタイプを、9:未使用 にします。
064                if( "0".equals( idxtype ) && ( "UNIQ".equalsIgnoreCase( clms ) || "UNIQSEQ".equalsIgnoreCase( clms ) ) ) {
065                        data[clmNo[INDTYPE]] = "9" ;    // 未使用
066                }
067
068                return super.makeLineList( clmNo,data,clms );
069        }
070
071        /**
072         * 定義の最後の部分の処理を実行します。
073         *
074         * @og.rev 6.0.2.3 (2014/10/10) EXEC_END_TAG を追加。キャッシュします。
075         * @og.rev 6.4.0.5 (2016/01/09) INDTYPE が 9:未使用 の場合の処理を追加。
076         *
077         * @param       clmNo   カラム番号配列
078         * @param       data    1行分のデータ配列
079         *
080         * @return      定義の最後の部分
081         */
082        @Override
083        protected String makeEndLine( final int[] clmNo,final String[] data ) {
084                return "9".equals( data[clmNo[INDTYPE]] ) ? "" : execEndTag ;
085        }
086
087        /**
088         * インデックス削除の構文を、作成します。
089         *
090         * @og.rev 5.6.9.2 (2013/10/18) 新規作成
091         * @og.rev 6.0.2.3 (2014/10/10) EXEC_END_TAG を追加。キャッシュします。
092         * @og.rev 6.4.4.1 (2016/03/18) StringBuilderの代わりに、OgBuilderを使用する。
093         * @og.rev 6.7.2.0 (2017/01/16) DROP INDEX インデックス名 に変更。プライマリキーは、削除しない。
094         *
095         * @param       clmNo   カラム番号配列
096         * @param       data    1行分のデータ配列
097         *
098         * @return      作成された1行分の文字列
099         * @og.rtnNotNull
100         */
101        @Override
102        protected String makeDropLine( final int[] clmNo,final String[] data ) {
103                // 6.7.2.0 (2017/01/16) プライマリキーは、削除しない。
104                final String idxtype   = data[clmNo[INDTYPE]];
105                if( "1".equals( idxtype ) || "2".equals( idxtype ) ) {                                  // 1:ユニークキー 2:通常のみ。9:未使用 というのがあるので、注意
106                        return super.makeDropLine( clmNo,data );
107                }
108                else {
109                        return "";
110                }
111        }
112
113        /**
114         * インデックスを作成するための文字列を返します。
115         * 通常、カラム名をそのまま返します。
116         *
117         * 7.3.0.0 (2021/01/06)
118         *   seqNoがマイナスの場合は、カラム名に DESC を付けて逆インデックスにします。
119         *
120         * ※ ORACLEの場合、逆インデックスはバグがあったり、正インデックスで自動判断するそうなので、
121         *    基本的には使わない方が良いそうです。
122         *
123         * ※ FIREBERD には、カラムごとの逆インデックスは定義できません。
124         *    エラーチェックは入れていませんので、ご注意ください。
125         *
126         * ※ MySQL は、8.0で採用されています。それ以前のバージョンでは動作しません。
127         * ※ MySQL の 500バイト以上のカラムのインデックス制限が解除されているかどうかは、未調査です。
128         *
129         * @og.rev 7.3.0.0 (2021/01/06) SEQNO がマイナスの場合、カラムに DESC を付ける(逆順カラム)
130         *
131         * @param       clm             カラム名
132         * @param       useLen  カラムのバイト数
133         * @param       seqNo   カラム順(マイナスの場合は、逆順)…DERBY以外には使用しないことにします。
134         *
135         * @return      インデックスカラムの文字列
136         * @see TableFilter_INDEX_MYSQL
137         */
138//      protected String makeIndexClmStr( final String clm, final String useLen ) {
139        protected String makeIndexClmStr( final String clm, final String useLen, final String seqNo ) {
140//              return clm;
141                return seqNo.charAt(0) == '-' ? clm + " DESC" : clm ;
142        }
143}