org.maachang.rimdb.index.position

## クラス PositionIndexPointer

- java.lang.Object
- - org.maachang.rimdb.index.position.PositionIndexPointer

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

      public final class PositionIndexPointer
      extends java.lang.Object
      implements Pointer

  空間インデックスポインタ.
  導入されたバージョン:
    rimdb-1.00
  バージョン:
    2014/07/13
  作成者:
    masahito suzuki

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

    - ### インタフェースから継承されたフィールド org.maachang.rimdb.index.Pointer

      `TYPE_BETWEEN, TYPE_BIG, TYPE_BIG_EQ, TYPE_EQ, TYPE_IN, TYPE_LIKE, TYPE_NEQ, TYPE_POSITION, TYPE_SMALL, TYPE_SMALL_EQ`

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

    コンストラクタ
    コンストラクタと説明
    `PositionIndexPointer()` コンストラクタ.

  - ### メソッドの概要

    メソッド
    修飾子とタイプ | メソッドと説明
    --- | ---
    `PositionIndexPointer` | `copy(boolean mode)` 情報コピー.
    `int` | `getHalf()` 半径を取得.
    `int` | `getNo()` 番号取得.
    `RadiusSort` | `getSort(Indexs indexTable)` 空間検索ソート要素を取得.
    `RadiusSort` | `getSort(PositionIndex index)` 空間検索ソート要素を取得.
    `int` | `getType()` 処理タイプを取得.
    `int` | `getX()` X軸を取得.
    `int` | `getY()` Y軸を取得.
    `boolean` | `isSet()` 情報が有効かチェック.
    `void` | `parameter(java.lang.Object word)` 情報セット.
    `void` | `reset(boolean mode)` 情報リセット.
    `void` | `search(MaskFlags out, Indexs indexTable)` 検索処理.
    `void` | `search(MaskFlags out, MaskFlags and, Indexs indexTable)` 検索処理.
    `void` | `search(MaskFlags out, MaskFlags and, PositionIndex index)` 検索処理.
    `void` | `search(MaskFlags out, PositionIndex index)` 検索処理.
    `void` | `set(int x, int y, int half)` 情報セット.
    `void` | `setNo(int no)` 番号設定.

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

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

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

    - #### PositionIndexPointer

          public PositionIndexPointer()

      コンストラクタ.

  - ### メソッドの詳細

    - #### reset

          public final void reset(boolean mode)

      情報リセット.
      定義:
        `reset` インタフェース内 `Pointer`
      パラメータ:
        `mode` - [true]を設定した場合、設定ワード条件も削除します.

    - #### setNo

          public final void setNo(int no)

      番号設定.
      定義:
        `setNo` インタフェース内 `Pointer`
      パラメータ:
        `no` - 対象の番号を設定します.

    - #### getNo

          public final int getNo()

      番号取得.
      定義:
        `getNo` インタフェース内 `Pointer`
      戻り値:
        int 番号が返却されます.

    - #### copy

          public final PositionIndexPointer copy(boolean mode)

      情報コピー.
      定義:
        `copy` インタフェース内 `Pointer`
      パラメータ:
        `mode` - [true]を設定した場合、パラメータ情報はコピーされません.
      戻り値:
        PositionIndexPointer コピーされた情報が返却されます.

    - #### set

          public final void set(int x,
                 int y,
                 int half)

      情報セット.
      パラメータ:
        `x` - 対象のX軸を設定します.
        `y` - 対象のY軸を設定します.
        `half` - 対象の半径を設定します.

    - #### parameter

          public final void parameter(java.lang.Object word)

      情報セット.
      定義:
        `parameter` インタフェース内 `Pointer`
      パラメータ:
        `word` - 検索内容を設定します.

    - #### isSet

          public final boolean isSet()

      情報が有効かチェック.
      戻り値:
        boolean [true]の場合、有効です.

    - #### getType

          public final int getType()

      処理タイプを取得.
      定義:
        `getType` インタフェース内 `Pointer`
      戻り値:
        int 処理タイプが返却されます[TYPE_XXXX].

    - #### getX

          public final int getX()

      X軸を取得.
      戻り値:
        int X軸が返却されます.

    - #### getY

          public final int getY()

      Y軸を取得.
      戻り値:
        int Y軸が返却されます.

    - #### getHalf

          public final int getHalf()

      半径を取得.
      戻り値:
        int 半径が返却されます.

    - #### search

          public final void search(MaskFlags out,
                    PositionIndex index)

      検索処理.
      パラメータ:
        `out` - 検索結果を設定するオブジェクトを設定します.
        `index` - 対象のインデックスオブジェクトを設定します.

    - #### search

          public final void search(MaskFlags out,
                    Indexs indexTable)

      検索処理.
      パラメータ:
        `out` - 検索結果を設定するオブジェクトを設定します.
        `indexTable` - 対象のインデックステーブルを設定します.

    - #### search

          public final void search(MaskFlags out,
                    MaskFlags and,
                    PositionIndex index)

      検索処理.
      パラメータ:
        `out` - 検索結果を設定するオブジェクトを設定します.
        `and` - And条件のオブジェクトを設定します.
        `index` - 対象のインデックスオブジェクトを設定します.

    - #### search

          public final void search(MaskFlags out,
                    MaskFlags and,
                    Indexs indexTable)

      検索処理.
      パラメータ:
        `out` - 検索結果を設定するオブジェクトを設定します.
        `and` - And条件のオブジェクトを設定します.
        `indexTable` - 対象のインデックステーブルを設定します.

    - #### getSort

          public final RadiusSort getSort(PositionIndex index)

      空間検索ソート要素を取得.
      パラメータ:
        `index` - 対象のインデックスオブジェクトを設定します.
      戻り値:
        RadiusSort ソート要素が返却されます.

    - #### getSort

          public final RadiusSort getSort(Indexs indexTable)

      空間検索ソート要素を取得.
      パラメータ:
        `indexTable` - 対象のインデックステーブルを設定します.
      戻り値:
        RadiusSort ソート要素が返却されます.