org.seasar.doma.jdbc

Class SelectOptions

java.lang.Object

org.seasar.doma.jdbc.SelectOptions

All Implemented Interfaces:

java.io.Serializable

public class SelectOptions
extends java.lang.Object
implements java.io.Serializable

The options for an SQL SELECT statement.

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

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected java.lang.String[]	aliases
protected boolean	count
protected long	countSize
protected SelectForUpdateType	forUpdateType
protected long	limit
protected long	offset
protected int	waitSeconds

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	SelectOptions()

Method Summary

Modifier and Type	Method and Description
SelectOptions	count() Indicates to count all rows.
SelectOptions	forUpdate() Indicates to apply pessimistic locking.
SelectOptions	forUpdate(java.lang.String... aliases) Indicates to apply pessimistic locking with specified aliases.
SelectOptions	forUpdateNowait() Indicates to apply no-wait pessimistic locking.
SelectOptions	forUpdateNowait(java.lang.String... aliases) Indicates to apply no-wait pessimistic locking with specified aliases.
SelectOptions	forUpdateWait(int waitSeconds) Indicates to apply pessimistic locking with specified wait seconds.
SelectOptions	forUpdateWait(int waitSeconds, java.lang.String... aliases) Indicates to apply pessimistic locking with specified wait seconds and aliases.
static SelectOptions	get() Creates a new SelectOptions instance.
long	getCount() Returns the count of all rows.
SelectOptions	limit(int limit) Indicates to apply the specified limit.
SelectOptions	offset(int offset) Indicates to apply the the specified offset.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

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 java.lang.String[] aliases

Constructor Detail

SelectOptions

protected SelectOptions()

Method Detail

get

public static SelectOptions get()

Creates a new SelectOptions instance.

Returns:

the new SelectOptions instance

forUpdate

public SelectOptions forUpdate()

Indicates to apply pessimistic locking.

Returns:

this instance

forUpdate

public SelectOptions forUpdate(java.lang.String... aliases)

Indicates to apply pessimistic locking with specified aliases.

Parameters:

aliases - aliases of the table or the column

Returns:

this instance

forUpdateNowait

public SelectOptions forUpdateNowait()

Indicates to apply no-wait pessimistic locking.

Returns:

the instance

forUpdateNowait

public SelectOptions forUpdateNowait(java.lang.String... aliases)

Indicates to apply no-wait pessimistic locking with specified aliases.

Parameters:

aliases - aliases of the table or the column

Returns:

this instance

forUpdateWait

public SelectOptions forUpdateWait(int waitSeconds)

Indicates to apply pessimistic locking with specified wait seconds.

Parameters:

waitSeconds - the wait seconds

Returns:

this instance

forUpdateWait

public SelectOptions forUpdateWait(int waitSeconds,
                                   java.lang.String... aliases)

Indicates to apply pessimistic locking with specified wait seconds and aliases.

Parameters:

waitSeconds - the wait seconds

aliases - aliases of the table or the column

Returns:

this instance

offset

public SelectOptions offset(int offset)

Indicates to apply the the specified offset.

Parameters:

offset - the offset

Returns:

this instance

limit

public SelectOptions limit(int limit)

Indicates to apply the specified limit.

Parameters:

limit - the limit

Returns:

this instance

count

public SelectOptions count()

Indicates to count all rows.

Returns:

this instance

getCount

public long getCount()

Returns the count of all rows.

If count() is not invoked before the DAO method execution, this method returns -1.

Returns:

the count of all rows