Author: arminw
Date: Tue Aug 8 12:11:46 2006
New Revision: 429782
URL: http://svn.apache.org/viewvc?rev=429782&view=rev
Log:
initial check in, forward mapping tool howto
Added:
db/ojb/branches/OJB_1_0_RELEASE/src/doc/forrest/src/documentation/content/xdocs/docu/howtos/howto-forward.xml
Added:
db/ojb/branches/OJB_1_0_RELEASE/src/doc/forrest/src/documentation/content/xdocs/docu/howtos/howto-forward.xml
URL:
http://svn.apache.org/viewvc/db/ojb/branches/OJB_1_0_RELEASE/src/doc/forrest/src/documentation/content/xdocs/docu/howtos/howto-forward.xml?rev=429782&view=auto
==============================================================================
---
db/ojb/branches/OJB_1_0_RELEASE/src/doc/forrest/src/documentation/content/xdocs/docu/howtos/howto-forward.xml
(added)
+++
db/ojb/branches/OJB_1_0_RELEASE/src/doc/forrest/src/documentation/content/xdocs/docu/howtos/howto-forward.xml
Tue Aug 8 12:11:46 2006
@@ -0,0 +1,85 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!--
+ Copyright 2002-2005 The Apache Software Foundation
+
+ Licensed under the Apache License, Version 2.0 (the "License");
+ you may not use this file except in compliance with the License.
+ You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ See the License for the specific language governing permissions and
+ limitations under the License.
+-->
+<!-- @version $Id: howto-use-lobs.xml 415080 2006-06-18 02:12:10 +0200 (So, 18
Jun 2006) arminw $ -->
+<!DOCTYPE document PUBLIC "-//APACHE//DTD Documentation V2.0//EN"
"document-v20.dtd">
+
+<document>
+ <header>
+ <title>HOWTO - OJB's Forward Engineering Tool</title>
+ <authors>
+ <person name="Tom Antony" email="[EMAIL PROTECTED]"/>
+ <person name="Armin Waibel" email="[EMAIL PROTECTED]"/>
+ </authors>
+ </header>
+
+ <body>
+
+
+ <anchor id="introduction"/>
+ <section>
+ <title>Introduction</title>
+ <p>
+ TODO
+ </p>
+ </section>
+
+
+
+ <anchor id="ant-task"/>
+ <section>
+ <title>Forward Ant Task</title>
+ <p>
+ For command line usage or to integrate it in custom Ant build
files, OJB supports an Ant Task
+ called <em>forward</em>.
+ </p>
+ <p>
+ This task supports a property <em>input</em> with the path to
the
+ <a href="site:repository">repository.xml</a> file (the object
class data mappings). If
+ not specified the file is expected in the task root directory.
+ <br/>
+ Additionally it's possible to set the output path of the
generated java beans using property
+ <em>bean.output</em> and the output path of the generated
+ <a href="ext:torque">torque</a>/<a
href="ext:ddlutils">DdlUtils</a> compatible
+ database xml script using property <em>db.output</em>.
+ </p>
+ <p>
+ To read the object mapping from
<code>/mySource/repository.xml</code> run the <em>forward</em>
+ task with
+ </p>
+ <source><![CDATA[
+ant -Dinput=/mySource/repository.xml forward
+ ]]></source>
+ <p>
+ In this case the forward mapping tool generate the java-beans
to directory
+ <code>/forward/beans</code> and the database xml script to
<code>/forward/xml</code>.
+ The root directory is the current working directory of the Ant
Task.
+ </p>
+ <p>
+ To read the object mapping from
<code>/mySource/repository.xml</code> and to move the generated
+ java-beans to directory <code>mySource/beans</code>run the
<em>forward</em>
+ task with
+ </p>
+ <source><![CDATA[
+ant -Dinput=/mySource/repository.xml -Dbeans.output=/mySource/beans forward
+ ]]></source>
+ </section>
+
+
+ </body>
+</document>
+
+
---------------------------------------------------------------------
To unsubscribe, e-mail: [EMAIL PROTECTED]
For additional commands, e-mail: [EMAIL PROTECTED]
