- The torque-gf templates are a set of templates for the torque-gf - code generator to produce code and sql for a given data model. - The data model needs to follow the torque dtd.
+ The torque templates are a set of templates for the torque + generator to produce code and sql for a given data model. + The data model needs to follow the torque dtd (TODO: link to dtd).
In the templates, the different generation goals (om classes, sql, doc...) are organized in different packages. For each generation goal, the correct package needs to be accessed. This is described in detail in the following sections.
- In the following, it is assumed that the maven 2 torque-gf plugin is - used to process the templates. + In the following, it is assumed that the maven 2 torque-generator plugin + is used to process the templates.

- For adding the maven 2 torque-gf plugin to your build, add the following - to your pom.xml: + For adding the maven 2 torque-generator plugin to your build, + add the following to your pom.xml:

org.apache.torque - maven-torque-gf-plugin - 0.2-SNAPSHOT + maven-torque-generator-plugin + 4.0-alpha1-SNAPSHOT ...(see below) org.apache.torque - templates-4-0 - 0.2-SNAPSHOT + torque-templates + 4.0-alpha1-SNAPSHOT @@ -63,7 +63,7 @@

For generating the OM classes, add the following execution to the - executions list of the maven torque-gf plugin: + executions list of the torque-generator plugin:

@@ -84,15 +84,17 @@ ]]>

- Replace ${torque.target.database} with the target databsase type + Replace ${torque.target.database} with the target database type (e.g. mysql, oracle). Replace ${torque.schema.source.dir} with the directory where you put your database schemata (e.g. /src/main/schema). Replace ${torque.target.package} with the base package for your generation, e.g. org.apache.torque.test.

- This will generate the om code in the directories - target/generated-sources and src/main/generated-sources. + This will generate the om code for all source files in the schema + directory ending on -schema.xml, but excluding id-table-schema.xml. + The output will be produced in the directories + target/generated-sources and src/main/generated-java.

@@ -122,13 +124,14 @@ ]]>

- This will generate the sql code in the directory + This will generate the sql code for all source files in the schema + directory ending on -schema.xml; the output goes to the directory target/generated-sql.

@@ -160,21 +163,23 @@ ]]>

- This will generate the html documentation in the directory - target/generated-docs. + This will generate the html documentation for all source files + in the schema directory ending on -schema.xml. + The output will be produced in the directory target/generated-docs.

- For generating xdoc documentation for the tables (to be included), - into your maven site, add the following execution to the executions list + For generating xdoc documentation for the tables + (to be included into your maven site), + add the following execution to the executions list of the maven torque-gf plugin:

]]>

- This will generate the xdoc documentation in the directory - target/generated-xdocs. You may then want to add the following - configuration to your pom to include this directory in your site: + This will generate the xdoc documentation + for all source files in the schema directory ending on -schema.xml. + The output is produced in the directory target/generated-xdocs. + You may then want to add the following configuration to your pom + to include this directory in your site:

--------------------------------------------------------------------- To unsubscribe, e-mail: torque-dev-unsubscribe@db.apache.org For additional commands, e-mail: torque-dev-help@db.apache.org