org.seasar.doma.jdbc.criteria.context

Class Settings

java.lang.Object

org.seasar.doma.jdbc.criteria.context.Settings

Direct Known Subclasses:

DeleteSettings, InsertSettings, SelectSettings, UpdateSettings

public class Settings
extends java.lang.Object

Represents the settings for a criteria query.

Constructor Summary

Constructors

Constructor and Description
Settings()

Method Summary

Modifier and Type	Method and Description
java.lang.String	getComment() Returns the comment for the SQL statement.
int	getQueryTimeout() Returns the query timeout limit in seconds.
SqlLogType	getSqlLogType() Returns the SQL log type.
void	setComment(java.lang.String comment) Sets the comment for the SQL statement.
void	setQueryTimeout(int queryTimeout) Sets the query timeout limit in seconds.
void	setSqlLogType(SqlLogType sqlLogType) Sets the SQL log type.

Methods inherited from class java.lang.Object

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

Constructor Detail

Settings

public Settings()

Method Detail

getComment

public java.lang.String getComment()

Returns the comment for the SQL statement.

Returns:

the comment. The default value is null.

setComment

public void setComment(java.lang.String comment)

Sets the comment for the SQL statement.

The implementation of Commenter can use this value.

Parameters:

comment - the comment for the SQL statement

getSqlLogType

public SqlLogType getSqlLogType()

Returns the SQL log type.

Returns:

the SQL log type. The default value is SqlLogType.FORMATTED

setSqlLogType

public void setSqlLogType(SqlLogType sqlLogType)

Sets the SQL log type.

Specify SqlLogType.RAW or SqlLogType.NONE for the sensitive SQL statement.

Parameters:

sqlLogType - the SQL log type

getQueryTimeout

public int getQueryTimeout()

Returns the query timeout limit in seconds.

Returns:

the query timeout limit in seconds. The default value is 0.

setQueryTimeout

public void setQueryTimeout(int queryTimeout)

Sets the query timeout limit in seconds.

Parameters:

queryTimeout - the query timeout limit in seconds. If the value is greater than or equal to 1, it is passed to Statement.setQueryTimeout(int).

See Also:

Statement.setQueryTimeout(int)