SqlTimeMetricsDaoContext (Nablarch-API)

java.lang.Object
- nablarch.integration.micrometer.instrument.dao.SqlTimeMetricsDaoContext

All Implemented Interfaces:

DaoContext
```
public class SqlTimeMetricsDaoContext
extends java.lang.Object
implements DaoContext
```
SQLの処理実行時間をメトリクスとして計測するDaoContextのラッパークラス。
メトリクスは、sql.process.timeという名前になる。

また、メトリクスには以下のタグが設定される。
- sql.id: SQLID(無い場合は"None")
- entity: エンティティクラスの名前(Class.getName())。
- method: 実行されたDaoContextのメソッドの単純名
引数で渡されたエンティティまたはエンティティのリストが、nullまたは空のリストの場合は、時間は計測されない（委譲先のメソッドの処理は実行される）。

Constructor Summary

Constructors
Constructor and Description
`SqlTimeMetricsDaoContext(DaoContext delegate, io.micrometer.core.instrument.MeterRegistry meterRegistry)` 委譲先の `DaoContext`と`MeterRegistry`を指定するコンストラクタ。

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`<T> void`	`batchDelete(java.util.List<T> entities)` エンティティオブジェクトを元に一括削除処理を行う。エンティティの主キーが削除条件となる。
`<T> void`	`batchInsert(java.util.List<T> entities)` エンティティオブジェクトの情報を一括で登録する。
`<T> void`	`batchUpdate(java.util.List<T> entities)` エンティティオブジェクトの情報を元に一括更新を行う。 `DaoContext.update(Object)`とは異なり、一括更新処理ではバージョン不一致チェックは行わない。例えば、バージョン番号が変更になっていた場合はそのレコードのみ更新されずに処理は正常に終了する。バージョン番号のチェックを必要とする場合には、`DaoContext.update(Object)`を使用すること。
`<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)` エンティティオブジェクトを元に削除処理を行う。エンティティの主キーが削除条件となる。
`<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をもとにバインド変数を展開して検索処理を行う。
`<T> T`	`findById(java.lang.Class<T> entityClass, java.lang.Object... id)` プライマリーキーによる検索を行う。
`<T> T`	`findByIdOrNull(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をもとに1件検索を行う。
`<T> T`	`findBySqlFileOrNull(java.lang.Class<T> entityClass, java.lang.String sqlId, java.lang.Object params)` SQL_IDをもとに1件検索を行う。
`DaoContext`	`getDelegate()` 委譲先の`DaoContext`を取得する。
`io.micrometer.core.instrument.MeterRegistry`	`getMeterRegistry()` `MeterRegistry`を取得する。
`java.lang.String`	`getMetricsDescription()` メトリクスの説明を取得する。
`java.lang.String`	`getMetricsName()` メトリクス名を取得する。
`<T> void`	`insert(T entity)` エンティティオブジェクトを元に登録処理を行う。
`DaoContext`	`page(long page)` ページングの何ページ目を検索するかを指定する。
`DaoContext`	`per(long per)` ページングの1ページにつき何件表示するかを指定する。
`void`	`setMetricsDescription(java.lang.String metricsDescription)` メトリクスの説明を設定する。
`void`	`setMetricsName(java.lang.String metricsName)` メトリクスの名前を設定する。
`<T> int`	`update(T entity)` エンティティオブジェクトを元に更新処理を行う。エンティティの主キーが更新条件となる。

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - SqlTimeMetricsDaoContext
```
public SqlTimeMetricsDaoContext(DaoContext delegate,
                                io.micrometer.core.instrument.MeterRegistry meterRegistry)
```
    委譲先の DaoContextとMeterRegistryを指定するコンストラクタ。
    
    Parameters:
    
    delegate - 委譲先のDaoContext
    
    meterRegistry - MeterRegistry
- Method Detail
  - findById
```
public <T> T findById(java.lang.Class<T> entityClass,
                      java.lang.Object... id)
```
    Description copied from interface: DaoContext
    
    プライマリーキーによる検索を行う。
    
    Specified by:
    
    findById in interface DaoContext
    
    Type Parameters:
    
    T - エンティティクラスの型
    
    Parameters:
    
    entityClass - エンティティクラス
    
    id - プライマリーキー (複合キーの場合は定義順)
    
    Returns:
    
    エンティティオブジェクト
  - findByIdOrNull
```
public <T> T findByIdOrNull(java.lang.Class<T> entityClass,
                            java.lang.Object... id)
```
    Description copied from interface: DaoContext
    
    プライマリーキーによる検索を行う。
    
    Specified by:
    
    findByIdOrNull in interface DaoContext
    
    Type Parameters:
    
    T - エンティティクラスの型
    
    Parameters:
    
    entityClass - エンティティクラス
    
    id - プライマリーキー (複合キーの場合は定義順)
    
    Returns:
    
    エンティティオブジェクト。0件の場合はnull。
  - findAll
```
public <T> EntityList<T> findAll(java.lang.Class<T> entityClass)
```
    Description copied from interface: DaoContext
    
    全件の検索を行う。
    
    Specified by:
    
    findAll in interface DaoContext
    
    Type Parameters:
    
    T - エンティティクラスの型
    
    Parameters:
    
    entityClass - エンティティクラス
    
    Returns:
    
    検索結果リスト。0件の場合は空リスト。
  - findAllBySqlFile
```
public <T> EntityList<T> findAllBySqlFile(java.lang.Class<T> entityClass,
                                          java.lang.String sqlId,
                                          java.lang.Object params)
```
    Description copied from interface: DaoContext
    
    SQL_IDをもとにバインド変数を展開して検索処理を行う。
    
    Specified by:
    
    findAllBySqlFile in interface DaoContext
    
    Type Parameters:
    
    T - 検索結果をマッピングするBeanクラスの型
    
    Parameters:
    
    entityClass - 検索結果をマッピングするBeanクラス
    
    sqlId - SQL_ID
    
    params - バインド変数
    
    Returns:
    
    検索結果リスト。0件の場合は空リスト。
  - findAllBySqlFile
```
public <T> EntityList<T> findAllBySqlFile(java.lang.Class<T> entityClass,
                                          java.lang.String sqlId)
```
    Description copied from interface: DaoContext
    
    SQL_IDをもとに検索を行う。
    
    Specified by:
    
    findAllBySqlFile in interface DaoContext
    
    Type Parameters:
    
    T - 検索結果をマッピングするBeanクラスの型
    
    Parameters:
    
    entityClass - 検索結果をマッピングするBeanクラス
    
    sqlId - SQL_ID
    
    Returns:
    
    検索結果リスト。0件の場合は空リスト。
  - findBySqlFile
```
public <T> T findBySqlFile(java.lang.Class<T> entityClass,
                           java.lang.String sqlId,
                           java.lang.Object params)
```
    Description copied from interface: DaoContext
    
    SQL_IDをもとに1件検索を行う。
    
    Specified by:
    
    findBySqlFile in interface DaoContext
    
    Type Parameters:
    
    T - 検索結果をマッピングするBeanクラスの型
    
    Parameters:
    
    entityClass - 検索結果をマッピングするBeanクラス
    
    sqlId - SQL_ID
    
    params - バインド変数
    
    Returns:
    
    エンティティオブジェクト
  - findBySqlFileOrNull
```
public <T> T findBySqlFileOrNull(java.lang.Class<T> entityClass,
                                 java.lang.String sqlId,
                                 java.lang.Object params)
```
    Description copied from interface: DaoContext
    
    SQL_IDをもとに1件検索を行う。
    
    Specified by:
    
    findBySqlFileOrNull in interface DaoContext
    
    Type Parameters:
    
    T - 検索結果をマッピングするBeanクラスの型
    
    Parameters:
    
    entityClass - 検索結果をマッピングするBeanクラス
    
    sqlId - SQL_ID
    
    params - バインド変数
    
    Returns:
    
    エンティティオブジェクト。0件の場合はnull。
  - countBySqlFile
```
public <T> long countBySqlFile(java.lang.Class<T> entityClass,
                               java.lang.String sqlId,
                               java.lang.Object params)
```
    Description copied from interface: DaoContext
    
    SQL_IDをもとに結果件数を取得する。
    
    Specified by:
    
    countBySqlFile in interface DaoContext
    
    Type Parameters:
    
    T - エンティティクラスの型
    
    Parameters:
    
    entityClass - エンティティクラス
    
    sqlId - SQL_ID
    
    params - バインド変数
    
    Returns:
    
    件数
  - update
```
public <T> int update(T entity)
               throws javax.persistence.OptimisticLockException
```
    Description copied from interface: DaoContext
    
    エンティティオブジェクトを元に更新処理を行う。
    エンティティの主キーが更新条件となる。
    
    Specified by:
    
    update in interface DaoContext
    
    Type Parameters:
    
    T - エンティティクラスの型
    
    Parameters:
    
    entity - エンティティオブジェクト
    
    Returns:
    
    更新件数
    
    Throws:
    
    javax.persistence.OptimisticLockException - バージョン不一致で更新対象が存在しない場合
  - batchUpdate
```
public <T> void batchUpdate(java.util.List<T> entities)
```
    Description copied from interface: DaoContext
    
    エンティティオブジェクトの情報を元に一括更新を行う。
    DaoContext.update(Object)とは異なり、一括更新処理ではバージョン不一致チェックは行わない。例えば、バージョン番号が変更になっていた場合はそのレコードのみ更新されずに処理は正常に終了する。バージョン番号のチェックを必要とする場合には、DaoContext.update(Object)を使用すること。
    
    Specified by:
    
    batchUpdate in interface DaoContext
    
    Type Parameters:
    
    T - エンティティクラスの型
    
    Parameters:
    
    entities - 更新対象のエンティティリスト
  - insert
```
public <T> void insert(T entity)
```
    Description copied from interface: DaoContext
    
    エンティティオブジェクトを元に登録処理を行う。
    
    Specified by:
    
    insert in interface DaoContext
    
    Type Parameters:
    
    T - エンティティクラスの型
    
    Parameters:
    
    entity - エンティティオブジェクト
  - batchInsert
```
public <T> void batchInsert(java.util.List<T> entities)
```
    Description copied from interface: DaoContext
    
    エンティティオブジェクトの情報を一括で登録する。
    
    Specified by:
    
    batchInsert in interface DaoContext
    
    Type Parameters:
    
    T - エンティティクラスの型
    
    Parameters:
    
    entities - エンティティリスト
  - delete
```
public <T> int delete(T entity)
```
    Description copied from interface: DaoContext
    
    エンティティオブジェクトを元に削除処理を行う。
    エンティティの主キーが削除条件となる。
    
    Specified by:
    
    delete in interface DaoContext
    
    Type Parameters:
    
    T - エンティティクラスの型
    
    Parameters:
    
    entity - エンティティオブジェクト
    
    Returns:
    
    削除件数
  - batchDelete
```
public <T> void batchDelete(java.util.List<T> entities)
```
    Description copied from interface: DaoContext
    
    エンティティオブジェクトを元に一括削除処理を行う。
    エンティティの主キーが削除条件となる。
    
    Specified by:
    
    batchDelete in interface DaoContext
    
    Type Parameters:
    
    T - エンティティクラスの型
    
    Parameters:
    
    entities - エンティティリスト
  - page
```
public DaoContext page(long page)
```
    Description copied from interface: DaoContext
    
    ページングの何ページ目を検索するかを指定する。
    
    Specified by:
    
    page in interface DaoContext
    
    Parameters:
    
    page - ページ番号(1-origin)
    
    Returns:
    
    DaoContextがそのまま返る。
  - per
```
public DaoContext per(long per)
```
    Description copied from interface: DaoContext
    
    ページングの1ページにつき何件表示するかを指定する。
    
    Specified by:
    
    per in interface DaoContext
    
    Parameters:
    
    per - ページ内表示件数
    
    Returns:
    
    DaoContextがそのまま返る。
  - defer
```
public DaoContext defer()
```
    Description copied from interface: DaoContext
    
    検索結果の取得を遅延させる。
    
    Specified by:
    
    defer in interface DaoContext
    
    Returns:
    
    DaoContextがそのまま返る。
  - setMetricsName
```
public void setMetricsName(java.lang.String metricsName)
```
    メトリクスの名前を設定する。
    
    Parameters:
    
    metricsName - メトリクスの名前
  - getMetricsName
```
public java.lang.String getMetricsName()
```
    メトリクス名を取得する。
    
    Returns:
    
    メトリクス名
  - setMetricsDescription
```
public void setMetricsDescription(java.lang.String metricsDescription)
```
    メトリクスの説明を設定する。
    
    Parameters:
    
    metricsDescription - メトリクスの説明
  - getMetricsDescription
```
public java.lang.String getMetricsDescription()
```
    メトリクスの説明を取得する。
    
    Returns:
    
    メトリクスの説明
  - getDelegate
```
public DaoContext getDelegate()
```
    委譲先のDaoContextを取得する。
    
    Returns:
    
    委譲先の DaoContext
  - getMeterRegistry
```
public io.micrometer.core.instrument.MeterRegistry getMeterRegistry()
```
    MeterRegistryを取得する。
    
    Returns:
    
    MeterRegistry

Class SqlTimeMetricsDaoContext

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

SqlTimeMetricsDaoContext

Method Detail

findById

findByIdOrNull

findAll

findAllBySqlFile

findAllBySqlFile

findBySqlFile

findBySqlFileOrNull

countBySqlFile

update

batchUpdate

insert

batchInsert

delete

batchDelete

page

per

defer

setMetricsName

getMetricsName

setMetricsDescription

getMetricsDescription

getDelegate

getMeterRegistry