[hibernate-commits] Hibernate SVN: r14190 - in branches/Branch_3_2/HibernateExt/tools/doc/reference/en: images and 1 other directories.
hibernate-commits at lists.jboss.org
hibernate-commits at lists.jboss.org
Thu Nov 8 12:13:00 EST 2007
Author: max.andersen at jboss.com
Date: 2007-11-08 12:13:00 -0500 (Thu, 08 Nov 2007)
New Revision: 14190
Added:
branches/Branch_3_2/HibernateExt/tools/doc/reference/en/images/codegenexporters.png
branches/Branch_3_2/HibernateExt/tools/doc/reference/en/images/codegenmaintab.png
branches/Branch_3_2/HibernateExt/tools/doc/reference/en/images/consolecfgwizard.png
branches/Branch_3_2/HibernateExt/tools/doc/reference/en/images/consoleoutline-before-reveng.png
branches/Branch_3_2/HibernateExt/tools/doc/reference/en/images/entitymodel.png
branches/Branch_3_2/HibernateExt/tools/doc/reference/en/images/hibernatecfgwizard.png
Removed:
branches/Branch_3_2/HibernateExt/tools/doc/reference/en/images/codegenexporters.gif
branches/Branch_3_2/HibernateExt/tools/doc/reference/en/images/codegenmaintab.gif
branches/Branch_3_2/HibernateExt/tools/doc/reference/en/images/codegenselectseam.gif
branches/Branch_3_2/HibernateExt/tools/doc/reference/en/images/consolecfgwizard.gif
branches/Branch_3_2/HibernateExt/tools/doc/reference/en/images/consoleoutline-before-reveng.gif
branches/Branch_3_2/HibernateExt/tools/doc/reference/en/images/dynamictranslation.png
branches/Branch_3_2/HibernateExt/tools/doc/reference/en/images/entitymodel.gif
branches/Branch_3_2/HibernateExt/tools/doc/reference/en/images/hbmxmlcompletion.gif
branches/Branch_3_2/HibernateExt/tools/doc/reference/en/images/hibernate_logo_a.gif
branches/Branch_3_2/HibernateExt/tools/doc/reference/en/images/hibernatecfgwizard.jpg
branches/Branch_3_2/HibernateExt/tools/doc/reference/en/images/queryconsole.gif
Modified:
branches/Branch_3_2/HibernateExt/tools/doc/reference/en/images/consolecfgclasspath.png
branches/Branch_3_2/HibernateExt/tools/doc/reference/en/images/consolecfgmappings.png
branches/Branch_3_2/HibernateExt/tools/doc/reference/en/images/dynamicquerytranslation.png
branches/Branch_3_2/HibernateExt/tools/doc/reference/en/images/queryconsole.png
branches/Branch_3_2/HibernateExt/tools/doc/reference/en/master.xml
branches/Branch_3_2/HibernateExt/tools/doc/reference/en/modules/ant.xml
branches/Branch_3_2/HibernateExt/tools/doc/reference/en/modules/plugins.xml
branches/Branch_3_2/HibernateExt/tools/doc/reference/en/modules/setup.xml
Log:
update CR1 docs
Deleted: branches/Branch_3_2/HibernateExt/tools/doc/reference/en/images/codegenexporters.gif
===================================================================
(Binary files differ)
Added: branches/Branch_3_2/HibernateExt/tools/doc/reference/en/images/codegenexporters.png
===================================================================
(Binary files differ)
Property changes on: branches/Branch_3_2/HibernateExt/tools/doc/reference/en/images/codegenexporters.png
___________________________________________________________________
Name: svn:mime-type
+ application/octet-stream
Deleted: branches/Branch_3_2/HibernateExt/tools/doc/reference/en/images/codegenmaintab.gif
===================================================================
(Binary files differ)
Added: branches/Branch_3_2/HibernateExt/tools/doc/reference/en/images/codegenmaintab.png
===================================================================
(Binary files differ)
Property changes on: branches/Branch_3_2/HibernateExt/tools/doc/reference/en/images/codegenmaintab.png
___________________________________________________________________
Name: svn:mime-type
+ application/octet-stream
Deleted: branches/Branch_3_2/HibernateExt/tools/doc/reference/en/images/codegenselectseam.gif
===================================================================
(Binary files differ)
Modified: branches/Branch_3_2/HibernateExt/tools/doc/reference/en/images/consolecfgclasspath.png
===================================================================
(Binary files differ)
Modified: branches/Branch_3_2/HibernateExt/tools/doc/reference/en/images/consolecfgmappings.png
===================================================================
(Binary files differ)
Deleted: branches/Branch_3_2/HibernateExt/tools/doc/reference/en/images/consolecfgwizard.gif
===================================================================
(Binary files differ)
Added: branches/Branch_3_2/HibernateExt/tools/doc/reference/en/images/consolecfgwizard.png
===================================================================
(Binary files differ)
Property changes on: branches/Branch_3_2/HibernateExt/tools/doc/reference/en/images/consolecfgwizard.png
___________________________________________________________________
Name: svn:mime-type
+ application/octet-stream
Deleted: branches/Branch_3_2/HibernateExt/tools/doc/reference/en/images/consoleoutline-before-reveng.gif
===================================================================
(Binary files differ)
Added: branches/Branch_3_2/HibernateExt/tools/doc/reference/en/images/consoleoutline-before-reveng.png
===================================================================
(Binary files differ)
Property changes on: branches/Branch_3_2/HibernateExt/tools/doc/reference/en/images/consoleoutline-before-reveng.png
___________________________________________________________________
Name: svn:mime-type
+ application/octet-stream
Modified: branches/Branch_3_2/HibernateExt/tools/doc/reference/en/images/dynamicquerytranslation.png
===================================================================
(Binary files differ)
Deleted: branches/Branch_3_2/HibernateExt/tools/doc/reference/en/images/dynamictranslation.png
===================================================================
(Binary files differ)
Deleted: branches/Branch_3_2/HibernateExt/tools/doc/reference/en/images/entitymodel.gif
===================================================================
(Binary files differ)
Added: branches/Branch_3_2/HibernateExt/tools/doc/reference/en/images/entitymodel.png
===================================================================
(Binary files differ)
Property changes on: branches/Branch_3_2/HibernateExt/tools/doc/reference/en/images/entitymodel.png
___________________________________________________________________
Name: svn:mime-type
+ application/octet-stream
Deleted: branches/Branch_3_2/HibernateExt/tools/doc/reference/en/images/hbmxmlcompletion.gif
===================================================================
(Binary files differ)
Deleted: branches/Branch_3_2/HibernateExt/tools/doc/reference/en/images/hibernate_logo_a.gif
===================================================================
(Binary files differ)
Deleted: branches/Branch_3_2/HibernateExt/tools/doc/reference/en/images/hibernatecfgwizard.jpg
===================================================================
(Binary files differ)
Added: branches/Branch_3_2/HibernateExt/tools/doc/reference/en/images/hibernatecfgwizard.png
===================================================================
(Binary files differ)
Property changes on: branches/Branch_3_2/HibernateExt/tools/doc/reference/en/images/hibernatecfgwizard.png
___________________________________________________________________
Name: svn:mime-type
+ application/octet-stream
Deleted: branches/Branch_3_2/HibernateExt/tools/doc/reference/en/images/queryconsole.gif
===================================================================
(Binary files differ)
Modified: branches/Branch_3_2/HibernateExt/tools/doc/reference/en/images/queryconsole.png
===================================================================
(Binary files differ)
Modified: branches/Branch_3_2/HibernateExt/tools/doc/reference/en/master.xml
===================================================================
--- branches/Branch_3_2/HibernateExt/tools/doc/reference/en/master.xml 2007-11-06 02:09:45 UTC (rev 14189)
+++ branches/Branch_3_2/HibernateExt/tools/doc/reference/en/master.xml 2007-11-08 17:13:00 UTC (rev 14190)
@@ -14,7 +14,7 @@
<subtitle>Reference Guide</subtitle>
- <releaseinfo>3.2.0.beta10</releaseinfo>
+ <releaseinfo>3.2.0.CR1</releaseinfo>
<mediaobject>
<imageobject>
Modified: branches/Branch_3_2/HibernateExt/tools/doc/reference/en/modules/ant.xml
===================================================================
--- branches/Branch_3_2/HibernateExt/tools/doc/reference/en/modules/ant.xml 2007-11-06 02:09:45 UTC (rev 14189)
+++ branches/Branch_3_2/HibernateExt/tools/doc/reference/en/modules/ant.xml 2007-11-08 17:13:00 UTC (rev 14190)
@@ -14,8 +14,7 @@
used independently of eclipse.</para>
<para>
- Note: until Hibernate 3.2 and related libraries are finally
- released there might be incompabilities with respect to the tools.
+ Note: There might be incompabilities with respect to the Hibernate3.jar bundled with the tools and your own jar.
Thus to avoid any confusion it is recommended to use the
hibernate3.jar & hibernate-annotations.jar bundled with the
tools when you want to use the Ant tasks. Do not worry about using
Modified: branches/Branch_3_2/HibernateExt/tools/doc/reference/en/modules/plugins.xml
===================================================================
--- branches/Branch_3_2/HibernateExt/tools/doc/reference/en/modules/plugins.xml 2007-11-06 02:09:45 UTC (rev 14189)
+++ branches/Branch_3_2/HibernateExt/tools/doc/reference/en/modules/plugins.xml 2007-11-08 17:13:00 UTC (rev 14190)
@@ -58,14 +58,14 @@
<mediaobject>
<imageobject role="fo">
- <imagedata contentwidth="5cm" fileref="images/hibernatecfgwizard.gif"
- format="GIF" />
+ <imagedata contentwidth="5cm" fileref="images/hibernatecfgwizard.png"
+ format="PNG" />
</imageobject>
<imageobject role="html">
<imagedata align="center"
- fileref="../shared/images/hibernatecfgwizard.gif"
- format="GIF" />
+ fileref="../shared/images/hibernatecfgwizard.png"
+ format="PNG" />
</imageobject>
</mediaobject>
@@ -109,13 +109,13 @@
<mediaobject>
<imageobject role="fo">
- <imagedata fileref="images/consolecfgwizard.gif" format="GIF" />
+ <imagedata fileref="images/consolecfgwizard.png" format="PNG" />
</imageobject>
<imageobject role="html">
<imagedata align="center"
- fileref="../shared/images/consolecfgwizard.gif"
- format="GIF" />
+ fileref="../shared/images/consolecfgwizard.png"
+ format="PNG" />
</imageobject>
<caption>Creating a Hibernate Console configuration</caption>
@@ -232,14 +232,14 @@
<mediaobject>
<imageobject role="fo">
- <imagedata align="center" fileref="images/consolecfgclasspath.gif"
- format="GIF" />
+ <imagedata align="center" fileref="images/consolecfgclasspath.png"
+ format="PNG" />
</imageobject>
<imageobject role="html">
<imagedata align="center"
- fileref="../shared/images/consolecfgclasspath.gif"
- format="GIF" />
+ fileref="../shared/images/consolecfgclasspath.png"
+ format="PNG" />
</imageobject>
<caption>Specifying classpath in a Hibernate Console
@@ -295,14 +295,14 @@
<para><mediaobject>
<imageobject role="fo">
- <imagedata align="center" fileref="images/consolecfgmappings.gif"
- format="GIF" />
+ <imagedata align="center" fileref="images/consolecfgmappings.png"
+ format="PNG" />
</imageobject>
<imageobject role="html">
<imagedata align="center"
- fileref="../shared/images/consolecfgmappings.gif"
- format="GIF" />
+ fileref="../shared/images/consolecfgmappings.png"
+ format="PNG" />
</imageobject>
<caption>Specifying additional mappings in a Hibernate console
@@ -349,14 +349,14 @@
<mediaobject>
<imageobject role="fo">
<imagedata align="center"
- fileref="images/consoleoutline-before-reveng.gif"
- format="GIF" />
+ fileref="images/consoleoutline-before-reveng.png"
+ format="PNG" />
</imageobject>
<imageobject role="html">
<imagedata align="center"
- fileref="../shared/images/consoleoutline-before-reveng.gif"
- format="GIF" />
+ fileref="../shared/images/consoleoutline-before-reveng.png"
+ format="PNG" />
</imageobject>
<caption>Console overview</caption>
@@ -400,13 +400,13 @@
<mediaobject>
<imageobject role="fo">
- <imagedata fileref="images/codegenmaintab.gif" format="GIF" />
+ <imagedata fileref="images/codegenmaintab.png" format="PNG" />
</imageobject>
<imageobject role="html">
<imagedata align="center"
- fileref="../shared/images/codegenmaintab.gif"
- format="GIF" />
+ fileref="../shared/images/codegenmaintab.png"
+ format="PNG" />
</imageobject>
</mediaobject>
@@ -561,18 +561,18 @@
<mediaobject>
<imageobject role="fo">
- <imagedata fileref="images/codegenexporters.gif" format="GIF" />
+ <imagedata fileref="images/codegenexporters.png" format="PNG" />
</imageobject>
<imageobject role="html">
<imagedata align="center"
- fileref="../shared/images/codegenexporters.gif"
- format="GIF" />
+ fileref="../shared/images/codegenexporters.png"
+ format="PNG" />
</imageobject>
</mediaobject>
<para>The following table describes in short the various
- exporters.</para>
+ exporters. Remember you can Add and Remove any exporters depending on your needs.</para>
<table>
<title>Code generation "Exporter" tab fields</title>
@@ -628,6 +628,12 @@
database schema and some of the mappings.</para></entry>
</row>
+ <row>
+ <entry><para>Generic Exporter (hbmtemplate)</para></entry>
+
+ <entry><para>Fully customizable exporter which can be used to perform custom generation.</para></entry>
+ </row>
+
</tbody>
</tgroup>
</table>
@@ -666,7 +672,39 @@
<entry><para>Generate EJB 3 annotations</para></entry>
</row>
+ <row>
+ <entry><para>for_each</para></entry>
+
+ <entry><para>Specifies which type of model elements the exporter should create a file and run through the templates. Possible values are: entity, component, configuration</para></entry>
+ </row>
+
<row>
+ <entry><para>template_path</para></entry>
+
+ <entry><para>Custom template directory for this specific exporter. You can use Eclipse variables.</para></entry>
+ </row>
+
+ <row>
+ <entry><para>template_name</para></entry>
+
+ <entry><para>Name for template relative to the template path</para></entry>
+ </row>
+
+ <row>
+ <entry><para>outputdir</para></entry>
+
+ <entry><para>Custom output directory for this specific exporter. You can use Eclipse variables.</para></entry>
+ </row>
+
+ <row>
+ <entry><para>file_pattern</para></entry>
+
+ <entry><para>Pattern to use for the generated files, relatively for the output dir. Example: {package-name}/{class-name}.java</para></entry>
+ </row>
+
+
+
+ <row>
<entry><para>dot.executable</para></entry>
<entry><para>executable to run GraphViz (only relevant, but
@@ -909,40 +947,35 @@
</mediaobject> Hibernate Console perspective showing entity structure,
query editor and result</para>
+ <para>The console configuration does not dynamically adjust to changes done in mappings and java code; to reload the configuration select the configuration and click the 'Reload' button in the view toolbar or in the context menu.</para>
<section>
- <title>Class Diagram</title>
+ <title>Mapping Diagram</title>
- <para>A class diagram is available in the view named "Hibernate Entity
- Model". It will show the model when the Configuration node in a
- Hibernate Console Configuration is selected.</para>
+ <para>A mapping diagram for entities are available by right clicking on the entity you want an mapping diagram for and then choose "Open Mapping Diagram"</para>
<mediaobject>
<imageobject role="fo">
- <imagedata fileref="images/entitymodel.gif" />
+ <imagedata fileref="images/entitymodel.png" />
</imageobject>
<imageobject role="html">
<imagedata align="center"
- fileref="../shared/images/entitymodel.gif" />
+ fileref="../shared/images/entitymodel.png" />
</imageobject>
</mediaobject>
- <para>This view supports zoom in/out and can also be printed. Zooming
- is done via the toolbar buttons in the view and printing is done by
- selecting the view and choose File/Print or use the Print Icon.</para>
</section>
</section>
<section>
<title>Prototyping Queries</title>
- <para>Queries can be prototyped by entering them in the HQL editor. The
- HQL Editor is opened by right-clicking the Console configuration and
- select "HQL Scratchpad".</para>
-
+ <para>Queries can be prototyped by entering them in the HQL or Criteria editor. The
+ query editors are opened by right-clicking the Console configuration and
+ selecting either "HQL Editor" or "Criteria Editor".</para>
+
<para>If the menu item is disabled then you need to first create an
- SessionFactory. That is done by right clicking the configuration and
- select "Create Session Factory" or by simpy expanding the Session
+ SessionFactory. That is done by simply expanding the Session
Factory node.</para>
<para>Executing the query is done by clicking the green run button in
@@ -958,10 +991,9 @@
details of possible errors (syntax errors, database errors, etc.) can be
seen in the Error Log view.</para>
- <para>Tip: HQL queries are executed using <literal>list()</literal> and
- without any limit of the size of the output. Be careful if you execute a
- query on a large result set. You might run out of memory. This will be
- improved in a future version.</para>
+ <para>Tip: HQL queries are executed by default using <literal>list()</literal> thus
+ without any limit of the size of the output the query could return a large result set.
+ You might run out of memory. To avoid this you can put a value in the Max results field to reduce the number of elements returned.</para>
<section>
<title>Dynamic Query Translator</title>
Modified: branches/Branch_3_2/HibernateExt/tools/doc/reference/en/modules/setup.xml
===================================================================
--- branches/Branch_3_2/HibernateExt/tools/doc/reference/en/modules/setup.xml 2007-11-06 02:09:45 UTC (rev 14189)
+++ branches/Branch_3_2/HibernateExt/tools/doc/reference/en/modules/setup.xml 2007-11-08 17:13:00 UTC (rev 14190)
@@ -3,15 +3,15 @@
<title>Download and install Hibernate Tools</title>
<para>Hibernate tools can be used "standalone" via Ant 1.6.x or fully
- integrated into a Eclipse 3.2.x based IDE, such as JBoss Eclipse IDE or a
- default Eclipse 3.2.x installation. The following describes the install
+ integrated into a Eclipse 3.3.x + WTP 2.x based IDE, such as JBoss Tools or an
+ default Eclipse 3.3.x + WTP 2.x installation. The following describes the install
steps in these environments.</para>
<section>
- <title>JBoss Eclipse IDE</title>
+ <title>JBoss Tools</title>
- <para>JBoss Eclipse IDE 2.x includes Hibernate Tools and thus nothing is
- required besides downloading and installing JBoss Eclipse IDE. If you need
+ <para>JBoss Tools 2.x includes Hibernate Tools and thus nothing is
+ required besides downloading and installing JBoss Tools. If you need
to update to a newer version of the Hibernate Tools just follow the
instructions in the Eclipse IDE section.</para>
</section>
@@ -19,9 +19,9 @@
<section>
<title>Eclipse IDE</title>
- <para>To install into any Eclipse 3.2.x based Eclipse IDE you can either
+ <para>To install into any Eclipse 3.3.x based Eclipse IDE you can either
download the Hibernate Tools distribution from the Hibernate website or
- use the JBoss IDE Eclipse update site (see http://tools.hibernate.org for
+ use the JBoss Tools update site (see http://tools.hibernate.org for
links to the update site).</para>
<para>If you download the Hibernate Tools distribution you need to place
@@ -41,7 +41,7 @@
<section>
<title>Usage of Eclipse WTP</title>
- <para>The Hibernate tools plugins currently uses WTP 1.5.x which at this
+ <para>The Hibernate tools plugins currently uses WTP 2.x which at this
time is the latest stable release from the Eclipse Webtools
project.</para>
@@ -51,11 +51,8 @@
has either the same version number or higher. It is thus recommended
that if you have issues with WTP provided features to try and install
the plugins on a clean install of eclipse to ensure there are no
- version-collisions.</para>
-
- <para>The tools only include a subset of the WTP 1.5.x plugins, thus if
- you want full access to the WTP functionallity the full WTP 1.5.x SDK should
- be able to instal on top of the plugins without any problems.</para>
+ version collisions.</para>
+
</section>
</section>
More information about the hibernate-commits
mailing list