nablarch.core.db.support

Class DbAccessSupport

java.lang.Object

nablarch.core.db.support.DbAccessSupport

Direct Known Subclasses:

BatchActionBase, MessagingAction

@Published
public class DbAccessSupport
extends java.lang.Object

クラスパス上のSQLが記述されたリソースファイル(SQLリソース)から、 実行可能なSQLステートメントを取得するサポートクラス。

Author:

hisaaki sioiri

Constructor Summary

Constructors

Constructor and Description
DbAccessSupport() コンストラクタ。 現在のインスタンスクラス名からSQLリソースを導出する。
DbAccessSupport(java.lang.Class<?> clazz) コンストラクタ。 指定されたクラスオブジェクトのクラス名からSQLリソースを導出する。 下記のように呼び出しを行う。

Method Summary

Modifier and Type	Method and Description
int	countByParameterizedSql(java.lang.String sqlId, java.lang.Object condition) 指定されたSQL_IDと条件から件数取得(カウント)用のSQL文を生成して実行する。
int	countByStatementSql(java.lang.String sqlId) 指定されたSQL_IDから件数取得（カウント）用のSQL文を生成して実行する。 本メソッドは、外部から条件を指定する必要のないSQL文の場合に使用する。 条件を指定する必要がある場合には、DbAccessSupport.countByParameterizedSql(String, Object)を使用すること。
ParameterizedSqlPStatement	getParameterizedSqlStatement(java.lang.String sqlId) 指定されたSQL_IDからParameterizedSqlPStatementを生成する。
ParameterizedSqlPStatement	getParameterizedSqlStatement(java.lang.String sqlId, java.lang.Object condition) 指定されたSQL_IDと条件からParameterizedSqlPStatementを生成する。
nablarch.core.db.statement.SqlCStatement	getSqlCStatement(java.lang.String sqlId) 指定されたSQL_IDからSqlCStatementを生成する。
SqlPStatement	getSqlPStatement(java.lang.String sqlId) 指定されたSQL_IDからSqlPStatementを生成する。
SqlResultSet	search(java.lang.String sqlId, ListSearchInfo condition) 指定されたSQL_IDとListSearchInfoから件数取得及び検索を実行する。 検索結果の件数は、指定されたListSearchInfoオブジェクトに設定する。

Constructor Detail

DbAccessSupport

public DbAccessSupport()

コンストラクタ。 現在のインスタンスクラス名からSQLリソースを導出する。

DbAccessSupport

public DbAccessSupport(java.lang.Class<?> clazz)

コンストラクタ。 指定されたクラスオブジェクトのクラス名からSQLリソースを導出する。

下記のように呼び出しを行う。

 DbAccessSupport dbSupport = new DbAccessSupport(getClass());
 

Parameters:

clazz - DBアクセス処理を行うクラスノクラスオブジェクト

Method Detail

getParameterizedSqlStatement

public final ParameterizedSqlPStatement getParameterizedSqlStatement(java.lang.String sqlId)

指定されたSQL_IDからParameterizedSqlPStatementを生成する。

Parameters:

sqlId - SQL_ID

Returns:

生成した ParameterizedSqlPStatement

getParameterizedSqlStatement

public final ParameterizedSqlPStatement getParameterizedSqlStatement(java.lang.String sqlId,
                                                                     java.lang.Object condition)

指定されたSQL_IDと条件からParameterizedSqlPStatementを生成する。

Parameters:

sqlId - SQL_ID

condition - 条件をもつオブジェクト

Returns:

生成した ParameterizedSqlPStatement

getSqlPStatement

public final SqlPStatement getSqlPStatement(java.lang.String sqlId)

指定されたSQL_IDからSqlPStatementを生成する。

Parameters:

sqlId - SQL_ID

Returns:

生成したSqlPStatement

countByStatementSql

public final int countByStatementSql(java.lang.String sqlId)

指定されたSQL_IDから件数取得（カウント）用のSQL文を生成して実行する。 本メソッドは、外部から条件を指定する必要のないSQL文の場合に使用する。 条件を指定する必要がある場合には、DbAccessSupport.countByParameterizedSql(String, Object)を使用すること。

Parameters:

sqlId - SQL_ID

Returns:

件数

countByParameterizedSql

public final int countByParameterizedSql(java.lang.String sqlId,
                                         java.lang.Object condition)

指定されたSQL_IDと条件から件数取得(カウント)用のSQL文を生成して実行する。

Parameters:

sqlId - SQL_ID

condition - 条件をもつオブジェクト

Returns:

件数

search

public final SqlResultSet search(java.lang.String sqlId,
                                 ListSearchInfo condition)
                          throws TooManyResultException

指定されたSQL_IDとListSearchInfoから件数取得及び検索を実行する。 検索結果の件数は、指定されたListSearchInfoオブジェクトに設定する。

Parameters:

sqlId - SQL_ID

condition - ListSearchInfoオブジェクト

Returns:

検索結果

Throws:

TooManyResultException - ページング付きの検索において検索結果件数が検索結果の最大件数(上限)を超えた場合。 検索結果の最大件数(上限)の設定については、ListSearchInfo.ListSearchInfo()を参照。

getSqlCStatement

public final nablarch.core.db.statement.SqlCStatement getSqlCStatement(java.lang.String sqlId)

指定されたSQL_IDからSqlCStatementを生成する。

Parameters:

sqlId - SQL_ID

Returns:

ステートメント