org.seasar.doma.jdbc
クラス SelectOptions

java.lang.Object
  org.seasar.doma.jdbc.SelectOptions

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

Serializable

public class SelectOptions
extends Object
implements Serializable

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

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

例

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

作成者:

taedium

関連項目:

直列化された形式

フィールドの概要

protected String[]	aliases 悲観的排他制御のロック対象のエイリアスの配列
protected boolean	count 集計するかどうか
protected long	countSize 集計サイズ
protected SelectForUpdateType	forUpdateType 悲観的排他制御の種別
protected long	limit ページングのリミット
protected long	offset ページングのオフセット
protected int	waitSeconds 悲観的排他制御の待機時間（秒）

コンストラクタの概要

protected

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

メソッドの概要

SelectOptions	count() 集計することを示します。
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() インスタンスを取得するためのファクトリメソッドです。
long	getCount() 集計を返します。
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 long offset

ページングのオフセット

limit

protected long limit

ページングのリミット

count

protected boolean count

集計するかどうか

countSize

protected long countSize

集計サイズ

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 - リミット

戻り値:

このインスタンス

count

public SelectOptions count()

集計することを示します。

戻り値:

このインスタンス

getCount

public long getCount()

集計を返します。

Daoのメソッドを実行する前にcount()を呼び出していない場合 -1 を返します。

戻り値:

集計サイズ