Author: smukhina
Date: 2009-05-11 12:27:29 -0400 (Mon, 11 May 2009)
New Revision: 15190
Removed:
branches/jbosstools-3.0.x/hibernatetools/docs/reference/en/images/plugins/plugins_23.png
branches/jbosstools-3.0.x/hibernatetools/docs/reference/en/images/plugins/plugins_24.png
branches/jbosstools-3.0.x/hibernatetools/docs/reference/en/images/plugins/plugins_25.png
Modified:
branches/jbosstools-3.0.x/hibernatetools/docs/reference/en/modules/codegen.xml
branches/jbosstools-3.0.x/hibernatetools/docs/reference/en/modules/plugins.xml
branches/jbosstools-3.0.x/hibernatetools/docs/reference/en/modules/preface.xml
branches/jbosstools-3.0.x/hibernatetools/docs/reference/en/modules/reverseengineering.xml
branches/jbosstools-3.0.x/hibernatetools/docs/reference/en/modules/setup.xml
branches/jbosstools-3.0.x/hibernatetools/docs/reference/pom.xml
Log:
https://jira.jboss.org/jira/browse/JBDS-717 merged changes from trunk are added to the
corresponding branch
Deleted:
branches/jbosstools-3.0.x/hibernatetools/docs/reference/en/images/plugins/plugins_23.png
===================================================================
(Binary files differ)
Deleted:
branches/jbosstools-3.0.x/hibernatetools/docs/reference/en/images/plugins/plugins_24.png
===================================================================
(Binary files differ)
Deleted:
branches/jbosstools-3.0.x/hibernatetools/docs/reference/en/images/plugins/plugins_25.png
===================================================================
(Binary files differ)
Modified: branches/jbosstools-3.0.x/hibernatetools/docs/reference/en/modules/codegen.xml
===================================================================
---
branches/jbosstools-3.0.x/hibernatetools/docs/reference/en/modules/codegen.xml 2009-05-11
16:27:17 UTC (rev 15189)
+++
branches/jbosstools-3.0.x/hibernatetools/docs/reference/en/modules/codegen.xml 2009-05-11
16:27:29 UTC (rev 15190)
@@ -353,7 +353,7 @@
</emphasis> attributes, unless you are defining a class without
bi-directional
associations.</para>
- <para>We recomend instead to add the <emphasis>
+ <para>We recommend instead to add the <emphasis>
<property>meta</property>
</emphasis> attributes at the property level:</para>
Modified: branches/jbosstools-3.0.x/hibernatetools/docs/reference/en/modules/plugins.xml
===================================================================
---
branches/jbosstools-3.0.x/hibernatetools/docs/reference/en/modules/plugins.xml 2009-05-11
16:27:17 UTC (rev 15189)
+++
branches/jbosstools-3.0.x/hibernatetools/docs/reference/en/modules/plugins.xml 2009-05-11
16:27:29 UTC (rev 15190)
@@ -268,8 +268,8 @@
<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>
+ persistence.xml. It's possible to use either already configured
hibernate or
+ JPA connection or specify a new one here.</para>
</entry>
<entry>
@@ -807,7 +807,7 @@
</entry>
<entry>
- <para>A table that has a multi-colum primary key a
<composite-id>
+ <para>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
@@ -838,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>
@@ -1240,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"/>
@@ -1899,53 +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, currently the wizards require that you have a <link
linkend="console_conf"
- >Hibernate Console Configuration</link> already
configured.</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>
Modified: branches/jbosstools-3.0.x/hibernatetools/docs/reference/en/modules/preface.xml
===================================================================
---
branches/jbosstools-3.0.x/hibernatetools/docs/reference/en/modules/preface.xml 2009-05-11
16:27:17 UTC (rev 15189)
+++
branches/jbosstools-3.0.x/hibernatetools/docs/reference/en/modules/preface.xml 2009-05-11
16:27:29 UTC (rev 15190)
@@ -143,9 +143,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>All JBoss Developer Studio/JBoss Tools release documentation you can
find at<ulink
url="http://docs.jboss.org/tools/">http://docs.jboss.org/too...
in the corresponding release directory.</para>
+ <para>The latest documentation builds are available at <ulink
url="http://download.jboss.org/jbosstools/nightly-docs/">htt...
</section>
</chapter>
Modified:
branches/jbosstools-3.0.x/hibernatetools/docs/reference/en/modules/reverseengineering.xml
===================================================================
---
branches/jbosstools-3.0.x/hibernatetools/docs/reference/en/modules/reverseengineering.xml 2009-05-11
16:27:17 UTC (rev 15189)
+++
branches/jbosstools-3.0.x/hibernatetools/docs/reference/en/modules/reverseengineering.xml 2009-05-11
16:27:29 UTC (rev 15190)
@@ -61,13 +61,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>
Modified: branches/jbosstools-3.0.x/hibernatetools/docs/reference/en/modules/setup.xml
===================================================================
---
branches/jbosstools-3.0.x/hibernatetools/docs/reference/en/modules/setup.xml 2009-05-11
16:27:17 UTC (rev 15189)
+++
branches/jbosstools-3.0.x/hibernatetools/docs/reference/en/modules/setup.xml 2009-05-11
16:27:29 UTC (rev 15190)
@@ -3,31 +3,35 @@
<title>Download and install Hibernate Tools</title>
<para><property>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>JBoss
- Tools</property> or a default Eclipse 3.3.x + WTP 2.x installation. The
following describes
- the install steps in these environments.</para>
+ 1.6.x or fully integrated into an Eclipse + WTP based IDE, such as
<property>JBDS/JBoss
+ Tools</property>, or a default Eclipse + WTP installation. The following
sections describe the
+ install steps in these environments.</para>
+ <note>
+ <title>Note:</title>
+ <para>The <property>Hibernate Tools 3.2.4.GA</property> (the
current release version) requires
+ Eclipse Ganymede 3.4.2.</para>
+ </note>
+
<section>
<title>JBoss Tools</title>
- <para><property>JBoss Tools 2.x</property> includes
<property>Hibernate Tools</property> and
- thus nothing is required besides <ulink
url="http://labs.jboss.com/tools/download/index.html"
- >downloading</ulink> and <ulink
- url="&gsglink;#JBossToolsInstall"
- >installing JBoss Tools</ulink>. If you need to update to a newer
version of the
- <property>Hibernate Tools</property> just follow the instructions in
the Eclipse IDE
- section.</para>
+ <para><property>JBoss Tools 3.0.0.GA</property> (the latest
release) includes
+ <property>Hibernate Tools 3.2.4.GA</property> and thus nothing is
required besides <ulink
+
url="http://jboss.org/tools/download/stable/3_0_0_GA.html">d...
and <ulink
+ url="&gsglink;#JBossToolsInstall">installing JBoss
Tools</ulink>. If you need to update
+ to a newer version of the <property>Hibernate Tools</property> just
follow the instructions in
+ the Eclipse IDE section.</para>
</section>
<section>
<title>Eclipse IDE</title>
- <para>To install into any <property>Eclipse 3.3.x</property> based
Eclipse IDE you can either
- download the <property>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>To install the <property>Hibernate Tools</property> into any
<property>Eclipse 3.4.x</property> based IDE you
+ can either download the <property>Hibernate Tools</property>
distribution from the <ulink
+
url="http://jboss.org/tools/download/stable/3_0_0_GA.html">J...
Tools download page</ulink>
+ or from the <ulink
url="http://download.jboss.org/jbosstools/updates/stable/">J... Tools
+ Update Site</ulink>.</para>
<para>If you download the <property>Hibernate Tools</property>
distribution you need to place
the <emphasis>
@@ -36,10 +40,12 @@
<property>/feature</property>
</emphasis> 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>-clean</property></emphasis> option, e.g.
<emphasis>
- <property>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 <emphasis>
+ <property>-clean</property>
+ </emphasis> option, e.g. <emphasis>
+ <property>eclipse -clean</property>.</emphasis> Using the
updatesite does not require any
+ additional steps.</para>
<note>
<title>Note:</title>
@@ -55,7 +61,7 @@
<title>Usage of Eclipse WTP</title>
<para>The <property>Hibernate Tools</property> plugins currently
use <property>WTP
- 2.x</property> which at this time is the latest stable release from the
Eclipse Webtools
+ 3.x</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
@@ -75,8 +81,8 @@
</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>/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>/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>
</section>
</chapter>
Modified: branches/jbosstools-3.0.x/hibernatetools/docs/reference/pom.xml
===================================================================
--- branches/jbosstools-3.0.x/hibernatetools/docs/reference/pom.xml 2009-05-11 16:27:17
UTC (rev 15189)
+++ branches/jbosstools-3.0.x/hibernatetools/docs/reference/pom.xml 2009-05-11 16:27:29
UTC (rev 15190)
@@ -77,6 +77,11 @@
<artifactId>jbosstools-docbook-xslt</artifactId>
<version>1.0.0-SNAPSHOT</version>
</dependency>
+ <dependency>
+ <groupId>org.apache.xmlgraphics</groupId>
+ <artifactId>fop</artifactId>
+ <version>0.95</version>
+ </dependency>
</dependencies>
<configuration>
<sourceDocumentName>${master}</sourceDocumentName>