org.dbflute.outsidesql

インタフェース OutsideSqlFilter

public interface OutsideSqlFilter

The filter call-back for outside-SQL.

導入されたバージョン:

0.9.7.6 (2010/11/24 Wednesday)

作成者:

jflute

ネストされたクラスのサマリー

ネストされたクラス

修飾子とタイプ	インタフェースと説明
static class	OutsideSqlFilter.ExecutionFilterType The type of execution filter.

メソッドのサマリー

修飾子とタイプ	メソッドと説明
String	filterExecution(String executedSql, OutsideSqlFilter.ExecutionFilterType filterType) Filter the outside-SQL immediately before execution.
String	filterReading(String readSql) Filter the outside-SQL immediately after reading a SQL file.

メソッドの詳細

filterExecution

String filterExecution(String executedSql,
                       OutsideSqlFilter.ExecutionFilterType filterType)

Filter the outside-SQL immediately before execution. (for user customization)
This filter is executed immediately before execution. (but removing comments and formatting options are after the filter)
And whether a procedure's SQL is contained or not is determined by containsProcedure().

パラメータ:

executedSql - The string of executed outside-SQL already resolved parameter comments. (NotNull)

filterType - The type of execution filter. (NotNull)

戻り値:

The filtered SQL that is executed by JDBC directly. (NotNull)

filterReading

String filterReading(String readSql)

Filter the outside-SQL immediately after reading a SQL file. (for user customization)
This filter is executed immediately after reading. (but removing UTF-8 BOM and adjusting bind mark on comment are before the filter)

パラメータ:

readSql - The string of read outside-SQL still remained parameter comments. (NotNull)

戻り値:

The filtered SQL that is executed by JDBC directly. (NotNull)