概要 | パッケージ | クラス | 階層ツリー | 非推奨 API | 索引 | ヘルプ
前のクラス 次のクラス | フレームあり フレームなし
概要: 入れ子 | フィールド | コンストラクタ | メソッド | 詳細: フィールド | コンストラクタ | メソッド

## okuyama.imdst.client
インタフェース OkuyamaResultSet

既知の実装クラスの一覧:
  OkuyamaMultiTagKeysResultSet, OkuyamaTagKeysResultSet

    public interface OkuyamaResultSet

OkuyamaClientが一度のリクエストでは取得しきれないような
大量のデータを扱う場合に利用するResultSetクラス.
以下のような構文にてデータを取得する
以下は、Tagを利用して全ての紐付くKeyとValueを出力している
-----------------------------------------------------------------
OkuyamaResultSet resultSet = client.getTagKeysResult(tagStr);
while(resultSet.next()) {
System.out.println("Key=" + (Object)resultSet.getKey());
System.out.println("Value=" + (Object)resultSet.getValue());
}
resultSet.close();
------------------------------------------------------------------

作成者:
  T.Okuyama

メソッドの概要
`void` | `close()` ResultSetを終了する.
`java.lang.Object` | `getKey()` 現在のカーソル位置のKey値を取得する.
`java.lang.Object` | `getValue()` 現在のカーソル位置のValue値を取得する.
`boolean` | `isClose()` このResultSetが終了しているかを確認する.
`boolean` | `next()` データ取得前に呼び出すことで取得位置を1つ進める.

メソッドの詳細

### next

    boolean next()
                 throws OkuyamaClientException

  データ取得前に呼び出すことで取得位置を1つ進める.
  OkuyamaResultSetが返された直後はカーソル位置がデータの最初の場所にないため、まず呼び出さなければデータは取得できない
  カーソルが終端に達し場合はfalseが返却されカーソルが終端ではない場合はtrueが返される

  戻り値:
    boolean カーソルが終端に達し場合はfalse カーソルが終端ではない場合はtrue
  例外:
    `OkuyamaClientException` - なんだかの理由でカーソルの移動に失敗した場合

### getKey

    java.lang.Object getKey()
                            throws OkuyamaClientException

  現在のカーソル位置のKey値を取得する.

  戻り値:
    Object Key値
  例外:
    `OkuyamaClientException` - なんだかの理由でKey値の取得に失敗した場合

### getValue

    java.lang.Object getValue()
                              throws OkuyamaClientException

  現在のカーソル位置のValue値を取得する.

  戻り値:
    Object Value値
  例外:
    `OkuyamaClientException` - なんだかの理由でValue値の取得に失敗した場合

### close

    void close()
               throws OkuyamaClientException

  ResultSetを終了する.
  利用後は必ず呼び出してリソースを解放する必要がある

  例外:
    `OkuyamaClientException` - なんだかの理由でリソースの解放に失敗した場合

### isClose

    boolean isClose()

  このResultSetが終了しているかを確認する.

  戻り値:
    boolean true=既に終了している false=終了していない

概要 | パッケージ | クラス | 階層ツリー | 非推奨 API | 索引 | ヘルプ
前のクラス 次のクラス | フレームあり フレームなし
概要: 入れ子 | フィールド | コンストラクタ | メソッド | 詳細: フィールド | コンストラクタ | メソッド