org.seasar.doma.extension.gen.task
クラス Gen

java.lang.Object
  org.apache.tools.ant.ProjectComponent
      org.apache.tools.ant.Task
          org.seasar.doma.extension.gen.task.AbstractTask
              org.seasar.doma.extension.gen.task.Gen

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

Cloneable

public class Gen
extends AbstractTask

コードを生成します。

次のコードを生成できます。

• エンティティクラス
• エンティティリスナークラス
• Daoインタフェース
• SQL

作成者:

taedium

フィールドの概要

protected DaoConfig	daoConfig Daoの設定
protected DaoDelegateDescFactory	daoDelegateDescFactory Daoデリゲート記述のファクトリ
protected DaoDescFactory	daoDescFactory Dao記述のファクトリ
protected DataSource	dataSource データソース
protected GenDialect	dialect 方言
protected DialectNameAttribute	dialectName 方言名
protected String	driverClassName Driver のサブタイプのクラス名
protected EntityConfig	entityConfig エンティティの設定
protected EntityDescFactory	entityDescFactory エンティティ記述のファクトリ
protected EntityListenerDescFactory	entityListenerDescFactory エンティティリスナー記述のファクトリ
protected EntityPropertyClassNameResolver	entityPropertyClassNameResolver エンティティプロパティのクラス名リゾルバ
protected EntityPropertyDescFactory	entityPropertyDescFactory エンティティプロパティ記述のファクトリ
protected String	genDialectClassName GenDialect のサブタイプのクラス名
protected Generator	generator ジェネレータ
protected String	ignoredTableNamePattern 対象としないテーブル名の正規表現
protected String	password JDBC接続パスワード
protected String	schemaName 対象とするテーブルが属するスキーマ名
protected SqlConfig	sqlConfig SQLの設定
protected SqlDescFactory	sqlDescFactory SQL記述ファクトリ
protected TableMetaReader	tableMetaReader テーブルメタデータ
protected String	tableNamePattern 対象とするテーブル名の正規表現
protected List<String>	tableTypes 対象とするテーブルの型のリスト
protected String	templateEncoding テンプレートのエンコーディング
protected File	templatePrimaryDir テンプレートを格納するプライマリディレクトリ、使用しない場合 null
protected String	url JDBC接続URL
protected String	user JDBC接続ユーザー
protected String	versionColumnNamePattern バージョンカラム名のパターン。

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

globalFactory, globalFactoryClassName

クラス org.apache.tools.ant.Task から継承されたフィールド

target, taskName, taskType, wrapper

クラス org.apache.tools.ant.ProjectComponent から継承されたフィールド

description, location, project

コンストラクタの概要

Gen()

メソッドの概要

DaoConfig	createDaoConfig() Daoの設定を作成します。
protected DaoDelegateDescFactory	createDaoDelegateDescFactory() Daoデリゲート記述ファクトリを作成します。
protected DaoDescFactory	createDaoDescFactory() Dao記述ファクトリを作成します。
protected DataSource	createDataSource() データソースを作成します。
EntityConfig	createEntityConfig() エンティティの設定を作成します。
protected EntityDescFactory	createEntityDescFactory() エンティティ記述ファクトリを作成します。
protected EntityListenerDescFactory	createEntityListenerDescFactory() エンティティリスナー記述ファクトリを作成します。
protected EntityPropertyClassNameResolver	createEntityPropertyClassNameResolver() エンティティプロパティのクラス名リゾルバを作成します。
protected EntityPropertyDescFactory	createEntityPropertyDescFactory() グローバルファクトリを作成します。
protected Generator	createGenerator() ジェネレータを作成します。
SqlConfig	createSqlConfig() SQLの設定を作成します。
protected SqlDescFactory	createSqlDescFactory() SQL記述ファクトリを作成します。
protected TableMetaReader	createTableMetaReader() テーブルメタデータを作成します。
protected void	doPrepare() サブクラスで準備します。
protected void	doRun() サブクラスで実行します。
protected void	doValidate() サブクラスで検証します。
protected void	generateDao(DaoDesc daoDesc) DaoのJavaコードを生成します。
protected void	generateDaoDelegate(DaoDelegateDesc daoDelegateDesc) DaoデリゲートのJavaコードを生成します。
protected void	generateEntity(EntityDesc entityDesc) エンティティのJavaコードを生成します。
protected void	generateEntityListener(EntityListenerDesc entityListenerDesc)
protected void	generateSql(DaoDesc daoDesc, SqlDesc sqlDesc) SQLを生成します。
void	setDialectName(DialectNameAttribute dialectName) 方言名を設定します。
void	setDriverClassName(String driverClassName) Driver のサブタイプのクラス名を設定します。
void	setGenDialectClassName(String genDialectClassName) GenDialect のサブタイプのクラス名を設定します。
void	setIgnoredTableNamePattern(String ignoredTableNamePattern) 対象としないテーブル名の正規表現を設定します。
void	setPassword(String password) JDBC接続パスワードを設定します。
void	setSchemaName(String schemaName) 対象とするテーブルが属するスキーマ名を設定します。
void	setTableNamePattern(String tableNamePattern) 対象とするテーブル名の正規表現を設定します。
void	setTableTypes(String tableTypes) カンマまたは空白で区切られたテーブルの型のリストを設定します
void	setTemplateEncoding(String templateEncoding) テンプレートのエンコーディングを設定します。
void	setTemplatePrimaryDir(File templatePrimaryDir) テンプレートを格納するプライマリディレクトリを設定します。
void	setUrl(String url) JDBC接続URLを設定します。
void	setUser(String user) JDBC接続ユーザーを設定します。
void	setVersionColumnNamePattern(String versionColumnNamePattern) バージョンカラム名のパターンを設定します。

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

execute, forName, newInstance, prepare, run, setGlobalFactoryClassName, validate

クラス org.apache.tools.ant.Task から継承されたメソッド

bindToOwner, getOwningTarget, getRuntimeConfigurableWrapper, getTaskName, getTaskType, getWrapper, handleErrorFlush, handleErrorOutput, handleFlush, handleInput, handleOutput, init, isInvalid, log, log, log, log, maybeConfigure, perform, reconfigure, setOwningTarget, setRuntimeConfigurableWrapper, setTaskName, setTaskType

クラス org.apache.tools.ant.ProjectComponent から継承されたメソッド

clone, getDescription, getLocation, getProject, setDescription, setLocation, setProject

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

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

フィールドの詳細

dialectName

protected DialectNameAttribute dialectName

方言名

genDialectClassName

protected String genDialectClassName

GenDialect のサブタイプのクラス名

driverClassName

protected String driverClassName

Driver のサブタイプのクラス名

user

protected String user

JDBC接続ユーザー

password

protected String password

JDBC接続パスワード

url

protected String url

JDBC接続URL

schemaName

protected String schemaName

対象とするテーブルが属するスキーマ名

tableNamePattern

protected String tableNamePattern

対象とするテーブル名の正規表現

ignoredTableNamePattern

protected String ignoredTableNamePattern

対象としないテーブル名の正規表現

tableTypes

protected List<String> tableTypes

対象とするテーブルの型のリスト

versionColumnNamePattern

protected String versionColumnNamePattern

バージョンカラム名のパターン。このパターンに合致した場合は org.seasar.doma.Versino が注釈されます。

templateEncoding

protected String templateEncoding

テンプレートのエンコーディング

templatePrimaryDir

protected File templatePrimaryDir

テンプレートを格納するプライマリディレクトリ、使用しない場合 null

dialect

protected GenDialect dialect

方言

dataSource

protected DataSource dataSource

データソース

tableMetaReader

protected TableMetaReader tableMetaReader

テーブルメタデータ

entityPropertyClassNameResolver

protected EntityPropertyClassNameResolver entityPropertyClassNameResolver

エンティティプロパティのクラス名リゾルバ

entityDescFactory

protected EntityDescFactory entityDescFactory

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

entityListenerDescFactory

protected EntityListenerDescFactory entityListenerDescFactory

エンティティリスナー記述のファクトリ

entityPropertyDescFactory

protected EntityPropertyDescFactory entityPropertyDescFactory

エンティティプロパティ記述のファクトリ

daoDescFactory

protected DaoDescFactory daoDescFactory

Dao記述のファクトリ

daoDelegateDescFactory

protected DaoDelegateDescFactory daoDelegateDescFactory

Daoデリゲート記述のファクトリ

sqlDescFactory

protected SqlDescFactory sqlDescFactory

SQL記述ファクトリ

generator

protected Generator generator

ジェネレータ

entityConfig

protected EntityConfig entityConfig

エンティティの設定

daoConfig

protected DaoConfig daoConfig

Daoの設定

sqlConfig

protected SqlConfig sqlConfig

SQLの設定

コンストラクタの詳細

Gen

public Gen()

メソッドの詳細

setUser

public void setUser(String user)

JDBC接続ユーザーを設定します。

パラメータ:

user - JDBC接続ユーザー

setPassword

public void setPassword(String password)

JDBC接続パスワードを設定します。

パラメータ:

password - JDBC接続パスワード

setUrl

public void setUrl(String url)

JDBC接続URLを設定します。

パラメータ:

url - JDBC接続URL

setDriverClassName

public void setDriverClassName(String driverClassName)

Driver のサブタイプのクラス名を設定します。

パラメータ:

driverClassName - Driver のサブタイプのクラス名

setDialectName

public void setDialectName(DialectNameAttribute dialectName)

方言名を設定します。

パラメータ:

dialectName - 方言名

setGenDialectClassName

public void setGenDialectClassName(String genDialectClassName)

GenDialect のサブタイプのクラス名を設定します。

パラメータ:

genDialectClassName - GenDialect のサブタイプのクラス名

setSchemaName

public void setSchemaName(String schemaName)

対象とするテーブルが属するスキーマ名を設定します。

パラメータ:

schemaName - 対象とするテーブルが属するスキーマ名

setTableNamePattern

public void setTableNamePattern(String tableNamePattern)

対象とするテーブル名の正規表現を設定します。

パラメータ:

tableNamePattern - 対象とするテーブル名の正規表現

setIgnoredTableNamePattern

public void setIgnoredTableNamePattern(String ignoredTableNamePattern)

対象としないテーブル名の正規表現を設定します。

パラメータ:

ignoredTableNamePattern - 対象としないテーブル名の正規表現

setTableTypes

public void setTableTypes(String tableTypes)

カンマまたは空白で区切られたテーブルの型のリストを設定します

パラメータ:

tableTypes - カンマまたは空白で区切られたテーブルの型のリスト

setVersionColumnNamePattern

public void setVersionColumnNamePattern(String versionColumnNamePattern)

バージョンカラム名のパターンを設定します。

パラメータ:

versionColumnNamePattern - バージョンカラム名のパターン

setTemplateEncoding

public void setTemplateEncoding(String templateEncoding)

テンプレートのエンコーディングを設定します。

パラメータ:

templateEncoding - テンプレートのエンコーディング

setTemplatePrimaryDir

public void setTemplatePrimaryDir(File templatePrimaryDir)

テンプレートを格納するプライマリディレクトリを設定します。

パラメータ:

templatePrimaryDir - テンプレートを格納するプライマリディレクトリ、使用しない場合 null

createEntityConfig

public EntityConfig createEntityConfig()

エンティティの設定を作成します。

戻り値:

エンティティの設定

createDaoConfig

public DaoConfig createDaoConfig()

Daoの設定を作成します。

戻り値:

Daoの設定

createSqlConfig

public SqlConfig createSqlConfig()

SQLの設定を作成します。

戻り値:

SQLの設定

doValidate

protected void doValidate()

クラス AbstractTask の記述:

サブクラスで検証します。

定義:

クラス AbstractTask 内の doValidate

doPrepare

protected void doPrepare()

クラス AbstractTask の記述:

サブクラスで準備します。

定義:

クラス AbstractTask 内の doPrepare

createDataSource

protected DataSource createDataSource()

データソースを作成します。

戻り値:

データソース

createTableMetaReader

protected TableMetaReader createTableMetaReader()

テーブルメタデータを作成します。

戻り値:

テーブルメタデータ

createEntityPropertyClassNameResolver

protected EntityPropertyClassNameResolver createEntityPropertyClassNameResolver()

エンティティプロパティのクラス名リゾルバを作成します。

戻り値:

エンティティプロパティのクラス名リゾルバ

createEntityPropertyDescFactory

protected EntityPropertyDescFactory createEntityPropertyDescFactory()

グローバルファクトリを作成します。

戻り値:

グローバルファクトリ

createEntityDescFactory

protected EntityDescFactory createEntityDescFactory()

エンティティ記述ファクトリを作成します。

戻り値:

エンティティ記述ファクトリ

createEntityListenerDescFactory

protected EntityListenerDescFactory createEntityListenerDescFactory()

エンティティリスナー記述ファクトリを作成します。

戻り値:

エンティティリスナー記述ファクトリ

createDaoDescFactory

protected DaoDescFactory createDaoDescFactory()

Dao記述ファクトリを作成します。

戻り値:

Dao記述ファクトリ

createDaoDelegateDescFactory

protected DaoDelegateDescFactory createDaoDelegateDescFactory()

Daoデリゲート記述ファクトリを作成します。

戻り値:

Daoデリゲート記述ファクトリ

導入されたバージョン:

1.7.0

createSqlDescFactory

protected SqlDescFactory createSqlDescFactory()

SQL記述ファクトリを作成します。

戻り値:

SQL記述ファクトリ

createGenerator

protected Generator createGenerator()

ジェネレータを作成します。

戻り値:

ジェネレータ

doRun

protected void doRun()

クラス AbstractTask の記述:

サブクラスで実行します。

定義:

クラス AbstractTask 内の doRun

generateEntity

protected void generateEntity(EntityDesc entityDesc)

エンティティのJavaコードを生成します。

パラメータ:

entityDesc - エンティティ記述

generateEntityListener

protected void generateEntityListener(EntityListenerDesc entityListenerDesc)

generateDao

protected void generateDao(DaoDesc daoDesc)

DaoのJavaコードを生成します。

パラメータ:

daoDesc - Dao記述

generateDaoDelegate

protected void generateDaoDelegate(DaoDelegateDesc daoDelegateDesc)

DaoデリゲートのJavaコードを生成します。

パラメータ:

daoDelegateDesc - Daoデリゲート記述

導入されたバージョン:

1.7.0

generateSql

protected void generateSql(DaoDesc daoDesc,
                           SqlDesc sqlDesc)

SQLを生成します。

パラメータ:

daoDesc - Dao記述

sqlDesc - SQL記述