org.dbflute.s2dao.sqlhandler

クラス TnAbstractBasicSqlHandler

java.lang.Object

org.dbflute.s2dao.sqlhandler.TnAbstractBasicSqlHandler

直系の既知のサブクラス:

TnAbstractEntityHandler, TnBasicParameterHandler, TnCommandContextHandler, TnProcedureHandler

public abstract class TnAbstractBasicSqlHandler
extends Object

The basic handler to execute SQL.
All SQL executions of DBFlute are under this handler.
This is always created when executing so it's non thread safe.

作成者:

modified by jflute (originated in S2Dao)

フィールドのサマリー

フィールド

修飾子とタイプ	フィールドと説明
protected DataSource	_dataSource
protected Object[]	_exceptionMessageSqlArgs
protected String	_sql
protected StatementFactory	_statementFactory

コンストラクタのサマリー

コンストラクタ

コンストラクタと説明
TnAbstractBasicSqlHandler(DataSource dataSource, StatementFactory statementFactory, String sql) Constructor.

メソッドのサマリー

修飾子とタイプ	メソッドと説明
protected void	addBatch(PreparedStatement ps)
protected void	assertObjectNotNull(String variableName, Object value)
protected void	bindArgs(Connection conn, PreparedStatement ps, Object[] args, Class<?>[] argTypes)
protected void	bindArgs(Connection conn, PreparedStatement ps, Object[] args, Class<?>[] argTypes, int beginIndex)
protected void	bindArgs(Connection conn, PreparedStatement ps, Object[] args, ValueType[] valueTypes)
protected String	buildDisplaySql(String sql, Object[] args)
protected String	buildExceptionMessageSql()
protected void	close(Connection conn)
protected void	close(ResultSet resultSet)
protected void	close(Statement st)
protected DisplaySqlBuilder	createDisplaySqlBuilder()
protected HandlingDataSourceWrapper	createInheritedConnectionDataSource(Connection conn) Create the data source (wrapper) to inherit connection.
protected BoundDateDisplayStyle	createResourcedLogDateDisplayStyle()
protected SQLExceptionHandler	createSQLExceptionHandler()
protected SQLExceptionResource	createSQLExceptionResource()
protected SqlLogInfo.SqlLogDisplaySqlBuilder	createSqlLogDisplaySqlBuilder(String alreadyBuiltDisplaySql)
protected void	doLogSql(Object[] args, Class<?>[] argTypes, boolean logEnabled, boolean hasSqlFireHook, boolean hasSqlLog, boolean hasSqlResult, Object sqlLogRegistry)
protected int[]	executeBatch(PreparedStatement ps, List<?> list)
protected boolean	executeProcedure(CallableStatement cs)
protected ResultSet	executeQuery(PreparedStatement ps)
protected int	executeUpdate(PreparedStatement ps)
protected ValueType	findValueType(Class<?> type, Object instance)
protected Class<?>[]	getArgTypes(Object[] args)
protected String	getBatchUpdateSQLFailureProcessTitle()
protected String	getBindVariableText(Object bindVariable)
protected Connection	getConnection() Get the database connection from data source.
protected ManualThreadDataSourceHandler	getManualThreadDataSourceHandler() Get the data source handler of manual thread.
protected BoundDateDisplayStyle	getSpecifiedLogDateDisplayStyle()
protected SqlFireHook	getSqlFireHook()
protected SqlLogHandler	getSqlLogHander()
protected Object	getSqlLogRegistry()
protected SqlResultHandler	getSqlResultHander()
protected String	getUpdateSQLFailureProcessTitle()
protected void	handleSQLException(SQLException e, SQLExceptionResource resource)
protected boolean	hasSqlFireHook()
protected boolean	hasSqlLogHandler()
protected boolean	hasSqlResultHandler()
protected void	hookSqlFireBefore()
protected void	hookSqlFireFinally(Object nativeResult, SQLException nativeCause)
protected boolean	isContainsLineSeparatorInSql(String displaySql)
protected boolean	isInternalDebugEnabled()
protected boolean	isLogEnabled()
protected boolean	isSaveMillis()
protected String	ln()
protected void	log(String msg)
protected void	logDisplaySql(String displaySql)
protected void	logSql(Object[] args, Class<?>[] argTypes)
protected DisplaySqlBuilder	newDisplaySqlBuilder(BoundDateDisplayStyle dateDisplayStyle)
protected CallableStatement	prepareCall(Connection conn)
protected SqlLogInfo	prepareSqlLogInfo(Object[] args, Class<?>[] argTypes, String alreadyBuiltDisplaySql)
protected PreparedStatement	prepareStatement(Connection conn)
protected boolean	processBeforeLogging(Object[] args, Class<?>[] argTypes, boolean logEnabled, boolean hasSqlFireHook, boolean hasSqlLog, boolean hasSqlResult, Object sqlLogRegistry)
protected void	pushToSqlLogRegistry(Object[] args, Class<?>[] argTypes, String firstDisplaySql, Object sqlLogRegistry)
protected void	saveAfterSqlTimeMillis()
protected void	saveBeforeSqlTimeMillis()
protected void	saveHookSqlLogInfo(SqlLogInfo sqlLogInfo)
protected void	saveResultSqlLogInfo(SqlLogInfo sqlLogInfo)
void	setExceptionMessageSqlArgs(Object[] exceptionMessageSqlArgs)
protected void	setFetchSize(Statement st, int fetchSize)
protected void	setMaxRows(Statement st, int maxRows)
protected long	systemTime()

クラスから継承されたメソッド java.lang.Object

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

フィールドの詳細

_dataSource

protected final DataSource _dataSource

_statementFactory

protected final StatementFactory _statementFactory

_sql

protected final String _sql

_exceptionMessageSqlArgs

protected Object[] _exceptionMessageSqlArgs

コンストラクタの詳細

TnAbstractBasicSqlHandler

public TnAbstractBasicSqlHandler(DataSource dataSource,
                                 StatementFactory statementFactory,
                                 String sql)

Constructor.

パラメータ:

dataSource - The data source for a database connection. (NotNull)

statementFactory - The factory of statement. (NotNull)

sql - The executed SQL. (NotNull)

メソッドの詳細

bindArgs

protected void bindArgs(Connection conn,
                        PreparedStatement ps,
                        Object[] args,
                        ValueType[] valueTypes)

パラメータ:

conn - The connection for the database. (NotNull)

ps - The prepared statement for the SQL. (NotNull)

args - The arguments for binding. (NullAllowed)

valueTypes - The types of binding value. (NotNull)

bindArgs

protected void bindArgs(Connection conn,
                        PreparedStatement ps,
                        Object[] args,
                        Class<?>[] argTypes)

パラメータ:

conn - The connection for the database. (NotNull)

ps - The prepared statement for the SQL. (NotNull)

args - The arguments for binding. (NullAllowed)

argTypes - The types of arguments. (NullAllowed: if args is null, this is also null)

bindArgs

protected void bindArgs(Connection conn,
                        PreparedStatement ps,
                        Object[] args,
                        Class<?>[] argTypes,
                        int beginIndex)

パラメータ:

conn - The connection for the database. (NotNull)

ps - The prepared statement for the SQL. (NotNull)

args - The arguments for binding. (NullAllowed)

argTypes - The types of arguments. (NullAllowed: if args is null, this is also null)

beginIndex - The index for beginning of binding.

findValueType

protected ValueType findValueType(Class<?> type,
                                  Object instance)

getArgTypes

protected Class<?>[] getArgTypes(Object[] args)

logSql

protected void logSql(Object[] args,
                      Class<?>[] argTypes)

processBeforeLogging

protected boolean processBeforeLogging(Object[] args,
                                       Class<?>[] argTypes,
                                       boolean logEnabled,
                                       boolean hasSqlFireHook,
                                       boolean hasSqlLog,
                                       boolean hasSqlResult,
                                       Object sqlLogRegistry)

doLogSql

protected void doLogSql(Object[] args,
                        Class<?>[] argTypes,
                        boolean logEnabled,
                        boolean hasSqlFireHook,
                        boolean hasSqlLog,
                        boolean hasSqlResult,
                        Object sqlLogRegistry)

logDisplaySql

protected void logDisplaySql(String displaySql)

isContainsLineSeparatorInSql

protected boolean isContainsLineSeparatorInSql(String displaySql)

buildDisplaySql

protected String buildDisplaySql(String sql,
                                 Object[] args)

getBindVariableText

protected String getBindVariableText(Object bindVariable)

createDisplaySqlBuilder

protected DisplaySqlBuilder createDisplaySqlBuilder()

getSpecifiedLogDateDisplayStyle

protected BoundDateDisplayStyle getSpecifiedLogDateDisplayStyle()

createResourcedLogDateDisplayStyle

protected BoundDateDisplayStyle createResourcedLogDateDisplayStyle()

newDisplaySqlBuilder

protected DisplaySqlBuilder newDisplaySqlBuilder(BoundDateDisplayStyle dateDisplayStyle)

getSqlFireHook

protected SqlFireHook getSqlFireHook()

hasSqlFireHook

protected boolean hasSqlFireHook()

saveHookSqlLogInfo

protected void saveHookSqlLogInfo(SqlLogInfo sqlLogInfo)

getSqlLogHander

protected SqlLogHandler getSqlLogHander()

hasSqlLogHandler

protected boolean hasSqlLogHandler()

prepareSqlLogInfo

protected SqlLogInfo prepareSqlLogInfo(Object[] args,
                                       Class<?>[] argTypes,
                                       String alreadyBuiltDisplaySql)

createSqlLogDisplaySqlBuilder

protected SqlLogInfo.SqlLogDisplaySqlBuilder createSqlLogDisplaySqlBuilder(String alreadyBuiltDisplaySql)

getSqlResultHander

protected SqlResultHandler getSqlResultHander()

hasSqlResultHandler

protected boolean hasSqlResultHandler()

saveResultSqlLogInfo

protected void saveResultSqlLogInfo(SqlLogInfo sqlLogInfo)

getSqlLogRegistry

protected Object getSqlLogRegistry()

pushToSqlLogRegistry

protected void pushToSqlLogRegistry(Object[] args,
                                    Class<?>[] argTypes,
                                    String firstDisplaySql,
                                    Object sqlLogRegistry)

handleSQLException

protected void handleSQLException(SQLException e,
                                  SQLExceptionResource resource)

createSQLExceptionHandler

protected SQLExceptionHandler createSQLExceptionHandler()

createSQLExceptionResource

protected SQLExceptionResource createSQLExceptionResource()

buildExceptionMessageSql

protected String buildExceptionMessageSql()

getConnection

protected Connection getConnection()

Get the database connection from data source.
getting connection for SQL executions is only here.
(for meta data is at TnBeanMetaDataFactoryImpl)

戻り値:

The new-created or inherited instance of connection. (NotNull)

getManualThreadDataSourceHandler

protected ManualThreadDataSourceHandler getManualThreadDataSourceHandler()

Get the data source handler of manual thread.

戻り値:

The instance of the data source handler. (NullAllowed: if null, no manual thread handling)

prepareStatement

protected PreparedStatement prepareStatement(Connection conn)

パラメータ:

conn - The instance of connection for the statement. (NotNull)

戻り値:

The new-created prepared statement. (NotNull)

prepareCall

protected CallableStatement prepareCall(Connection conn)

パラメータ:

conn - The instance of connection for the statement. (NotNull)

戻り値:

The new-created call-able statement. (NotNull)

createInheritedConnectionDataSource

protected HandlingDataSourceWrapper createInheritedConnectionDataSource(Connection conn)

Create the data source (wrapper) to inherit connection.

パラメータ:

conn - The instance of connection to be wrapped. (NotNull)

戻り値:

The new-created wrapper for data source handling. (NotNull)

executeQuery

protected ResultSet executeQuery(PreparedStatement ps)
                          throws SQLException

例外:

SQLException

executeUpdate

protected int executeUpdate(PreparedStatement ps)

getUpdateSQLFailureProcessTitle

protected String getUpdateSQLFailureProcessTitle()

executeBatch

protected int[] executeBatch(PreparedStatement ps,
                             List<?> list)

getBatchUpdateSQLFailureProcessTitle

protected String getBatchUpdateSQLFailureProcessTitle()

addBatch

protected void addBatch(PreparedStatement ps)

executeProcedure

protected boolean executeProcedure(CallableStatement cs)
                            throws SQLException

例外:

SQLException

isSaveMillis

protected boolean isSaveMillis()

saveBeforeSqlTimeMillis

protected void saveBeforeSqlTimeMillis()

saveAfterSqlTimeMillis

protected void saveAfterSqlTimeMillis()

hookSqlFireBefore

protected void hookSqlFireBefore()

hookSqlFireFinally

protected void hookSqlFireFinally(Object nativeResult,
                                  SQLException nativeCause)

setFetchSize

protected void setFetchSize(Statement st,
                            int fetchSize)

setMaxRows

protected void setMaxRows(Statement st,
                          int maxRows)

close

protected void close(Statement st)

close

protected void close(ResultSet resultSet)

close

protected void close(Connection conn)

isLogEnabled

protected boolean isLogEnabled()

log

protected void log(String msg)

isInternalDebugEnabled

protected boolean isInternalDebugEnabled()

assertObjectNotNull

protected void assertObjectNotNull(String variableName,
                                   Object value)

ln

protected String ln()

systemTime

protected long systemTime()

setExceptionMessageSqlArgs

public void setExceptionMessageSqlArgs(Object[] exceptionMessageSqlArgs)