EntityUtil (Nablarch-API)

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

@Published(tag="architect")
public final class EntityUtil
extends java.lang.Object

エンティティに関するユーティリティクラス。

メソッドのサマリー

すべてのメソッド staticメソッド concreteメソッド
修飾子とタイプ	メソッドと説明
`static void`	`clearCache()` キャッシュ情報をクリアする。
`static <T> T`	`createEntity(java.lang.Class<T> entityClass, SqlRow row)` 検索結果を元にエンティティオブジェクトを生成する。
`static java.util.List<ColumnMeta>`	`findAllColumns(java.lang.Class<?> entityClass)` エンティティクラスから全カラムの情報を取得する。
`static <T> java.util.Map<ColumnMeta,java.lang.Object>`	`findAllColumns(T entity)` エンティティから全カラムの情報と、その値を取得する。
`protected static EntityMeta`	`findEntityMeta(java.lang.Class<?> entityClass)` エンティティクラスに対応したエンティティ情報を取得する。
`static <T> ColumnMeta`	`findGeneratedValueColumn(java.lang.Class<T> entityClass)` エンティティクラスから`GeneratedValue`が設定されたカラムを取得する。
`static <T> ColumnMeta`	`findGeneratedValueColumn(T entity)` エンティティから`GeneratedValue`が設定されたカラムを取得する。
`static java.util.List<ColumnMeta>`	`findIdColumns(java.lang.Class<?> entityClass)` エンティティクラスからIDカラムの情報を全て取得する。
`static <T> java.util.Map<ColumnMeta,java.lang.Object>`	`findIdColumns(T entity)` エンティティからIDカラムの情報と、その値を全て取得する。
`static <T> ColumnMeta`	`findVersionColumn(T entity)` バージョンカラムの情報を取得する。
`static java.lang.String`	`getSchemaName(java.lang.Class<?> entityClass)` エンティティクラスからスキーマ名を取得する。
`static java.lang.String`	`getTableName(java.lang.Class<?> entityClass)` エンティティクラスからテーブル名を取得する。
`static java.lang.String`	`getTableNameWithSchema(java.lang.Class<?> entityClass)` エンティティクラスからスキーマ名を修飾したテーブル名("スキーマ名.テーブル名"形式)を取得する。
`static void`	`setProperty(java.lang.Object entity, java.lang.String propertyName, java.lang.Object value)` エンティティのプロパティに値をセットする。

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

- メソッドの詳細
  - getTableName
```
public static java.lang.String getTableName(java.lang.Class<?> entityClass)
```
    エンティティクラスからテーブル名を取得する。
    
    パラメータ:
    
    entityClass - エンティティクラス
    
    戻り値:
    
    テーブル名
  - getSchemaName
```
public static java.lang.String getSchemaName(java.lang.Class<?> entityClass)
```
    エンティティクラスからスキーマ名を取得する。
    
    パラメータ:
    
    entityClass - エンティティクラス
    
    戻り値:
    
    スキーマ名
  - getTableNameWithSchema
```
public static java.lang.String getTableNameWithSchema(java.lang.Class<?> entityClass)
```
    エンティティクラスからスキーマ名を修飾したテーブル名("スキーマ名.テーブル名"形式)を取得する。
    スキーマを持たないテーブルの場合、テーブル名のみを返す。
    
    パラメータ:
    
    entityClass - エンティティクラス
    
    戻り値:
    
    スキーマ名を修飾したテーブル名
  - findIdColumns
```
public static java.util.List<ColumnMeta> findIdColumns(java.lang.Class<?> entityClass)
```
    エンティティクラスからIDカラムの情報を全て取得する。
    
    パラメータ:
    
    entityClass - エンティティクラス
    
    戻り値:
    
    IDカラム情報
  - findIdColumns
```
public static <T> java.util.Map<ColumnMeta,java.lang.Object> findIdColumns(T entity)
```
    エンティティからIDカラムの情報と、その値を全て取得する。
    
    型パラメータ:
    
    T - エンティティクラスの型
    
    パラメータ:
    
    entity - エンティティオブジェクト
    
    戻り値:
    
    IDカラム情報と値
  - findAllColumns
```
public static java.util.List<ColumnMeta> findAllColumns(java.lang.Class<?> entityClass)
```
    エンティティクラスから全カラムの情報を取得する。
    
    パラメータ:
    
    entityClass - エンティティクラス
    
    戻り値:
    
    全カラムの情報
  - findAllColumns
```
public static <T> java.util.Map<ColumnMeta,java.lang.Object> findAllColumns(T entity)
```
    エンティティから全カラムの情報と、その値を取得する。
    
    型パラメータ:
    
    T - エンティティクラスの型
    
    パラメータ:
    
    entity - エンティティ
    
    戻り値:
    
    全カラムの情報と値
  - findVersionColumn
```
public static <T> ColumnMeta findVersionColumn(T entity)
```
    バージョンカラムの情報を取得する。
    バージョンカラムが定義されていない場合はnullを返す。
    
    型パラメータ:
    
    T - エンティティクラスの型
    
    パラメータ:
    
    entity - エンティティ
    
    戻り値:
    
    バージョン情報を保持するカラムの情報
  - findGeneratedValueColumn
```
public static <T> ColumnMeta findGeneratedValueColumn(T entity)
```
    エンティティからGeneratedValueが設定されたカラムを取得する。
    採番対象のカラムが定義されていない場合はnullを返す。
    
    型パラメータ:
    
    T - エンティティクラスの型
    
    パラメータ:
    
    entity - エンティティ
    
    戻り値:
    
    採番対象のカラムの情報
  - findGeneratedValueColumn
```
public static <T> ColumnMeta findGeneratedValueColumn(java.lang.Class<T> entityClass)
```
    エンティティクラスからGeneratedValueが設定されたカラムを取得する。
    採番対象のカラムが定義されていない場合はnullを返す。
    
    型パラメータ:
    
    T - エンティティクラスの型
    
    パラメータ:
    
    entityClass - エンティティクラス
    
    戻り値:
    
    採番対象のカラムの情報
  - createEntity
```
public static <T> T createEntity(java.lang.Class<T> entityClass,
                                 SqlRow row)
```
    検索結果を元にエンティティオブジェクトを生成する。
    
    型パラメータ:
    
    T - エンティティクラスの型
    
    パラメータ:
    
    entityClass - 生成するエンティティのクラス
    
    row - 検索結果の1レコード
    
    戻り値:
    
    エンティティオブジェクト
    
    例外:
    
    java.lang.IllegalStateException - エンティティクラスのプロパティにサポート外の型が定義されている場合
    
    BeansException - エンティティオブジェクトの生成に失敗した場合, セッターが正常に呼び出せなかった場合
  - setProperty
```
public static void setProperty(java.lang.Object entity,
                               java.lang.String propertyName,
                               java.lang.Object value)
```
    エンティティのプロパティに値をセットする。
    
    パラメータ:
    
    entity - 対象のエンティティ
    
    propertyName - 値をセットするプロパティ名
    
    value - セットする値
    
    例外:
    
    BeansException - セッターが正常に呼び出せなかった場合
  - findEntityMeta
```
protected static EntityMeta findEntityMeta(java.lang.Class<?> entityClass)
```
    エンティティクラスに対応したエンティティ情報を取得する。
    キャッシュ上にエンティティ情報が存在する場合はその情報を返す。まだキャッシュされていない場合には、エンティティ情報を生成しキャッシュに格納する。
    
    パラメータ:
    
    entityClass - エンティティクラス
    
    戻り値:
    
    エンティティ情報
  - clearCache
```
public static void clearCache()
```
    キャッシュ情報をクリアする。

クラス EntityUtil

メソッドのサマリー

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

メソッドの詳細

getTableName

getSchemaName

getTableNameWithSchema

findIdColumns

findIdColumns

findAllColumns

findAllColumns

findVersionColumn

findGeneratedValueColumn

findGeneratedValueColumn

createEntity

setProperty

findEntityMeta

clearCache