The Seasar Project

トップレベルパラメータ

トップレベルパラメータの定義は次の通りです。

ネストした要素として指定されるパラメータ

EntityConfig

エンティティクラスの生成に関する設定を表すデータ型です。

このデータ型を使用するとエンティティクラスとエンティティリスナークラスを生成できます。エンティティクラスとエンティティリスナーは同じパッケージに生成されます。

EntityConfigのパラメータ定義は次のとおりです。

DaoConfig

Daoインタフェースの生成に関する設定を表すデータ型です。

このデータ型を使用するとエンティティごとに1つのDaoインタフェースとDaoデリゲートクラスを生成できます。

DaoConfigのパラメータ定義は次のとおりです。

SqlConfig

SQLファイルの生成に関する設定を表すデータ型です。

このデータ型を使用するとエンティティごとにデフォルトで2つのSQLファイルを生成できます。 生成されるSQLは次のものです。

• 条件に識別子を指定して検索するSQL
• 条件に識別子とバージョンを指定して検索するSQL

ただし、エンティティが識別子を持たない場合、SQLファイルは生成されません。 また、エンティティがバージョンを持たない場合は、条件にバージョンを指定するSQLは生成されません。

テンプレートを用意することで、独自のSQLファイルを生成できます。詳細は、独自のSQLファイルを生成するを参照してください。

SqlConfigのパラメータ定義は次のとおりです。

エンティティクラスに共通のスーパークラスを指定する

EntityConfigのsuperclassName属性に、エンティティクラスに共通のスーパークラスの名前を指定できます。 たとえば、エンティティに対応するすべてのテーブルにCREATE_TIMESTAMPとUPDATE_TIMESTAMPというカラムが定義されている場合、 次のようなクラスを作成し、すべてのエンティティのスーパークラスに指定できます。

@Entity
public abstract class Common {
    Date createTimestamp;
    Date updateTimestamp;
    ...
}

スーパークラス名をsuperclassName属性に指定します。

<gen
    dialectName="${dialectName}"
    driverClassName="${driverClassName}"
    url="${url}"
    user="${user}"
    password="${password}">
    <entityConfig
        superclassName="example.Common"
        ...
    />
<gen/>

タスクを実行するとexample.Commonを継承した次のようなクラスが生成されます。

@Entity
public class Employee extends Common {
    @Id
    Integer id;
    String name;
    ...
}

エンティティリスナーに共通のスーパークラスを指定する

EntityConfigのlistenerSuperclassName属性に、エンティティリスナーに共通のスーパークラスの名前を指定できます。 通常、EntityConfigのsuperclassName属性と合わせて使用します。 たとえば、次のようにエンティティクラスに共通のスーパークラスとそのクラスを型パラメータとして受け取るエンティティリスナーの2つを用意します。

@Entity
public abstract class Common {
    Date createTimestamp;
    Date updateTimestamp;
    ...
}

public class CommonListener<T extends Common> implements EntityListener<T> {
    public void preInsert(T entity, PreInsertContext<T> context) {...}
    public void preUpdate(T entity, PreUpdateContext<T> context) {...}
    public void preDelete(T entity, PreDeleteContext<T> context) {...}
    public void postInsert(T entity, PostInsertContext<T> context) {...}
    public void postUpdate(T entity, PostUpdateContext<T> context) {...}
    public void postDelete(T entity, PostDeleteContext<T> context) {...}
}

これらのクラス名をsuperclassName属性とlistenerSuperclassName属性に指定します。

<gen
    dialectName="${dialectName}"
    driverClassName="${driverClassName}"
    url="${url}"
    user="${user}"
    password="${password}">
    <entityConfig
        superclassName="example.Common"
        listenerSuperclassName="example.CommonListener"
        ...
    />
<gen/>

タスクを実行するとexample.CommonListenerを継承した次のようなクラスが生成されます。

public class EmployeeListener extends CommonListener<Employee> {
}

エンティティプロパティのクラス名を指定する

ドメインクラスを使用する場合など、特定のエンティティプロパティに対しクラス名を指定したいことがあります。

クラス名の指定は、プロパティファイルで行います。 キーは、エンティティプロパティの完全修飾名を正規表現で表したもの、値はマッピングしたいクラスの完全修飾名です。 エンティティプロパティの完全修飾名とは、「エンティティクラスの完全修飾名」と「エンティティプロパティ名」を「@」で連結したものです。 たとえば、EmployeeエンティティクラスのエンティティプロパティemployeeNameの完全修飾名は、「example.entity.Employee@employeeName」です。 Employeeエンティティクラスの中でエンティティプロパティ名が「Name」で終わるものを「example.domain.Name」クラスにマッピングさせるには、次のように記述します。

example.entity.Employee@.*Name$=example.domain.Name

プロパティ名の部分を正規表現で示しています。正規表現はプロパティ名に対してのみ使用できます（@より左のクラス名は必ず完全修飾名でなければいけません）。

生成されるエンティティクラスでは、次のようにemployeeNameプロパティの型が「example.domain.Name」になります。

import example.domain.Name;

@Entity
public class Employee extends Common {
    @Id
    Integer id;
    Name employeeName;
    ...
}

Employeeエンティティクラスに限らず、すべてのエンティティクラスを対象にエンティティプロパティ名が「Name」で終わるものを「example.domain.Name」クラスにマッピングさせたい場合は次のように記述します。

.*Name$=example.domain.Name

プロパティファイルは、エンティティプロパティごとに上から順番に評価され、正規表現がマッチした時点で評価を終えます。 どの行にもマッチしない場合、クラス名はデフォルトのクラス名になります。

プロパティファイルはentityPropertyClassNamesFile属性に指定できます。（ここではプロパティファイルの名前をentityPropertyClassNames.propertiesとします。）

<gen
    dialectName="${dialectName}"
    driverClassName="${driverClassName}"
    url="${url}"
    user="${user}"
    password="${password}">
    <entityConfig
        entityPropertyClassNamesFile="entityPropertyClassNames.properties"
        ...
    />
<gen/>

独自のテンプレートファイルを使用する

Doma-Genのテンプレートは、配布ファイルのresources/templateディレクトリ以下にあります。 エンティティクラスのテンプレートはentity.ftl、エンティティリスナークラスのテンプレートはentityListener.ftl、Daoインタフェースのテンプレートはdao.ftl、DaoデリゲートクラスのテンプレートはdaoDelegate.ftlになります。 また、識別子を条件に検索するSQLのテンプレートはselectById.sql.ftl、識別子とバージョンを条件に検索するSQLのテンプレートはselectByIdAndVersion.sql.ftlです。 これをコピーして、修正を加えるのが良いでしょう。 テンプレートの記述方法についてはFreeMarkerのドキュメントを参照してください。

修正したテンプレートファイルは、ファイル名を変更せずにtemplateFilePrimaryDir属性に指定するディレクトリに配置します。 mytemplateディレクトリに配置する場合、templatePrimaryDir属性にmytemplateを指定します。

<gen
    dialectName="${dialectName}"
    driverClassName="${driverClassName}"
    url="${url}"
    user="${user}"
    password="${password}"
    templatePrimaryDir="mytemplate">
    <entityConfig
        ...
    />
<gen/>

それぞれのテンプレートは、特定のデータモデルを参照します。 テンプレートとデータモデルクラスの対応付けを以下に示します。

独自のSQLファイルを生成する

テンプレートを用意することで、独自のSQLファイルを生成できます。 テンプレートファイルの名前は、「生成したいsqlファイル名」 + 「.ftl」としてください。

たとえば、全件検索を行うSQLファイルselectAll.sqlを生成するには、selectAll.sql.ftlという名前のテンプレートファイルを作成します。 テンプレートファイルには、以下のように記述します。 （テンプレートはデータモデルとしてorg.seasar.doma.extension.gen.SqlDescのインスタンスを参照します。）

select
<#list entityDesc.entityPropertyDescs as property>
  ${property.columnName}<#if property_has_next>,</#if>
</#list>
from
  ${entityDesc.tableName}

selectAll.sql.ftlは、templateFilePrimaryDir属性に指定するディレクトリに配置します。 mytemplateディレクトリに配置する場合、templatePrimaryDir属性にmytemplateを指定します。

<gen
    dialectName="${dialectName}"
    driverClassName="${driverClassName}"
    url="${url}"
    user="${user}"
    password="${password}"
    templatePrimaryDir="mytemplate">
    <sqlConfig
        ...
    />
<gen/>

このように、独自のSQLファイルを生成する場合、SQLファイルに対応するDaoメソッドについても生成するとよいでしょう。 Daoメソッドを生成するには、Daoインタフェースのテンプレートであるdao.ftlを修正し、templateFilePrimaryDir属性に指定するディレクトリに配置します。

生成するJavaファイルに共通のヘッダーとしてコピーライトを含める

lib.ftlというファイルを作成し、これをtemplatePrimaryDir属性に指定するディレクトリに配置します。 lib.ftlには次のようにcopyrightの定義をします。

<#assign copyright>
/*
 * Copyright 2008-2009 ...
 * All rights reserved.
 */
</#assign>

<gen
    dialectName="${dialectName}"
    driverClassName="${driverClassName}"
    url="${url}"
    user="${user}"
    password="${password}"
    templatePrimaryDir="mytemplate">
    <entityConfig
        ...
    />
<gen/>

生成するJavaファイルにauthorを指定する

lib.ftlというファイルを作成し、これをtemplatePrimaryDir属性に指定するディレクトリに配置します。 lib.ftlには次のようにauthorの定義をします。

<#assign author="Nakamura">

<gen
    dialectName="${dialectName}"
    driverClassName="${driverClassName}"
    url="${url}"
    user="${user}"
    password="${password}"
    templatePrimaryDir="mytemplate">
    <entityConfig
        ...
    />
<gen/>