nablarch.common.dao

インタフェース DaoContext

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

UniversalDaoの実行コンテキスト。

ページネーションのためのページ数などを状態としてもつ必要があるので、 このコンテキストを介してSQLの実行処理が行われる。

作成者:

kawasima, Hisaaki Shioiri

メソッドのサマリー

修飾子とタイプ	メソッドと説明
<T> void	batchDelete(List<T> entities) エンティティオブジェクトを元に一括削除処理を行う。
<T> void	batchInsert(List<T> entities) エンティティオブジェクトの情報を一括で登録する。
<T> void	batchUpdate(List<T> entities) エンティティオブジェクトの情報を元に一括更新を行う。
<T> long	countBySqlFile(Class<T> entityClass, String sqlId, Object params) SQL_IDをもとに結果件数を取得する。
DaoContext	defer() 検索結果の取得を遅延させる。
<T> int	delete(T entity) エンティティオブジェクトを元に削除処理を行う。
<T> EntityList<T>	findAll(Class<T> entityClass) 全件の検索を行う。
<T> EntityList<T>	findAllBySqlFile(Class<T> entityClass, String sqlId) SQL_IDをもとに検索を行う。
<T> EntityList<T>	findAllBySqlFile(Class<T> entityClass, String sqlId, Object params) SQL_IDをもとにバインド変数を展開して検索処理を行う。
<T> T	findById(Class<T> entityClass, Object... id) プライマリーキーによる検索を行う。
<T> T	findBySqlFile(Class<T> entityClass, String sqlId, Object params) SQL_IDをもとに1件検索を行う。
<T> void	insert(T entity) エンティティオブジェクトを元に登録処理を行う。
DaoContext	page(long page) ページングの何ページ目を検索するかを指定する。
DaoContext	per(long per) ページングの1ページにつき何件表示するかを指定する。
<T> int	update(T entity) エンティティオブジェクトを元に更新処理を行う。

メソッドの詳細

findById

<T> T findById(Class<T> entityClass,
               Object... id)

プライマリーキーによる検索を行う。

型パラメータ:

T - エンティティクラスの型

パラメータ:

entityClass - エンティティクラス

id - プライマリーキー (複合キーの場合は定義順)

戻り値:

エンティティオブジェクト

findAll

@Published
<T> EntityList<T> findAll(Class<T> entityClass)

全件の検索を行う。

型パラメータ:

T - エンティティクラスの型

パラメータ:

entityClass - エンティティクラス

戻り値:

検索結果リスト。0件の場合は空リスト。

findAllBySqlFile

@Published
<T> EntityList<T> findAllBySqlFile(Class<T> entityClass,
                                              String sqlId,
                                              Object params)

SQL_IDをもとにバインド変数を展開して検索処理を行う。

型パラメータ:

T - 検索結果をマッピングするBeanクラスの型

パラメータ:

entityClass - 検索結果をマッピングするBeanクラス

sqlId - SQL_ID

params - バインド変数

戻り値:

検索結果リスト。0件の場合は空リスト。

findAllBySqlFile

@Published
<T> EntityList<T> findAllBySqlFile(Class<T> entityClass,
                                              String sqlId)

SQL_IDをもとに検索を行う。

型パラメータ:

T - 検索結果をマッピングするBeanクラスの型

パラメータ:

entityClass - 検索結果をマッピングするBeanクラス

sqlId - SQL_ID

戻り値:

検索結果リスト。0件の場合は空リスト。

findBySqlFile

<T> T findBySqlFile(Class<T> entityClass,
                    String sqlId,
                    Object params)

SQL_IDをもとに1件検索を行う。

型パラメータ:

T - 検索結果をマッピングするBeanクラスの型

パラメータ:

entityClass - 検索結果をマッピングするBeanクラス

sqlId - SQL_ID

params - バインド変数

戻り値:

エンティティオブジェクト

countBySqlFile

<T> long countBySqlFile(Class<T> entityClass,
                        String sqlId,
                        Object params)

SQL_IDをもとに結果件数を取得する。

型パラメータ:

T - エンティティクラスの型

パラメータ:

entityClass - エンティティクラス

sqlId - SQL_ID

params - バインド変数

戻り値:

件数

update

<T> int update(T entity)

エンティティオブジェクトを元に更新処理を行う。

エンティティの主キーが更新条件となる。

型パラメータ:

T - エンティティクラスの型

パラメータ:

entity - エンティティオブジェクト

戻り値:

更新件数

例外:

javax.persistence.OptimisticLockException - バージョン不一致で更新対象が存在しない場合

batchUpdate

<T> void batchUpdate(List<T> entities)

エンティティオブジェクトの情報を元に一括更新を行う。

DaoContext.update(Object)とは異なり、一括更新処理ではバージョン不一致チェックは行わない。 例えば、バージョン番号が変更になっていた場合はそのレコードのみ更新されずに処理は正常に終了する。 バージョン番号のチェックを必要とする場合には、DaoContext.update(Object)を使用すること。

型パラメータ:

T - エンティティクラスの型

パラメータ:

entities - 更新対象のエンティティリスト

insert

<T> void insert(T entity)

エンティティオブジェクトを元に登録処理を行う。

型パラメータ:

T - エンティティクラスの型

パラメータ:

entity - エンティティオブジェクト

batchInsert

<T> void batchInsert(List<T> entities)

エンティティオブジェクトの情報を一括で登録する。

型パラメータ:

T - エンティティクラスの型

パラメータ:

entities - エンティティリスト

delete

<T> int delete(T entity)

エンティティオブジェクトを元に削除処理を行う。

エンティティの主キーが削除条件となる。

型パラメータ:

T - エンティティクラスの型

パラメータ:

entity - エンティティオブジェクト

戻り値:

削除件数

batchDelete

<T> void batchDelete(List<T> entities)

エンティティオブジェクトを元に一括削除処理を行う。

エンティティの主キーが削除条件となる。

型パラメータ:

T - エンティティクラスの型

パラメータ:

entities - エンティティリスト

page

DaoContext page(long page)

ページングの何ページ目を検索するかを指定する。

パラメータ:

page - ページ番号(1-origin)

戻り値:

DaoContextがそのまま返る。

per

DaoContext per(long per)

ページングの1ページにつき何件表示するかを指定する。

パラメータ:

per - ページ内表示件数

戻り値:

DaoContextがそのまま返る。

defer

DaoContext defer()

検索結果の取得を遅延させる。

戻り値:

DaoContextがそのまま返る。