org.maachang.mimdb.core.impl

## クラス MStringIndex

- java.lang.Object
- - org.maachang.mimdb.core.impl.MStringIndex

- すべての実装されたインタフェース:
    MimdbBase, MimdbIndex

      public class MStringIndex
      extends java.lang.Object
      implements MimdbIndex

  文字列インデックスカラム.
  導入されたバージョン:
    MasterInMemDB 1.00
  バージョン:
    2013/10/12
  作成者:
    masahito suzuki

- - ### フィールドの概要

    - ### インタフェースから継承されたフィールド org.maachang.mimdb.core.MimdbIndex

      `COLUMN_BOOL, COLUMN_DATE, COLUMN_FLOAT, COLUMN_INT, COLUMN_LONG, COLUMN_STRING, COLUMN_TIME, COLUMN_TIMESTAMP`

  - ### コンストラクタの概要

    コンストラクタ
    コンストラクタと説明
    `MStringIndex(long id, java.lang.String n, boolean h)` コンストラクタ.
    `MStringIndex(long id, java.lang.String n, int size, boolean h)` コンストラクタ.
    `MStringIndex(long id, java.lang.String n, int size, boolean ngram, boolean h)` コンストラクタ.

  - ### メソッドの概要

    メソッド
    修飾子とタイプ | メソッドと説明
    --- | ---
    `void` | `add(char[] value, int lineNo)` 情報セット.
    `void` | `add(MStringIndexKey value, int lineNo)` 情報セット.
    `void` | `add(java.lang.Object value, int lineNo)` 情報セット.
    `void` | `add(java.lang.String value, int lineNo)` 情報セット.
    `MimdbMiddleSearch` | `and(MimdbSearchElement info, MimdbMiddleSearch and)` AND検索処理.
    `void` | `clear()` クリア.
    `void` | `createIndex()` インデックスの生成.
    `long` | `getDbId()` DB更新IDを取得.
    `int` | `getDBType()` DBカラムタイプを取得.
    `int` | `getIndexSize()` インデックス数を取得.
    `java.lang.String` | `getName()` カラム名を取得.
    `int[]` | `getSortNoList()` ソート順条件を取得.
    `int` | `getType()` カラムタイプを取得.
    `boolean` | `isIndex()` インデックス化されているかチェック.
    `boolean` | `isNGram()` NGramでのLike検索に対応しているかチェック.
    `MimdbMiddleSearch` | `or(MimdbSearchElement info, MimdbMiddleSearch or)` OR検索処理.
    `MimdbMiddleSearch` | `search(MimdbSearchElement info)` 検索処理.

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

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

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

    - #### MStringIndex

          public MStringIndex(long id,
                      java.lang.String n,
                      boolean h)

      コンストラクタ.
      パラメータ:
        `id` - DbIdを設定します.
        `n` - カラム名を設定します.
        `h` - ハッシュインデックスを利用する場合は[true].

    - #### MStringIndex

          public MStringIndex(long id,
                      java.lang.String n,
                      int size,
                      boolean h)

      コンストラクタ.
      パラメータ:
        `id` - DbIdを設定します.
        `size` - 初期バッファサイズを設定.
        `n` - カラム名を設定します.
        `h` - ハッシュインデックスを利用する場合は[true].

    - #### MStringIndex

          public MStringIndex(long id,
                      java.lang.String n,
                      int size,
                      boolean ngram,
                      boolean h)

      コンストラクタ.
      パラメータ:
        `id` - DbIdを設定します.
        `n` - カラム名を設定します.
        `size` - 初期バッファサイズを設定.
        `ngram` - Like検索をNGramで行う場合は[true]を設定します.
        `h` - ハッシュインデックスを利用する場合は[true].

  - ### メソッドの詳細

    - #### clear

          public void clear()

      クリア.
      定義:
        `clear` インタフェース内 `MimdbIndex`

    - #### getDbId

          public long getDbId()

      DB更新IDを取得. この情報が、結果データと一致しない場合は、その結果データは古くなっています.
      定義:
        `getDbId` インタフェース内 `MimdbBase`
      戻り値:
        int DB更新IDが返却されます.

    - #### isNGram

          public boolean isNGram()

      NGramでのLike検索に対応しているかチェック.
      定義:
        `isNGram` インタフェース内 `MimdbIndex`
      戻り値:
        boolean [true]の場合、NGramでのLike検索が可能です.

    - #### add

          public void add(java.lang.String value,
                 int lineNo)

      情報セット.
      パラメータ:
        `value` - 対象の情報を設定します.
        `lineNo` - 行番号を設定します.

    - #### add

          public void add(char[] value,
                 int lineNo)

      情報セット.
      パラメータ:
        `value` - 対象の情報を設定します.
        `lineNo` - 行番号を設定します.

    - #### add

          public void add(MStringIndexKey value,
                 int lineNo)

      情報セット.
      パラメータ:
        `value` - 対象の情報を設定します.
        `lineNo` - 行番号を設定します.

    - #### add

          public void add(java.lang.Object value,
                 int lineNo)
                   throws java.lang.Exception

      情報セット.
      パラメータ:
        `value` - 対象の情報を設定します.
        `lineNo` - 行番号を設定します.
      例外:
        `java.lang.Exception` - 例外.

    - #### createIndex

          public void createIndex()
                           throws java.lang.Exception

      インデックスの生成.
      定義:
        `createIndex` インタフェース内 `MimdbIndex`
      例外:
        `java.lang.Exception` - 例外.

    - #### isIndex

          public boolean isIndex()

      インデックス化されているかチェック.
      定義:
        `isIndex` インタフェース内 `MimdbIndex`
      戻り値:
        boolean [true]の場合、インデックス化されています.

    - #### search

          public MimdbMiddleSearch search(MimdbSearchElement info)
                                   throws java.lang.Exception

      検索処理.
      定義:
        `search` インタフェース内 `MimdbIndex`
      パラメータ:
        `info` - 検索条件を設定します.
      戻り値:
        MimdbMiddleSearch 検索結果が返却されます.
      例外:
        `java.lang.Exception` - 例外.

    - #### and

          public MimdbMiddleSearch and(MimdbSearchElement info,
                              MimdbMiddleSearch and)
                                throws java.lang.Exception

      AND検索処理.
      定義:
        `and` インタフェース内 `MimdbIndex`
      パラメータ:
        `info` - 検索条件を設定します.
        `and` - アンド検索条件元を設定します.
      戻り値:
        MimdbMiddleSearch 検索結果が返却されます.
      例外:
        `java.lang.Exception` - 例外.

    - #### or

          public MimdbMiddleSearch or(MimdbSearchElement info,
                             MimdbMiddleSearch or)
                               throws java.lang.Exception

      OR検索処理.
      定義:
        `or` インタフェース内 `MimdbIndex`
      パラメータ:
        `info` - 検索条件を設定します.
        `or` - オア検索条件元を設定します.
      戻り値:
        MimdbMiddleSearch 検索結果が返却されます.
      例外:
        `java.lang.Exception` - 例外.

    - #### getIndexSize

          public int getIndexSize()

      インデックス数を取得.
      定義:
        `getIndexSize` インタフェース内 `MimdbIndex`
      戻り値:
        int インデックス数が返却されます.

    - #### getSortNoList

          public int[] getSortNoList()

      ソート順条件を取得.
      定義:
        `getSortNoList` インタフェース内 `MimdbIndex`
      戻り値:
        int[] ソート順の条件が返却されます.

    - #### getName

          public java.lang.String getName()

      カラム名を取得.
      定義:
        `getName` インタフェース内 `MimdbIndex`
      戻り値:
        String カラム名が返却されます.

    - #### getType

          public int getType()

      カラムタイプを取得.
      定義:
        `getType` インタフェース内 `MimdbIndex`
      戻り値:
        int カラムタイプが返却されます.

    - #### getDBType

          public int getDBType()

      DBカラムタイプを取得.
      定義:
        `getDBType` インタフェース内 `MimdbIndex`
      戻り値:
        int DBカラムタイプ(java.sql.Types)が返却されます.