BasicDaoContext (Nablarch-API)

java.lang.Object
- nablarch.common.dao.BasicDaoContext

すべての実装されたインタフェース:

DaoContext
```
public class BasicDaoContext
extends java.lang.Object
implements DaoContext
```
DaoContextのデフォルト実装クラス。

メソッドのサマリー

すべてのメソッドインスタンス・メソッド concreteメソッド
修飾子とタイプ	メソッドと説明
`<T> void`	`batchDelete(java.util.List<T> entities)` エンティティオブジェクトを元に一括削除処理を行う。
`<T> void`	`batchInsert(java.util.List<T> entities)` エンティティオブジェクトの情報を一括で登録する。
`<T> void`	`batchUpdate(java.util.List<T> entities)` エンティティオブジェクトの情報を元に一括更新を行う。
`<T> long`	`countBySqlFile(java.lang.Class<T> entityClass, java.lang.String sqlId, java.lang.Object params)` SQL_IDをもとに結果件数を取得する。
`DaoContext`	`defer()` 検索結果の取得を遅延させる。
`<T> int`	`delete(T entity)` エンティティオブジェクトを元に削除処理を行う。
`protected nablarch.common.dao.SqlResourceHolder`	`executeQuery(java.lang.String normalizedSqlId, java.lang.Object params, SelectOption selectOption)` 検索クエリを実行する。
`<T> EntityList<T>`	`findAll(java.lang.Class<T> entityClass)` 全件の検索を行う。
`<T> EntityList<T>`	`findAllBySqlFile(java.lang.Class<T> entityClass, java.lang.String sqlId)` SQL_IDをもとに検索を行う。
`<T> EntityList<T>`	`findAllBySqlFile(java.lang.Class<T> entityClass, java.lang.String sqlId, java.lang.Object params)` SQL_IDをもとにバインド変数を展開して検索処理を行う。
`protected <T> EntityList<T>`	`findAllBySqlFileWithoutPaginate(java.lang.Class<T> entityClass, java.lang.String sqlId, java.lang.Object params)` ページングなしの場合の検索を実行する。
`protected <T> EntityList<T>`	`findAllBySqlFIleWithPaginate(java.lang.Class<T> entityClass, java.lang.String sqlId, java.lang.Object params)` ページネーションつきの検索を実行する。
`<T> T`	`findById(java.lang.Class<T> entityClass, java.lang.Object... id)` プライマリーキーによる検索を行う。
`<T> T`	`findBySqlFile(java.lang.Class<T> entityClass, java.lang.String sqlId, java.lang.Object params)` SQL_IDをもとに検索処理を行いEntityを取得する。
`<T> void`	`insert(T entity)` エンティティオブジェクトを元に登録処理を行う。
`protected <T> java.lang.String`	`normalizeSqlId(java.lang.String sqlId, java.lang.Class<T> entityClass)` SQL_IDにファイル名がついてない場合は、Entityクラスの完全修飾名を付加する。
`DaoContext`	`page(long page)` ページングの何ページ目を検索するかを指定する。
`DaoContext`	`per(long per)` ページングの1ページにつき何件表示するかを指定する。
`protected void`	`setDbConnection(AppDbConnection dbConnection)` 使用するデータベースコネクションを設定する。
`protected void`	`setIdGenerator(javax.persistence.GenerationType type, IdGenerator generator)` IDジェネレータを設定する。
`<T> java.lang.String`	`tableName(T entity)` エンティティクラス名からテーブル名へ変換する。
`<T> int`	`update(T entity)` エンティティオブジェクトを元に更新処理を行う。

クラスから継承されたメソッド java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- メソッドの詳細
  - findById
```
public <T> T findById(java.lang.Class<T> entityClass,
                      java.lang.Object... id)
```
    プライマリーキーによる検索を行う。
    この実装では、プライマリーキーのメタデータをDatabaseMetaDataから取得する。それに失敗した場合にこのメソッドを呼ぶと、IllegalStateExceptionを送出する。
    
    定義:
    
    findById インタフェース内 DaoContext
    
    型パラメータ:
    
    T - エンティティクラスの型
    
    パラメータ:
    
    entityClass - エンティティクラス
    
    id - プライマリーキー (複合キーの場合は定義順)
    
    戻り値:
    
    エンティティオブジェクト
  - findAll
```
public <T> EntityList<T> findAll(java.lang.Class<T> entityClass)
```
    インタフェースからコピーされた説明: DaoContext
    
    全件の検索を行う。
    
    定義:
    
    findAll インタフェース内 DaoContext
    
    型パラメータ:
    
    T - エンティティクラスの型
    
    パラメータ:
    
    entityClass - エンティティクラス
    
    戻り値:
    
    検索結果リスト。0件の場合は空リスト。
  - findAllBySqlFile
```
public <T> EntityList<T> findAllBySqlFile(java.lang.Class<T> entityClass,
                                          java.lang.String sqlId,
                                          java.lang.Object params)
```
    インタフェースからコピーされた説明: DaoContext
    
    SQL_IDをもとにバインド変数を展開して検索処理を行う。
    
    定義:
    
    findAllBySqlFile インタフェース内 DaoContext
    
    型パラメータ:
    
    T - 検索結果をマッピングするBeanクラスの型
    
    パラメータ:
    
    entityClass - 検索結果をマッピングするBeanクラス
    
    sqlId - SQL_ID
    
    params - バインド変数
    
    戻り値:
    
    検索結果リスト。0件の場合は空リスト。
  - findAllBySqlFile
```
public <T> EntityList<T> findAllBySqlFile(java.lang.Class<T> entityClass,
                                          java.lang.String sqlId)
```
    インタフェースからコピーされた説明: DaoContext
    
    SQL_IDをもとに検索を行う。
    
    定義:
    
    findAllBySqlFile インタフェース内 DaoContext
    
    型パラメータ:
    
    T - 検索結果をマッピングするBeanクラスの型
    
    パラメータ:
    
    entityClass - 検索結果をマッピングするBeanクラス
    
    sqlId - SQL_ID
    
    戻り値:
    
    検索結果リスト。0件の場合は空リスト。
  - executeQuery
```
protected nablarch.common.dao.SqlResourceHolder executeQuery(java.lang.String normalizedSqlId,
                                                             java.lang.Object params,
                                                             SelectOption selectOption)
```
    検索クエリを実行する。
    
    パラメータ:
    
    normalizedSqlId - SQL ID
    
    params - バインド変数
    
    selectOption - 検索オプション
    
    戻り値:
    
    検索結果
  - findAllBySqlFileWithoutPaginate
```
protected <T> EntityList<T> findAllBySqlFileWithoutPaginate(java.lang.Class<T> entityClass,
                                                            java.lang.String sqlId,
                                                            java.lang.Object params)
```
    ページングなしの場合の検索を実行する。
    
    型パラメータ:
    
    T - エンティティクラス
    
    パラメータ:
    
    entityClass - エンティティクラス
    
    sqlId - SQL ID
    
    params - バインド変数
    
    戻り値:
    
    エンティティクラスのリスト
  - findAllBySqlFIleWithPaginate
```
protected <T> EntityList<T> findAllBySqlFIleWithPaginate(java.lang.Class<T> entityClass,
                                                         java.lang.String sqlId,
                                                         java.lang.Object params)
```
    ページネーションつきの検索を実行する。
    遅延ロード(deferがtrueの場合)、IllegalArgumentExceptionを送出する。
    
    型パラメータ:
    
    T - エンティティクラス
    
    パラメータ:
    
    entityClass - エンティティクラス
    
    sqlId - SQL ID
    
    params - バインド変数
    
    戻り値:
    
    エンティティリストを返します。
  - findBySqlFile
```
public <T> T findBySqlFile(java.lang.Class<T> entityClass,
                           java.lang.String sqlId,
                           java.lang.Object params)
```
    SQL_IDをもとに検索処理を行いEntityを取得する。
    
    定義:
    
    findBySqlFile インタフェース内 DaoContext
    
    型パラメータ:
    
    T - 総称型
    
    パラメータ:
    
    entityClass - エンティティクラス
    
    sqlId - SQL_ID
    
    params - バインド変数
    
    戻り値:
    
    1件のEntity。見つからない場合はNoDataExceptionを送出する。
  - countBySqlFile
```
public <T> long countBySqlFile(java.lang.Class<T> entityClass,
                               java.lang.String sqlId,
                               java.lang.Object params)
```
    インタフェースからコピーされた説明: DaoContext
    
    SQL_IDをもとに結果件数を取得する。
    
    定義:
    
    countBySqlFile インタフェース内 DaoContext
    
    型パラメータ:
    
    T - エンティティクラスの型
    
    パラメータ:
    
    entityClass - エンティティクラス
    
    sqlId - SQL_ID
    
    params - バインド変数
    
    戻り値:
    
    件数
  - update
```
public <T> int update(T entity)
               throws javax.persistence.OptimisticLockException
```
    インタフェースからコピーされた説明: DaoContext
    
    エンティティオブジェクトを元に更新処理を行う。
    エンティティの主キーが更新条件となる。
    
    定義:
    
    update インタフェース内 DaoContext
    
    型パラメータ:
    
    T - エンティティクラスの型
    
    パラメータ:
    
    entity - エンティティオブジェクト
    
    戻り値:
    
    更新件数
    
    例外:
    
    javax.persistence.OptimisticLockException - バージョン不一致で更新対象が存在しない場合
  - batchUpdate
```
public <T> void batchUpdate(java.util.List<T> entities)
```
    インタフェースからコピーされた説明: DaoContext
    
    エンティティオブジェクトの情報を元に一括更新を行う。
    DaoContext.update(Object)とは異なり、一括更新処理ではバージョン不一致チェックは行わない。例えば、バージョン番号が変更になっていた場合はそのレコードのみ更新されずに処理は正常に終了する。バージョン番号のチェックを必要とする場合には、DaoContext.update(Object)を使用すること。
    
    定義:
    
    batchUpdate インタフェース内 DaoContext
    
    型パラメータ:
    
    T - エンティティクラスの型
    
    パラメータ:
    
    entities - 更新対象のエンティティリスト
  - insert
```
public <T> void insert(T entity)
```
    インタフェースからコピーされた説明: DaoContext
    
    エンティティオブジェクトを元に登録処理を行う。
    
    定義:
    
    insert インタフェース内 DaoContext
    
    型パラメータ:
    
    T - エンティティクラスの型
    
    パラメータ:
    
    entity - エンティティオブジェクト
  - batchInsert
```
public <T> void batchInsert(java.util.List<T> entities)
```
    インタフェースからコピーされた説明: DaoContext
    
    エンティティオブジェクトの情報を一括で登録する。
    
    定義:
    
    batchInsert インタフェース内 DaoContext
    
    型パラメータ:
    
    T - エンティティクラスの型
    
    パラメータ:
    
    entities - エンティティリスト
  - delete
```
public <T> int delete(T entity)
```
    インタフェースからコピーされた説明: DaoContext
    
    エンティティオブジェクトを元に削除処理を行う。
    エンティティの主キーが削除条件となる。
    
    定義:
    
    delete インタフェース内 DaoContext
    
    型パラメータ:
    
    T - エンティティクラスの型
    
    パラメータ:
    
    entity - エンティティオブジェクト
    
    戻り値:
    
    削除件数
  - batchDelete
```
public <T> void batchDelete(java.util.List<T> entities)
```
    インタフェースからコピーされた説明: DaoContext
    
    エンティティオブジェクトを元に一括削除処理を行う。
    エンティティの主キーが削除条件となる。
    
    定義:
    
    batchDelete インタフェース内 DaoContext
    
    型パラメータ:
    
    T - エンティティクラスの型
    
    パラメータ:
    
    entities - エンティティリスト
  - tableName
```
public <T> java.lang.String tableName(T entity)
```
    エンティティクラス名からテーブル名へ変換する。
    
    型パラメータ:
    
    T - エンティティクラス
    
    パラメータ:
    
    entity - エンティティ
    
    戻り値:
    
    テーブル名
  - page
```
public DaoContext page(long page)
```
    インタフェースからコピーされた説明: DaoContext
    
    ページングの何ページ目を検索するかを指定する。
    
    定義:
    
    page インタフェース内 DaoContext
    
    パラメータ:
    
    page - ページ番号(1-origin)
    
    戻り値:
    
    DaoContextがそのまま返る。
  - per
```
public DaoContext per(long per)
```
    インタフェースからコピーされた説明: DaoContext
    
    ページングの1ページにつき何件表示するかを指定する。
    
    定義:
    
    per インタフェース内 DaoContext
    
    パラメータ:
    
    per - ページ内表示件数
    
    戻り値:
    
    DaoContextがそのまま返る。
  - defer
```
public DaoContext defer()
```
    インタフェースからコピーされた説明: DaoContext
    
    検索結果の取得を遅延させる。
    
    定義:
    
    defer インタフェース内 DaoContext
    
    戻り値:
    
    DaoContextがそのまま返る。
  - normalizeSqlId
```
protected <T> java.lang.String normalizeSqlId(java.lang.String sqlId,
                                              java.lang.Class<T> entityClass)
```
    SQL_IDにファイル名がついてない場合は、Entityクラスの完全修飾名を付加する。
    
    型パラメータ:
    
    T - エンティティ型
    
    パラメータ:
    
    sqlId - SQL ID
    
    entityClass - エンティティクラス
    
    戻り値:
    
    正規化したSQL ID
  - setIdGenerator
```
protected void setIdGenerator(javax.persistence.GenerationType type,
                              IdGenerator generator)
```
    IDジェネレータを設定する。
    
    パラメータ:
    
    type - IDジェネレータのタイプ
    
    generator - IDジェネレータ
  - setDbConnection
```
protected void setDbConnection(AppDbConnection dbConnection)
```
    使用するデータベースコネクションを設定する。
    
    パラメータ:
    
    dbConnection - データベースコネクション

クラス BasicDaoContext

メソッドのサマリー

クラスから継承されたメソッド java.lang.Object

メソッドの詳細

findById

findAll

findAllBySqlFile

findAllBySqlFile

executeQuery

findAllBySqlFileWithoutPaginate

findAllBySqlFIleWithPaginate

findBySqlFile

countBySqlFile

update

batchUpdate

insert

batchInsert

delete

batchDelete

tableName

page

per

defer

normalizeSqlId

setIdGenerator

setDbConnection