Menu
▾
▴
[Hibernate-commits] Hibernate/doc tools.aft,1.37,1.38 tools.aft-TOC,1.22,1.23 tools.html,1.80,1.81
|
From: <cel...@us...> - 2002-11-22 04:05:23
|
Update of /cvsroot/hibernate/Hibernate/doc In directory sc8-pr-cvs1:/tmp/cvs-serv32471/Hibernate/doc Modified Files: tools.aft tools.aft-TOC tools.html Log Message: Added documentation for reverse engineering tool. Index: tools.aft =================================================================== RCS file: /cvsroot/hibernate/Hibernate/doc/tools.aft,v retrieving revision 1.37 retrieving revision 1.38 diff -C2 -d -r1.37 -r1.38 *** tools.aft 10 Nov 2002 03:40:55 -0000 1.37 --- tools.aft 22 Nov 2002 04:05:20 -0000 1.38 *************** *** 226,229 **** --- 226,258 ---- |--package=''package__suffix''| a string to append to the package name when generating the proxy package name (eg. |proxy|) + ----------------------------------------------------------------------- + **Reverse Engineering Tool + + The Reverse Engineering Tool may be used to generate Hibernate mapping files and Java source files from an existing database schema. Using database metadata, the tool retrieves table and column information and generates appropriate mapping files and Java source. + The tool is implemented as a small Swing application with several configuration screens: + ***Connection Panel + Configure the JDBC connection here. Note that the specified JDBC driver class must be in the classpath. + ***Tables + Select the tables for generation in this panel. Start by clicking the "tables" button at the top of the panel. Specify a catalog, schema, and table name pattern in the resulting dialog (the table name pattern is specified using SQL 'like' syntax). On exiting the dialog, the tables panel will display the selected database tables. You may select one or more tables for generation. + ***Mapping + The mapping panel may be used to configure the mapping file generator. + + *|Mapping File| - select to generate one mapping file for each database table, or to generate a single map for all tables. + + *|Key Field Name| - specify the name of the identifier property used in each Hibernate class + + *|Generator| - select the Hibernate generator that will assign identifier values. The |params| button produces a dialog for configuring generator parameters. + + *|Key Field Type| - select Hibernate types or Java types. Selecting Hibernate types will result in Java source using primitive field types, selecting Java types will result in Java source using object types (Integer, etc.). + + *|Key Field Class| - specify the type of key field to be used in the mapping file and generated source. + + ***Code + *|Package Name| - sets the package name for generated Java source + + *|Base Class Name| - set a base class for generated Java source files. useful if you want to consolidate common behavior in Hibernate classes. + + ***Output + *|Output Directory| - sets the output directory for the generated mapping file and Java sources. Note that all files will be created in a directory according to the package name, relative to the output directory specified here. #---PASS-HTML <A href=http://sourceforge.net/projects/hibernate><IMG src=http://sourceforge.net/sflogo.php?group_id=40712></A> Index: tools.aft-TOC =================================================================== RCS file: /cvsroot/hibernate/Hibernate/doc/tools.aft-TOC,v retrieving revision 1.22 retrieving revision 1.23 diff -C2 -d -r1.22 -r1.23 *** tools.aft-TOC 10 Nov 2002 03:40:55 -0000 1.22 --- tools.aft-TOC 22 Nov 2002 04:05:20 -0000 1.23 *************** *** 16,17 **** --- 16,23 ---- * {-Proxy Generation@Proxy Generation-} * {-command line options@command line options-} + * {-Reverse Engineering Tool@Reverse Engineering Tool-} + * {-Connection Panel@Connection Panel-} + * {-Tables@Tables-} + * {-Mapping@Mapping-} + * {-Code@Code-} + * {-Output@Output-} Index: tools.html =================================================================== RCS file: /cvsroot/hibernate/Hibernate/doc/tools.html,v retrieving revision 1.80 retrieving revision 1.81 diff -C2 -d -r1.80 -r1.81 *** tools.html 10 Nov 2002 03:40:55 -0000 1.80 --- tools.html 22 Nov 2002 04:05:20 -0000 1.81 *************** *** 42,46 **** <li> <a href="#Proxy Generation">Proxy Generation</a></li> <ul> ! <li> <a href="#command line options">command line options</a> </li> --- 42,54 ---- <li> <a href="#Proxy Generation">Proxy Generation</a></li> <ul> ! <li> <a href="#command line options">command line options</a></li> ! </ul> ! <li> <a href="#Reverse Engineering Tool">Reverse Engineering Tool</a></li> ! <ul> ! <li> <a href="#Connection Panel">Connection Panel</a></li> ! <li> <a href="#Tables">Tables</a></li> ! <li> <a href="#Mapping">Mapping</a></li> ! <li> <a href="#Code">Code</a></li> ! <li> <a href="#Output">Output</a> </li> *************** *** 337,341 **** <tt>--package=<em>package_suffix</em></tt> a string to append to the package name when generating the proxy package name (eg. <tt>proxy</tt>) </p> ! <A href=http://sourceforge.net/projects/hibernate><IMG src=http://sourceforge.net/sflogo.php?group_id=40712></A><!--End Section 3--> <!-- End SectLevel3 --> <!--End Section 2--> --- 345,401 ---- <tt>--package=<em>package_suffix</em></tt> a string to append to the package name when generating the proxy package name (eg. <tt>proxy</tt>) </p> ! <hr> ! <!--End Section 3--> ! <!-- End SectLevel3 --> ! <!--End Section 2--> ! <h3><a name="Reverse Engineering Tool">Reverse Engineering Tool</a></h3> ! <p class="Body"> ! The Reverse Engineering Tool may be used to generate Hibernate mapping files and Java source files from an existing database schema. Using database metadata, the tool retrieves table and column information and generates appropriate mapping files and Java source. ! The tool is implemented as a small Swing application with several configuration screens: ! </p> ! <!-- Start SectLevel3 --> ! <h4><a name="Connection Panel">Connection Panel</a></h4> ! <p class="Body"> ! Configure the JDBC connection here. Note that the specified JDBC driver class must be in the classpath. ! </p> ! <!--End Section 3--> ! <h4><a name="Tables">Tables</a></h4> ! <p class="Body"> ! Select the tables for generation in this panel. Start by clicking the "tables" button at the top of the panel. Specify a catalog, schema, and table name pattern in the resulting dialog (the table name pattern is specified using SQL 'like' syntax). On exiting the dialog, the tables panel will display the selected database tables. You may select one or more tables for generation. ! </p> ! <!--End Section 3--> ! <h4><a name="Mapping">Mapping</a></h4> ! <p class="Body"> ! The mapping panel may be used to configure the mapping file generator. ! </p> ! <ul> ! <li><tt>Mapping File</tt> - select to generate one mapping file for each database table, or to generate a single map for all tables.</li> ! </ul> ! <ul> ! <li><tt>Key Field Name</tt> - specify the name of the identifier property used in each Hibernate class</li> ! </ul> ! <ul> ! <li><tt>Generator</tt> - select the Hibernate generator that will assign identifier values. The <tt>params</tt> button produces a dialog for configuring generator parameters.</li> ! </ul> ! <ul> ! <li><tt>Key Field Type</tt> - select Hibernate types or Java types. Selecting Hibernate types will result in Java source using primitive field types, selecting Java types will result in Java source using object types (Integer, etc.).</li> ! </ul> ! <ul> ! <li><tt>Key Field Class</tt> - specify the type of key field to be used in the mapping file and generated source.</li> ! </ul> ! <!--End Section 3--> ! <h4><a name="Code">Code</a></h4> ! <ul> ! <li><tt>Package Name</tt> - sets the package name for generated Java source</li> ! </ul> ! <ul> ! <li><tt>Base Class Name</tt> - set a base class for generated Java source files. useful if you want to consolidate common behavior in Hibernate classes.</li> ! </ul> ! <!--End Section 3--> ! <h4><a name="Output">Output</a></h4> ! <ul> ! <li><tt>Output Directory</tt> - sets the output directory for the generated mapping file and Java sources. Note that all files will be created in a directory according to the package name, relative to the output directory specified here.<A href=http://sourceforge.net/projects/hibernate><IMG src=http://sourceforge.net/sflogo.php?group_id=40712></A></li> ! </ul> ! <!--End Section 3--> <!-- End SectLevel3 --> <!--End Section 2--> |
