org.opengion.plugin.table

## クラス TableFilter_INDEX

- java.lang.Object
- - org.opengion.hayabusa.db.AbstractTableFilter
  - - org.opengion.plugin.table.TableFilter_INDEX

- すべての実装されたインタフェース:
    TableFilter
  直系の既知のサブクラス:
    TableFilter_INDEX_DERBY, TableFilter_INDEX_FIREBIRD, TableFilter_INDEX_HSQLDB, TableFilter_INDEX_MYSQL, TableFilter_INDEX_ORACLE, TableFilter_INDEX_POSTGRES, TableFilter_INDEX_SQLSERVER

      public class TableFilter_INDEX
      extends AbstractTableFilter

       TableFilter_INDEX は、TableUpda インターフェースを継承した、DBTableModel 処理用の
       実装クラスです。

       ここでは、インデックス一覧の検索結果より、GF07 のインデックスカラム定義テーブルから
       必要な情報を取得し、インデックス作成スクリプトを作成します。
       出力ファイルは、テーブル名＋"C.sql" という命名規則で作成します。
       検索では、(SYSTEM_ID,TBLSYU,TABLE_NAME,TABLE_LABEL,INDEX_NAME,NAME_JA,INDTYPE,TABLESPACE_NAME,INITIAL_EXTENT)
       の項目を取得する必要があります。

       6.1.0.0 (2014/12/26) より、NEXT_EXTENT は使用しなくなりました。

       パラメータは、tableFilterタグの keys, vals にそれぞれ記述するか、BODY 部にCSS形式で記述します。
       【パラメータ】
        {
             DIR : {@BASE_DIR}/sql/install/02_INDEX ;    出力ファイルの基準フォルダ(必須)
             XML : false ;                                    XML出力を行うかどうか[true/false]を指定します(初期値:false)。
             DROP: false ;                                    INDEX構文の前に、DROP構文を出力するかどうか[true/false]を指定します(初期値:false)。
        }

  形式サンプル:

         ●形式：
              select SYSTEM_ID,TBLSYU,TABLE_NAME,TABLE_LABEL,INDEX_NAME,NAME_JA,INDTYPE,TABLESPACE_NAME,INITIAL_EXTENT from GF07
              ① <og:tableFilter classId="INDEX" keys="DIR,XML" vals="{@BASE_DIR}/sql/install/02_INDEX,false" />

              ② <og:tableFilter classId="INDEX" >
                       {
                           DIR : {@BASE_DIR}/sql/install/02_INDEX ;
                           XML : false ;
                           DROP: false ;
                       }
                 </og:tableFilter>

  変更履歴:

    5.6.6.0 (2013/07/05) keys の整合性チェックを追加

  バージョン
    0.9.0 2000/10/17
  作成者
    Kazuhiko Hasegawa
  導入されたバージョン:
    JDK1.1,

- - ### フィールドのサマリー

    フィールド
    修飾子とタイプ | フィールドと説明
    --- | ---
    `protected static int` | `INDEX_NAME` データのアクセス用の配列番号 4
    `protected static int` | `INDTYPE` データのアクセス用の配列番号 6
    `protected static int` | `INITIAL_EXTENT` データのアクセス用の配列番号 8
    `protected static int` | `SYSTEM_ID` データのアクセス用の配列番号 0
    `protected static int` | `TABLE_LABEL` データのアクセス用の配列番号 3
    `protected static int` | `TABLE_NAME` データのアクセス用の配列番号 2
    `protected static int` | `TABLESPACE_NAME` データのアクセス用の配列番号 7
    `protected static int` | `TBLSYU` データのアクセス用の配列番号 1

    - ### クラスから継承されたフィールド org.opengion.hayabusa.db.AbstractTableFilter

      `BUFFER_MIDDLE, CR, EXEC_END_TAG, EXEC_START_TAG, execEndTag, isXml, XML_END_TAG, XML_START_TAG`

  - ### コンストラクタのサマリー

    コンストラクタ
    コンストラクタと説明
    `TableFilter_INDEX()` デフォルトコンストラクター

  - ### メソッドのサマリー

    すべてのメソッド インスタンス・メソッド concreteメソッド
    修飾子とタイプ | メソッドと説明
    --- | ---
    `DBTableModel` | `execute()` DBTableModel処理を実行します。
    `protected java.lang.String` | `makeDropLine(int[] clmNo, java.lang.String[] data)` インデックス削除の構文を、作成します。
    `protected java.lang.String` | `makeEndLine(int[] clmNo, java.lang.String[] data)` 定義の最後の部分の処理を実行します。
    `protected java.lang.String` | `makeHeadLine(int[] clmNo, java.lang.String[] data)` ヘッダー部分の処理を実行します。
    `protected java.lang.String` | `makeIndexClmStr(java.lang.String clm, java.lang.String useLen)` インデックスを作成するための文字列を返します。
    `protected java.lang.String` | `makeLineList(int[] clmNo, java.lang.String[] data, java.lang.String clms)` インデックス作成の処理を実行します。

    - ### クラスから継承されたメソッド org.opengion.hayabusa.db.AbstractTableFilter

      `getDbid, getDBTableModel, getErrorCode, getErrorMessage, getKeys, getModifyType, getParameterRows, getResource, getSql, getTableColumnNo, getTransaction, getValue, initSet, isDebug, makeErrorMessage, setDbid, setDBTableModel, setDebug, setKeysVals, setModifyType, setParameterRows, setParamMap, setResource, setSql, setTransaction`

    - ### クラスから継承されたメソッド java.lang.Object

      `clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

- - ### フィールドの詳細

    - #### SYSTEM_ID

          protected static final int SYSTEM_ID

      データのアクセス用の配列番号 0
      関連項目:
        定数フィールド値

    - #### TBLSYU

          protected static final int TBLSYU

      データのアクセス用の配列番号 1
      関連項目:
        定数フィールド値

    - #### TABLE_NAME

          protected static final int TABLE_NAME

      データのアクセス用の配列番号 2
      関連項目:
        定数フィールド値

    - #### TABLE_LABEL

          protected static final int TABLE_LABEL

      データのアクセス用の配列番号 3
      関連項目:
        定数フィールド値

    - #### INDEX_NAME

          protected static final int INDEX_NAME

      データのアクセス用の配列番号 4
      関連項目:
        定数フィールド値

    - #### INDTYPE

          protected static final int INDTYPE

      データのアクセス用の配列番号 6
      関連項目:
        定数フィールド値

    - #### TABLESPACE_NAME

          protected static final int TABLESPACE_NAME

      データのアクセス用の配列番号 7
      関連項目:
        定数フィールド値

    - #### INITIAL_EXTENT

          protected static final int INITIAL_EXTENT

      データのアクセス用の配列番号 8
      関連項目:
        定数フィールド値

  - ### コンストラクタの詳細

    - #### TableFilter_INDEX

          public TableFilter_INDEX()

      デフォルトコンストラクター
      変更履歴:

        6.4.1.1 (2016/01/16) keysMap を、サブクラスから設定させるように変更。

  - ### メソッドの詳細

    - #### execute

          public DBTableModel execute()

      DBTableModel処理を実行します。
      戻り値:
        実行結果のテーブルモデル
      変更履歴:

        3.8.7.0 (2006/12/15) アクセスログ取得の為,ApplicationInfoオブジェクトを設定
        4.0.0.0 (2007/11/28) メソッドの戻り値をチェックします。
        4.3.7.0 (2009/06/01) XML出力機能追加
        5.1.1.0 (2009/12/01) XML_START_TAG に、tableName をセットします。
        5.1.9.0 (2010/08/01) Transaction 対応
        5.5.2.6 (2012/05/25) protected変数を、private化したため、getterメソッドで取得するように変更
        5.6.9.2 (2013/10/18) INDEXを作成する前に、削除構文を入れるかどうかを指定。
        6.0.2.3 (2014/10/10) EXEC_END_TAG を追加。キャッシュします。
        6.0.2.3 (2014/10/10) isDrop=false の場合、まとめDropファイル(AllDropC.xml)を作成します。
        6.5.0.1 (2016/10/21) ErrorMessage をまとめるのと、直接 Throwable を渡します。

    - #### makeHeadLine

          protected java.lang.String makeHeadLine(int[] clmNo,
                                                  java.lang.String[] data)

      ヘッダー部分の処理を実行します。
      パラメータ:
        `clmNo` - カラム番号配列
        `data` - １行分のデータ配列
      戻り値:
        ヘッダー部分の文字列
      変更履歴:

        5.6.6.0 (2013/07/05) FixLengthData の簡易コンストラクタを使用

      このメソッドは、nullを返しません

    - #### makeLineList

          protected java.lang.String makeLineList(int[] clmNo,
                                                  java.lang.String[] data,
                                                  java.lang.String clms)

      インデックス作成の処理を実行します。
      パラメータ:
        `clmNo` - カラム番号配列
        `data` - １行分のデータ配列
        `clms` - カラム名(CSV形式)
      戻り値:
        作成された１行分の文字列
      変更履歴:

        5.3.8.0 (2011/08/01) プライマリキー対応
        5.6.9.2 (2013/10/18) INDTYPE で、その他ではなく、2:通常 で判断する。
        6.4.0.5 (2016/01/09) INDTYPE が 9:未使用 の場合の処理を追加。
        6.4.4.1 (2016/03/18) StringBuilderの代わりに、OgBuilderを使用する。

      このメソッドは、nullを返しません

    - #### makeEndLine

          protected java.lang.String makeEndLine(int[] clmNo,
                                                 java.lang.String[] data)

      定義の最後の部分の処理を実行します。 6.1.0.0 (2014/12/26) より、 １．TABLESPACE_NAME を指定しない場合は、TABLESPACE 句を出力しません。 ２．INITIAL_EXTENT を 0 で指定した場合は、STORAGE 句を出力しません。 ３．NEXT と PCTINCREASE は、出力しません。
      パラメータ:
        `clmNo` - カラム番号配列
        `data` - １行分のデータ配列
      戻り値:
        定義の最後の部分
      変更履歴:

        5.3.9.0 (2011/09/01) プライマリキー対応２
        6.0.2.3 (2014/10/10) isXml で、CR + EXEC_END_TAG のキャッシュ(execEndTag)を利用します。
        6.1.0.0 (2014/12/26) TABLESPACE_NAME,INITIAL_EXTENT が未設定の場合、設定しません。
        6.4.4.1 (2016/03/18) StringBuilderの代わりに、OgBuilderを使用する。

      このメソッドは、nullを返しません

    - #### makeDropLine

          protected java.lang.String makeDropLine(int[] clmNo,
                                                  java.lang.String[] data)

      インデックス削除の構文を、作成します。
      パラメータ:
        `clmNo` - カラム番号配列
        `data` - １行分のデータ配列
      戻り値:
        作成された１行分の文字列
      変更履歴:

        5.6.9.2 (2013/10/18) 新規作成
        6.0.2.3 (2014/10/10) isXml で、CR + EXEC_END_TAG のキャッシュ(execEndTag)を利用します。
        6.4.4.1 (2016/03/18) StringBuilderの代わりに、OgBuilderを使用する。

      このメソッドは、nullを返しません

    - #### makeIndexClmStr

          protected java.lang.String makeIndexClmStr(java.lang.String clm,
                                                     java.lang.String useLen)

      インデックスを作成するための文字列を返します。 通常、カラム名をそのまま返します。 但し、唯一、MySQLの場合、500バイト以上のカラムについては、TEXTで定義しており、 この場合、インデックス化するバイト数(最大255)を指定する必要があります。 このケースに対応するため、カラム名とバイト数を元に判定し、部分インデックスを 作成するための文字列を作成します。
      パラメータ:
        `clm` - カラム名
        `useLen` - カラムのバイト数
      戻り値:
        インデックスカラムの文字列
      関連項目:
        `TableFilter_INDEX_MYSQL`

Webアプリケーションフレームワーク openGion
Copyright (c) 2009 The openGion Project.