db-ojb-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From arm...@apache.org
Subject svn commit: r430580 - in /db/ojb/branches/OJB_1_0_RELEASE/src/doc/forrest/src/documentation/content/xdocs/docu/howtos: howto-build-mappings.xml howto-forward.xml
Date Thu, 10 Aug 2006 23:12:51 GMT
Author: arminw
Date: Thu Aug 10 16:12:50 2006
New Revision: 430580

URL: http://svn.apache.org/viewvc?rev=430580&view=rev
Log:
update forward tool doc

Modified:
    db/ojb/branches/OJB_1_0_RELEASE/src/doc/forrest/src/documentation/content/xdocs/docu/howtos/howto-build-mappings.xml
    db/ojb/branches/OJB_1_0_RELEASE/src/doc/forrest/src/documentation/content/xdocs/docu/howtos/howto-forward.xml

Modified: db/ojb/branches/OJB_1_0_RELEASE/src/doc/forrest/src/documentation/content/xdocs/docu/howtos/howto-build-mappings.xml
URL: http://svn.apache.org/viewvc/db/ojb/branches/OJB_1_0_RELEASE/src/doc/forrest/src/documentation/content/xdocs/docu/howtos/howto-build-mappings.xml?rev=430580&r1=430579&r2=430580&view=diff
==============================================================================
--- db/ojb/branches/OJB_1_0_RELEASE/src/doc/forrest/src/documentation/content/xdocs/docu/howtos/howto-build-mappings.xml
(original)
+++ db/ojb/branches/OJB_1_0_RELEASE/src/doc/forrest/src/documentation/content/xdocs/docu/howtos/howto-build-mappings.xml
Thu Aug 10 16:12:50 2006
@@ -238,15 +238,8 @@
 
 <section><title>Forward engineering from repository.xml</title>
 	<p>
-		There is currently no tool available that directly supports this model.
-		It is not difficult to implement an XSLT stylesheet that transforms
-		the OJB repository.xml directly into DDL Statements.
+        OJB provide a forward engineering tool - a <a href="site:forward-tool">howto
can be found here</a>.
     </p>
-    <p>
-		An even simpler approach could be to transform the repository.xml file into
-		a Torque xml file. DDL can then be generated by the Torque engine.<br/>
-		If you write such an XSLT file please tell us about it!
-	</p>
 </section>
 
         <anchor id="xdoclet"/>
@@ -303,19 +296,19 @@
 				The ODMG and the JDO interface are supported. RDBS2J creates the
 				*.jdo files and the repository_user.xml, which are needed by OJB.
 			</li>
-            <li>
-				<strong>The OJB ReverseDB tool</strong><br/>
-				OJB ships with a simple reverse engineering tool that
-				allows to connect to a RDBMS via JDBC and to take the tables
-				from the database catalog as input.<br/>
-				This tool provides a nice GUI to generate Java classes and the
-				matching repository.xml file.<br/>
-				You can invoke the ReverseDB tool with the ANT target <code>reverse-db</code>.
-			</li>
+            <!--<li>-->
+				<!--<strong>The OJB ReverseDB tool</strong><br/>-->
+				<!--OJB ships with a simple reverse engineering tool that-->
+				<!--allows to connect to a RDBMS via JDBC and to take the tables-->
+				<!--from the database catalog as input.<br/>-->
+				<!--This tool provides a nice GUI to generate Java classes and the-->
+				<!--matching repository.xml file.<br/>-->
+				<!--You can invoke the ReverseDB tool with the ANT target <code>reverse-db</code>.-->
+			<!--</li>-->
 		</ul>
-            <note>
-                The ReverseDB tool is not up to date - any help is welcome.
-            </note>
+            <!--<note>-->
+                <!--The ReverseDB tool is not up to date - any help is welcome.-->
+            <!--</note>-->
 </section>
 
     </body>

Modified: 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=430580&r1=430579&r2=430580&view=diff
==============================================================================
--- db/ojb/branches/OJB_1_0_RELEASE/src/doc/forrest/src/documentation/content/xdocs/docu/howtos/howto-forward.xml
(original)
+++ db/ojb/branches/OJB_1_0_RELEASE/src/doc/forrest/src/documentation/content/xdocs/docu/howtos/howto-forward.xml
Thu Aug 10 16:12:50 2006
@@ -33,7 +33,30 @@
         <section>
             <title>Introduction</title>
             <p>
-                TODO
+                The <em>Forward Engineering Tool</em> for OJB reads the
+                metadata mappings and generates the source code for
+                persistent Java beans as well as database independent
+                schema in Apache Torque (database) xml format. Apache's <a href="ext:ddlutils">DDLUtils</a>
+                or <a href="ext:torque">Torque</a> can be used generate a database
specific schema from
+                this database xml file.
+            </p>
+            <p>
+                The tool supports the automatic generation of
+                indirection tables specified in m:n mappings. The tool
+                also takes care of an indirection table that is
+                additionally mapped to other persistent classes. Note
+                that the tool does not support the case where a single
+                table is used as an indirection table between more
+                than one set of persistent entities. The tool also
+                handles the case of one sided m:n mappings i.e. an
+                indirection table defined in a collection-descriptor
+                by only one side of the m:n mapping.
+            </p>
+            <p>
+                The tool also takes care of persistent inner classes.
+                If the outer class is not defined in the metadata for
+                such inner classes, an artificial outer class is
+                generated for holding those inner class(es).
             </p>
         </section>
 
@@ -43,13 +66,13 @@
         <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>.
+                For command line usage or to integrate it in custom <a href="ext:ant">Ant</a>
build files,
+                OJB's Ant build file supports a 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.
+                <a href="site:repository">repository.xml</a> file (the metadata
mapping file).
+                If not specified the file is expected in current used JVM working 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



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


Mime
View raw message