nablarch.core.db.dialect

インタフェース Dialect

既知の実装クラスのリスト:

DB2Dialect, DefaultDialect, H2Dialect, OracleDialect, PostgreSQLDialect, SqlServerDialect

@Published(tag="architect")
public interface Dialect

データベースの実装依存の方言を吸収するためのインタフェース。

メソッドのサマリー

修飾子とタイプ	メソッドと説明
java.lang.String	buildSequenceGeneratorSql(java.lang.String sequenceName) シーケンスオブジェクトの次の値を取得するSQL文を構築する。
java.lang.String	convertCountSql(java.lang.String sql) SQL文をレコード数取得用のSQL文に変換する。
<T> T	convertFromDatabase(java.lang.Object value, java.lang.Class<T> javaType) データベースから入力(取得した値)を変換する。
java.lang.String	convertPaginationSql(java.lang.String sql, SelectOption selectOption) SQL文をページング用のSQL文に変換する。
java.lang.Object	convertToDatabase(java.lang.Object value, int sqlType) SQL型をもとにデータベースに出力する値に変換する。
<T,DB> DB	convertToDatabase(T value, java.lang.Class<DB> dbType) データベースに出力する値に変換する。
java.lang.String	getPingSql() ping用のSQL文を返す。
ResultSetConvertor	getResultSetConvertor() ResultSetから値を取得するための変換クラスを返却する。
boolean	isDuplicateException(java.sql.SQLException sqlException) SQL例外が一意制約違反による例外か否か。
boolean	isTransactionTimeoutError(java.sql.SQLException sqlException) SQL例外がトランザクションタイムアウトと判断すべき例外か否か。
boolean	supportsIdentity() IDENTITY(オートインクリメントカラム)が使用できるか否か。
boolean	supportsOffset() SQL文でのオフセット指定が使用できるか否か
boolean	supportsSequence() SEQUENCEが使用できるか否か。

メソッドの詳細

supportsIdentity

boolean supportsIdentity()

IDENTITY(オートインクリメントカラム)が使用できるか否か。

戻り値:

使用可能な場合は、 true

supportsSequence

boolean supportsSequence()

SEQUENCEが使用できるか否か。

戻り値:

使用可能な場合は、 true

supportsOffset

boolean supportsOffset()

SQL文でのオフセット指定が使用できるか否か

戻り値:

使用可能な場合は、true

isTransactionTimeoutError

boolean isTransactionTimeoutError(java.sql.SQLException sqlException)

SQL例外がトランザクションタイムアウトと判断すべき例外か否か。

パラメータ:

sqlException - SQL例外

戻り値:

トランザクションタイムアウトと判断すべき場合true

isDuplicateException

boolean isDuplicateException(java.sql.SQLException sqlException)

SQL例外が一意制約違反による例外か否か。

パラメータ:

sqlException - SQL例外

戻り値:

SQL例外が一意制約違反の場合true

getResultSetConvertor

ResultSetConvertor getResultSetConvertor()

ResultSetから値を取得するための変換クラスを返却する。

戻り値:

変換クラス。

buildSequenceGeneratorSql

java.lang.String buildSequenceGeneratorSql(java.lang.String sequenceName)

シーケンスオブジェクトの次の値を取得するSQL文を構築する。

パラメータ:

sequenceName - シーケンス名

戻り値:

シーケンスオブジェクトの次の値を取得するSQL文

convertPaginationSql

java.lang.String convertPaginationSql(java.lang.String sql,
                                      SelectOption selectOption)

SQL文をページング用のSQL文に変換する。

パラメータ:

sql - SQL文

selectOption - 検索時のオプション

戻り値:

変換したSQL文

convertCountSql

java.lang.String convertCountSql(java.lang.String sql)

SQL文をレコード数取得用のSQL文に変換する。

パラメータ:

sql - SQL文

戻り値:

変換したSQL文

getPingSql

java.lang.String getPingSql()

ping用のSQL文を返す。

データベースへの死活チェックを行うための、ping用SQL文を生成する。

戻り値:

ping用のSQL文

convertToDatabase

java.lang.Object convertToDatabase(java.lang.Object value,
                                   int sqlType)

SQL型をもとにデータベースに出力する値に変換する。

パラメータ:

value - 出力する値

sqlType - SQL型

戻り値:

変換後の値

convertToDatabase

<T,DB> DB convertToDatabase(T value,
                            java.lang.Class<DB> dbType)

データベースに出力する値に変換する。

型パラメータ:

T - 出力する値の型

DB - データベースに出力する型

パラメータ:

value - 出力する値

dbType - データベースの型に対応したクラス

戻り値:

変換後の値

convertFromDatabase

<T> T convertFromDatabase(java.lang.Object value,
                          java.lang.Class<T> javaType)

データベースから入力(取得した値)を変換する。

型パラメータ:

T - 変換後の型

パラメータ:

value - 変換する値

javaType - 変換後のクラス

戻り値:

変換後の値