org.seasar.doma.jdbc
クラス SelectOptions

java.lang.Object
  上位を拡張 org.seasar.doma.jdbc.SelectOptions

public class SelectOptions
extends Object

検索系SQLを実行する際のオプションです。

get()でインスタンスを取得し、メソッド呼び出しをチェインさせることができます。

 SelectOptions options = SelectOptions.get().offset(10).limit(50).forUpdate();
 

作成者:
taedium

フィールドの概要
protected  String[] aliases
          悲観的排他制御のロック対象のエイリアスの配列
protected  SelectForUpdateType forUpdateType
          悲観的排他制御の種別
protected  int limit
          ページングのリミット
protected  int offset
          ページングのオフセット
protected  int waitSeconds
          悲観的排他制御の待機時間(秒)
 
コンストラクタの概要
protected SelectOptions()
          インスタンスを構築します。
 
メソッドの概要
 SelectOptions forUpdate()
          悲観的排他制御用のSQLへ変換することを示します。
 SelectOptions forUpdate(String... aliases)
          ロック対象のテーブルやカラムのエイリアスを指定し、悲観的排他制御用のSQLへ変換することを示します。
 SelectOptions forUpdateNowait()
          ロックの取得を待機しない悲観的排他制御用のSQLへ変換することを示します。
 SelectOptions forUpdateNowait(String... aliases)
          ロック対象のテーブルやカラムのエイリアスを指定し、ロックの取得を待機しない悲観的排他制御用のSQLへ変換することを示します。
 SelectOptions forUpdateWait(int waitSeconds)
          ロックの取得まで指定された時間待機する悲観的排他制御用のSQLへ変換することを示します。
 SelectOptions forUpdateWait(int waitSeconds, String... aliases)
          ロック対象のテーブルやカラムのエイリアスを指定し、ロックの取得まで指定された時間待機する悲観的排他制御用のSQLへ変換することを示します。
static SelectOptions get()
          インスタンスを取得するためのファクトリメソッドです。
 String[] getAliases()
          ロック対象のテーブルもしくはカラムのエイリアスの配列を返します。
 SelectForUpdateType getForUpdateType()
          悲観的排他制御の種別を返します。
 int getLimit()
          ページングのリミットを返します。
 int getOffset()
          ページングのオフセットを返します。
 int getWaitSeconds()
          悲観的排他制御のロック取得の待機時間を返します。
 SelectOptions limit(int limit)
          リミットを指定してページング用のSQLへ変換することを示します。
 SelectOptions offset(int offset)
          オフセットを指定してページング用のSQLへ変換することを示します。
 
クラス java.lang.Object から継承されたメソッド
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

フィールドの詳細

offset

protected int offset
ページングのオフセット


limit

protected int limit
ページングのリミット


forUpdateType

protected SelectForUpdateType forUpdateType
悲観的排他制御の種別


waitSeconds

protected int waitSeconds
悲観的排他制御の待機時間(秒)


aliases

protected String[] aliases
悲観的排他制御のロック対象のエイリアスの配列

コンストラクタの詳細

SelectOptions

protected SelectOptions()
インスタンスを構築します。

メソッドの詳細

get

public static SelectOptions get()
インスタンスを取得するためのファクトリメソッドです。

戻り値:
新しい SelectOptions

forUpdate

public SelectOptions forUpdate()
悲観的排他制御用のSQLへ変換することを示します。

戻り値:
このインスタンス

forUpdate

public SelectOptions forUpdate(String... aliases)
ロック対象のテーブルやカラムのエイリアスを指定し、悲観的排他制御用のSQLへ変換することを示します。

パラメータ:
aliases - テーブルやカラムのエイリアス
戻り値:
このインスタンス

forUpdateNowait

public SelectOptions forUpdateNowait()
ロックの取得を待機しない悲観的排他制御用のSQLへ変換することを示します。

戻り値:
このインスタンス

forUpdateNowait

public SelectOptions forUpdateNowait(String... aliases)
ロック対象のテーブルやカラムのエイリアスを指定し、ロックの取得を待機しない悲観的排他制御用のSQLへ変換することを示します。

パラメータ:
aliases - テーブルやカラムのエイリアス
戻り値:
このインスタンス

forUpdateWait

public SelectOptions forUpdateWait(int waitSeconds)
ロックの取得まで指定された時間待機する悲観的排他制御用のSQLへ変換することを示します。

パラメータ:
waitSeconds - 待機時間(秒)
戻り値:
このインスタンス

forUpdateWait

public SelectOptions forUpdateWait(int waitSeconds,
                                   String... aliases)
ロック対象のテーブルやカラムのエイリアスを指定し、ロックの取得まで指定された時間待機する悲観的排他制御用のSQLへ変換することを示します。

パラメータ:
waitSeconds - 待機時間(秒)
aliases - テーブルやカラムのエイリアス
戻り値:
このインスタンス

offset

public SelectOptions offset(int offset)
オフセットを指定してページング用のSQLへ変換することを示します。

パラメータ:
offset - オフセット
戻り値:
このインスタンス

limit

public SelectOptions limit(int limit)
リミットを指定してページング用のSQLへ変換することを示します。

パラメータ:
limit - リミット
戻り値:
このインスタンス

getForUpdateType

public SelectForUpdateType getForUpdateType()
悲観的排他制御の種別を返します。

戻り値:
悲観的排他制御の種別

getWaitSeconds

public int getWaitSeconds()
悲観的排他制御のロック取得の待機時間を返します。

戻り値:
待機時間(秒)

getAliases

public String[] getAliases()
ロック対象のテーブルもしくはカラムのエイリアスの配列を返します。

戻り値:
テーブルもしくはカラムのエイリアスの配列

getOffset

public int getOffset()
ページングのオフセットを返します。

戻り値:
オフセット

getLimit

public int getLimit()
ページングのリミットを返します。

戻り値:
リミット


Copyright © 2009 The Seasar Foundation. All Rights Reserved.