Package nablarch.core.db.statement

Class SqlLogFormatter

java.lang.Object

nablarch.core.db.statement.SqlLogFormatter

Direct Known Subclasses:

SqlJsonLogFormatter

@Published(tag="architect")
public class SqlLogFormatter
extends Object

SQLログを出力するクラス。

Author:

Kiyohito Itoh

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	SqlLogFormatter.AdditionalInfoItem	付加情報を取得するクラス。
static class	SqlLogFormatter.BatchCountItem	バッチ件数を取得するクラス。
static class	SqlLogFormatter.CountItem	検索件数を取得するクラス。
static class	SqlLogFormatter.ExecuteTimeItem	実行時間を取得するクラス。
static class	SqlLogFormatter.FetchSizeItem	フェッチ件数を取得するクラス。
static class	SqlLogFormatter.MethodNameItem	メソッド名を取得するクラス。
static class	SqlLogFormatter.QueryTimeoutItem	タイムアウト時間を取得するクラス。
static class	SqlLogFormatter.RetrieveTimeItem	データ取得時間を取得するクラス。
static class	SqlLogFormatter.SizeItem	最大取得件数を取得するクラス。
static class	SqlLogFormatter.SqlItem	SQL文を取得するクラス。
static class	SqlLogFormatter.SqlLogContext	SQLログのコンテキスト情報を保持するクラス。
static class	SqlLogFormatter.StartPositionItem	取得開始位置を取得するクラス。
static class	SqlLogFormatter.UpdateCountItem	更新件数を取得するクラス。

Field Summary

Fields

Modifier and Type	Field	Description
static final String	PROPS_PREFIX	プロパティ名のプレフィックス

Constructor Summary

Constructors

Constructor	Description
SqlLogFormatter()	フォーマット済みのログ出力項目を初期化する。

Method Summary

Modifier and Type	Method	Description
String	endExecute(String methodName, long executeTime)	SqlPStatement#executeメソッドの実行終了時のSQLログをフォーマットする。
String	endExecuteBatch(String methodName, long executeTime, int batchCount)	SqlPStatement#executeBatchメソッドの更新終了時のSQLログをフォーマットする。
String	endExecuteQuery(String methodName, long executeTime)	SqlPStatement#executeQueryメソッドの検索終了時のSQLログをフォーマットする。
String	endExecuteUpdate(String methodName, long executeTime, int updateCount)	SqlPStatement#executeUpdateメソッドの更新終了時のSQLログをフォーマットする。
String	endRetrieve(String methodName, long executeTime, long retrieveTime, int count)	SqlPStatement#retrieveメソッドの検索終了時のSQLログをフォーマットする。
protected LogItem<SqlLogFormatter.SqlLogContext>[]	getFormattedLogItems(Map<String,LogItem<SqlLogFormatter.SqlLogContext>> logItems, Map<String,String> props, String formatPropName, String defaultFormat)	フォーマット済みのログ出力項目を取得する。
protected Map<String,LogItem<SqlLogFormatter.SqlLogContext>>	getLogItems()	フォーマット対象のログ出力項目を取得する。
protected void	initialize(Map<String,String> props)	初期化
String	startExecute(String methodName, String sql, String additionalInfo)	SqlPStatement#executeメソッドの実行開始時のSQLログをフォーマットする。
String	startExecuteBatch(String methodName, String sql, String additionalInfo)	SqlPStatement#executeBatchメソッドの更新開始時のSQLログをフォーマットする。
String	startExecuteQuery(String methodName, String sql, String additionalInfo)	SqlPStatement#executeQueryメソッドの検索開始時のSQLログをフォーマットする。
String	startExecuteUpdate(String methodName, String sql, String additionalInfo)	SqlPStatement#executeUpdateメソッドの更新開始時のSQLログをフォーマットする。
String	startRetrieve(String methodName, String sql, int startPosition, int size, int queryTimeout, int fetchSize, String additionalInfo)	SqlPStatement#retrieveメソッドの検索開始時のSQLログをフォーマットする。

Methods inherited from class java.lang.Object

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

Field Details

PROPS_PREFIX

public static final String PROPS_PREFIX

プロパティ名のプレフィックス

See Also:

• Constant Field Values

Constructor Details

SqlLogFormatter

public SqlLogFormatter()

フォーマット済みのログ出力項目を初期化する。

Method Details

initialize

protected void initialize(Map<String,String> props)

初期化

Parameters:

props - 各種ログの設定情報

getFormattedLogItems

protected LogItem<SqlLogFormatter.SqlLogContext>[] getFormattedLogItems(Map<String,LogItem<SqlLogFormatter.SqlLogContext>> logItems,
 Map<String,String> props,
 String formatPropName,
 String defaultFormat)

フォーマット済みのログ出力項目を取得する。

Parameters:

logItems - フォーマット対象のログ出力項目

props - 各種ログ出力の設定情報

formatPropName - フォーマットのプロパティ名

defaultFormat - デフォルトのフォーマット

Returns:

フォーマット済みのログ出力項目

getLogItems

protected Map<String,LogItem<SqlLogFormatter.SqlLogContext>> getLogItems()

フォーマット対象のログ出力項目を取得する。

Returns:

フォーマット対象のログ出力項目

startRetrieve

public String startRetrieve(String methodName,
 String sql,
 int startPosition,
 int size,
 int queryTimeout,
 int fetchSize,
 String additionalInfo)

SqlPStatement#retrieveメソッドの検索開始時のSQLログをフォーマットする。

Parameters:

methodName - メソッド名 メソッド名

sql - SQL文 SQL文

startPosition - 取得開始位置

size - 取得最大件数

queryTimeout - タイムアウト時間

fetchSize - フェッチする行数

additionalInfo - 付加情報 付加情報

Returns:

フォーマット済みのメッセージ

endRetrieve

public String endRetrieve(String methodName,
 long executeTime,
 long retrieveTime,
 int count)

SqlPStatement#retrieveメソッドの検索終了時のSQLログをフォーマットする。

Parameters:

methodName - メソッド名 メソッド名

executeTime - 実行時間

retrieveTime - データ取得時間

count - 検索件数

Returns:

フォーマット済みのメッセージ

startExecuteQuery

public String startExecuteQuery(String methodName,
 String sql,
 String additionalInfo)

SqlPStatement#executeQueryメソッドの検索開始時のSQLログをフォーマットする。

Parameters:

methodName - メソッド名 メソッド名

sql - SQL文

additionalInfo - 付加情報

Returns:

フォーマット済みメッセージ

endExecuteQuery

public String endExecuteQuery(String methodName,
 long executeTime)

SqlPStatement#executeQueryメソッドの検索終了時のSQLログをフォーマットする。

Parameters:

methodName - メソッド名 メソッド名

executeTime - 実行時間

Returns:

フォーマット済みメッセージ

startExecuteUpdate

public String startExecuteUpdate(String methodName,
 String sql,
 String additionalInfo)

SqlPStatement#executeUpdateメソッドの更新開始時のSQLログをフォーマットする。

Parameters:

methodName - メソッド名 メソッド名

sql - SQL文

additionalInfo - 付加情報

Returns:

フォーマット済みメッセージ

endExecuteUpdate

public String endExecuteUpdate(String methodName,
 long executeTime,
 int updateCount)

SqlPStatement#executeUpdateメソッドの更新終了時のSQLログをフォーマットする。

Parameters:

methodName - メソッド名 メソッド名

executeTime - 実行時間

updateCount - 更新件数

Returns:

フォーマット済みメッセージ

startExecute

public String startExecute(String methodName,
 String sql,
 String additionalInfo)

SqlPStatement#executeメソッドの実行開始時のSQLログをフォーマットする。

Parameters:

methodName - メソッド名 メソッド名

sql - SQL文

additionalInfo - 付加情報

Returns:

フォーマット済みメッセージ

endExecute

public String endExecute(String methodName,
 long executeTime)

SqlPStatement#executeメソッドの実行終了時のSQLログをフォーマットする。

Parameters:

methodName - メソッド名 メソッド名

executeTime - 実行時間

Returns:

フォーマット済みメッセージ

startExecuteBatch

public String startExecuteBatch(String methodName,
 String sql,
 String additionalInfo)

SqlPStatement#executeBatchメソッドの更新開始時のSQLログをフォーマットする。

Parameters:

methodName - メソッド名

sql - SQL文

additionalInfo - 付加情報

Returns:

フォーマット済みメッセージ

endExecuteBatch

public String endExecuteBatch(String methodName,
 long executeTime,
 int batchCount)

SqlPStatement#executeBatchメソッドの更新終了時のSQLログをフォーマットする。

Parameters:

methodName - メソッド名

executeTime - 実行時間

batchCount - バッチ件数

Returns:

フォーマット済みメッセージ