EntityDescFactory (doma-gen 2.0.0 API)

java.lang.Object
- org.seasar.doma.extension.gen.EntityDescFactory

public class EntityDescFactory
extends java.lang.Object

エンティティ記述のファクトリです。

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

protected static class EntityDescFactory.EntityPropertyInfo
エンティティプロパティ情報です。

Nested Classes
Modifier and Type	Class and Description
`protected static class`	`EntityDescFactory.EntityPropertyInfo` エンティティプロパティ情報です。

Field Summary

Fields
Modifier and Type	Field and Description
`protected ClassDescSupport`	`classDescSupport` クラス記述のサポートクラス
`protected EntityPropertyDescFactory`	`entityPropertyDescFactory` エンティティプロパティ記述のファクトリ
`protected NamingType`	`namingType` ネーミング規約
`protected java.lang.String`	`originalStatesPropertyName` 元のステートを表すプロパティの名前
`protected java.lang.String`	`packageName` パッケージ名
`protected boolean`	`showCatalogName` カタログ名を表示する場合 `true`
`protected boolean`	`showDbComment` データベースのコメントを表示する場合 `true`
`protected boolean`	`showSchemaName` スキーマ名を表示する場合 `true`
`protected boolean`	`showTableName` テーブル名を表示する場合 `true`
`protected java.lang.Class<?>`	`superclass` スーパークラス
`protected boolean`	`useAccessor` アクセッサーを使用する場合 `true`
`protected boolean`	`useListener` エンティティリスナーを使用する場合 `true`

Constructor Summary

Constructors
Constructor and Description
`EntityDescFactory(java.lang.String packageName, java.lang.Class<?> superclass, EntityPropertyDescFactory entityPropertyDescFactory, NamingType namingType, java.lang.String originalStatesPropertyName, boolean showCatalogName, boolean showSchemaName, boolean showTableName, boolean showDbComment, boolean useAccessor, boolean useListener)` インスタンスを構築します。

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`EntityDesc`	`createEntityDesc(TableMeta tableMeta)` エンティティ記述を作成します。
`EntityDesc`	`createEntityDesc(TableMeta tableMeta, java.lang.String simpleName)` エンティティの名前を指定してエンティティ記述を作成します。
`protected java.util.Set<EntityDescFactory.EntityPropertyInfo>`	`getSuperclassEntityPropertyInfo()` スーパークラスに定義されたエンティティプロパティの情報のセットを返します。
`protected void`	`handleEntityPropertyDesc(EntityDesc entityDesc, TableMeta tableMeta)` エンティティプロパティ記述を処理します。
`protected void`	`handleImportName(EntityDesc entityDesc, TableMeta tableMeta)` インポート名を処理します。
`protected void`	`handleShowTableName(EntityDesc entityDesc, TableMeta tableMeta)` カタログ名を表示するかどうか処理します。
`protected boolean`	`isNameDifferentBetweenEntityAndTable(EntityDesc entityDesc)` エンティティ名とテーブル名が異なる場合 `true`を返します。
`protected void`	`mergeEntityProperty(EntityPropertyDesc dest, EntityDescFactory.EntityPropertyInfo src)` エンティティプロパティ記述にエンティティプロパティ情報をマージします。

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

- Field Detail
  - packageName
```
protected final java.lang.String packageName
```
    パッケージ名
  - entityPropertyDescFactory
```
protected final EntityPropertyDescFactory entityPropertyDescFactory
```
    エンティティプロパティ記述のファクトリ
  - namingType
```
protected final NamingType namingType
```
    ネーミング規約
  - originalStatesPropertyName
```
protected java.lang.String originalStatesPropertyName
```
    元のステートを表すプロパティの名前
  - showCatalogName
```
protected final boolean showCatalogName
```
    カタログ名を表示する場合 true
  - showSchemaName
```
protected final boolean showSchemaName
```
    スキーマ名を表示する場合 true
  - showTableName
```
protected final boolean showTableName
```
    テーブル名を表示する場合 true
  - showDbComment
```
protected final boolean showDbComment
```
    データベースのコメントを表示する場合 true
  - useAccessor
```
protected final boolean useAccessor
```
    アクセッサーを使用する場合 true
  - useListener
```
protected final boolean useListener
```
    エンティティリスナーを使用する場合 true
  - superclass
```
protected final java.lang.Class<?> superclass
```
    スーパークラス
  - classDescSupport
```
protected final ClassDescSupport classDescSupport
```
    クラス記述のサポートクラス
- Constructor Detail
  - EntityDescFactory
```
public EntityDescFactory(java.lang.String packageName,
                         java.lang.Class<?> superclass,
                         EntityPropertyDescFactory entityPropertyDescFactory,
                         NamingType namingType,
                         java.lang.String originalStatesPropertyName,
                         boolean showCatalogName,
                         boolean showSchemaName,
                         boolean showTableName,
                         boolean showDbComment,
                         boolean useAccessor,
                         boolean useListener)
```
    インスタンスを構築します。
    
    Parameters:
    
    packageName - パッケージ名
    
    superclass - スーパークラス
    
    entityPropertyDescFactory - エンティティプロパティ記述のファクトリ
    
    namingType - ネーミング規約
    
    originalStatesPropertyName - オリジナルの状態を表すプロパティの名前
    
    showCatalogName - カタログ名を表示する場合 true
    
    showSchemaName - スキーマ名を表示する場合 true
    
    showTableName - テーブル名を表示する場合 true
    
    showDbComment - コメントを表示する場合 true
    
    useAccessor - アクセッサーを使用する場合 true
    
    useListener - エンティティリスナーを使用する場合 true
- Method Detail
  - createEntityDesc
```
public EntityDesc createEntityDesc(TableMeta tableMeta)
```
    エンティティ記述を作成します。
    
    Parameters:
    
    tableMeta - テーブルメタデータ
    
    Returns:
    
    エンティティ記述
  - createEntityDesc
```
public EntityDesc createEntityDesc(TableMeta tableMeta,
                                   java.lang.String simpleName)
```
    エンティティの名前を指定してエンティティ記述を作成します。
    
    Parameters:
    
    tableMeta - テーブルメタデータ
    
    simpleName - エンティティ名
    
    Returns:
    
    エンティティ記述
  - handleShowTableName
```
protected void handleShowTableName(EntityDesc entityDesc,
                                   TableMeta tableMeta)
```
    カタログ名を表示するかどうか処理します。
    
    Parameters:
    
    entityDesc - エンティティ記述
    
    tableMeta - テーブルメタデータ
  - isNameDifferentBetweenEntityAndTable
```
protected boolean isNameDifferentBetweenEntityAndTable(EntityDesc entityDesc)
```
    エンティティ名とテーブル名が異なる場合 trueを返します。
    
    Parameters:
    
    entityDesc - エンティティ記述
    
    Returns:
    
    エンティティ名とテーブル名が異なる場合 true
  - handleEntityPropertyDesc
```
protected void handleEntityPropertyDesc(EntityDesc entityDesc,
                                        TableMeta tableMeta)
```
    エンティティプロパティ記述を処理します。
    
    Parameters:
    
    entityDesc - エンティティ記述
    
    tableMeta - テーブルメタデータ
  - mergeEntityProperty
```
protected void mergeEntityProperty(EntityPropertyDesc dest,
                                   EntityDescFactory.EntityPropertyInfo src)
```
    エンティティプロパティ記述にエンティティプロパティ情報をマージします。
    
    Parameters:
    
    dest - エンティティプロパティ記述
    
    src - エンティティプロパティ情報
    
    Since:
    
    1.7.0
  - getSuperclassEntityPropertyInfo
```
protected java.util.Set<EntityDescFactory.EntityPropertyInfo> getSuperclassEntityPropertyInfo()
```
    スーパークラスに定義されたエンティティプロパティの情報のセットを返します。
    
    Returns:
    
    スーパークラスに定義されたエンティティプロパティの情報のセット
    
    Since:
    
    1.7.0
  - handleImportName
```
protected void handleImportName(EntityDesc entityDesc,
                                TableMeta tableMeta)
```
    インポート名を処理します。
    
    Parameters:
    
    entityDesc - エンティティ記述
    
    tableMeta - テーブルメタデータ

Class EntityDescFactory

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

packageName

entityPropertyDescFactory

namingType

originalStatesPropertyName

showCatalogName

showSchemaName

showTableName

showDbComment

useAccessor

useListener

superclass

classDescSupport

Constructor Detail

EntityDescFactory

Method Detail

createEntityDesc

createEntityDesc

handleShowTableName

isNameDifferentBetweenEntityAndTable

handleEntityPropertyDesc

mergeEntityProperty

getSuperclassEntityPropertyInfo

handleImportName