Acquiring ojb-blank

The build files +

Configuration via <code>build.properties</code>

@@ -193,7 +223,7 @@ urlProtocol - The protocol of the database url (see below), usually jdbc + The protocol of the database url (see below), usually jdbc. urlSubprotocol @@ -259,6 +289,7 @@

Building via <code>build.xml</code> @@ -301,7 +332,7 @@ xdoclet Creates the runtime configuration files that describe the repository, from javadoc comments embedded in your java source files. Details on how to - this are given in the tutorials + this are given in the tutorials and in the documentation of the XDoclet OJB module. @@ -321,15 +352,225 @@ If you want to create the database as well, and you have javadoc comments in your source code that describe the repository, then you would call Ant this way:

- +

This will perform in that order the actions build, xdoclet - and setup-db.
+ (invoked automatically from the next action) and setup-db.
Of course, you do not need to use Torque to setup your database, but it is a convenient way to do so.

+ +

+ Sample project +

+ First we change the database properties to these values (assuming that Torque will + be used to setup the database): +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Property	Value
jcdAlias	We leave the default value of `default`.
databaseName	Since the application manages products, we call the database + `productmanager`.
databaseUser	This depends on your setup. For the purposes of this guide, let's call him + `steve`.
databasePassword	Again depending on your setup. How about `secret` (you know that + you should not use this password in reality ?!).
dbmsName	`MySQL`
jdbcRuntimeDriver	Its called `com.mysql.jdbc.Driver`.
jdbcLevel	For the newer Mysql drivers this is 3.0.
urlProtocol	The default of `jdbc` will do.
urlSubprotocol	For MySQL, we're using `mysql`.
urlDbalias	Assuming that the database runs locally on the default port, we have + `//localhost/${databaseName}`.
torque.database	We want to use Torque, so we put `mysql` here.
torque.database.createUrl	MySQL allows to create a database via jdbc. The url that we should use + to do so, is the normal url used to access the database minus the database + name. So the value here is: + `${urlProtocol}:${urlSubProtocol}://localhost/`. + Please note that the trailing slash is important.

+ Ok, now we have everything configured for building. The build.properties + file now looks like this (the comments have been removed for brevity): +

+ +

+ Looks like we're ready for building. Again, we're assuming that the source code is + already present. So we're invoking Ant now in the top-level folder + productmanager: +

+ +

+ which should (assuming five java classes) produce an output like this +

+ +[ojbdoclet] Generating ojb repository descriptor (build/resources//repository_user.xml) +[ojbdoclet] Type test.Project +[ojbdoclet] Processed 5 types +[ojbdoclet] Processed 5 types +[ojbdoclet] (XDocletMain.start 47 ) Running +[ojbdoclet] Generating torque schema (build/resources//project-schema.xml) +[ojbdoclet] Processed 5 types + +setup-db: + +check-use-classpath: + +check-run-only-on-schema-change: + +sql-check: + +sql: + [echo] +------------------------------------------+ + [echo] | | + [echo] | Generating SQL for YOUR Torque project! | + [echo] | Woo hoo! | + [echo] | | + [echo] +------------------------------------------+ + +sql-classpath: +[torque-sql] Using contextProperties file: + /home/steve/projects/productmanager/build.properties +[torque-sql] Using classpath +[torque-sql] Generating to file + /home/steve/projects/productmanager/build/resources/report.productmanager.sql.generation +[torque-sql] Parsing file: 'ojbcore-schema.xml' +[torque-sql] (transform.DTDResolver 128 ) Resolver: used database.dtd from + org.apache.torque.engine.database.transform package +[torque-sql] Parsing file: 'project-schema.xml' +[torque-sql] (transform.DTDResolver 140 ) Resolver: used + http://jakarta.apache.org/turbine/dtd/database.dtd + +sql-template: + +create-db-check: + +create-db: +[torque-data-model] Using classpath +[torque-data-model] Generating to file + /home/steve/projects/productmanager/build/resources/create-db.sql +[torque-data-model] Parsing file: 'ojbcore-schema.xml' +[torque-data-model] (transform.DTDResolver 128 ) Resolver: used database.dtd from + org.apache.torque.engine.database.transform package +[torque-data-model] Parsing file: 'project-schema.xml' +[torque-data-model] (transform.DTDResolver 140 ) Resolver: used + http://jakarta.apache.org/turbine/dtd/database.dtd + [echo] + [echo] Executing the create-db.sql script ... + [echo] + [sql] Executing file: + /home/steve/projects/productmanager/build/resources/create-db.sql + [sql] 2 of 2 SQL statements executed successfully + +insert-sql: +[torque-sql-exec] Our new url -> jdbc:mysql://localhost/productmanager +[torque-sql-exec] Executing file: + /home/steve/projects/productmanager/build/resources/project-schema.sql +[torque-sql-exec] Executing file: + /home/steve/projects/productmanager/build/resources/ojbcore-schema.sql +[torque-sql-exec] 50 of 50 SQL statements executed successfully + +BUILD SUCCESSFUL]]> +

+ That was it. You now have your database setup properly. Go on, have a look: +

+ show tables; +]]> +

+ There, all tables for your project, as well as the tables required for some + OJB functionality which we also used in the above process (you can recognize + them by their names which start with ojb_). +