org.seasar.doma.jdbc

Interface Sql<P extends SqlParameter>

Type Parameters:

P - the parameter type

All Known Implementing Classes:

AbstractSql, CallableSql, EmptySql, PreparedSql, ScriptCommand.ScriptSql

public interface Sql<P extends SqlParameter>

An SQL.

The implementation class is not required to be thread safe.

Method Summary

Modifier and Type	Method and Description
java.lang.String	getFormattedSql() Returns the formatted SQL string.
SqlKind	getKind() Returns the kind of the SQL.
java.util.List<P>	getParameters() Returns the parameter list.
java.lang.String	getRawSql() Returns the raw SQL string.
java.lang.String	getSqlFilePath() Returns the file path that contains this SQL.
SqlLogType	getSqlLogType() Returns the type of the SQL log.

Method Detail

getKind

SqlKind getKind()

Returns the kind of the SQL.

Returns:

the kind of the SQL

getRawSql

java.lang.String getRawSql()

Returns the raw SQL string.

The bind variables are displayed as ?.

Returns:

the raw SQL string

getFormattedSql

java.lang.String getFormattedSql()

Returns the formatted SQL string.

The bind variables are replaced with the string representations of the parameters.

Returns:

the formatted SQL string

getSqlFilePath

java.lang.String getSqlFilePath()

Returns the file path that contains this SQL.

Returns:

the file path that contains this SQL、or null if this SQL is auto-generated

getParameters

java.util.List<P> getParameters()

Returns the parameter list.

Returns:

the parameter list

getSqlLogType

SqlLogType getSqlLogType()

Returns the type of the SQL log.

Returns:

the type of the SQL log