org.maachang.rimdb.index.string

## クラス NGram

- java.lang.Object
- - org.maachang.rimdb.index.string.NGram

-     public class NGram
      extends java.lang.Object

  NGram情報.
  導入されたバージョン:
    rimdb-1.00
  バージョン:
    2014/07/18
  作成者:
    masahito suzuki

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

    メソッド
    修飾子とタイプ | メソッドと説明
    --- | ---
    `static java.lang.Object` | `createIndex(IString[] list)` NGramインデックス情報の作成.
    `static org.maachang.rimdb.index.string.LikePositionList` | `endsWith(org.maachang.rimdb.index.string.LikePositionList and, java.lang.Object ngram, IString value)` 終端検索.
    `static org.maachang.rimdb.index.string.LikePositionList` | `eqaulsPosition(boolean last, org.maachang.rimdb.index.string.LikePositionList and, java.lang.Object ngram, IString value, int addOff, IString beforeIndexOf)` 現在ポジション後に指定文字が連続しているかチェック.
    `static org.maachang.rimdb.index.string.LikePositionList` | `indexOf(org.maachang.rimdb.index.string.LikePositionList and, java.lang.Object ngram, IString value)` 文字検索.
    `static org.maachang.rimdb.index.string.LikePositionList` | `startsWith(java.lang.Object ngram, IString value)` 開始検索.

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

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

- - ### メソッドの詳細

    - #### createIndex

          public static final java.lang.Object createIndex(IString[] list)

      NGramインデックス情報の作成.
      パラメータ:
        `list` - 対象の文字列群を設定します.
      戻り値:
        Object NGramインデックスが返却されます.

    - #### startsWith

          public static final org.maachang.rimdb.index.string.LikePositionList startsWith(java.lang.Object ngram,
                                                                    IString value)

      開始検索.
      パラメータ:
        `ngram` - createNGramで作成されたオブジェクトを設定します.
        `value` - チェック対象の開始文字列を設定します.
      戻り値:
        NGramResult 一致項番群が返却されます. [null]の場合、検索結果は存在しません.

    - #### endsWith

          public static final org.maachang.rimdb.index.string.LikePositionList endsWith(org.maachang.rimdb.index.string.LikePositionList and,
                                                                  java.lang.Object ngram,
                                                                  IString value)

      終端検索.
      パラメータ:
        `and` - 連結検索条件を設定します.
        `ngram` - createNGramで作成されたオブジェクトを設定します.
        `value` - チェック対象の開始文字列を設定します.
      戻り値:
        NGramResult 一致項番群が返却されます. [null]の場合、検索結果は存在しません.

    - #### indexOf

          public static final org.maachang.rimdb.index.string.LikePositionList indexOf(org.maachang.rimdb.index.string.LikePositionList and,
                                                                 java.lang.Object ngram,
                                                                 IString value)

      文字検索.
      パラメータ:
        `and` - 連結検索条件を設定します.
        `ngram` - createNGramで作成されたオブジェクトを設定します.
        `value` - チェック対象の開始文字列を設定します.
      戻り値:
        NGramResult 一致項番群が返却されます. [null]の場合、検索結果は存在しません.

    - #### eqaulsPosition

          public static final org.maachang.rimdb.index.string.LikePositionList eqaulsPosition(boolean last,
                                                                        org.maachang.rimdb.index.string.LikePositionList and,
                                                                        java.lang.Object ngram,
                                                                        IString value,
                                                                        int addOff,
                                                                        IString beforeIndexOf)

      現在ポジション後に指定文字が連続しているかチェック.
      パラメータ:
        `last` - 一致した条件が最後方条件としてチェックする場合は[true].
        `and` - 連結検索条件を設定します.
        `ngram` - createNGramで作成されたオブジェクトを設定します.
        `value` - チェック対象の開始文字列を設定します.
        `addOff` - 対象のオフセット位置を移動させて検索する場合に利用します.
        `beforeIndexOf` - 前回のindexof処理時の条件を設定することで、offset配置のやり直しが出来ます.
      戻り値:
        NGramResult 一致項番群が返却されます. [null]の場合、検索結果は存在しません.