org.seasar.doma.extension.gen
クラス EntityDesc

java.lang.Object
  org.seasar.doma.extension.gen.ClassDesc
      org.seasar.doma.extension.gen.EntityDesc

public class EntityDesc
extends ClassDesc

エンティティ記述です。

作成者:

taedium

フィールドの概要

protected String	catalogName カタログ名
protected boolean	compositeId 複合識別子を持つ場合 true
protected List<EntityPropertyDesc>	entityPropertyDescs エンティティプロパティ記述のリスト 親エンティティがある場合に、親エンティティのプロパティも対象になります。
protected List<EntityPropertyDesc>	idEntityPropertyDescs 識別子のエンティティプロパティ記述のリスト
protected String	listenerClassSimpleName リスナークラスの単純名
protected NamingType	namingType ネーミング規約
protected String	originalStatesPropertyName 元のステートを表すプロパティの名前
protected List<EntityPropertyDesc>	ownEntityPropertyDescs このエンティティ記述が表すエンティティが所有するエンティティプロパティ記述のリスト 親エンティティがある場合に、親エンティティのプロパティは対象外となります。
protected String	qualifiedTableName テーブルの完全修飾名
protected String	schemaName スキーマ名
protected boolean	showCatalogName カタログ名を表示する場合 true
protected boolean	showDbComment データベースのコメントを表示する場合 true
protected boolean	showSchemaName スキーマ名を表示する場合 true
protected boolean	showTableName テーブル名を表示する場合 true
protected String	superclassSimpleName スーパークラスの単純名
protected String	tableName テーブル名
protected String	templateName テンプレート名
protected boolean	useAccessor アクセッサーを使用する場合 true
protected boolean	useListener エンティティリスナーを使用する場合 true
protected EntityPropertyDesc	versionEntityPropertyDesc バージョンのエンティティプロパティ記述

クラス org.seasar.doma.extension.gen.ClassDesc から継承されたフィールド

comment, importNames, packageName, simpleName

コンストラクタの概要

EntityDesc()

メソッドの概要

void	addEntityPropertyDesc(EntityPropertyDesc entityPropertyDesc) エンティティプロパティ記述を追加します。
String	getCatalogName() カタログ名を返します。
List<EntityPropertyDesc>	getEntityPropertyDescs() エンティティプロパティ記述のリストを返します。
List<EntityPropertyDesc>	getIdEntityPropertyDescs() 識別子のエンティティプロパティ記述のリストを返します。
String	getListenerClassSimpleName() リスナークラスの単純名を返します。
NamingType	getNamingType() ネーミング規約を返します。
String	getOriginalStatesPropertyName() 元のステートを表すプロパティの名前を返します。
List<EntityPropertyDesc>	getOwnEntityPropertyDescs() 所有するエンティティプロパティ記述のリストを返します。
String	getQualifiedTableName() テーブルの完全修飾名を返します。
String	getSchemaName() スキーマ名を返します。
String	getSuperclassSimpleName() スーパークラスの単純名を返します。
String	getTableName() テーブル名 を返します。
String	getTemplateName() テンプレート名を返します。
EntityPropertyDesc	getVersionEntityPropertyDesc() バージョンのエンティティプロパティ記述を返します。
boolean	isCompositeId() 複合識別子を持つ場合 true を返します。
boolean	isShowCatalogName() カタログ名を表示する場合 true を返します。
boolean	isShowDbComment() データベースのコメントを表示する場合 true を返します。
boolean	isShowSchemaName() スキーマ名を表示する場合 true を返します。
boolean	isShowTableName() テーブル名を表示する場合 true を返します。
boolean	isUseAccessor() アクセッサーを使用する場合 true を返します。
boolean	isUseListener() エンティティリスナーを使用する場合 trueを返します。
void	setCatalogName(String catalogName) カタログ名を設定します。
void	setCompositeId(boolean compositeId) 複合識別子を持つ場合 true を設定します。
void	setListenerClassSimpleName(String listenerClassSimpleName) リスナークラスの単純名を設定します。
void	setNamingType(NamingType namingType) ネーミング規約を設定します。
void	setOriginalStatesPropertyName(String originalStatesPropertyName) 元のステートを表すプロパティの名前を設定します。
void	setQualifiedTableName(String qualifiedTableName) テーブルの完全修飾名
void	setSchemaName(String schemaName) スキーマ名を設定します。
void	setShowCatalogName(boolean showCatalogName) カタログ名を表示する場合 true を設定します。
void	setShowDbComment(boolean showDbComment) データベースのコメントを表示する場合 true を設定します。
void	setShowSchemaName(boolean showSchemaName) スキーマ名を表示する場合 true を設定します。
void	setShowTableName(boolean showTableName) テーブル名を表示する場合 true を設定します。
void	setSuperclassSimpleName(String superclassSimpleName) スーパークラスの単純名を設定します。
void	setTableName(String tableName) テーブル名 を設定します。
void	setTemplateName(String templateName) テンプレート名を設定します。
void	setUseAccessor(boolean useAccessor) アクセッサーを使用する場合 true を設定します。
void	setUseListener(boolean useListener) エンティティリスナーを使用する場合 trueを返します。

クラス org.seasar.doma.extension.gen.ClassDesc から継承されたメソッド

addImportName, getComment, getImportNames, getPackageName, getQualifiedName, getSimpleName, setComment, setPackageName, setSimpleName

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

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

フィールドの詳細

catalogName

protected String catalogName

カタログ名

schemaName

protected String schemaName

スキーマ名

tableName

protected String tableName

テーブル名

qualifiedTableName

protected String qualifiedTableName

テーブルの完全修飾名

superclassSimpleName

protected String superclassSimpleName

スーパークラスの単純名

listenerClassSimpleName

protected String listenerClassSimpleName

リスナークラスの単純名

namingType

protected NamingType namingType

ネーミング規約

originalStatesPropertyName

protected String originalStatesPropertyName

元のステートを表すプロパティの名前

compositeId

protected boolean compositeId

複合識別子を持つ場合 true

showCatalogName

protected boolean showCatalogName

カタログ名を表示する場合 true

showSchemaName

protected boolean showSchemaName

スキーマ名を表示する場合 true

showTableName

protected boolean showTableName

テーブル名を表示する場合 true

useAccessor

protected boolean useAccessor

アクセッサーを使用する場合 true

useListener

protected boolean useListener

エンティティリスナーを使用する場合 true

showDbComment

protected boolean showDbComment

データベースのコメントを表示する場合 true

templateName

protected String templateName

テンプレート名

entityPropertyDescs

protected final List<EntityPropertyDesc> entityPropertyDescs

エンティティプロパティ記述のリスト

親エンティティがある場合に、親エンティティのプロパティも対象になります。

ownEntityPropertyDescs

protected final List<EntityPropertyDesc> ownEntityPropertyDescs

このエンティティ記述が表すエンティティが所有するエンティティプロパティ記述のリスト

親エンティティがある場合に、親エンティティのプロパティは対象外となります。

導入されたバージョン:

1.7.0

idEntityPropertyDescs

protected final List<EntityPropertyDesc> idEntityPropertyDescs

識別子のエンティティプロパティ記述のリスト

versionEntityPropertyDesc

protected EntityPropertyDesc versionEntityPropertyDesc

バージョンのエンティティプロパティ記述

コンストラクタの詳細

EntityDesc

public EntityDesc()

メソッドの詳細

setTemplateName

public void setTemplateName(String templateName)

テンプレート名を設定します。

パラメータ:

templateName - テンプレート名

getTemplateName

public String getTemplateName()

テンプレート名を返します。

戻り値:

テンプレート名

setCatalogName

public void setCatalogName(String catalogName)

カタログ名を設定します。

パラメータ:

catalogName - カタログ名

getCatalogName

public String getCatalogName()

カタログ名を返します。

戻り値:

カタログ名

setSchemaName

public void setSchemaName(String schemaName)

スキーマ名を設定します。

パラメータ:

schemaName - スキーマ名

getSchemaName

public String getSchemaName()

スキーマ名を返します。

戻り値:

スキーマ名

setTableName

public void setTableName(String tableName)

テーブル名 を設定します。

パラメータ:

tableName - テーブル名

getTableName

public String getTableName()

テーブル名 を返します。

戻り値:

テーブル名

getSuperclassSimpleName

public String getSuperclassSimpleName()

スーパークラスの単純名を返します。

戻り値:

スーパークラスの単純名

setSuperclassSimpleName

public void setSuperclassSimpleName(String superclassSimpleName)

スーパークラスの単純名を設定します。

パラメータ:

superclassSimpleName - スーパークラスの単純名

getListenerClassSimpleName

public String getListenerClassSimpleName()

リスナークラスの単純名を返します。

戻り値:

リスナークラスの単純名

setListenerClassSimpleName

public void setListenerClassSimpleName(String listenerClassSimpleName)

リスナークラスの単純名を設定します。

パラメータ:

listenerClassSimpleName - リスナークラスの単純名

getNamingType

public NamingType getNamingType()

ネーミング規約を返します。

戻り値:

ネーミング規約

setNamingType

public void setNamingType(NamingType namingType)

ネーミング規約を設定します。

パラメータ:

namingType - ネーミング規約

getOriginalStatesPropertyName

public String getOriginalStatesPropertyName()

元のステートを表すプロパティの名前を返します。

戻り値:

t元のステートを表すプロパティの名前

setOriginalStatesPropertyName

public void setOriginalStatesPropertyName(String originalStatesPropertyName)

元のステートを表すプロパティの名前を設定します。

パラメータ:

originalStatesPropertyName - 元のステートを表すプロパティの名前

setCompositeId

public void setCompositeId(boolean compositeId)

複合識別子を持つ場合 true を設定します。

パラメータ:

compositeId - 複合識別子を持つ場合 true

isCompositeId

public boolean isCompositeId()

複合識別子を持つ場合 true を返します。

戻り値:

複合識別子を持つ場合 true

isShowCatalogName

public boolean isShowCatalogName()

カタログ名を表示する場合 true を返します。

戻り値:

カタログ名を表示する場合 true

setShowCatalogName

public void setShowCatalogName(boolean showCatalogName)

カタログ名を表示する場合 true を設定します。

パラメータ:

showCatalogName - カタログ名を表示する場合 true

isShowSchemaName

public boolean isShowSchemaName()

スキーマ名を表示する場合 true を返します。

戻り値:

スキーマ名を表示する場合 true

setShowSchemaName

public void setShowSchemaName(boolean showSchemaName)

スキーマ名を表示する場合 true を設定します。

パラメータ:

showSchemaName - スキーマ名を表示する場合 true

isShowTableName

public boolean isShowTableName()

テーブル名を表示する場合 true を返します。

戻り値:

テーブル名を表示する場合 true

setShowTableName

public void setShowTableName(boolean showTableName)

テーブル名を表示する場合 true を設定します。

パラメータ:

showTableName - テーブル名を表示する場合 true

isUseAccessor

public boolean isUseAccessor()

アクセッサーを使用する場合 true を返します。

戻り値:

アクセッサーを使用する場合 true

setUseAccessor

public void setUseAccessor(boolean useAccessor)

アクセッサーを使用する場合 true を設定します。

パラメータ:

useAccessor - アクセッサーを使用する場合 true

isUseListener

public boolean isUseListener()

エンティティリスナーを使用する場合 trueを返します。

戻り値:

エンティティリスナーを使用する場合 true

setUseListener

public void setUseListener(boolean useListener)

エンティティリスナーを使用する場合 trueを返します。

パラメータ:

useListener - エンティティリスナーを使用する場合 true

isShowDbComment

public boolean isShowDbComment()

データベースのコメントを表示する場合 true を返します。

戻り値:

データベースのコメントを表示する場合 true

setShowDbComment

public void setShowDbComment(boolean showDbComment)

データベースのコメントを表示する場合 true を設定します。

パラメータ:

showDbComment - データベースのコメントを表示する場合 true

addEntityPropertyDesc

public void addEntityPropertyDesc(EntityPropertyDesc entityPropertyDesc)

エンティティプロパティ記述を追加します。

パラメータ:

entityPropertyDesc - エンティティプロパティ記述

getEntityPropertyDescs

public List<EntityPropertyDesc> getEntityPropertyDescs()

エンティティプロパティ記述のリストを返します。

戻り値:

エンティティプロパティ記述のリスト

getOwnEntityPropertyDescs

public List<EntityPropertyDesc> getOwnEntityPropertyDescs()

所有するエンティティプロパティ記述のリストを返します。

戻り値:

所有するエンティティプロパティ記述のリスト

導入されたバージョン:

1.7.0

getIdEntityPropertyDescs

public List<EntityPropertyDesc> getIdEntityPropertyDescs()

識別子のエンティティプロパティ記述のリストを返します。

戻り値:

識別子のエンティティプロパティ記述のリスト

getVersionEntityPropertyDesc

public EntityPropertyDesc getVersionEntityPropertyDesc()

バージョンのエンティティプロパティ記述を返します。

戻り値:

バージョンのエンティティプロパティ記述

getQualifiedTableName

public String getQualifiedTableName()

テーブルの完全修飾名を返します。

戻り値:

テーブルの完全修飾名

setQualifiedTableName

public void setQualifiedTableName(String qualifiedTableName)

テーブルの完全修飾名

パラメータ:

qualifiedTableName - テーブルの完全修飾名を設定します。