- The dependencies of a project are specified - in a file named project.xml in the + The dependencies of a project are specified + in a file named project.xml in the top level directory of your project. (This is not the only use of this file, - see the + see the maven getting started guide - and the + and the Maven Project descriptor reference for more information.) @@ -182,9 +182,9 @@

If you did not create a project.xml file yet, - create it in the top level directory of your project + create it in the top level directory of your project and fill it using the following template. (If you - already have a project.xml, + already have a project.xml, just add the dependency.)

- Replace the variables ${driverJarName}, - ${databaseName}, and ${driverVersion} by the values - needed to locate the driver jar. These variable + Replace the variables ${driverJarName}, + ${databaseName}, and ${driverVersion} by the values + needed to locate the driver jar. These variable must be chosen such that using the path - ${repo}/${groupId}/${type}s/${artifactId}-${version}.${type} + ${repo}/${groupId}/${type}s/${artifactId}-${version}.${type} points to the driver jar you copied into the local maven repository. - Here, ${repo} is the path to the - local maven repository, ${type} is set to - jar by default, and the other variables + Here, ${repo} is the path to the + local maven repository, ${type} is set to + jar by default, and the other variables are set in the project.xml. If the name of the driver jar cannot be expressed as - ${artifactId}-${version}.${type}, rename + ${artifactId}-${version}.${type}, rename the driver jar in yor local maven repository.

For example, if the downloaded driver was put into the local - repository as + repository as mysql/jars/mysql-connector-java-3.1.6-bin.jar, ${artifactId} would be set to mysql-connector-java, @@ -258,22 +258,22 @@ ]]>

- Note that creating the database might not work + Note that creating the database might not work for some databases at all (e.g. oracle). - Also, for other databases (e.g. mysql), - the database user must be database administrator + Also, for other databases (e.g. mysql), + the database user must be database administrator to be able to create the database, and often (e.g. mysql, postgresql), one must connect to a database which is different from the database - which one wants to create (this is why there are - different properties + which one wants to create (this is why there are + different properties torque.database.createUrl and torque.database.buildUrl - in the project.properties + in the project.properties for creating the database and the tables, - respectively).
- If you encounter problems in this step, - you might want to skip it + respectively).
+ If you encounter problems in this step, + you might want to skip it and create the database manually.

- +

- The libraries which the generated classes depend on + The libraries which the generated classes depend on are specified in the file project.xml in the top level directory of the project. - You already created this file in step 3 of the - tutorial; now it needs to be extended a bit. + You already created this file in step 3 of the + tutorial; now it needs to be extended a bit. Assuming that you use JDK 1.4+, you need to add the following entries to the <dependencies> section of your project.xml @@ -124,7 +124,7 @@ village 2.0-dev-20030825 - + xercesImpl xerces @@ -136,19 +136,19 @@ xml-apis 2.0.2 - + ]]>

- You need not download any of these libraries - - Maven will download them automatically when you + You need not download any of these libraries - + Maven will download them automatically when you build your project.

Note: There is no need to include the torque-gen jar file in your project - classpath, including it may adversly affect the logging configuration of + classpath, including it may adversly affect the logging configuration of your application.

@@ -158,7 +158,7 @@

- The second step in the configuration of the + The second step in the configuration of the Torque Runtime are the Torque run-time properties. As the name suggests, these properties are used when your application is @@ -172,11 +172,11 @@

- We will save our runtime properties in the + We will save our runtime properties in the a file called torque.properties. Create a subdirectory src/conf in the top-level directory of your project, and create - a new file called torque.properties + a new file called torque.properties in it. Add the following lines to this file:

@@ -273,23 +273,23 @@

- Torque uses + Torque uses commons-logging as a logging interface. - To enable logging in your application, read the + To enable logging in your application, read the commons-logging user guide.

- +

If you have no trouble running the tutorial, you do not need to configure logging now. If, however, - you experience runtime errors later on - and do not find the reason immediately, - it might be a good idea to configure - logging and look at the log messages. Also, for a - "serious" application, logging is - indispensible in order to track down any + you experience runtime errors later on + and do not find the reason immediately, + it might be a good idea to configure + logging and look at the log messages. Also, for a + "serious" application, logging is + indispensible in order to track down any unexpected errors.

Modified: db/torque/runtime/trunk/xdocs/tutorial/step6.xml URL: http://svn.apache.org/viewcvs/db/torque/runtime/trunk/xdocs/tutorial/step6.xml?rev=239636&r1=239635&r2=239636&view=diff ============================================================================== --- db/torque/runtime/trunk/xdocs/tutorial/step6.xml (original) +++ db/torque/runtime/trunk/xdocs/tutorial/step6.xml Wed Aug 24 05:38:09 2005 @@ -33,10 +33,10 @@ Now that you've generated your object model with Torque, and created a sample application, you are now ready to compile everything. Again, Maven is used - to control the build process. + to control the build process.

- First, we need to tell maven where the java source + First, we need to tell maven where the java source files are located. To do this, add the following section just after the <dependencies> of your project.xml which you created sooner on in the @@ -49,9 +49,9 @@ ]]> -

Afterwards, you can compile your jave source files - by typing the following in the top-level directory + by typing the following in the top-level directory of your project:

@@ -64,8 +64,8 @@ build without any errors. All of the resulting Java class files are placed in the target/classes directory. If the compiler - misses any external libraries, review the - <dependencies> section in your + misses any external libraries, review the + <dependencies> section in your project.xml. Should you encounter other errors, go back and review your application code. @@ -83,22 +83,22 @@ jars denoted in the <dependencies> section of your project.xml, and all of your application and object model classes located in - target/classes. + target/classes.

- Before compiling your application, + Before compiling your application, maven will have downloaded all libraries your project depends on to the local maven repository. Gathering them from there is a cumbersome process. - To ease copying them into one place, we modify + To ease copying them into one place, we modify Maven's build process a little. For this, you need to create a new file called - maven.xml in the top-level directory - of your project. It needs to have the + maven.xml in the top-level directory + of your project. It needs to have the following content:

- + @@ -119,15 +119,15 @@ ]]>

- Now change into the target directory. In addition - to the classes subdirectory which was + Now change into the target directory. In addition + to the classes subdirectory which was already created in the first compilation run, you see that maven has generated an additional - lib directory which contains the needed + lib directory which contains the needed libraries, and that maven also copied the Torque.properties file here.

- +

Now everything is in one place, and you can start the application by typing @@ -176,7 +176,7 @@ Booklist (should be empty): ]]> - +

If your application throws an exception, it could be for one of many reasons, most of which are not very Modified: db/torque/runtime/trunk/xdocs/user-guide.xml URL: http://svn.apache.org/viewcvs/db/torque/runtime/trunk/xdocs/user-guide.xml?rev=239636&r1=239635&r2=239636&view=diff ============================================================================== --- db/torque/runtime/trunk/xdocs/user-guide.xml (original) +++ db/torque/runtime/trunk/xdocs/user-guide.xml Wed Aug 24 05:38:09 2005 @@ -63,14 +63,14 @@ Torque consists of two main components:

- Generator - The Torque generator uses a single XML - database schema file to generate the SQL for your target database and - Torque's Peer-based object relational model. The generator can be - executed using the Torque maven-plugin or + Generator - The Torque generator uses a single XML + database schema file to generate the SQL for your target database and + Torque's Peer-based object relational model. The generator can be + executed using the Torque maven-plugin or an Ant build file.
- Runtime - The Torque runtime is required in order to + Runtime - The Torque runtime is required in order to compile and use of the classes produced by the generator.

@@ -83,10 +83,10 @@

- If you have not already done so, download and install - Maven. You then need to obtain the - Torque maven plugin. The Maven Howto - includes details of how to build the maven plugin from source, but you can + If you have not already done so, download and install + Maven. You then need to obtain the + Torque maven plugin. The Maven Howto + includes details of how to build the maven plugin from source, but you can easily install a binary distribution thus:

@@ -100,26 +100,26 @@

- If you prefer to use Ant you need access - to the Torque generator distribution and associated libraries - these are - available from the + If you prefer to use Ant you need access + to the Torque generator distribution and associated libraries - these are + available from the - Downloads page (the file to download is torque-gen-3.2-rc1.tar.gz or + Downloads page (the file to download is torque-gen-3.2-rc1.tar.gz or torque-gen-3.2-rc1.zip, depending on your development platform). Unpack the archive to reveal the following directory structure:

torque.useClasspath to - false + jar containing the templates. If you want to + modify the templates, you can unpack the + templates jar, set the + torque.useClasspath to + false and the torque.schema.dir to the correct directory in the build.properties @@ -127,7 +127,7 @@ IDBroker. build.properties <--- The various properties that you use to configure the Torque generator. - build-torque.xml <--- The Ant build file containing the various torque + build-torque.xml <--- The Ant build file containing the various torque goals. default.properties <--- The default property values that are used to configure the Torque generator. @@ -137,10 +137,10 @@ ]]>

- The instructions below are targeted towards using the Torque maven-plugin. - If you are using Ant the instructions are basically the same, but instead of + The instructions below are targeted towards using the Torque maven-plugin. + If you are using Ant the instructions are basically the same, but instead of using project.properties you use build.properties - and instead of using maven torque:${goal-name} you use + and instead of using maven torque:${goal-name} you use ant -f build-torque.xml ${target-name}.

@@ -149,10 +149,10 @@

- At runtime the generated object model classes need access to the Torque + At runtime the generated object model classes need access to the Torque runtime distribution and associated libraries - these are available from the - Downloads page (the file to download is torque-3.1.1.tar.gz or + Downloads page (the file to download is torque-3.1.1.tar.gz or torque-3.1.1.zip, depending on your development platform). We will cover what to do with this file in a later step.

@@ -270,9 +270,9 @@

- The runtime distribution archive includes an Ant build file that can be used + The runtime distribution archive includes an Ant build file that can be used to generate your Torque runtime configuration - see the Torque - tutSorial for + tutSorial for details.

@@ -280,7 +280,7 @@ torque.database.default = my_project torque.database.my_project.adapter = mysql -# Using commons-dbcp +# Using commons-dbcp torque.dsfactory.my_project.factory = org.apache.torque.dsfactory.SharedPoolDataSourceFactory torque.dsfactory.my_project.connection.driver = org.gjt.mm.mysql.Driver torque.dsfactory.my_project.connection.url = jdbc:mysql://localhost:3306/my_project @@ -289,7 +289,7 @@ ]]>

- The above example uses the commons-dbcp connection pool - see + The above example uses the commons-dbcp connection pool - see Pool-config Howto details of the available DataSource factories.

@@ -299,12 +299,12 @@

- In order to be able to compile and use the generated class files it is + In order to be able to compile and use the generated class files it is necessary to include the Torque runtime jar file and jar files for all of - the necessary dependencies in the classpath of your project. The necessary + the necessary dependencies in the classpath of your project. The necessary jars are included in the torque/lib directory of the Torque runtime. If you are using Maven to build your project it may be easiest to - copy the necessary dependencies from the + copy the necessary dependencies from the Torque runtime POM.

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