説明
概要
名前クラスを生成します。 名前クラスとは、エンティティのプロパティ名に対応するメソッドをもつクラスで、エンティティクラスにつき1つ生成されます。 生成される名前クラスは次のようなコードになります。 これはエンティティクラスAddressに対する名前クラスです。
/** * {@link Address}のプロパティ名の集合です。 * * @author S2JDBC-Gen */ public class AddressNames { /** * idのプロパティ名を返します。 * * @return idのプロパティ名 */ public static PropertyName<Integer> id() { return new PropertyName<Integer>("id"); } /** * cityのプロパティ名を返します。 * * @return cityのプロパティ名 */ public static PropertyName<String> city() { return new PropertyName<String>("city"); } /** * employeeのプロパティ名を返します。 * * @return employeeのプロパティ名 */ public static _EmployeeNames employee() { return new _EmployeeNames("employee"); } /** * @author S2JDBC-Gen */ public static class _AddressNames extends PropertyName<Address> { /** * インスタンスを構築します。 */ public _AddressNames() { } /** * インスタンスを構築します。 * * @param name * 名前 */ public _AddressNames(final String name) { super(name); } /** * インスタンスを構築します。 * * @param parent * 親 * @param name * 名前 */ public _AddressNames(final PropertyName<?> parent, final String name) { super(parent, name); } /** * idのプロパティ名を返します。 * * @return idのプロパティ名 */ public PropertyName<Integer> id() { return new PropertyName<Integer>(this, "id"); } /** * cityのプロパティ名を返します。 * * @return cityのプロパティ名 */ public PropertyName<String> city() { return new PropertyName<String>(this, "city"); } /** * employeeのプロパティ名を返します。 * * @return employeeのプロパティ名 */ public _EmployeeNames employee() { return new _EmployeeNames(this, "employee"); } } }
名前クラスは、エンティティクラスの修正のたびに再作成し、常に最新のプロパティを反映させてください。
名前クラスのメソッドは、static importの機能を使って呼び出されることを想定しています。 static importを利用した名前クラスの使用例は次のようになります。
List<Address> list = jdbcManager .from(Address.class) .innerJoin(employee()) .where(eq(city(), "TOKYO")) .getResultList();
employee()とcity()が名前クラスのメソッドです。
パラメータ
トップレベルのパラメータ
属性 | 説明 | デフォルト値 | 必須 |
---|---|---|---|
classpathDir | エンティティクラスを含むクラスパスのディレクトリです。このディレクトリはタスクの実行時のクラスパスに含まれている必要があります。 | - | YES |
rootPackageName | ルートパッケージ名です。 | "" | NO |
entityPackageName | エンティティクラスのパッケージ名です。エンティティクラスは、rootPackageNameとこの値をピリオドで連結したパッケージに配置されているとみなされます。 | "entity" | NO |
entityClassNamePattern | このタスクで対象とするエンティティクラス名の正規表現です。 | ".*" | NO |
ignoreEntityClassNamePattern | このタスクで対象としないエンティティクラス名の正規表現です。 | "" | NO |
namesPackageName | 名前クラスのパッケージ名です。名前クラスは、rootPackageNameとこの値をピリオドで連結したパッケージに配置されます。 | "entity" | NO |
namesClassNameSuffix | 名前クラス名のサフィックスです。 | "Names" | NO |
namesTemplateFileName | 名前クラスのテンプレートファイル名です。 | "java/names.ftl" | NO |
templateFileEncoding | テンプレートファイルのエンコーディングです。 | "UTF-8" | NO |
templateFilePrimaryDir | テンプレートファイルを検索する際の優先ディレクトリです。 | - | NO |
javaFileDestDir | Javaファイルの出力先ディレクトリです。 | "src/main/java" | NO |
javaFileEncoding | Javaファイルのエンコーディングです。 | "UTF-8" | NO |
overwrite | "true"の場合、名前インタフェースのJavaファイルを上書きします。 | "true" | NO |
configPath | JdbcManagerのコンポーネント定義を含む設定ファイルです。 | "s2jdbc.dicon" | NO |
env | 環境名です。 | "ut" | NO |
jdbcManagerName | JdbcManagerのコンポーネント名です。接続先のデータベースはJdbcManagerのコンポーネント名によって決まります。 | "jdbcManager" | NO |
factoryClassName | S2JDBC-Genの公開されたインタフェースの実装を作成するファクトリのクラス名です。S2JDBC-Genをカスタマイズする場合に独自のファクトリクラスを指定できます。ここに指定するクラスはorg.seasar.extension.jdbc.gen.internal.factory.Factoryインタフェースを実装している必要があります。 | "org.seasar.extension.jdbc.gen .internal.factory.FactoryImpl" |
NO |
commandInvokerClassName | S2JDBC-Genのコマンドを呼び出すクラスの名前です。コマンドの呼び出し前後で任意の処理を実行したい場合に指定します。ここに指定するクラスはorg.seasar.extension.jdbc.gen.command.CommandInvokerインタフェースを実装している必要があります。 | "org.seasar.extension.jdbc.gen .internal.command.CommandInvokerImpl" |
NO |
classpath | このタスクを実行する際のクラスパスです。 | - | classpathrefが指定されていない場合YES |
classpathref | このタスクを実行する際のクラスパスの参照です。 | - | classpathが指定されていない場合YES |