Author: ochikvina
Date: 2009-05-07 13:04:50 -0400 (Thu, 07 May 2009)
New Revision: 15118
Modified:
trunk/hibernatetools/docs/reference/en/master_output.xml
Log:
https://jira.jboss.org/jira/browse/JBDS-717 - master_output.xml is generated;
Modified: trunk/hibernatetools/docs/reference/en/master_output.xml
===================================================================
--- trunk/hibernatetools/docs/reference/en/master_output.xml 2009-05-07 17:03:56 UTC (rev
15117)
+++ trunk/hibernatetools/docs/reference/en/master_output.xml 2009-05-07 17:04:50 UTC (rev
15118)
@@ -34,13 +34,13 @@
<pubdate>April 2008</pubdate>
<copyright>
<year>2007</year>
- <year><diffmk:wrapper
diffmk:change="changed">2009</diffmk:wrapper></year>
- <holder><diffmk:wrapper diffmk:change="changed">JBoss, a
division of Red Hat</diffmk:wrapper></holder>
+ <year>2009</year>
+ <holder>JBoss, a division of Red Hat</holder>
</copyright>
- <releaseinfo><diffmk:wrapper diffmk:change="changed">
+ <releaseinfo>
Version: 3.2.4.GA
- </diffmk:wrapper></releaseinfo>
+ </releaseinfo>
<mediaobject>
@@ -202,9 +202,9 @@
<section>
<title>Other relevant resources on the topic</title>
- <para>Hibernate Tools page on the <ulink
url="http://www.hibernate.org/255.html">hibernate.org</ul...
- <para>All JBoss Developer Studio/JBoss Tools documentation you can find
<ulink
url="http://www.jboss.com/products/devstudio/docs">here</...
- <para>The latest documentation builds are available <ulink
url="http://download.jboss.org/jbosstools/nightly-docs/">her...
+ <!--para>Hibernate Tools page on the <ulink
url="http://www.hibernate.org/255.html">hibernate.org</ul...
+ <para><diffmk:wrapper diffmk:change="changed">All JBoss
Developer Studio/JBoss Tools release documentation you can find
at</diffmk:wrapper><diffmk:wrapper
diffmk:change="changed">http://docs.jboss.org/tools</diff...
diffmk:change="changed"> in the corresponding release
directory.</diffmk:wrapper></para>
+ <para><diffmk:wrapper diffmk:change="changed">The latest
documentation builds are available at </diffmk:wrapper><ulink
url="http://download.jboss.org/jbosstools/nightly-docs/"><...
diffmk:change="changed">http://download.jboss.org/jbosstools...
</section>
</chapter>
@@ -213,39 +213,47 @@
<chapter id="setup"
xml:base="file:///home/ochikvina/WORK/for_compare/trunk/hibernatetools/docs/reference/en/modules/setup.xml">
<title>Download and install Hibernate Tools</title>
- <para><property moreinfo="none">Hibernate Tools</property>
can be used "standalone" via Ant
- 1.6.x or fully integrated into an Eclipse 3.3.x + WTP 2.x based IDE, such as
<property moreinfo="none">JBoss
- Tools</property> or a default Eclipse 3.3.x + WTP 2.x installation. The
following describes
- the install steps in these environments.</para>
+ <para><property moreinfo="none">Hibernate
Tools</property><diffmk:wrapper diffmk:change="added"> can be used
"standalone" via Ant
+ 1.6.x or fully integrated into an Eclipse + WTP based IDE, such as
</diffmk:wrapper><property diffmk:change="added"
moreinfo="none"><diffmk:wrapper
diffmk:change="added">JBDS/JBoss
+ Tools</diffmk:wrapper></property><diffmk:wrapper
diffmk:change="added">, or a default Eclipse + WTP installation. The
following sections describe the
+ install steps in these environments.</diffmk:wrapper></para>
+ <note diffmk:change="added">
+ <title diffmk:change="added"><diffmk:wrapper
diffmk:change="added">Note:</diffmk:wrapper></title>
+ <para diffmk:change="added"><diffmk:wrapper
diffmk:change="added">The </diffmk:wrapper><property
moreinfo="none"><diffmk:wrapper
diffmk:change="changed">Hibernate Tools
3.2.4.GA</diffmk:wrapper></property><diffmk:wrapper
diffmk:change="changed"> (the current release version) requires
+ Eclipse Ganymede 3.4.2.</diffmk:wrapper></para>
+ </note>
+
<section>
<title>JBoss Tools</title>
- <para><property moreinfo="none">JBoss Tools
2.x</property> includes <property moreinfo="none">Hibernate
Tools</property> and
- thus nothing is required besides <ulink
url="http://labs.jboss.com/tools/download/index.html">downlo...
and <ulink
url="../../GettingStartedGuide/html_single/index.html#JBossToolsInstall">installing
JBoss Tools</ulink>. If you need to update to a newer version of the
- <property moreinfo="none">Hibernate Tools</property> just
follow the instructions in the Eclipse IDE
- section.</para>
+ <para><property moreinfo="none"><diffmk:wrapper
diffmk:change="changed">JBoss Tools
3.0.0.GA</diffmk:wrapper></property><diffmk:wrapper
diffmk:change="changed"> (the latest release) includes
+ </diffmk:wrapper><property
moreinfo="none"><diffmk:wrapper
diffmk:change="changed">Hibernate Tools
3.2.4.GA</diffmk:wrapper></property><diffmk:wrapper
diffmk:change="changed"> and thus nothing is required besides
</diffmk:wrapper><ulink
url="http://jboss.org/tools/download/stable/3_0_0_GA.html">d...
and <ulink
url="../../GettingStartedGuide/html_single/index.html#JBossToolsInstall">installing
JBoss Tools</ulink><diffmk:wrapper diffmk:change="changed">. If you
need to update
+ to a newer version of the </diffmk:wrapper><property
moreinfo="none">Hibernate Tools</property><diffmk:wrapper
diffmk:change="changed"> just follow the instructions in
+ the Eclipse IDE section.</diffmk:wrapper></para>
</section>
<section>
<title>Eclipse IDE</title>
- <para>To install into any <property moreinfo="none">Eclipse
3.3.x</property> based Eclipse IDE you can either
- download the <property moreinfo="none">Hibernate
Tools</property> distribution from the <ulink
url="http://www.hibernate.org/6.html">Hibernate website</ulink> or use
the <ulink
url="http://download.jboss.org/jbosstools/updates/stable/">J... Tools Update
Site</ulink>
- (see also <ulink
url="http://tools.hibernate.org">http://tools.hibernate.org</ulink> for
links
- to the update site).</para>
+ <para><diffmk:wrapper diffmk:change="added">To install the
</diffmk:wrapper><property diffmk:change="added"
moreinfo="none"><diffmk:wrapper
diffmk:change="added">Hibernate
Tools</diffmk:wrapper></property><diffmk:wrapper
diffmk:change="added"> into any </diffmk:wrapper><property
moreinfo="none"><diffmk:wrapper
diffmk:change="changed">Eclipse
3.4.x</diffmk:wrapper></property><diffmk:wrapper
diffmk:change="changed"> based IDE you
+ can either download the </diffmk:wrapper><property
moreinfo="none">Hibernate Tools</property> distribution from the
<diffmk:wrapper diffmk:change="changed">JBoss Tools download
page</diffmk:wrapper><diffmk:wrapper diffmk:change="changed">
+ or from the </diffmk:wrapper><ulink
url="http://download.jboss.org/jbosstools/updates/stable/">&...
diffmk:change="changed">JBoss Tools
+ Update Site</diffmk:wrapper></ulink><diffmk:wrapper
diffmk:change="added">.</diffmk:wrapper></para>
<para>If you download the <property moreinfo="none">Hibernate
Tools</property> distribution you need to place
the <emphasis>
<property moreinfo="none">/plugins</property>
</emphasis> and <emphasis>
<property moreinfo="none">/feature</property>
- </emphasis> directory into your eclipse directory or eclipse extensions
directory. Sometimes
+ </emphasis><diffmk:wrapper diffmk:change="changed"> directory
into your eclipse directory or eclipse extensions directory. Sometimes
Eclipse does not automatically detect new plugins and thus the tools will not be
activated. To
- ensure eclipse sees these changes just clean up the cached plugin information by
running eclipse with the <emphasis>
- <property
moreinfo="none">-clean</property></emphasis> option, e.g.
<emphasis>
- <property moreinfo="none">eclipse
- -clean</property>.</emphasis> Using the updatesite does not require
any additional steps.</para>
+ ensure eclipse sees these changes just clean up the cached plugin information by
running
+ eclipse with the </diffmk:wrapper><emphasis>
+ <property moreinfo="none">-clean</property>
+ </emphasis> option, e.g. <emphasis>
+ <property moreinfo="none"><diffmk:wrapper
diffmk:change="changed">eclipse
-clean</diffmk:wrapper></property>.</emphasis><diffmk:wrapper
diffmk:change="changed"> Using the updatesite does not require any
+ additional steps.</diffmk:wrapper></para>
<note>
<title>Note:</title>
@@ -257,8 +265,8 @@
<section>
<title>Usage of Eclipse WTP</title>
- <para>The <property moreinfo="none">Hibernate
Tools</property> plugins currently use <property
moreinfo="none">WTP
- 2.x</property> which at this time is the latest stable release from the
Eclipse Webtools
+ <para>The <property moreinfo="none">Hibernate
Tools</property> plugins currently use <property
moreinfo="none"><diffmk:wrapper diffmk:change="changed">WTP
+ 3.x</diffmk:wrapper></property> which at this time is the latest
stable release from the Eclipse Webtools
project.</para>
<para>Because the WTP project not always have had proper versioning of their
plugins there
@@ -278,9 +286,9 @@
</emphasis> and associated libraries. The libraries are included in the
distribution from the
Hibernate website and the Eclipse updatesite. The libraries are located in the
eclipse plugins
directory at <emphasis>
- <property
moreinfo="none">/plugins/org.hibernate.eclipse.x.x.x/lib/tools/</property></emphasis>.
These libraries are 100%
- independent from the eclipse platform. How to use these via ant tasks are described
in the
- <link linkend="ant">Ant Tools</link> chapter.</para>
+ <property
moreinfo="none">/plugins/org.hibernate.eclipse.x.x.x/lib/tools/</property>
+ </emphasis><diffmk:wrapper diffmk:change="changed">. These
libraries are 100% independent from the eclipse platform. How to use these
+ via ant tasks are described in the </diffmk:wrapper><link
linkend="ant">Ant Tools</link> chapter.</para>
</section>
</chapter>
@@ -669,9 +677,9 @@
</entry>
<entry>
- <para>DTP provided connection that you can use instead of what is in
cfg.xml and jpa
- persistence.xml. It's possible to use already configured connection
or
- specify a new one here.</para>
+ <para><diffmk:wrapper diffmk:change="changed">DTP
provided connection that you can use instead of what is in cfg.xml and jpa
+ persistence.xml. It's possible to use either already configured
hibernate or
+ JPA connection or specify a new one
here.</diffmk:wrapper></para>
</entry>
<entry>
@@ -1207,13 +1215,13 @@
</entry>
<entry>
- <para>A table that has a multi-colum primary key a
<composite-id>
+ <para><diffmk:wrapper diffmk:change="changed">A
table that has a multi-column primary key a <composite-id>
mapping will always be created. If this option is enabled and there are
matching
foreign-keys each key column is still considered a 'basic'
scalar (string, long,
etc.) instead of a reference to an entity. If you disable this option
a
<key-many-to-one> instead. Note: a
<many-to-one>
property is still created, but is simply marked as non-updatable and
- non-insertable.</para>
+ non-insertable.</diffmk:wrapper></para>
</entry>
</row>
@@ -1238,27 +1246,24 @@
strategy.</para>
</entry>
</row>
-
- <row diffmk:change="added">
- <entry diffmk:change="added">
- <para diffmk:change="added"><diffmk:wrapper
diffmk:change="added">Detect one-to-one
associations</diffmk:wrapper></para>
+
+ <row>
+ <entry>
+ <para>Detect one-to-one associations</para>
</entry>
-
- <entry diffmk:change="added">
- <para diffmk:change="added"><diffmk:wrapper
diffmk:change="added">
- Reverse engineering detects one-to-one associations via primary key and
both hbm.xml and annotation generation generates the proper code for it.
- </diffmk:wrapper></para>
- <para diffmk:change="added"><diffmk:wrapper
diffmk:change="added">
- 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.
-
- </diffmk:wrapper></para>
+
+ <entry>
+ <para><diffmk:wrapper diffmk:change="changed">
Reverse engineering detects one-to-one associations via primary key and both
+ hbm.xml and annotation generation generates the proper code for it.
</diffmk:wrapper></para>
+ <para><diffmk:wrapper diffmk:change="changed"> 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. </diffmk:wrapper></para>
</entry>
</row>
-
-
-
+
+
+
<row>
<entry>
<para>Use custom templates</para>
@@ -1639,13 +1644,13 @@
<tip>
<title>Tip:</title>
- <para>If the property is a directory, it is
- possible to browse directories in the Value field.</para>
+ <para><diffmk:wrapper diffmk:change="changed">If the
property is a directory, it is possible to browse directories in the Value
+ field.</diffmk:wrapper></para>
</tip>
-
+
<figure float="0">
<title>Specifying the Property Value</title>
-
+
<mediaobject>
<imageobject>
<imagedata
fileref="images/plugins/plugins_8b.png"></imagedata>
@@ -2281,54 +2286,117 @@
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 moreinfo="none">New > Other... > JPA
> JPA Project</property>
+ <para><diffmk:wrapper diffmk:change="changed">When starting a
new JPA project from </diffmk:wrapper><emphasis>
+ <property moreinfo="none"><diffmk:wrapper
diffmk:change="changed">New > Other > JPA > JPA
Project</diffmk:wrapper></property>
</emphasis> (or simply <emphasis>
<property moreinfo="none">New > JPA
Project</property>
- </emphasis> in <property moreinfo="none">JPA
Perspective</property>) on the JPA Facet page you'll be
- prompted to choose Hibernate as a target platform.</para>
+ </emphasis> in <property moreinfo="none">JPA
Perspective</property><diffmk:wrapper diffmk:change="added">), the
first wizard page looks as
+ follows.</diffmk:wrapper></para>
+ <figure diffmk:change="added" float="0">
+ <title diffmk:change="added"><diffmk:wrapper
diffmk:change="added">Starting JPA
Project</diffmk:wrapper></title>
+ <mediaobject diffmk:change="added">
+ <imageobject diffmk:change="added">
+ <imagedata diffmk:change="added"
fileref="images/plugins/dali_integration1.png"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <para diffmk:change="added"><diffmk:wrapper
diffmk:change="added">It's possible here to select a target runtime and
change the project
+ configuration, or you can leave everything as it
is.</diffmk:wrapper></para>
+
+ <para diffmk:change="added"><diffmk:wrapper
diffmk:change="added">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
</diffmk:wrapper><emphasis diffmk:change="added">
+ <property diffmk:change="added"
moreinfo="none"><diffmk:wrapper diffmk:change="added">Add
connection</diffmk:wrapper></property>
+ </emphasis><diffmk:wrapper diffmk:change="added">
link.</diffmk:wrapper></para>
+
+ <para diffmk:change="added"><diffmk:wrapper
diffmk:change="added">Hitting </diffmk:wrapper><emphasis
diffmk:change="added">
+ <property diffmk:change="added"
moreinfo="none"><diffmk:wrapper
diffmk:change="added">Finish</diffmk:wrapper></property>
+ </emphasis><diffmk:wrapper diffmk:change="added"> will
generate the project.</diffmk:wrapper></para>
+
<figure float="0">
<title>Targeting at Hibernate Platform</title>
<mediaobject>
<imageobject>
- <imagedata
fileref="images/plugins/plugins_23.png"></imagedata>
+ <imagedata
fileref="images/plugins/dali_integration2.png"></imagedata>
</imageobject>
</mediaobject>
</figure>
+ <note diffmk:change="added">
+ <title diffmk:change="added"><diffmk:wrapper
diffmk:change="added">Note:</diffmk:wrapper></title>
+
+ <para diffmk:change="added"><diffmk:wrapper
diffmk:change="added">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
</diffmk:wrapper><property diffmk:change="added"
moreinfo="none"><diffmk:wrapper
diffmk:change="added">Hibernate
Tools</diffmk:wrapper></property><diffmk:wrapper
diffmk:change="added">
+ features without additional setup.</diffmk:wrapper></para>
+ </note>
+
<para>By enabling Hibernate platform specific features you can now generate DDL
and Entities.
For that find <emphasis>
- <property moreinfo="none">JPA Tools > Generate
DDL.../Generate Entities...</property>
+ <property moreinfo="none"><diffmk:wrapper
diffmk:change="changed">JPA Tools > Generate DDL/Generate
Entities</diffmk:wrapper></property>
</emphasis> options in the context menu of your JPA project.</para>
<figure float="0">
<title>Generate DDL/Entities</title>
<mediaobject>
<imageobject>
- <imagedata
fileref="images/plugins/plugins_24.png"></imagedata>
+ <imagedata
fileref="images/plugins/dali_integration3.png"></imagedata>
</imageobject>
</mediaobject>
</figure>
- <para>The Generate DDL/Entities wizards first will ask you to choose the
<property moreinfo="none">Console
- Configuration</property>.</para>
+ <note diffmk:change="added">
+ <title diffmk:change="added"><diffmk:wrapper
diffmk:change="added">Note:</diffmk:wrapper></title>
+ <para diffmk:change="added"><diffmk:wrapper
diffmk:change="added">Please, remember to put the proper database driver to
the classpath of your
+ project.</diffmk:wrapper></para>
+ </note>
+
+ <para><diffmk:wrapper diffmk:change="changed">The
</diffmk:wrapper><property moreinfo="none"><diffmk:wrapper
diffmk:change="changed">Generate DDL/Entities
wizards</diffmk:wrapper></property><diffmk:wrapper
diffmk:change="changed"> first will ask you to choose the directory where
all
+ output will be written.</diffmk:wrapper></para>
+
<figure float="0">
<title>Generate Entities Wizard</title>
<mediaobject>
<imageobject>
- <imagedata
fileref="images/plugins/plugins_25.png"></imagedata>
+ <imagedata
fileref="images/plugins/dali_integration4.png"></imagedata>
</imageobject>
</mediaobject>
</figure>
- <note>
- <title>Note:</title>
+ <para diffmk:change="added"><diffmk:wrapper
diffmk:change="added">To generate entities you can
use:</diffmk:wrapper></para>
- <para><diffmk:wrapper diffmk:change="changed">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
</diffmk:wrapper><link linkend="console_conf">Hibernate Console
Configuration</link><diffmk:wrapper diffmk:change="changed">. A
Hibernate Console Configuration is created when the wizard finishes its
work.</diffmk:wrapper></para>
- </note>
+ <itemizedlist diffmk:change="added">
+ <listitem diffmk:change="added">
+ <para diffmk:change="added"><diffmk:wrapper
diffmk:change="added">a Hibernate Console Configuration (proposed by
default)</diffmk:wrapper></para>
+ <para diffmk:change="added"><diffmk:wrapper
diffmk:change="added">Just make sure that the
</diffmk:wrapper><emphasis diffmk:change="added">
+ <property diffmk:change="added"
moreinfo="none"><diffmk:wrapper diffmk:change="added">Use
Console Configuration</diffmk:wrapper></property>
+ </emphasis><diffmk:wrapper diffmk:change="added"> checkbox
is selected and choose a needed configuration from the </diffmk:wrapper><emphasis
diffmk:change="added">
+ <property diffmk:change="added"
moreinfo="none"><diffmk:wrapper
diffmk:change="added">Console
+
configurations</diffmk:wrapper></property></emphasis><diffmk:wrapper
diffmk:change="added"> list box.</diffmk:wrapper></para>
+
+ <figure diffmk:change="added" float="0">
+ <title><diffmk:wrapper diffmk:change="changed">Generate
Entities Wizard</diffmk:wrapper></title>
+ <mediaobject diffmk:change="added">
+ <imageobject diffmk:change="added">
+ <imagedata diffmk:change="added"
fileref="images/plugins/dali_integration5.png"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+ </listitem>
+ </itemizedlist>
+
+ <itemizedlist diffmk:change="added">
+ <listitem diffmk:change="added">
+ <para><diffmk:wrapper diffmk:change="added">or a DTP
connection directly</diffmk:wrapper></para>
+ <para diffmk:change="added"><diffmk:wrapper
diffmk:change="added">Just uncheck </diffmk:wrapper><emphasis
diffmk:change="added">
+ <property diffmk:change="added"
moreinfo="none"><diffmk:wrapper diffmk:change="added">Use
Console Configuration</diffmk:wrapper></property>
+ </emphasis><diffmk:wrapper diffmk:change="added"> and
adjust database settings.</diffmk:wrapper></para>
+ </listitem>
+ </itemizedlist>
+
+ <para diffmk:change="added"><diffmk:wrapper
diffmk:change="added">Thus, you can now have the Hibernate runtime support in
Eclipse JPA projects.</diffmk:wrapper></para>
</section>
</chapter>
@@ -3716,13 +3784,13 @@
<hibernate-reverse-engineering>
<type-mapping>
- <!-- jdbc-type is name fom java.sql.Types -->
+ <!-- jdbc-type is name for java.sql.Types -->
<sql-type jdbc-type="VARCHAR" length='20'
hibernate-type="SomeUserType" />
<sql-type jdbc-type="VARCHAR" length='1'
hibernate-type="yes_no" />
- <!-- length, scale and precision can be used to specify the mapping precisly -->
+ <!-- length, scale and precision can be used to specify the mapping precisely -->
<sql-type jdbc-type="NUMERIC" precision='1'
hibernate-type="boolean" />
<!-- the type-mappings are ordered. This mapping will be consulted last,
- thus overriden by the previous one if precision=1 for the column -->
+ thus overridden by the previous one if precision=1 for the column -->
<sql-type jdbc-type="NUMERIC" hibernate-type="long" />
</type-mapping>
@@ -4905,7 +4973,7 @@
</emphasis> attributes, unless you are defining a class without
bi-directional
associations.</para>
- <para>We recomend instead to add the <emphasis>
+ <para><diffmk:wrapper diffmk:change="changed">We recommend
instead to add the </diffmk:wrapper><emphasis>
<property moreinfo="none">meta</property>
</emphasis> attributes at the property level:</para>
@@ -5176,7 +5244,7 @@
<para>The rest chapters have shown the aspects of using the <property
moreinfo="none">Hibernate
Tools</property> via Ant tasks.</para>
- <para>Please, visit <ulink
url="http://www.jboss.com/index.html?module=bb&op=viewforum&...
+ <para>Please, visit <ulink
url="http://www.jboss.com/index.html?module=bb&op=viewforum&...
Tools Users Forum</ulink> to leave questions or/and suggestions on the
topic. Your
feedback is always appreciated.</para>
</section>