Author: ochikvina
Date: 2009-03-24 05:21:04 -0400 (Tue, 24 Mar 2009)
New Revision: 14305
Modified:
trunk/hibernatetools/docs/reference/en/modules/plugins.xml
Log:
https://jira.jboss.org/jira/browse/JBDS-632 - JPA Generate Entities Wizard ui is changed.
The "Hibernate support for Dali plugins in Eclipse WTP" chapter is updated.
Modified: trunk/hibernatetools/docs/reference/en/modules/plugins.xml
===================================================================
--- trunk/hibernatetools/docs/reference/en/modules/plugins.xml 2009-03-24 09:19:13 UTC
(rev 14304)
+++ trunk/hibernatetools/docs/reference/en/modules/plugins.xml 2009-03-24 09:21:04 UTC
(rev 14305)
@@ -12,7 +12,8 @@
<para>Hibernate Eclipse Tools include wizards for creating Hibernate mapping
files,
configuration files (.cfg.xml), revenge.xml as well as wizards for adjusting
Console
Configuration and Code Generation. Special structured and XML editors, editors for
executing
- HQL and Criteria queries are also provided in Hibernate Console. Refer to <link
linkend="hibernate_key_features">Key Features</link> section to find
all benefits that you
+ HQL and Criteria queries are also provided in Hibernate Console. Refer to <link
+ linkend="hibernate_key_features">Key Features</link> section
to find all benefits that you
can take advantage of while using the tools within Eclipse.</para>
<note>
@@ -837,27 +838,24 @@
strategy.</para>
</entry>
</row>
-
+
<row>
<entry>
<para>Detect one-to-one associations</para>
</entry>
-
+
<entry>
- <para>
- Reverse engineering detects one-to-one associations via primary key and
both hbm.xml and annotation generation generates the proper code for it.
- </para>
- <para>
- The detection is enabled by default (except for Seam 1.2 and Seam 2.0)
reverse engineering.
- For Hibernate Tools generation there is a checkbox to disable if not
wanted.
-
- </para>
+ <para> Reverse engineering detects one-to-one associations via
primary key and both
+ hbm.xml and annotation generation generates the proper code for it.
</para>
+ <para> The detection is enabled by default (except for Seam 1.2 and
Seam 2.0)
+ reverse engineering. For Hibernate Tools generation there is a checkbox
to disable
+ if not wanted. </para>
</entry>
</row>
-
-
-
+
+
+
<row>
<entry>
<para>Use custom templates</para>
@@ -1239,13 +1237,13 @@
<tip>
<title>Tip:</title>
- <para>If the property is a directory, it is
- possible to browse directories in the Value field.</para>
+ <para>If the property is a directory, it is possible to browse directories
in the Value
+ field.</para>
</tip>
-
+
<figure>
<title>Specifying the Property Value</title>
-
+
<mediaobject>
<imageobject>
<imagedata fileref="images/plugins/plugins_8b.png"/>
@@ -1525,7 +1523,8 @@
(including usertypes) if the default rules are not applicable. Here again to see
the database
tables press <emphasis>
<property>Refresh</property>
- </emphasis> button underneath. More about type mappings you can find further
in the <link linkend="type_map">Type Mappings</link>
section.</para>
+ </emphasis> button underneath. More about type mappings you can find further
in the <link
+ linkend="type_map">Type Mappings</link> section.</para>
<figure>
<title>Type Mappings Page</title>
@@ -1897,54 +1896,116 @@
support Eclipse Dali integration what now makes it possible to use a Hibernate as a
complete
JPA development platform.</para>
- <para>When starting your new JPA project from <emphasis>
- <property>New > Other... > JPA > JPA Project</property>
+ <para>When starting a new JPA project from <emphasis>
+ <property>New > Other > JPA > JPA
Project</property>
</emphasis> (or simply <emphasis>
- <property>New > JPA Project</property>
- </emphasis> in <property>JPA Perspective</property>) on the JPA
Facet page you'll be
- prompted to choose Hibernate as a target platform.</para>
+ <property>New > JPA Project</property>
+ </emphasis> in <property>JPA Perspective</property>), the first
wizard page looks as
+ follows.</para>
<figure>
+ <title>Starting JPA Project</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/plugins/dali_integration1.png"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <para>It's possible here to select a target runtime and change the
project
+ configuration, or you can leave everything as it is.</para>
+
+ <para>On the JPA Facet page you should choose Hibernate as a target platform.
Also select the
+ proper database connection, if it is defined, or add a new one by clicking the
<emphasis>
+ <property>Add connection</property>
+ </emphasis> link.</para>
+
+ <para>Hitting <emphasis>
+ <property>Finish</property>
+ </emphasis> will generate the project.</para>
+
+ <figure>
<title>Targeting at Hibernate Platform</title>
<mediaobject>
<imageobject>
- <imagedata fileref="images/plugins/plugins_23.png"/>
+ <imagedata fileref="images/plugins/dali_integration2.png"/>
</imageobject>
</mediaobject>
</figure>
+ <note>
+ <title>Note:</title>
+
+ <para>Please note, if you choose Hibernate as a platform while creating a
JPA/Dali project, a
+ Hibernate Console Configuration for the project is created automatically when
the
+ wizard finishes its work. It allows a full usage of <property>Hibernate
Tools</property>
+ features without additional setup.</para>
+ </note>
+
<para>By enabling Hibernate platform specific features you can now generate DDL
and Entities.
For that find <emphasis>
- <property>JPA Tools > Generate DDL.../Generate
Entities...</property>
+ <property>JPA Tools > Generate DDL/Generate Entities</property>
</emphasis> options in the context menu of your JPA project.</para>
<figure>
<title>Generate DDL/Entities</title>
<mediaobject>
<imageobject>
- <imagedata fileref="images/plugins/plugins_24.png"/>
+ <imagedata fileref="images/plugins/dali_integration3.png"/>
</imageobject>
</mediaobject>
</figure>
- <para>The Generate DDL/Entities wizards first will ask you to choose the
<property>Console
- Configuration</property>.</para>
+ <note>
+ <title>Note:</title>
+ <para>Please, remember to put the proper database driver to the classpath of
your
+ project.</para>
+ </note>
+
+ <para>The <property>Generate DDL/Entities wizards</property> first
will ask you to choose the directory where all
+ output will be written.</para>
+
<figure>
<title>Generate Entities Wizard</title>
<mediaobject>
<imageobject>
- <imagedata fileref="images/plugins/plugins_25.png"/>
+ <imagedata fileref="images/plugins/dali_integration4.png"/>
</imageobject>
</mediaobject>
</figure>
- <note>
- <title>Note:</title>
+ <para>To generate entities you can use:</para>
- <para>Please note, if you choose Hibernate as a platform and leave the Target
Runtime
- with <none>, the wizard does not require you to have a <link
linkend="console_conf"
- >Hibernate Console Configuration</link>. A Hibernate Console
Configuration is created when the wizard finishes its work.</para>
- </note>
+ <itemizedlist>
+ <listitem>
+ <para>a Hibernate Console Configuration (proposed by default)</para>
+ <para>Just make sure that the <emphasis>
+ <property>Use Console Configuration</property>
+ </emphasis> checkbox is selected and choose a needed configuration from the
<emphasis>
+ <property>Console
+ configurations</property></emphasis> list box.</para>
+
+ <figure>
+ <title>Generate Entities Wizard</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata
fileref="images/plugins/dali_integration5.png"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
+ </listitem>
+ </itemizedlist>
+
+ <itemizedlist>
+ <listitem>
+ <para>or a DTP connection directly</para>
+ <para>Just uncheck <emphasis>
+ <property>Use Console Configuration</property>
+ </emphasis> and adjust database settings.</para>
+ </listitem>
+ </itemizedlist>
+
+ <para>Thus, you can now have the Hibernate runtime support in Eclipse JPA
projects.</para>
</section>
</chapter>