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
018import org.opengion.fukurou.system.OgBuilder ;                          // 6.4.4.1 (2016/03/18)
019
020/**
021 * TableFilter_INDEX_MYSQL は、TableUpda インターフェースを継承した、DBTableModel 処理用の
022 * 実装クラスです。とくに、MySQL用のインデックス作成スクリプトを作成します。
023 *
024 * ここでは、テーブル一覧の検索結果より、GF07 のインデックスカラム定義テーブルから
025 * 必要な情報を取得し、テーブル作成スクリプトを作成します。
026 * 出力ファイルは、テーブル名+"I.sql" という命名規則で作成します。
027 * 検索では、(SYSTEM_ID,TBLSYU,TABLE_NAME,TABLE_LABEL,INDEX_NAME,NAME_JA,INDTYPE,TABLESPACE_NAME,INITIAL_EXTENT)
028 * の項目を取得する必要があります。
029 *
030 * @og.rev 4.0.0.0 (2005/08/31) 新規作成
031 *
032 * @version  0.9.0  2000/10/17
033 * @author   Kazuhiko Hasegawa
034 * @since    JDK1.1,
035 */
036public class TableFilter_INDEX_MYSQL extends TableFilter_INDEX {
037        /** このプログラムのVERSION文字列を設定します。   {@value} */
038        private static final String VERSION = "7.3.0.0 (2021/01/06)" ;
039
040        /**
041         * デフォルトコンストラクター
042         *
043         * @og.rev 6.4.2.0 (2016/01/29) PMD refactoring. Each class should declare at least one constructor.
044         */
045        public TableFilter_INDEX_MYSQL() { 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         *
094         * @param       clmNo   カラム番号配列
095         * @param       data    1行分のデータ配列
096         *
097         * @return      作成された1行分の文字列
098         * @og.rtnNotNull
099         */
100        @Override
101        protected String makeDropLine( final int[] clmNo,final String[] data ) {
102                return new OgBuilder()
103                                .appendCR()                                                                                     // 先頭に、改行を入れておきます。
104                                .appendIfCR( isXml , EXEC_START_TAG )
105                                .append( "ALTER TABLE " , data[clmNo[TABLE_NAME]] )
106                                .append( " DROP INDEX " , data[clmNo[INDEX_NAME]] )
107                                .append( execEndTag )
108                                .toString();
109        }
110
111        /**
112         * インデックスを作成するための文字列を返します。
113         * 但し、唯一、MySQLの場合、500バイト以上のカラムについては、TEXTで定義しており、
114         * この場合、インデックス化するバイト数(最大255)を指定する必要があります。
115         * このケースに対応するため、カラム名とバイト数を元に判定し、部分インデックスを
116         * 作成するための文字列を作成します。
117         *
118         * @og.rev 5.1.1.2 (2009/12/10)
119         * @og.rev 7.3.0.0 (2021/01/06) SEQNO がマイナスの場合、カラムに DESC を付ける(逆順カラム)
120         *
121         * @param       clm             カラム名
122         * @param       useLen  カラムのバイト数
123         * @param       seqNo   カラム順(マイナスの場合は、逆順)…DERBY以外には使用しないことにします。
124         *
125         * @return      インデックスカラムの文字列
126         */
127        @Override
128//      protected String makeIndexClmStr( final String clm, final String useLen ) {
129        protected String makeIndexClmStr( final String clm, final String useLen, final String seqNo ) {
130                // 6.3.9.1 (2015/11/27) Found 'DD'-anomaly for variable(PMD)
131                return useLen != null
132                                && !useLen.isEmpty()
133                                && Integer.parseInt( useLen ) > TableFilter_TABLE_MYSQL.CLM_MAX_SIZE
134                                        ? clm + "(255)" : clm ;
135        }
136}