Gen (doma-gen 2.0.0 API)

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

All Implemented Interfaces:

java.lang.Cloneable
```
public class Gen
extends AbstractTask
```
コードを生成します。
次のコードを生成できます。
- エンティティクラス
- エンティティリスナークラス
- Daoインタフェース
- SQL

Field Summary

Fields
Modifier and Type	Field and Description
`protected DaoConfig`	`daoConfig` Daoの設定
`protected DaoDescFactory`	`daoDescFactory` Dao記述のファクトリ
`protected javax.sql.DataSource`	`dataSource` データソース
`protected GenDialect`	`dialect` 方言
`protected java.lang.String`	`dialectClassName` `org.seasar.doma.jdbc.dialect.Dialect` のサブタイプのクラス名
`protected DialectNameAttribute`	`dialectName` 方言名
`protected java.lang.String`	`driverClassName` `Driver` のサブタイプのクラス名
`protected EntityConfig`	`entityConfig` エンティティの設定
`protected EntityDescFactory`	`entityDescFactory` エンティティ記述のファクトリ
`protected EntityListenerDescFactory`	`entityListenerDescFactory` エンティティリスナー記述のファクトリ
`protected EntityPropertyClassNameResolver`	`entityPropertyClassNameResolver` エンティティプロパティのクラス名リゾルバ
`protected EntityPropertyDescFactory`	`entityPropertyDescFactory` エンティティプロパティ記述のファクトリ
`protected java.lang.String`	`genDialectClassName` `GenDialect` のサブタイプのクラス名
`protected Generator`	`generator` ジェネレータ
`protected java.lang.String`	`ignoredTableNamePattern` 対象としないテーブル名の正規表現
`protected java.lang.String`	`password` JDBC接続パスワード
`protected ResultSetMetaReader`	`resultSetMetaReader` 結果セットメタデータのファクトリ
`protected java.lang.String`	`schemaName` 対象とするテーブルが属するスキーマ名
`protected SqlConfig`	`sqlConfig` SQLの設定
`protected SqlDescFactory`	`sqlDescFactory` SQL記述ファクトリ
`protected SqlTestCaseConfig`	`sqlTestCaseConfig` SQLテストケースの設定
`protected SqlTestCaseDescFactory`	`sqlTestCaseDescFactory` SQLテストケース記述ファクトリ
`protected SqlTestSuiteDescFactory`	`sqlTestSuiteDescFactory` SQLテストスイート記述ファクトリ
`protected TableMetaReader`	`tableMetaReader` テーブルメタデータのファクトリ
`protected java.lang.String`	`tableNamePattern` 対象とするテーブル名の正規表現
`protected java.util.List<java.lang.String>`	`tableTypes` 対象とするテーブルの型のリスト
`protected java.lang.String`	`templateEncoding` テンプレートのエンコーディング
`protected java.io.File`	`templatePrimaryDir` テンプレートを格納するプライマリディレクトリ、使用しない場合 `null`
`protected java.lang.String`	`url` JDBC接続URL
`protected java.lang.String`	`user` JDBC接続ユーザー
`protected java.lang.String`	`versionColumnNamePattern` バージョンカラム名のパターン。このパターンに合致した場合は `org.seasar.doma.Versino` が注釈されます。

Fields inherited from class org.seasar.doma.extension.gen.task.AbstractTask
globalFactory, globalFactoryClassName

Fields inherited from class org.apache.tools.ant.Task
target, taskName, taskType, wrapper

Fields inherited from class org.apache.tools.ant.ProjectComponent
description, location, project

Constructor Summary

Constructors
Constructor and Description

Gen()

Constructors
Constructor and Description
`Gen()`

Method Summary

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

Methods inherited from class org.seasar.doma.extension.gen.task.AbstractTask
execute, forName, newInstance, prepare, run, setGlobalFactoryClassName, validate

Methods inherited from class 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

Methods inherited from class org.apache.tools.ant.ProjectComponent
clone, getDescription, getLocation, getProject, setDescription, setLocation, setProject

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

- Field Detail
  - dialectName
```
protected DialectNameAttribute dialectName
```
    方言名
  - dialectClassName
```
protected java.lang.String dialectClassName
```
    org.seasar.doma.jdbc.dialect.Dialect のサブタイプのクラス名
  - genDialectClassName
```
protected java.lang.String genDialectClassName
```
    GenDialect のサブタイプのクラス名
  - driverClassName
```
protected java.lang.String driverClassName
```
    Driver のサブタイプのクラス名
  - user
```
protected java.lang.String user
```
    JDBC接続ユーザー
  - password
```
protected java.lang.String password
```
    JDBC接続パスワード
  - url
```
protected java.lang.String url
```
    JDBC接続URL
  - schemaName
```
protected java.lang.String schemaName
```
    対象とするテーブルが属するスキーマ名
  - tableNamePattern
```
protected java.lang.String tableNamePattern
```
    対象とするテーブル名の正規表現
  - ignoredTableNamePattern
```
protected java.lang.String ignoredTableNamePattern
```
    対象としないテーブル名の正規表現
  - tableTypes
```
protected java.util.List<java.lang.String> tableTypes
```
    対象とするテーブルの型のリスト
  - versionColumnNamePattern
```
protected java.lang.String versionColumnNamePattern
```
    バージョンカラム名のパターン。このパターンに合致した場合は org.seasar.doma.Versino が注釈されます。
  - templateEncoding
```
protected java.lang.String templateEncoding
```
    テンプレートのエンコーディング
  - templatePrimaryDir
```
protected java.io.File templatePrimaryDir
```
    テンプレートを格納するプライマリディレクトリ、使用しない場合 null
  - dialect
```
protected GenDialect dialect
```
    方言
  - dataSource
```
protected javax.sql.DataSource dataSource
```
    データソース
  - tableMetaReader
```
protected TableMetaReader tableMetaReader
```
    テーブルメタデータのファクトリ
  - resultSetMetaReader
```
protected ResultSetMetaReader resultSetMetaReader
```
    結果セットメタデータのファクトリ
  - entityPropertyClassNameResolver
```
protected EntityPropertyClassNameResolver entityPropertyClassNameResolver
```
    エンティティプロパティのクラス名リゾルバ
  - entityDescFactory
```
protected EntityDescFactory entityDescFactory
```
    エンティティ記述のファクトリ
  - entityListenerDescFactory
```
protected EntityListenerDescFactory entityListenerDescFactory
```
    エンティティリスナー記述のファクトリ
  - entityPropertyDescFactory
```
protected EntityPropertyDescFactory entityPropertyDescFactory
```
    エンティティプロパティ記述のファクトリ
  - daoDescFactory
```
protected DaoDescFactory daoDescFactory
```
    Dao記述のファクトリ
  - sqlDescFactory
```
protected SqlDescFactory sqlDescFactory
```
    SQL記述ファクトリ
  - sqlTestCaseDescFactory
```
protected SqlTestCaseDescFactory sqlTestCaseDescFactory
```
    SQLテストケース記述ファクトリ
  - sqlTestSuiteDescFactory
```
protected SqlTestSuiteDescFactory sqlTestSuiteDescFactory
```
    SQLテストスイート記述ファクトリ
  - generator
```
protected Generator generator
```
    ジェネレータ
  - entityConfig
```
protected EntityConfig entityConfig
```
    エンティティの設定
  - daoConfig
```
protected DaoConfig daoConfig
```
    Daoの設定
  - sqlConfig
```
protected SqlConfig sqlConfig
```
    SQLの設定
  - sqlTestCaseConfig
```
protected SqlTestCaseConfig sqlTestCaseConfig
```
    SQLテストケースの設定
- Constructor Detail
  - Gen
```
public Gen()
```
- Method Detail
  - setUser
```
public void setUser(java.lang.String user)
```
    JDBC接続ユーザーを設定します。
    
    Parameters:
    
    user - JDBC接続ユーザー
  - setPassword
```
public void setPassword(java.lang.String password)
```
    JDBC接続パスワードを設定します。
    
    Parameters:
    
    password - JDBC接続パスワード
  - setUrl
```
public void setUrl(java.lang.String url)
```
    JDBC接続URLを設定します。
    
    Parameters:
    
    url - JDBC接続URL
  - setDriverClassName
```
public void setDriverClassName(java.lang.String driverClassName)
```
    Driver のサブタイプのクラス名を設定します。
    
    Parameters:
    
    driverClassName - Driver のサブタイプのクラス名
  - setDialectName
```
public void setDialectName(DialectNameAttribute dialectName)
```
    方言名を設定します。
    
    Parameters:
    
    dialectName - 方言名
  - setGenDialectClassName
```
public void setGenDialectClassName(java.lang.String genDialectClassName)
```
    GenDialect のサブタイプのクラス名を設定します。
    
    Parameters:
    
    genDialectClassName - GenDialect のサブタイプのクラス名
  - setSchemaName
```
public void setSchemaName(java.lang.String schemaName)
```
    対象とするテーブルが属するスキーマ名を設定します。
    
    Parameters:
    
    schemaName - 対象とするテーブルが属するスキーマ名
  - setTableNamePattern
```
public void setTableNamePattern(java.lang.String tableNamePattern)
```
    対象とするテーブル名の正規表現を設定します。
    
    Parameters:
    
    tableNamePattern - 対象とするテーブル名の正規表現
  - setIgnoredTableNamePattern
```
public void setIgnoredTableNamePattern(java.lang.String ignoredTableNamePattern)
```
    対象としないテーブル名の正規表現を設定します。
    
    Parameters:
    
    ignoredTableNamePattern - 対象としないテーブル名の正規表現
  - setTableTypes
```
public void setTableTypes(java.lang.String tableTypes)
```
    カンマまたは空白で区切られたテーブルの型のリストを設定します
    
    Parameters:
    
    tableTypes - カンマまたは空白で区切られたテーブルの型のリスト
  - setVersionColumnNamePattern
```
public void setVersionColumnNamePattern(java.lang.String versionColumnNamePattern)
```
    バージョンカラム名のパターンを設定します。
    
    Parameters:
    
    versionColumnNamePattern - バージョンカラム名のパターン
  - setTemplateEncoding
```
public void setTemplateEncoding(java.lang.String templateEncoding)
```
    テンプレートのエンコーディングを設定します。
    
    Parameters:
    
    templateEncoding - テンプレートのエンコーディング
  - setTemplatePrimaryDir
```
public void setTemplatePrimaryDir(java.io.File templatePrimaryDir)
```
    テンプレートを格納するプライマリディレクトリを設定します。
    
    Parameters:
    
    templatePrimaryDir - テンプレートを格納するプライマリディレクトリ、使用しない場合 null
  - createEntityConfig
```
public EntityConfig createEntityConfig()
```
    エンティティの設定を作成します。
    
    Returns:
    
    エンティティの設定
  - createDaoConfig
```
public DaoConfig createDaoConfig()
```
    Daoの設定を作成します。
    
    Returns:
    
    Daoの設定
  - createSqlConfig
```
public SqlConfig createSqlConfig()
```
    SQLの設定を作成します。
    
    Returns:
    
    SQLの設定
  - createSqlTestCaseConfig
```
public SqlTestCaseConfig createSqlTestCaseConfig()
```
    SQLテストケースの設定を作成します。
    
    Returns:
    
    SQLテストケースの設定
  - doValidate
```
protected void doValidate()
```
    Description copied from class: AbstractTask
    
    サブクラスで検証します。
    
    Specified by:
    
    doValidate in class AbstractTask
  - doPrepare
```
protected void doPrepare()
```
    Description copied from class: AbstractTask
    
    サブクラスで準備します。
    
    Specified by:
    
    doPrepare in class AbstractTask
  - createDataSource
```
protected javax.sql.DataSource createDataSource()
```
    データソースを作成します。
    
    Returns:
    
    データソース
  - createTableMetaReader
```
protected TableMetaReader createTableMetaReader()
```
    テーブルメタデータのファクトリを作成します。
    
    Returns:
    
    テーブルメタデータのファクトリ
  - createResultSetMetaReader
```
protected ResultSetMetaReader createResultSetMetaReader()
```
    結果セットメタデータのファクトリを作成します。
    
    Returns:
    
    結果セットメタデータのファクトリ
  - createEntityPropertyClassNameResolver
```
protected EntityPropertyClassNameResolver createEntityPropertyClassNameResolver()
```
    エンティティプロパティのクラス名リゾルバを作成します。
    
    Returns:
    
    エンティティプロパティのクラス名リゾルバ
  - createEntityPropertyDescFactory
```
protected EntityPropertyDescFactory createEntityPropertyDescFactory()
```
    グローバルファクトリを作成します。
    
    Returns:
    
    グローバルファクトリ
  - createEntityDescFactory
```
protected EntityDescFactory createEntityDescFactory()
```
    エンティティ記述ファクトリを作成します。
    
    Returns:
    
    エンティティ記述ファクトリ
  - createEntityListenerDescFactory
```
protected EntityListenerDescFactory createEntityListenerDescFactory()
```
    エンティティリスナー記述ファクトリを作成します。
    
    Returns:
    
    エンティティリスナー記述ファクトリ
  - createDaoDescFactory
```
protected DaoDescFactory createDaoDescFactory()
```
    Dao記述ファクトリを作成します。
    
    Returns:
    
    Dao記述ファクトリ
  - createSqlDescFactory
```
protected SqlDescFactory createSqlDescFactory()
```
    SQL記述ファクトリを作成します。
    
    Returns:
    
    SQL記述ファクトリ
  - createSqlTestCaseDescFactory
```
protected SqlTestCaseDescFactory createSqlTestCaseDescFactory()
```
    SQLテストケース記述ファクトリを作成します。
    
    Returns:
    
    SQLテストケース記述ファクトリ
  - createSqlTestSuiteDescFactory
```
protected SqlTestSuiteDescFactory createSqlTestSuiteDescFactory()
```
    SQLテストスイート記述ファクトリを作成します。
    
    Returns:
    
    SQLテストスイート記述ファクトリ
  - createGenerator
```
protected Generator createGenerator()
```
    ジェネレータを作成します。
    
    Returns:
    
    ジェネレータ
  - doRun
```
protected void doRun()
```
    Description copied from class: AbstractTask
    
    サブクラスで実行します。
    
    Specified by:
    
    doRun in class AbstractTask
  - processAll
```
protected void processAll()
```
  - processSingleEntity
```
protected void processSingleEntity()
```
  - generateEntity
```
protected void generateEntity(EntityDesc entityDesc)
```
    エンティティのJavaコードを生成します。
    
    Parameters:
    
    entityDesc - エンティティ記述
  - generateEntityListener
```
protected void generateEntityListener(EntityListenerDesc entityListenerDesc)
```
  - generateDao
```
protected void generateDao(DaoDesc daoDesc)
```
    DaoのJavaコードを生成します。
    
    Parameters:
    
    daoDesc - Dao記述
  - generateSql
```
protected void generateSql(DaoDesc daoDesc,
                           SqlDesc sqlDesc)
```
    SQLを生成します。
    
    Parameters:
    
    daoDesc - Dao記述
    
    sqlDesc - SQL記述
  - generateSqlTest
```
protected void generateSqlTest(SqlTestCaseDesc sqlTestCaseDesc)
```
    SQLのテストコードを生成します。
    
    Parameters:
    
    sqlTestCaseDesc - SQLテスト記述

Class Gen

Field Summary

Fields inherited from class org.seasar.doma.extension.gen.task.AbstractTask

Fields inherited from class org.apache.tools.ant.Task

Fields inherited from class org.apache.tools.ant.ProjectComponent

Constructor Summary

Method Summary

Methods inherited from class org.seasar.doma.extension.gen.task.AbstractTask

Methods inherited from class org.apache.tools.ant.Task

Methods inherited from class org.apache.tools.ant.ProjectComponent

Methods inherited from class java.lang.Object

Field Detail

dialectName

dialectClassName

genDialectClassName

driverClassName

user

password

url

schemaName

tableNamePattern

ignoredTableNamePattern

tableTypes

versionColumnNamePattern

templateEncoding

templatePrimaryDir

dialect

dataSource

tableMetaReader

resultSetMetaReader

entityPropertyClassNameResolver

entityDescFactory

entityListenerDescFactory

entityPropertyDescFactory

daoDescFactory

sqlDescFactory

sqlTestCaseDescFactory

sqlTestSuiteDescFactory

generator

entityConfig

daoConfig

sqlConfig

sqlTestCaseConfig

Constructor Detail

Gen

Method Detail

setUser

setPassword

setUrl

setDriverClassName

setDialectName

setGenDialectClassName

setSchemaName

setTableNamePattern

setIgnoredTableNamePattern

setTableTypes

setVersionColumnNamePattern

setTemplateEncoding

setTemplatePrimaryDir

createEntityConfig

createDaoConfig

createSqlConfig

createSqlTestCaseConfig

doValidate

doPrepare

createDataSource

createTableMetaReader

createResultSetMetaReader

createEntityPropertyClassNameResolver

createEntityPropertyDescFactory

createEntityDescFactory

createEntityListenerDescFactory

createDaoDescFactory

createSqlDescFactory

createSqlTestCaseDescFactory

createSqlTestSuiteDescFactory

createGenerator

doRun

processAll

processSingleEntity