JBoss Tools SVN: r20588 - in branches/jbosstools-3.1.x/hibernatetools/docs/reference: en and 1 other directory.
12:03 p.m.
Author: ochikvina
Date: 2010-03-03 06:03:27 -0500 (Wed, 03 Mar 2010)
New Revision: 20588
Modified:
branches/jbosstools-3.1.x/hibernatetools/docs/reference/en/master.xml
branches/jbosstools-3.1.x/hibernatetools/docs/reference/en/master_output.xml
branches/jbosstools-3.1.x/hibernatetools/docs/reference/pom.xml
Log:
<html><head><meta name="qrichtext" content="1"
/></head><body style="font-size:9pt;font-family:Sans Serif">
<p>https://jira.jboss.org/jira/browse/JBDS-1107 -Updated docs source files here with
the ones for JBDS 3.0.0 GA release. </p>
<p></p>
</body></html>
Modified: branches/jbosstools-3.1.x/hibernatetools/docs/reference/en/master.xml
===================================================================
--- branches/jbosstools-3.1.x/hibernatetools/docs/reference/en/master.xml 2010-03-03
10:34:07 UTC (rev 20587)
+++ branches/jbosstools-3.1.x/hibernatetools/docs/reference/en/master.xml 2010-03-03
11:03:27 UTC (rev 20588)
@@ -50,7 +50,7 @@
</copyright>
<releaseinfo>
- Version: 3.3.0.CR1
+ Version: 3.3.0.GA
</releaseinfo>
Modified: branches/jbosstools-3.1.x/hibernatetools/docs/reference/en/master_output.xml
===================================================================
---
branches/jbosstools-3.1.x/hibernatetools/docs/reference/en/master_output.xml 2010-03-03
10:34:07 UTC (rev 20587)
+++
branches/jbosstools-3.1.x/hibernatetools/docs/reference/en/master_output.xml 2010-03-03
11:03:27 UTC (rev 20588)
@@ -39,16 +39,17 @@
<author><firstname>Max</firstname><surname>Andersen</surname><email>max.andersen(a)jboss.com</email></author>
<author><firstname>Olga</firstname><surname>Chikvina</surname></author>
<author><firstname>Svetlana</firstname><surname>Mukhina</surname><email>smukhina(a)exadel.com</email></author>
-
- <pubdate>April 2008</pubdate>
+
<copyright>
<year>2007</year>
+ <year>2008</year>
<year>2009</year>
+ <year>2010</year>
<holder>JBoss by Red Hat</holder>
</copyright>
<releaseinfo><diffmk:wrapper diffmk:change="changed">
- Version: 3.3.0.CR1
+ Version: 3.3.0.GA
</diffmk:wrapper></releaseinfo>
@@ -69,7 +70,7 @@
<toc></toc>
-<chapter id="preface"
xml:base="file:///home/ochikvina/WORK/for_compare/jbosstools-3.1.0.CR1/hibernatetools/docs/reference/en/modules/preface.xml">
+<chapter id="preface"
xml:base="file:///home/vchukhutsina/repos/ochik_jboss/hibernatetools/docs/reference/en/modules/preface.xml">
<title>Preface</title>
@@ -231,77 +232,106 @@
</chapter>
-<chapter id="setup"
xml:base="file:///home/ochikvina/WORK/for_compare/jbosstools-3.1.0.CR1/hibernatetools/docs/reference/en/modules/setup.xml">
+<chapter id="setup"
xml:base="file:///home/vchukhutsina/repos/ochik_jboss/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 + WTP based IDE, such as <property
moreinfo="none">JBDS/JBoss
- Tools</property>, or a default Eclipse + WTP installation. The following
sections describe the
- install steps in these environments.</para>
-
+ <para><property moreinfo="none">Hibernate Tools</property>
can be used "standalone" via Ant 1.6.x or
+ fully integrated into an Eclipse + WTP based IDE, such as <property
moreinfo="none">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 moreinfo="none">Hibernate Tools
3.2.4.GA</property> (the current release version) requires
- Eclipse Ganymede 3.4.2.</para>
+ <para>The <property moreinfo="none">Hibernate Tools
3.3.0</property> (the current release version) requires
+ Eclipse Galileo 3.5.</para>
</note>
-
<section>
<title>JBoss Tools</title>
-
- <para><property moreinfo="none">JBoss Tools
3.0.0.GA</property> (the latest release) includes
- <property moreinfo="none">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="../../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">JBoss Tools
3.1.0</property> (the latest release) includes <property
moreinfo="none">Hibernate
+ Tools 3.3.0</property> and thus nothing is required besides <property
moreinfo="none">downloading</property>
+ and <property moreinfo="none">installing JBoss
Tools</property>. 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>
</section>
-
<section>
<title>Eclipse IDE</title>
-
- <para>To install the <property moreinfo="none">Hibernate
Tools</property> into any <property moreinfo="none">Eclipse
3.4.x</property> based IDE you
- can either download the <property moreinfo="none">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 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
- 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>
-
+ <para>To install the <property moreinfo="none">Hibernate
Tools</property> into any <property moreinfo="none">Eclipse
+ 3.5</property> based IDE you can either use <ulink
url="http://download.jboss.org/jbosstools/updates/stable/">J... Tools Update
Site</ulink>
+ or install it manually.</para>
+ <para>If you want to install the <property
moreinfo="none">Hibernate Tools</property> distribution manually you
+ need to:</para>
+ <itemizedlist>
+ <listitem>
+ <para>Download from www.eclipse.org:</para>
+ <itemizedlist>
+ <listitem>
+ <para>birt-report-framework-2_5_0.zip</para>
+ </listitem>
+ <listitem>
+ <para>birt-wtp-integration-sdk-2_3_2.zip</para>
+ </listitem>
+ <listitem>
+ <para>dtp-sdk_1.7.0.zip</para>
+ </listitem>
+ <listitem>
+ <para>eclipse-SDK-3.5-win32.zip</para>
+ </listitem>
+ <listitem>
+ <para>emf-runtime-2.5.0.zip</para>
+ </listitem>
+ <listitem>
+ <para>GEF-SDK-3.5.0.zip</para>
+ </listitem>
+ <listitem>
+
<para>org.eclipse.swtbot.eclipse.test-2.0.0.371-dev-e35.zip</para>
+ </listitem>
+ <listitem>
+ <para>org.eclipse.swtbot.eclipse-2.0.0.340-dev.zip</para>
+ </listitem>
+ <listitem>
+ <para>site-1.6.2.zip</para>
+ </listitem>
+ <listitem>
+ <para>tptp.sdk-TPTP-4.6.0.zip</para>
+ </listitem>
+ <listitem>
+ <para>wtp-sdk-R-3.1-20090616035105.zip</para>
+ </listitem>
+ <listitem>
+ <para>xsd-runtime-2.5.0.zip</para>
+ </listitem>
+ </itemizedlist>
+ </listitem>
+ <listitem>
+ <para>Then you should unpack these files into Eclipse install
folder.</para>
+ </listitem>
+ <listitem>
+ <para>From <ulink
url="https://www.hibernate.org/6.html">hibernate.org-Download
Overview</ulink> download <ulink
url="http://downloads.sourceforge.net/project/jboss/JBossTools/JBoss...
Tools</ulink>
+ .</para>
+
+ </listitem>
+ <listitem>
+ <para>Unpack <property moreinfo="none">Hibernate
Tools</property> in eclipse/dropins folder</para>
+ </listitem>
+ </itemizedlist>
<note>
<title>Note:</title>
- <para>If you need more basic instructions on installing plugins and general
usage of eclipse
+ <para>If you need more detailed instructions on plugins installation and
general usage of eclipse
then check out <ulink
url="https://eclipse-tutorial.dev.java.net/">https://eclipse...
and especially <ulink
url="https://eclipse-tutorial.dev.java.net/visual-tutorials/updatema...
which
covers using the update manager.</para>
</note>
-
<section>
<title>Usage of Eclipse WTP</title>
-
<para>The <property moreinfo="none">Hibernate
Tools</property> plugins currently use <property
moreinfo="none">WTP
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
might exist WTP plugins in your existing eclipse directory from other Eclipse
based projects
that are from an earlier WTP release but 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>
-
</section>
</section>
-
<section>
<title>Ant</title>
-
<para>To use the tools via Ant you need the <emphasis>
<property moreinfo="none">hibernate-tools.jar</property>
</emphasis> and associated libraries. The libraries are included in the
distribution from the
@@ -314,7 +344,7 @@
</chapter>
-<chapter id="codegenarchitecture"
xml:base="file:///home/ochikvina/WORK/for_compare/jbosstools-3.1.0.CR1/hibernatetools/docs/reference/en/modules/codegenarchitecture.xml">
+<chapter id="codegenarchitecture"
xml:base="file:///home/vchukhutsina/repos/ochik_jboss/hibernatetools/docs/reference/en/modules/codegenarchitecture.xml">
<title>Code generation architecture</title>
<para>The code generation mechanism in the <property
moreinfo="none">Hibernate Tools</property> consists of a few
@@ -426,72 +456,85 @@
</chapter>
-<chapter id="plugins" role="updated"
xml:base="file:///home/ochikvina/WORK/for_compare/jbosstools-3.1.0.CR1/hibernatetools/docs/reference/en/modules/plugins.xml">
+<chapter id="plugins" role="updated"
xml:base="file:///home/vchukhutsina/repos/ochik_jboss/hibernatetools/docs/reference/en/modules/plugins.xml">
<title>Eclipse Plugins</title>
-
<para>This chapter will introduce you to the functionality that <property
moreinfo="none">Hibernate
Tools</property> provide within Eclipse. That is a set of wizards and editors
for simplifying
the work with <property
moreinfo="none">Hibernate</property>.</para>
-
<section>
<title>Introduction</title>
-
<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
can take advantage of while using the tools within Eclipse.</para>
-
<note>
<title>Note:</title>
- <para>Please note that these tools do not try to hide any functionality of
- <property moreinfo="none">Hibernate</property>. The tools
make working with <property moreinfo="none">Hibernate</property>
- easier, but you are still encouraged/required to read the <ulink
url="http://www.hibernate.org/5.html">Hibernate Documentation</ulink>
to fully utilize
+ <para><diffmk:wrapper diffmk:change="changed">Please note
that these tools do not try to hide any functionality of
</diffmk:wrapper><property
moreinfo="none">Hibernate</property>. The tools make working with
<property moreinfo="none">Hibernate</property><diffmk:wrapper
diffmk:change="changed"> easier,
+ but you are still encouraged/required to read the
</diffmk:wrapper><ulink
url="http://www.hibernate.org/5.html">Hibernate Documentation</ulink>
to fully utilize
<property moreinfo="none">Hibernate Tools</property> and
especially <property moreinfo="none">Hibernate</property> it
self.</para>
</note>
+ <section diffmk:change="added" id="download_base_project">
+ <title diffmk:change="added"><diffmk:wrapper
diffmk:change="added">Download base
project</diffmk:wrapper></title>
+ <para diffmk:change="added"><diffmk:wrapper
diffmk:change="added">You can download example projects which are used as
base for this chapter.</diffmk:wrapper></para>
+ <para diffmk:change="added"><property
diffmk:change="added" moreinfo="none"><diffmk:wrapper
diffmk:change="added">JPA base
project</diffmk:wrapper></property><diffmk:wrapper
diffmk:change="added"> is available </diffmk:wrapper><ulink
diffmk:change="added"
url="http://anonsvn.jboss.org/repos/jbosstools/trunk//hibernatetools...
diffmk:change="added">here</diffmk:wrapper></ulink><diffmk:wrapper
diffmk:change="added">
+ and base </diffmk:wrapper><property diffmk:change="added"
moreinfo="none"><diffmk:wrapper diffmk:change="added">Java
project</diffmk:wrapper></property><diffmk:wrapper
diffmk:change="added"> is situated </diffmk:wrapper><ulink
diffmk:change="added"
url="http://anonsvn.jboss.org/repos/jbosstools/trunk//hibernatetools...
diffmk:change="added">here</diffmk:wrapper></ulink><diffmk:wrapper
diffmk:change="added">.</diffmk:wrapper></para>
+ <para diffmk:change="added"><diffmk:wrapper
diffmk:change="added">Also you need start </diffmk:wrapper><ulink
diffmk:change="added"
url="http://anonsvn.jboss.org/repos/jbosstools/trunk//hibernatetools...
diffmk:change="added">database</diffmk:wrapper></ulink><diffmk:wrapper
diffmk:change="added">.</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">How to run database you can know in
</diffmk:wrapper><ulink diffmk:change="added"
url="http://docs.jboss.org/tools/3.0.1.GA/en/GettingStartedGuide/htm...
diffmk:change="added">Getting Started
Guide</diffmk:wrapper></ulink><diffmk:wrapper
diffmk:change="added">.</diffmk:wrapper></para>
+ </note>
+ </section>
+
</section>
-
<section id="map_file_wizard">
<title>Creating a Hibernate Mapping File</title>
-
<para>Hibernate mapping files are used to specify how your objects are related
to database
tables.</para>
-
- <para>To create basic mappings for properties and associations, i. e. generate
<emphasis>
+ <para>To create basic mappings for properties and associations, i. e. generate
<emphasis>
<property moreinfo="none">.hbm.xml</property>
- </emphasis> files, Hibernate Tools provide a basic wizard which you can bring
up by navigating <emphasis>
+ </emphasis><diffmk:wrapper diffmk:change="changed"> files,
Hibernate Tools provide a basic wizard which you can bring up by navigating
+ </diffmk:wrapper><emphasis>
<property moreinfo="none">New > Hibernate XML mapping
file</property>.</emphasis></para>
- <para>At first you'll be asked to select a package or multiple individual
classes to map.</para>
+ <para><diffmk:wrapper diffmk:change="changed">At first
you'll be asked to select a package or multiple individual classes to map.
+ It's also possible to create an empty file, don't select any packages or
classes and an
+ empty .hbm will be created in the specified
location</diffmk:wrapper></para>
+ <para diffmk:change="added"
id="depth_control"><diffmk:wrapper diffmk:change="added">With
</diffmk:wrapper><property diffmk:change="added"
moreinfo="none"><diffmk:wrapper diffmk:change="added">depth
control</diffmk:wrapper></property><diffmk:wrapper
diffmk:change="added"> option you can define dependences depth for
+ choosing classes (it means to set level of references which is used to collect
linked classes
+ to the selection). </diffmk:wrapper></para>
<figure float="0">
<title>Hibernate XML Mapping File Wizard</title>
-
<mediaobject>
<imageobject>
<imagedata
fileref="images/plugins/plugins_0.png"></imagedata>
</imageobject>
</mediaobject>
</figure>
-
- <para>Next wizard page lists the mappings to be generated.</para>
+ <para><diffmk:wrapper diffmk:change="added">The next wizard
page lists the mappings to be generated. As you see </diffmk:wrapper><property
diffmk:change="added" moreinfo="none"><diffmk:wrapper
diffmk:change="added">Customers</diffmk:wrapper></property><diffmk:wrapper
diffmk:change="added">, </diffmk:wrapper><property
diffmk:change="added" moreinfo="none"><diffmk:wrapper
diffmk:change="added">Orders</diffmk:wrapper></property><diffmk:wrapper
diffmk:change="added">, </diffmk:wrapper><property
diffmk:change="added" moreinfo="none"><diffmk:wrapper
diffmk:change="added">Productlines</diffmk:wrapper></property><diffmk:wrapper
diffmk:change="added"> and </diffmk:wrapper><property
diffmk:change="added" moreinfo="none"><diffmk:wrapper
diffmk:change="added">Products</diffmk:wrapper></property><diffmk:wrapper
diffmk:change="added"> classes added under
</diffmk:wrapper><property diffmk:change="added"
moreinfo="none"><diffmk:wrapper diffmk:change="added">depth
control</diffmk:wrappe!
r></property><diffmk:wrapper diffmk:change="added"> driving.
</diffmk:wrapper></para>
<figure float="0">
- <title>Mappings to be generated</title>
-
+ <title>Mappings to be generated</title>
<mediaobject>
<imageobject>
<imagedata
fileref="images/plugins/plugins_0_a.png"></imagedata>
</imageobject>
</mediaobject>
</figure>
- <para>Pressing finish creates the files.</para>
-
+
+ <para diffmk:change="added"><diffmk:wrapper
diffmk:change="added">This wizard page outputs a generated .hbm files
preview.</diffmk:wrapper></para>
+ <figure diffmk:change="added" float="0">
+ <title diffmk:change="added"><diffmk:wrapper
diffmk:change="added">Preview Generated Mapping
Files</diffmk:wrapper></title>
+ <mediaobject diffmk:change="added">
+ <imageobject diffmk:change="added">
+ <imagedata diffmk:change="added"
fileref="images/plugins/plugins_0_b.png"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+ <para><diffmk:wrapper diffmk:change="added">Pressing
</diffmk:wrapper><property diffmk:change="added"
moreinfo="none"><diffmk:wrapper
diffmk:change="added">Finish</diffmk:wrapper></property><diffmk:wrapper
diffmk:change="added"> creates the
files.</diffmk:wrapper></para>
</section>
-
<section id="hib_config_file">
<title>Creating a Hibernate Configuration File</title>
-
- <para>To be able to reverse engineer, prototype queries, and of course to
simply use
- <property moreinfo="none">Hibernate Core</property> a
<emphasis>
+ <para><diffmk:wrapper diffmk:change="changed">To be able to
reverse engineer, prototype queries, and of course to simply use
</diffmk:wrapper><property moreinfo="none">Hibernate
Core</property> a <emphasis>
<property moreinfo="none">hibernate.properties</property>
</emphasis> or <emphasis>
<property moreinfo="none">hibernate.cfg.xml</property>
@@ -499,42 +542,36 @@
generating the <emphasis>
<property moreinfo="none">hibernate.cfg.xml</property>
</emphasis> file if you do not already have such one.</para>
-
<para>Start the wizard by clicking <emphasis>
- <property moreinfo="none">New > Other
(Ctrl+N)</property></emphasis>, then <emphasis>
+ <property moreinfo="none">New > Other
(Ctrl+N)</property>
+ </emphasis>, then <emphasis>
<property moreinfo="none">Hibernate > Hibernate
Configuration File (cfg.xml)</property>
</emphasis> and press <emphasis>
<property moreinfo="none">Next</property>
- </emphasis>
- or on a web Seam project in the <property moreinfo="none">Web
Projects</property> view
- <emphasis><property moreinfo="none"> WebContent -> New
-> File -> Hibernate Configuration 3.0</property>
+ </emphasis><diffmk:wrapper diffmk:change="changed"> or on a
web Seam project in the </diffmk:wrapper><property
moreinfo="none">Web Projects</property><diffmk:wrapper
diffmk:change="changed"> view </diffmk:wrapper><emphasis>
+ <property moreinfo="none"> WebContent -> New ->
File -> Hibernate Configuration 3.0</property>
</emphasis>. After selecting the wanted location for the <emphasis>
<property moreinfo="none">hibernate.cfg.xml</property>
</emphasis> file, you will see the following page:</para>
-
<figure float="0">
<title>Hibernate Configuration File Wizard</title>
<mediaobject>
<imageobject role="fo">
<imagedata align="center"
fileref="images/plugins/plugins_1.png"
format="PNG"></imagedata>
</imageobject>
-
<imageobject role="html">
<imagedata align="center"
fileref="images/plugins/plugins_1.png"
format="PNG"></imagedata>
</imageobject>
</mediaobject>
</figure>
-
<note>
<title>Note:</title>
<para>The contents in the combo boxes for the JDBC driver class and JDBC URL
change
automatically, depending on the Dialect and actual driver you have
chosen.</para>
</note>
-
<para>Enter your configuration information in this dialog. Details about the
configuration
options can be found in <ulink
url="http://docs.jboss.org/ejb3/app-server/Hibernate3/reference/en/h...
Reference Documentation</ulink>.</para>
-
<para>Press <emphasis>
<property moreinfo="none">Finish</property>
</emphasis> to create the configuration file, after optionally creating a
Console
@@ -546,739 +583,620 @@
<property moreinfo="none">hibernate.cfg.xml</property>
</emphasis> for the basis of a Console configuration.</para>
</section>
-
<section id="console_conf">
<title>Hibernate Console Configuration</title>
-
<para>A Console configuration describes how the <property
moreinfo="none">Hibernate plugin</property> should
configure <property moreinfo="none">Hibernate</property> and
what configuration files, including which
classpath are needed to load the POJO's, JDBC drivers etc. It is required to
make usage of
query prototyping, reverse engineering and code generation. You can have multiple
named
console configurations. Normally you would just need one per project, but more is
definitely
possible if your project requires this.</para>
- <section id="creat_console_conf">
- <title>Creating a Hibernate Console Configuration</title>
-
-
- <para>You create a console configuration by running the <property
moreinfo="none">Console Configuration
- Wizard</property>, shown in the following screenshot. The same wizard will
also be used if
- you are coming from the <emphasis>
- <property moreinfo="none">hibernate.cfg.xml</property>
- </emphasis> wizard and had enabled <emphasis>
- <property moreinfo="none">Create Console
Configuration</property>
- </emphasis>.</para>
-
- <note>
- <title>Note:</title>
- <para>The wizard will look at the current selection in the IDE and try and
auto-detect the
- settings which you then can just approve or modify to suit your
needs.</para>
- </note>
- <para></para>
-
- <para>The dialog consists of five tabs: </para>
-
- <itemizedlist>
- <listitem>
- <para><emphasis>
- <property moreinfo="none">Main</property>
- </emphasis> for the basic/required settings</para>
- </listitem>
- </itemizedlist>
-
- <figure float="0">
- <title> Creating Hibernate Console Configuration</title>
- <mediaobject>
- <imageobject role="fo">
- <imagedata align="center"
fileref="images/plugins/plugins_2.png"
format="PNG"></imagedata>
- </imageobject>
-
- <imageobject role="html">
- <imagedata align="center"
fileref="images/plugins/plugins_2.png"
format="PNG"></imagedata>
- </imageobject>
- </mediaobject>
- </figure>
-
- <para>The following table describes the available settings on the
<emphasis>
- <property moreinfo="none">Main</property>
- </emphasis> tab. The wizard can automatically detect default values for most
of these if you
- started the wizard with the relevant java project or resource
selected.</para>
-
- <table>
- <title>Hibernate Console Configuration Parameters</title>
-
- <tgroup cols="3">
- <colspec align="left" colnum="1"
colwidth="1*"></colspec>
-
- <colspec colnum="2" colwidth="3*"></colspec>
-
- <colspec align="left" colnum="3"
colwidth="1*"></colspec>
-
- <thead>
- <row>
- <entry align="center">
- <para>Parameter</para>
- </entry>
-
- <entry align="center">
- <para>Description</para>
- </entry>
-
- <entry align="center">
- <para>Auto detected value</para>
- </entry>
- </row>
- </thead>
-
- <tbody>
- <row>
- <entry>
- <para>Name</para>
- </entry>
-
- <entry>
- <para>The unique name of the console configuration</para>
- </entry>
-
- <entry>
- <para>Name of the selected project</para>
- </entry>
- </row>
-
- <row>
- <entry>
- <para>Type</para>
- </entry>
-
- <entry>
- <para>Choose between "Core", "Annotations" and
- "JPA". Note that the two latter requires running Eclipse IDE
with
- a JDK 5 runtime, otherwise you will get classloading and/or version
errors.</para>
- </entry>
-
- <entry>
- <para>No default value</para>
- </entry>
- </row>
-
- <row>
- <entry>
- <para>Project</para>
- </entry>
-
- <entry>
- <para>The name of a java project which classpath should be used in
the console
- configuration</para>
- </entry>
-
- <entry>
- <para>Name of the selected project</para>
- </entry>
- </row>
-
- <row>
- <entry>
- <para>Database connection</para>
- </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 either already configured
hibernate or
- JPA connection or specify a new one here.</para>
- </entry>
-
- <entry>
- <para>[Hibernate Configured connection]</para>
- </entry>
- </row>
-
- <row>
- <entry>
- <para>Property file</para>
- </entry>
-
- <entry>
- <para>Path to a hibernate.properties file</para>
- </entry>
-
- <entry>
- <para>First hibernate.properties file found in the selected
project</para>
- </entry>
- </row>
-
- <row>
- <entry>
- <para>Configuration file</para>
- </entry>
-
- <entry>
- <para>Path to a hibernate.cfg.xml file</para>
- </entry>
-
- <entry>
- <para>First hibernate.cfg.xml file found in the selected
project</para>
- </entry>
- </row>
-
- <row>
- <entry>
- <para>Persistence unit</para>
- </entry>
-
- <entry>
- <para>Name of the persistence unit to use</para>
- </entry>
-
- <entry>
- <para><diffmk:wrapper diffmk:change="changed">No
default value (lets Hibernate Entity Manager find the persistence
- unit or it can be defined manually using Browse
button)</diffmk:wrapper></para>
- </entry>
- </row>
-
- </tbody>
- </tgroup>
- </table>
-
- <tip>
- <title>Tip:</title>
-
- <para>The two latter settings are normally not required if you specify a
project and it has <emphasis>
- <property moreinfo="none">
- <literal moreinfo="none"> /hibernate.cfg.xml
</literal>
- </property>
- </emphasis> or <emphasis>
- <property moreinfo="none">
- <literal
moreinfo="none">/META-INF/persistence.xml</literal>
- </property>
- </emphasis> in its project classpath.</para>
- </tip>
-
-
- <itemizedlist>
- <listitem>
- <para>
- <emphasis>
- <property moreinfo="none">Options</property>
- </emphasis> for the additional/optional settings</para>
- </listitem>
- </itemizedlist>
-
- <figure float="0">
- <title>Options Tab of the Console Configuration Wizard</title>
-
- <mediaobject>
- <imageobject>
- <imagedata
fileref="images/plugins/plugins_2_a.png"></imagedata>
- </imageobject>
- </mediaobject>
- </figure>
-
- <para>The next table describes Hibernate Console Configuration options
available on the <emphasis>
- <property moreinfo="none">Options</property>
- </emphasis> tab.</para>
-
- <table>
- <title>Hibernate Console Configuration Options</title>
-
- <tgroup cols="3">
- <colspec align="left" colnum="1"
colwidth="1*"></colspec>
-
- <colspec colnum="2" colwidth="3*"></colspec>
-
- <colspec align="left" colnum="3"
colwidth="1*"></colspec>
-
- <thead>
- <row>
- <entry align="center">
- <para>Parameter</para>
- </entry>
-
- <entry align="center">
- <para>Description</para>
- </entry>
-
- <entry align="center">
- <para>Auto detected value</para>
- </entry>
- </row>
- </thead>
-
- <tbody>
- <row>
- <entry>
- <para>Naming strategy</para>
- </entry>
-
- <entry>
- <para>Fully qualified classname of a custom NamingStrategy. Only
required if you use a
- special naming strategy.</para>
- </entry>
-
- <entry>
- <para>No default value</para>
- </entry>
- </row>
-
- <row>
- <entry>
- <para>Entity resolver</para>
- </entry>
-
- <entry>
- <para>Fully qualified classname of a custom EntityResolver. Only
required if you have
- special xml entity includes in your mapping files.</para>
- </entry>
-
- <entry>
- <para>No default value</para>
- </entry>
- </row>
-
- </tbody>
- </tgroup>
- </table>
-
- <itemizedlist>
- <listitem>
- <para><emphasis>
- <property moreinfo="none">Classpath</property>
- </emphasis> for classpath</para>
- </listitem>
- </itemizedlist>
-
- <figure float="0">
- <title>Specifying Classpath in Hibernate Console Configuration</title>
- <mediaobject>
- <imageobject role="fo">
- <imagedata align="center"
fileref="images/plugins/plugins_3.png"
format="PNG"></imagedata>
- </imageobject>
-
- <imageobject role="html">
- <imagedata align="center"
fileref="images/plugins/plugins_3.png"
format="PNG"></imagedata>
- </imageobject>
-
- </mediaobject>
- </figure>
-
- <para>The following table specifies the parameters of the Classpath tab of the
wizard.</para>
-
- <table>
- <title>Hibernate Console Configuration Classpath</title>
-
- <tgroup cols="3">
- <colspec align="left" colnum="1"
colwidth="1*"></colspec>
-
- <colspec colnum="2" colwidth="3*"></colspec>
-
- <colspec colnum="3" colwidth="1*"></colspec>
-
- <thead>
- <row>
- <entry align="center">
- <para>Parameter</para>
- </entry>
-
- <entry align="center">
- <para>Description</para>
- </entry>
-
- <entry align="center">
- <para>Auto detected value</para>
- </entry>
- </row>
- </thead>
-
- <tbody>
- <row>
- <entry>
- <para>Classpath</para>
- </entry>
-
- <entry>
- <para>The classpath for loading POJO and JDBC drivers; only needed if
the default
- classpath of the Project does not contain the required classes. Do not
add Hibernate
- core libraries or dependencies, they are already included. If you get
ClassNotFound
- errors then check this list for possible missing or redundant
- directories/jars.</para>
- </entry>
-
- <entry>
- <para>Empty</para>
- </entry>
- </row>
-
- <row>
- <entry>
- <para>Include default classpath from project</para>
- </entry>
-
- <entry>
- <para>When enabled the project classpath will be appended to the
classpath specified
- above</para>
- </entry>
-
- <entry>
- <para>Enabled</para>
- </entry>
- </row>
-
- </tbody>
- </tgroup>
- </table>
-
- <itemizedlist>
- <listitem>
- <para><emphasis>
- <property moreinfo="none">Mappings</property>
- </emphasis> for additional mappings</para>
- </listitem>
- </itemizedlist>
-
- <figure float="0">
- <title>Specifying additional Mappings in Hibernate Console
Configuration</title>
- <mediaobject>
- <imageobject role="fo">
- <imagedata align="center"
fileref="images/plugins/plugins_4.png"
format="PNG"></imagedata>
- </imageobject>
-
- <imageobject role="html">
- <imagedata align="center"
fileref="images/plugins/plugins_4.png"
format="PNG"></imagedata>
- </imageobject>
- </mediaobject>
- </figure>
-
- <para>Parameters of the Mappings tab of the <property
moreinfo="none">Hibernate Console Configuration
- wizard</property> are explained below:</para>
- <table>
- <title>Hibernate Console Configuration Mappings</title>
-
- <tgroup cols="3">
- <colspec align="left" colnum="1"
colwidth="1*"></colspec>
-
- <colspec colnum="2" colwidth="3*"></colspec>
-
- <colspec colnum="3" colwidth="1*"></colspec>
-
- <thead>
- <row>
- <entry align="center">
- <para>Parameter</para>
- </entry>
-
- <entry align="center">
- <para>Description</para>
- </entry>
-
- <entry align="center">
- <para>Auto detected value</para>
- </entry>
- </row>
- </thead>
-
- <tbody>
- <row>
- <entry>
- <para>Mapping files </para>
- </entry>
-
- <entry>
- <para>List of additional mapping files that should be loaded. Note:
A
- hibernate.cfg.xml or persistence.xml can also contain mappings. Thus if
these are
- duplicated here, you will get "Duplicate mapping" errors when
using the console
- configuration.</para>
- </entry>
-
- <entry>
- <para>empty</para>
- </entry>
- </row>
- </tbody>
- </tgroup>
- </table>
-
- <itemizedlist>
- <listitem>
- <para>and the last tab <emphasis>
- <property moreinfo="none">Common</property>
- </emphasis></para>
- </listitem>
- </itemizedlist>
-
- <figure float="0">
- <title>Common Tab of the Console Configuration Wizard</title>
-
- <mediaobject>
- <imageobject>
- <imagedata
fileref="images/plugins/plugins_4_a.png"></imagedata>
- </imageobject>
- </mediaobject>
- </figure>
-
- <para>It allows to define general aspects of the launch configuration including
storage
- location, console encoding and some others.</para>
-
- <para>Clicking <emphasis>
- <property moreinfo="none">Finish</property>
- </emphasis> creates the configuration and shows it in the <property
moreinfo="none">Hibernate Configurations
- view</property>.</para>
-
- <figure float="0">
- <title>Console Overview</title>
- <mediaobject>
- <imageobject role="fo">
- <imagedata align="center"
fileref="images/plugins/plugins_5.png"
format="PNG"></imagedata>
- </imageobject>
-
- <imageobject role="html">
- <imagedata align="center"
fileref="images/plugins/plugins_5.png"
format="PNG"></imagedata>
- </imageobject>
-
- </mediaobject>
- </figure>
- </section>
+ <section id="creat_console_conf">
+ <title>Creating a Hibernate Console Configuration</title>
+ <para><diffmk:wrapper diffmk:change="changed">You can create
a console configuration by running the </diffmk:wrapper><property
moreinfo="none"><diffmk:wrapper
diffmk:change="changed">Console Configuration
+ Wizard</diffmk:wrapper></property><diffmk:wrapper
diffmk:change="changed">, shown in the following screenshot. The same wizard
will also be used if
+ you are coming from the </diffmk:wrapper><emphasis>
+ <property moreinfo="none">hibernate.cfg.xml</property>
+ </emphasis> wizard and had enabled <emphasis>
+ <property moreinfo="none">Create Console
Configuration</property>
+ </emphasis>.</para>
+ <note diffmk:change="added">
+ <title>Note:</title>
+ <para><diffmk:wrapper diffmk:change="changed">The wizard
will look at the current selection in the IDE and try and auto-detect the
+ settings which you then can just approve or modify to suit your
needs.</diffmk:wrapper></para>
+ </note>
+ <para></para>
+ <para>The dialog consists of five tabs: </para>
+ <itemizedlist diffmk:change="added">
+ <listitem diffmk:change="added">
+ <para><emphasis>
+ <property moreinfo="none">Main</property>
+ </emphasis> for the basic/required settings</para>
+ </listitem>
+ </itemizedlist>
+ <figure diffmk:change="added" float="0">
+ <title> Creating Hibernate Console Configuration</title>
+ <mediaobject diffmk:change="added">
+ <imageobject diffmk:change="added" role="fo">
+ <imagedata align="center"
fileref="images/plugins/plugins_2.png"
format="PNG"></imagedata>
+ </imageobject>
+ <imageobject diffmk:change="added" role="html">
+ <imagedata align="center"
fileref="images/plugins/plugins_2.png"
format="PNG"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+ <para>The following table describes the available settings on the
<emphasis>
+ <property moreinfo="none">Main</property>
+ </emphasis><diffmk:wrapper diffmk:change="changed"> tab.
The wizard can automatically detect the default values for most of them if you
+ started the wizard with the relevant java project or resource
selected.</diffmk:wrapper></para>
+ <table diffmk:change="added">
+ <title>Hibernate Console Configuration Parameters</title>
+ <tgroup cols="3" diffmk:change="added">
+ <colspec align="left" colnum="1"
colwidth="1*"></colspec>
+ <colspec colnum="2" colwidth="3*"></colspec>
+ <colspec align="left" colnum="3"
colwidth="1*"></colspec>
+ <thead diffmk:change="added">
+ <row diffmk:change="added">
+ <entry align="center" diffmk:change="added">
+ <para>Parameter</para>
+ </entry>
+ <entry align="center" diffmk:change="added">
+ <para>Description</para>
+ </entry>
+ <entry align="center" diffmk:change="added">
+ <para>Auto detected value</para>
+ </entry>
+ </row>
+ </thead>
+ <tbody diffmk:change="added">
+ <row diffmk:change="added">
+ <entry diffmk:change="added">
+ <para>Name</para>
+ </entry>
+ <entry diffmk:change="added">
+ <para>The unique name of the console configuration</para>
+ </entry>
+ <entry diffmk:change="added">
+ <para>Name of the selected project</para>
+ </entry>
+ </row>
+ <row diffmk:change="added">
+ <entry diffmk:change="added">
+ <para>Type</para>
+ </entry>
+ <entry diffmk:change="added">
+ <para><diffmk:wrapper
diffmk:change="changed">Choose between "Core",
"Annotations" and "JPA".
+ Note that the two latter requires running Eclipse IDE with a JDK 5
runtime,
+ otherwise you will get classloading and/or version
errors.</diffmk:wrapper></para>
+ </entry>
+ <entry diffmk:change="added">
+ <para>No default value</para>
+ </entry>
+ </row>
+ <row diffmk:change="added">
+ <entry diffmk:change="added">
+ <para>Project</para>
+ </entry>
+ <entry diffmk:change="added">
+ <para><diffmk:wrapper diffmk:change="changed">The
name of a java project which classpath should be used in the console
+ configuration</diffmk:wrapper></para>
+ </entry>
+ <entry diffmk:change="added">
+ <para>Name of the selected project</para>
+ </entry>
+ </row>
+ <row diffmk:change="added">
+ <entry diffmk:change="added">
+ <para>Database connection</para>
+ </entry>
+ <entry diffmk:change="added">
+ <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 diffmk:change="added">
+ <para>[Hibernate Configured connection]</para>
+ </entry>
+ </row>
+ <row diffmk:change="added">
+ <entry diffmk:change="added">
+ <para>Property file</para>
+ </entry>
+ <entry diffmk:change="added">
+ <para>Path to a hibernate.properties file</para>
+ </entry>
+ <entry diffmk:change="added">
+ <para>First hibernate.properties file found in the selected
project</para>
+ </entry>
+ </row>
+ <row diffmk:change="added">
+ <entry diffmk:change="added">
+ <para>Configuration file</para>
+ </entry>
+ <entry diffmk:change="added">
+ <para>Path to a hibernate.cfg.xml file</para>
+ </entry>
+ <entry diffmk:change="added">
+ <para>First hibernate.cfg.xml file found in the selected
project</para>
+ </entry>
+ </row>
+ <row diffmk:change="added">
+ <entry diffmk:change="added">
+ <para>Persistence unit</para>
+ </entry>
+ <entry diffmk:change="added">
+ <para>Name of the persistence unit to use</para>
+ </entry>
+ <entry diffmk:change="added">
+ <para><diffmk:wrapper diffmk:change="changed">No
default value (let Hibernate Entity Manager find the persistence unit or
+ it can be defined manually using Browse
button)</diffmk:wrapper></para>
+ </entry>
+ </row>
+ </tbody>
+ </tgroup>
+ </table>
+ <tip diffmk:change="added">
+ <title>Tip:</title>
+ <para><diffmk:wrapper diffmk:change="changed">The two
latter settings are usually not required if you specify a project and it has
+ </diffmk:wrapper><emphasis>
+ <property diffmk:change="added" moreinfo="none">
+ <literal moreinfo="none"> /hibernate.cfg.xml
</literal>
+ </property>
+ </emphasis> or <emphasis>
+ <property diffmk:change="added" moreinfo="none">
+ <literal
moreinfo="none">/META-INF/persistence.xml</literal>
+ </property>
+ </emphasis> in its project classpath.</para>
+ </tip>
+ <itemizedlist diffmk:change="added">
+ <listitem diffmk:change="added">
+ <para diffmk:change="added">
+ <emphasis diffmk:change="added">
+ <property moreinfo="none">Options</property>
+ </emphasis> for the additional/optional settings</para>
+ </listitem>
+ </itemizedlist>
+ <figure diffmk:change="added" float="0">
+ <title>Options Tab of the Console Configuration Wizard</title>
+ <mediaobject diffmk:change="added">
+ <imageobject diffmk:change="added">
+ <imagedata
fileref="images/plugins/plugins_2_a.png"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+ <para><diffmk:wrapper diffmk:change="changed">The next table
describes Hibernate Console Configuration options available on the
+ </diffmk:wrapper><emphasis>
+ <property moreinfo="none">Options</property>
+ </emphasis> tab.</para>
+ <table diffmk:change="added">
+ <title>Hibernate Console Configuration Options</title>
+ <tgroup cols="3" diffmk:change="added">
+ <colspec align="left" colnum="1"
colwidth="1*"></colspec>
+ <colspec colnum="2" colwidth="3*"></colspec>
+ <colspec align="left" colnum="3"
colwidth="1*"></colspec>
+ <thead diffmk:change="added">
+ <row diffmk:change="added">
+ <entry align="center" diffmk:change="added">
+ <para>Parameter</para>
+ </entry>
+ <entry align="center" diffmk:change="added">
+ <para>Description</para>
+ </entry>
+ <entry align="center" diffmk:change="added">
+ <para>Auto detected value</para>
+ </entry>
+ </row>
+ </thead>
+ <tbody diffmk:change="added">
+ <row diffmk:change="added">
+ <entry diffmk:change="added">
+ <para><diffmk:wrapper
diffmk:change="changed">Database dialect</diffmk:wrapper></para>
+ </entry>
+ <entry>
+ <para diffmk:change="added"><diffmk:wrapper
diffmk:change="added">Define a database dialect. It's possible either to
write your value or choose
+ from list. </diffmk:wrapper></para>
+ </entry>
+ <entry diffmk:change="added">
+ <para><diffmk:wrapper diffmk:change="changed">No
default value</diffmk:wrapper></para>
+ </entry>
+ </row>
+ <row diffmk:change="added">
+ <entry diffmk:change="added">
+ <para diffmk:change="added"><diffmk:wrapper
diffmk:change="added">Naming strategy</diffmk:wrapper></para>
+ </entry>
+ <entry>
+ <para diffmk:change="added"><diffmk:wrapper
diffmk:change="added">Fully qualified classname of a custom NamingStrategy.
Only required if you use
+ a special naming strategy.</diffmk:wrapper></para>
+ </entry>
+ <entry diffmk:change="added">
+ <para>No default value</para>
+ </entry>
+ </row>
+ <row diffmk:change="added">
+ <entry diffmk:change="added">
+ <para>Entity resolver</para>
+ </entry>
+ <entry diffmk:change="added">
+ <para><diffmk:wrapper diffmk:change="changed">Fully
qualified classname of a custom EntityResolver. Only required if you
+ have special xml entity includes in your mapping
files.</diffmk:wrapper></para>
+ </entry>
+ <entry diffmk:change="added">
+ <para>No default value</para>
+ </entry>
+ </row>
+ </tbody>
+ </tgroup>
+ </table>
+ <itemizedlist diffmk:change="added">
+ <listitem diffmk:change="added">
+ <para><emphasis>
+ <property moreinfo="none">Classpath</property>
+ </emphasis> for classpath</para>
+ </listitem>
+ </itemizedlist>
+ <figure diffmk:change="added" float="0">
+ <title>Specifying Classpath in Hibernate Console
Configuration</title>
+ <mediaobject diffmk:change="added">
+ <imageobject diffmk:change="added" role="fo">
+ <imagedata align="center"
fileref="images/plugins/plugins_3.png"
format="PNG"></imagedata>
+ </imageobject>
+ <imageobject diffmk:change="added" role="html">
+ <imagedata align="center"
fileref="images/plugins/plugins_3.png"
format="PNG"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+ <para>The following table specifies the parameters of the Classpath tab of
the wizard.</para>
+ <table diffmk:change="added">
+ <title>Hibernate Console Configuration Classpath</title>
+ <tgroup cols="3" diffmk:change="added">
+ <colspec align="left" colnum="1"
colwidth="1*"></colspec>
+ <colspec colnum="2" colwidth="3*"></colspec>
+ <colspec colnum="3" colwidth="1*"></colspec>
+ <thead diffmk:change="added">
+ <row diffmk:change="added">
+ <entry align="center" diffmk:change="added">
+ <para>Parameter</para>
+ </entry>
+ <entry align="center" diffmk:change="added">
+ <para>Description</para>
+ </entry>
+ <entry align="center" diffmk:change="added">
+ <para>Auto detected value</para>
+ </entry>
+ </row>
+ </thead>
+ <tbody diffmk:change="added">
+ <row diffmk:change="added">
+ <entry diffmk:change="added">
+ <para>Classpath</para>
+ </entry>
+ <entry diffmk:change="added">
+ <para><diffmk:wrapper diffmk:change="changed">The
classpath for loading POJO and JDBC drivers; only needed if the default
+ classpath of the Project does not contain the required classes. Do not
add
+ Hibernate core libraries or dependencies, they are already included. If
you get
+ ClassNotFound errors then check this list for possible missing or
redundant
+ directories/jars.</diffmk:wrapper></para>
+ </entry>
+ <entry diffmk:change="added">
+ <para>Empty</para>
+ </entry>
+ </row>
+ <row diffmk:change="added">
+ <entry diffmk:change="added">
+ <para>Include default classpath from project</para>
+ </entry>
+ <entry diffmk:change="added">
+ <para><diffmk:wrapper diffmk:change="changed">When
enabled the project classpath will be appended to the classpath specified
+ above</diffmk:wrapper></para>
+ </entry>
+ <entry diffmk:change="added">
+ <para>Enabled</para>
+ </entry>
+ </row>
+ </tbody>
+ </tgroup>
+ </table>
+ <itemizedlist diffmk:change="added">
+ <listitem diffmk:change="added">
+ <para><emphasis>
+ <property moreinfo="none">Mappings</property>
+ </emphasis> for additional mappings</para>
+ </listitem>
+ </itemizedlist>
+ <figure diffmk:change="added" float="0">
+ <title>Specifying additional Mappings in Hibernate Console
Configuration</title>
+ <mediaobject diffmk:change="added">
+ <imageobject diffmk:change="added" role="fo">
+ <imagedata align="center"
fileref="images/plugins/plugins_4.png"
format="PNG"></imagedata>
+ </imageobject>
+ <imageobject diffmk:change="added" role="html">
+ <imagedata align="center"
fileref="images/plugins/plugins_4.png"
format="PNG"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+ <para>Parameters of the Mappings tab of the <property
moreinfo="none"><diffmk:wrapper
diffmk:change="changed">Hibernate Console Configuration
+ wizard</diffmk:wrapper></property> are explained
below:</para>
+ <table diffmk:change="added">
+ <title>Hibernate Console Configuration Mappings</title>
+ <tgroup cols="3" diffmk:change="added">
+ <colspec align="left" colnum="1"
colwidth="1*"></colspec>
+ <colspec colnum="2" colwidth="3*"></colspec>
+ <colspec colnum="3" colwidth="1*"></colspec>
+ <thead diffmk:change="added">
+ <row diffmk:change="added">
+ <entry align="center" diffmk:change="added">
+ <para>Parameter</para>
+ </entry>
+ <entry align="center" diffmk:change="added">
+ <para>Description</para>
+ </entry>
+ <entry align="center" diffmk:change="added">
+ <para>Auto detected value</para>
+ </entry>
+ </row>
+ </thead>
+ <tbody diffmk:change="added">
+ <row diffmk:change="added">
+ <entry diffmk:change="added">
+ <para>Mapping files </para>
+ </entry>
+ <entry diffmk:change="added">
+ <para><diffmk:wrapper diffmk:change="changed">List
of additional mapping files that should be loaded. Note: A
+ hibernate.cfg.xml or persistence.xml can also contain mappings. Thus if
these are
+ duplications here, you will get "Duplicate mapping" errors
when using the console
+ configuration.</diffmk:wrapper></para>
+ </entry>
+ <entry diffmk:change="added">
+ <para>empty</para>
+ </entry>
+ </row>
+ </tbody>
+ </tgroup>
+ </table>
+ <itemizedlist diffmk:change="added">
+ <listitem diffmk:change="added">
+ <para>and the last tab <emphasis>
+ <property moreinfo="none">Common</property>
+ </emphasis></para>
+ </listitem>
+ </itemizedlist>
+ <figure diffmk:change="added" float="0">
+ <title>Common Tab of the Console Configuration Wizard</title>
+ <mediaobject diffmk:change="added">
+ <imageobject diffmk:change="added">
+ <imagedata
fileref="images/plugins/plugins_4_a.png"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+ <para><diffmk:wrapper diffmk:change="changed">It allows to
define general aspects of the launch configuration including storage
+ location, console encoding and some others.</diffmk:wrapper></para>
+ <para>Clicking <emphasis>
+ <property moreinfo="none">Finish</property>
+ </emphasis> creates the configuration and shows it in the <property
moreinfo="none"><diffmk:wrapper
diffmk:change="changed">Hibernate Configurations
+ view</diffmk:wrapper></property>.</para>
+ <figure diffmk:change="added" float="0">
+ <title>Console Overview</title>
+ <mediaobject diffmk:change="added">
+ <imageobject diffmk:change="added" role="fo">
+ <imagedata align="center"
fileref="images/plugins/plugins_5.png"
format="PNG"></imagedata>
+ </imageobject>
+ <imageobject diffmk:change="added" role="html">
+ <imagedata align="center"
fileref="images/plugins/plugins_5.png"
format="PNG"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+ </section>
<section id="modif_console_conf">
- <title>Modifying a Hibernate Console Configuration
- </title>
- <para>When you created a hibernate console configuration you can modify it in
2 ways:
- </para>
-
+ <title><diffmk:wrapper diffmk:change="changed">Modifying a
Hibernate Console Configuration </diffmk:wrapper></title>
+ <para><diffmk:wrapper diffmk:change="changed">When you
created a hibernate console configuration you can modify it in 2 ways:
</diffmk:wrapper></para>
<itemizedlist>
<listitem>
- <para>right click on the configuration in
- <emphasis>
- <property moreinfo="none">Hibernate Configurations
View->Edit Configuration
- </property>
- </emphasis>.</para>
-
- <figure float="0">
- <title>Opening Edit Configuration Wizard</title>
-
- <mediaobject>
- <imageobject>
- <imagedata
fileref="images/plugins/plugins_4_c.png"></imagedata>
- </imageobject>
- </mediaobject>
- </figure>
- <para> After clicking you will see the Edit Configuration Wizard that is
similar to <emphasis>
+ <para><diffmk:wrapper diffmk:change="changed">right-click
on the configuration in </diffmk:wrapper><emphasis>
+ <property moreinfo="none"><diffmk:wrapper
diffmk:change="changed">Hibernate Configurations View->Edit
Configuration </diffmk:wrapper></property>
+ </emphasis><diffmk:wrapper diffmk:change="added"> or
just double-click on </diffmk:wrapper><property diffmk:change="added"
moreinfo="none"><diffmk:wrapper diffmk:change="added">Console
Configuration</diffmk:wrapper></property><diffmk:wrapper
diffmk:change="added"> item.</diffmk:wrapper></para>
+ <figure float="0">
+ <title>Opening Edit Configuration Wizard</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata
fileref="images/plugins/plugins_4_c.png"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+ <para><diffmk:wrapper diffmk:change="changed"> After
clicking you will see the Edit Configuration Wizard that is similar to
+ </diffmk:wrapper><emphasis>
<property moreinfo="none">Create Console
Configuration</property>
- </emphasis>,described in <link
linkend="creat_console_conf">Creating a Hibernate Console Configuration
section</link>.
- </para>
+ </emphasis>,described in <link
linkend="creat_console_conf"><diffmk:wrapper
diffmk:change="changed">Creating a Hibernate Console
+ Configuration section</diffmk:wrapper></link><diffmk:wrapper
diffmk:change="changed">. </diffmk:wrapper></para>
</listitem>
- <listitem><para>use Properties view for modifying some of Console
Configuration properties.</para>
+ <listitem>
+ <para>use Properties view for modifying some of Console Configuration
properties.</para>
<figure float="0">
<title>Properties View</title>
-
<mediaobject>
<imageobject>
<imagedata
fileref="images/plugins/plugins_4_b.png"></imagedata>
</imageobject>
</mediaobject>
</figure>
- <para>The following table describes the available settings in the
Properties view. Most properties are changeable by left click but some are not.
-
- <table>
- <title>Properties</title>
-
- <tgroup cols="3">
- <colspec align="left" colnum="1"
colwidth="1*"></colspec>
-
- <colspec colnum="2"
colwidth="3*"></colspec>
-
- <colspec align="left" colnum="3"
colwidth="1*"></colspec>
-
- <thead>
- <row>
- <entry align="center">
- <para>Property</para>
- </entry>
-
- <entry align="center">
- <para>Description</para>
- </entry>
-
- <entry align="center">
- <para>Is Changeable</para>
- </entry>
- </row>
- </thead>
-
- <tbody>
- <row>
- <entry>
- <para>Additional mapping files </para>
- </entry>
-
- <entry>
- <para>List of additional mapping files that should be loaded.
- </para>
- </entry>
-
- <entry>
- <para>False</para>
- </entry>
- </row>
- <row>
- <entry>
- <para>Configuration file</para>
- </entry>
-
- <entry>
- <para>Path to a hibernate.cfg.xml file</para>
- </entry>
-
- <entry>
- <para>False</para>
- </entry>
- </row>
- <row>
- <entry>
- <para>Connection</para>
- </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 either already configured
hibernate or
- JPA connection or specify a new one here.</para>
- </entry>
-
- <entry>
- <para>True</para>
- </entry>
- </row>
- <row>
- <entry>
- <para>Name</para>
- </entry>
-
- <entry>
- <para>The unique name of the console
configuration</para>
- </entry>
-
- <entry>
- <para>True</para>
- </entry>
- </row>
- <row>
- <entry>
- <para>Project</para>
- </entry>
-
- <entry>
- <para>The name of a java project which classpath should be used
in the console
- configuration</para>
- </entry>
-
- <entry>
- <para>True</para>
- </entry>
- </row>
- <row>
- <entry>
- <para>Properties file</para>
- </entry>
-
- <entry>
- <para>Path to a hibernate.properties file</para>
- </entry>
-
- <entry>
- <para>False</para>
- </entry>
- </row>
- <row>
- <entry>
- <para>Type</para>
- </entry>
-
- <entry>
- <para>Choose between "CORE", "ANNOTATIONS"
and
- "JPA" according to the method of relational mapping you
want to use. Note that the two latter requires running Eclipse IDE with
- a JDK 5 runtime, otherwise you will get classloading and/or version
errors.</para>
- </entry>
-
- <entry>
- <para>True</para>
- </entry>
- </row>
-
- </tbody>
- </tgroup>
- </table>
-
- </para>
+ <para><diffmk:wrapper diffmk:change="changed">The
following table describes the available settings in the Properties view. Most
+ properties are changeable by left click but some are not.
</diffmk:wrapper><table>
+ <title>Properties</title>
+ <tgroup cols="3" diffmk:change="added">
+ <colspec align="left" colnum="1"
colwidth="1*"></colspec>
+ <colspec colnum="2"
colwidth="3*"></colspec>
+ <colspec align="left" colnum="3"
colwidth="1*"></colspec>
+ <thead diffmk:change="added">
+ <row diffmk:change="added">
+ <entry align="center"
diffmk:change="added">
+ <para>Property</para>
+ </entry>
+ <entry align="center"
diffmk:change="added">
+ <para>Description</para>
+ </entry>
+ <entry align="center"
diffmk:change="added">
+ <para>Is Changeable</para>
+ </entry>
+ </row>
+ </thead>
+ <tbody diffmk:change="added">
+ <row diffmk:change="added">
+ <entry diffmk:change="added">
+ <para>Additional mapping files </para>
+ </entry>
+ <entry diffmk:change="added">
+ <para><diffmk:wrapper
diffmk:change="changed">List of additional mapping files that should be
loaded. </diffmk:wrapper></para>
+ </entry>
+ <entry diffmk:change="added">
+ <para>False</para>
+ </entry>
+ </row>
+ <row diffmk:change="added">
+ <entry diffmk:change="added">
+ <para>Configuration file</para>
+ </entry>
+ <entry diffmk:change="added">
+ <para>Path to a hibernate.cfg.xml file</para>
+ </entry>
+ <entry diffmk:change="added">
+ <para>False</para>
+ </entry>
+ </row>
+ <row diffmk:change="added">
+ <entry diffmk:change="added">
+ <para>Connection</para>
+ </entry>
+ <entry diffmk:change="added">
+ <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 diffmk:change="added">
+ <para>True</para>
+ </entry>
+ </row>
+ <row diffmk:change="added">
+ <entry diffmk:change="added">
+ <para>Name</para>
+ </entry>
+ <entry diffmk:change="added">
+ <para>The unique name of the console
configuration</para>
+ </entry>
+ <entry diffmk:change="added">
+ <para>True</para>
+ </entry>
+ </row>
+ <row diffmk:change="added">
+ <entry diffmk:change="added">
+ <para>Project</para>
+ </entry>
+ <entry diffmk:change="added">
+ <para><diffmk:wrapper
diffmk:change="changed">The name of a java project which classpath should be
used in the console
+ configuration</diffmk:wrapper></para>
+ </entry>
+ <entry diffmk:change="added">
+ <para>True</para>
+ </entry>
+ </row>
+ <row diffmk:change="added">
+ <entry diffmk:change="added">
+ <para>Properties file</para>
+ </entry>
+ <entry diffmk:change="added">
+ <para>Path to a hibernate.properties file</para>
+ </entry>
+ <entry diffmk:change="added">
+ <para>False</para>
+ </entry>
+ </row>
+ <row diffmk:change="added">
+ <entry diffmk:change="added">
+ <para>Type</para>
+ </entry>
+ <entry diffmk:change="added">
+ <para><diffmk:wrapper
diffmk:change="changed">Choose between "CORE",
"ANNOTATIONS" and
+ "JPA" according to the method of relational mapping you
want to
+ use. Note, the two latter requires running Eclipse IDE with a JDK
5
+ runtime, otherwise you will get classloading and/or version
errors.</diffmk:wrapper></para>
+ </entry>
+ <entry diffmk:change="added">
+ <para>True</para>
+ </entry>
+ </row>
+ </tbody>
+ </tgroup>
+ </table></para>
</listitem>
</itemizedlist>
</section>
-
+ <section diffmk:change="added" id="closing_conf_config">
+ <title diffmk:change="added"><diffmk:wrapper
diffmk:change="added">Closing Hibernate Console
Configuration</diffmk:wrapper></title>
+ <para diffmk:change="added"><diffmk:wrapper
diffmk:change="added">To close </diffmk:wrapper><property
diffmk:change="added" moreinfo="none"><diffmk:wrapper
diffmk:change="added">Hibernate Console
Configuration</diffmk:wrapper></property><diffmk:wrapper
diffmk:change="added"> you need do right-click your configuration
+ and choose </diffmk:wrapper><property diffmk:change="added"
moreinfo="none"><diffmk:wrapper diffmk:change="added">Close
Configuration</diffmk:wrapper></property><diffmk:wrapper
diffmk:change="added"> option </diffmk:wrapper></para>
+ <figure diffmk:change="added" float="0">
+ <title diffmk:change="added"><diffmk:wrapper
diffmk:change="added">Close Hibernate Console
Configuration</diffmk:wrapper></title>
+ <mediaobject diffmk:change="added">
+ <imageobject diffmk:change="added">
+ <imagedata diffmk:change="added"
fileref="images/plugins/plugins_4_d.png"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+ <para diffmk:change="added"><diffmk:wrapper
diffmk:change="added">While closing configuration the connection with
database will be closed, jar libs will
+ be unlock (for Windows) and other resources will set as free.
</diffmk:wrapper></para>
</section>
-
-
-
+ </section>
<section id="refeng_codegen" role="updated">
<title>Reverse Engineering and Code Generation</title>
-
- <para>A "click-and-generate" reverse engineering and code generation
facility
- is available. This facility allows you to generate a range of artifacts based on
database or
- an already existing Hibernate configuration, be that mapping files or annotated
classes. Some
- of these are POJO Java source file, Hibernate <emphasis>
+ <para><diffmk:wrapper diffmk:change="changed">A
"click-and-generate" reverse engineering and code generation facility is
+ available. This facility allows you to generate a range of artifacts based on
database or an
+ already existing Hibernate configuration, be that mapping files or annotated
classes. Some of
+ these are POJO Java source file, Hibernate </diffmk:wrapper><emphasis>
<property moreinfo="none">.hbm.xml</property>
</emphasis>, <emphasis>
<property moreinfo="none">hibernate.cfg.xml</property>
</emphasis> generation and schema documentation.</para>
-
<para>To start working with this process, start the <property
moreinfo="none">Hibernate Code
- Generation</property> which is available in the toolbar via the
- <property moreinfo="none">Hibernate</property> icon or via
the <emphasis>
+ Generation</property><diffmk:wrapper
diffmk:change="changed"> which is available in the toolbar via the
</diffmk:wrapper><property
moreinfo="none">Hibernate</property> icon or via the <emphasis>
<property moreinfo="none">Run > Hibernate Code
Generation</property>
</emphasis> menu item.</para>
-
<section id="code_gen">
<title>Code Generation Launcher</title>
-
<para>When you click on <emphasis>
<property moreinfo="none">Open Hibernate Code Generation
Dialog...</property>
</emphasis> the standard Eclipse launcher dialog will appear. In this
dialog you can create,
edit and delete named Hibernate code generation
"launchers".</para>
-
<figure float="0" id="hib_code_gen">
<title>Getting Hibernate Code Generation Wizard</title>
<mediaobject>
<imageobject role="fo">
<imagedata fileref="images/plugins/plugins_6.png"
format="PNG"></imagedata>
</imageobject>
-
<imageobject role="html">
<imagedata align="center"
fileref="images/plugins/plugins_6.png"
format="PNG"></imagedata>
</imageobject>
</mediaobject>
</figure>
-
<para></para>
-
<figure float="0">
<title>Hibernate Code Generation Wizard</title>
<mediaobject>
<imageobject role="fo">
<imagedata align="center"
fileref="images/plugins/plugins_7.png" format="PNG"
scale="80"></imagedata>
</imageobject>
-
<imageobject role="html">
<imagedata align="center"
fileref="images/plugins/plugins_7.png"
format="PNG"></imagedata>
</imageobject>
</mediaobject>
</figure>
-
<para>The first time you create a code generation launcher you should give it
a meaningful
name, otherwise the default prefix <emphasis>
<property moreinfo="none">New_Generation</property>
</emphasis> will be used.</para>
-
<tip>
<title>Tip:</title>
- <para>The "At least one exporter option must be selected" is just
a
- warning stating that for this launch to work you need to select an exporter on
the
- Exporter tab. When an exporter has been selected the warning will
disappear.</para>
+ <para><diffmk:wrapper diffmk:change="changed">The "At
least one exporter option must be selected" is just a warning
+ stating that for this launch to work you need to select an exporter on the
Exporter tab.
+ When an exporter has been selected the warning will
disappear.</diffmk:wrapper></para>
</tip>
-
<para>The dialog also have the standard tabs <emphasis>
<property moreinfo="none">Refresh</property>
</emphasis> and <emphasis>
@@ -1286,62 +1204,49 @@
</emphasis> that can be used to configure which directories should be
automatically
refreshed and various general settings launchers, such as saving them in a
project for
sharing the launcher within a team.</para>
-
<para>On the <emphasis>
<property moreinfo="none">Main</property>
</emphasis> tab you see the following fields:</para>
-
<table>
<title>Code generation "Main" tab fields</title>
-
<tgroup cols="2">
<colspec align="left" colnum="1"
colwidth="1*"></colspec>
-
<colspec colnum="2" colwidth="3*"></colspec>
-
<colspec colnum="3" colwidth="0.5*"></colspec>
-
<thead>
<row>
<entry align="center">
<para>Field</para>
</entry>
-
<entry align="center">
<para>Description</para>
</entry>
</row>
</thead>
-
<tbody>
<row>
<entry>
<para>Console Configuration</para>
</entry>
-
<entry>
<para>The name of the console configuration which should be used
when code
generating</para>
</entry>
</row>
-
<row>
<entry>
<para>Output directory</para>
</entry>
-
<entry>
- <para>Path to a directory where all output will be written by
default. Be aware that
- existing files will be overwritten, so be sure to specify the correct
- directory.</para>
+ <para><diffmk:wrapper diffmk:change="changed">Path
to a directory where all output will be written by default. It's possible
+ to enter absolute directory path, for example - "d:/temp". Be
aware that existing
+ files will be overwritten, so be sure to specify the correct
directory.</diffmk:wrapper></para>
</entry>
</row>
-
<row>
<entry>
<para>Reverse engineer from JDBC Connection</para>
</entry>
-
<entry>
<para>If enabled, the tools will reverse engineer the database
available via the
connection information in the selected Hibernate Console Configuration
and
@@ -1350,23 +1255,19 @@
configuration.</para>
</entry>
</row>
-
<row>
<entry>
<para>Package</para>
</entry>
-
<entry>
<para>The package name here is used as the default package name for
any entities
found when reverse engineering</para>
</entry>
</row>
-
<row>
<entry>
<para>reveng.xml</para>
</entry>
-
<entry>
<para>Path to a reveng.xml file. A reveng.xml file allows you to
control certain
aspects of the reverse engineering. e.g. how jdbc types are mapped to
hibernate
@@ -1375,12 +1276,10 @@
create a new one. See more details about the reveng.xml file in
<xref linkend="reverseengineering"></xref>.</para>
</entry>
</row>
-
<row>
<entry>
<para>reveng. strategy</para>
</entry>
-
<entry>
<para>If reveng.xml does not provide enough customization you can
provide your own
implementation of an ReverseEngineeringStrategy. The class needs to be
in the
@@ -1389,50 +1288,42 @@
example of a custom strategy.</para>
</entry>
</row>
-
<row>
<entry>
<para>Generate basic typed composite ids</para>
</entry>
-
<entry>
- <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
+ <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
- <code><key-many-to-one></code> instead. Note:
a <code><many-to-one></code>
- property is still created, but is simply marked as non-updatable and
- non-insertable.</para>
+
</diffmk:wrapper><code><key-many-to-one></code><diffmk:wrapper
diffmk:change="changed"> instead. Note: a
+
</diffmk:wrapper><code><many-to-one></code><diffmk:wrapper
diffmk:change="changed"> property is still created, but is simply marked
+ as non-updatable and
non-insertable.</diffmk:wrapper></para>
</entry>
</row>
-
<row>
<entry>
<para>Detect optimistic lock columns</para>
</entry>
-
<entry>
<para>Automatically detect optimistic lock columns. Controllable
via reveng.
strategy; the current default is to use columns named VERSION or
TIMESTAMP.</para>
</entry>
</row>
-
<row>
<entry>
<para>Detect many-to-many tables</para>
</entry>
-
<entry>
<para>Automatically detect many-to-many tables. Controllable via
reveng.
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>
@@ -1441,27 +1332,20 @@
if not wanted. </para>
</entry>
</row>
-
-
-
-
<row>
<entry>
<para>Use custom templates</para>
</entry>
-
<entry>
<para>If enabled, the Template directory will be searched first
when looking up the
templates, allowing you to redefine how the individual templates
process the
hibernate mapping model.</para>
</entry>
</row>
-
<row>
<entry>
<para>Template directory</para>
</entry>
-
<entry>
<para>A path to a directory with custom templates</para>
</entry>
@@ -1470,334 +1354,267 @@
</tgroup>
</table>
</section>
-
<section id="exportes">
<title>Exporters</title>
-
<para>The <emphasis>
<property moreinfo="none">Exporters</property>
</emphasis> tab is used to specify which type of code that should be
generated. Each
selection represents an Exporter that is responsible for generating the code,
hence the
name.</para>
-
<figure float="0">
<title>Selecting Exporters</title>
<mediaobject>
<imageobject role="fo">
<imagedata align="center"
fileref="images/plugins/plugins_8.png" format="PNG"
scale="80"></imagedata>
</imageobject>
-
<imageobject role="html">
<imagedata align="center"
fileref="images/plugins/plugins_8.png"
format="PNG"></imagedata>
</imageobject>
</mediaobject>
</figure>
-
<para>The following table describes in short the various exporters. Remember
you can
add/remove any Exporters depending on your needs.</para>
-
<table>
<title>Code generation "Exporter" tab fields</title>
-
<tgroup cols="2">
<colspec align="left" colnum="1"
colwidth="1*"></colspec>
-
<colspec colnum="2" colwidth="3*"></colspec>
-
<thead>
<row>
<entry align="center">
<para>Field</para>
</entry>
-
<entry align="center">
<para>Description</para>
</entry>
</row>
</thead>
-
<tbody>
<row>
<entry>
<para>Domain code</para>
</entry>
-
<entry>
<para>Generates POJO's for all the persistent classes and
components found in the
given Hibernate configuration.</para>
</entry>
</row>
-
<row>
<entry>
<para>DAO code</para>
</entry>
-
<entry>
<para>Generates a set of DAO's for each entity
found.</para>
</entry>
</row>
-
<row>
<entry>
<para>Hibernate XML Mappings</para>
</entry>
-
<entry>
<para>Generate mapping (hbm.xml) files for each
entity.</para>
</entry>
</row>
-
<row>
<entry>
<para>Hibernate XML Configuration</para>
</entry>
-
<entry>
<para>Generate a hibernate.cfg.xml file. Used to keep the
hibernate.cfg.xml update
with any new found mapping files.</para>
</entry>
</row>
-
<row>
<entry>
<para>Schema Documentation (.html)</para>
</entry>
-
<entry>
<para>Generates a set of html pages that documents the 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>
-
<row>
<entry>
<para>Schema Export (.ddl)</para>
</entry>
-
<entry>
<para>Generates the appropriate SQL DDL and allows you to store the
result in a file
or export it directly to the database.</para>
</entry>
</row>
-
</tbody>
</tgroup>
</table>
-
<para>Each Exporter listens to certain properties and these can be setup in
the <emphasis>
<property moreinfo="none">Properties</property>
</emphasis> section where you can add/remove predefined or customer
properties for each of
the exporters. The following table lists the time of writing predefined
properties:</para>
-
<para>
<table>
<title>Exporter Properties</title>
-
<tgroup cols="2">
<colspec align="left" colnum="1"
colwidth="1*"></colspec>
-
<colspec colnum="2" colwidth="3*"></colspec>
-
<thead>
<row>
<entry align="center">
<para>Name</para>
</entry>
-
<entry align="center">
<para>Description</para>
</entry>
</row>
</thead>
-
<tbody>
<row>
<entry>
<para>jdk5</para>
</entry>
-
<entry>
<para>Generate Java 5 syntax</para>
</entry>
</row>
-
<row>
<entry>
<para>ejb3</para>
</entry>
-
<entry>
<para>Generate EJB 3 annotations</para>
</entry>
</row>
-
<row>
<entry>
<para>for_each</para>
</entry>
-
<entry>
<para>Specifies for 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 optional for
Schema
documentation)</para>
</entry>
</row>
-
<row>
<entry>
<para>drop</para>
</entry>
-
<entry>
<para>Output will contain drop statements for the tables, indices
and
constraints</para>
</entry>
</row>
-
<row>
<entry>
<para>delimiter</para>
</entry>
-
<entry>
<para>If specified the statements will be dumped to this
file</para>
</entry>
</row>
-
<row>
<entry>
<para>create</para>
</entry>
-
<entry>
<para>Output will contain create statements for the tables,
indices and
constraints</para>
</entry>
</row>
-
<row>
<entry>
<para>scriptToConsole</para>
</entry>
-
<entry>
<para>The script will be output to Console</para>
</entry>
</row>
-
<row>
<entry>
<para>exportToDatabase</para>
</entry>
-
<entry>
<para>Executes the generated statements against the
database</para>
</entry>
</row>
-
<row>
<entry>
<para>outputFileName</para>
</entry>
-
<entry>
<para>If specified the statements will be dumped to this
file</para>
</entry>
</row>
-
<row>
<entry>
<para>haltOnError</para>
</entry>
-
<entry>
<para>Halts the build process if an error occurs</para>
</entry>
</row>
-
<row>
<entry>
<para>format</para>
</entry>
-
<entry>
<para>Applies basic formatting to the statements</para>
</entry>
</row>
-
<row>
<entry>
<para>schemaUpdate</para>
</entry>
-
<entry>
<para>Updates a schema</para>
</entry>
@@ -1806,32 +1623,25 @@
</tgroup>
</table>
</para>
-
<para>To add a property to the chosen Exporter click the <emphasis>
<property moreinfo="none">Add</property>
</emphasis> button in the <property
moreinfo="none">Properties</property> section. In the appeared dialog
you should select the property from the proposed list and the value for
it.</para>
-
<figure float="0">
<title>Adding the Property for Schema Export (.ddl)</title>
-
<mediaobject>
<imageobject>
<imagedata
fileref="images/plugins/plugins_8a.png"></imagedata>
</imageobject>
</mediaobject>
</figure>
-
<tip>
<title>Tip:</title>
-
<para>If the property is a directory, it is possible to browse directories
in the Value
field.</para>
</tip>
-
<figure float="0">
<title>Specifying the Property Value</title>
-
<mediaobject>
<imageobject>
<imagedata
fileref="images/plugins/plugins_8b.png"></imagedata>
@@ -1840,10 +1650,8 @@
</figure>
</section>
</section>
-
<section id="map_config_editor">
<title>Hibernate Mapping and Configuration File Editor</title>
-
<para>The <property moreinfo="none">Hibernate Mapping File
editor</property> provides XML editing functionality
for the <emphasis>
<property moreinfo="none">hbm.xml </property>
@@ -1851,52 +1659,41 @@
<property moreinfo="none">cfg.xml</property>
</emphasis> files. The editor is based on the Eclipse WTP tools and extends
its functionality
to provide Hibernate specific code completion.</para>
-
<figure float="0">
<title>XML Editing Functionality</title>
<mediaobject>
<imageobject role="fo">
<imagedata align="center"
fileref="images/plugins/plugins_9.png" format="PNG"
scale="80"></imagedata>
</imageobject>
-
<imageobject role="html">
<imagedata align="center"
fileref="images/plugins/plugins_9.png"
format="PNG"></imagedata>
</imageobject>
</mediaobject>
</figure>
-
<section>
<title>Java property/class completion</title>
-
- <para>Package, class, and field completion is enabled for relevant XML
attributes. The
- auto-completion detects its context and limits the completion for e.g.
<code><property></code> and only shows the properties/fields
available in the enclosing
- <code><class></code>
- ,
- <code><subclass></code>
- etc. It is also possible to navigate from the <emphasis>
+ <para><diffmk:wrapper diffmk:change="changed">Package, class,
and field completion is enabled for relevant XML attributes. The
+ auto-completion detects its context and limits the completion for e.g.
+
</diffmk:wrapper><code><property></code><diffmk:wrapper
diffmk:change="changed"> and only shows the properties/fields available in
the
+ enclosing
</diffmk:wrapper><code><class></code><diffmk:wrapper
diffmk:change="changed"> ,
</diffmk:wrapper><code><subclass></code><diffmk:wrapper
diffmk:change="changed"> etc. It is also
+ possible to navigate from the </diffmk:wrapper><emphasis>
<property moreinfo="none">hbm.xml</property>
</emphasis> files to the relevant class/field in java code.</para>
-
<figure float="0">
<title>Navigation Functionality</title>
-
<mediaobject>
<imageobject role="fo">
<imagedata align="center"
fileref="images/plugins/plugins_10.png" format="PNG"
scale="80"></imagedata>
</imageobject>
-
<imageobject role="html">
<imagedata align="center"
fileref="images/plugins/plugins_10.png"
format="PNG"></imagedata>
</imageobject>
</mediaobject>
-
</figure>
-
<para>This is done via the standard hyperlink navigation functionality in
Eclipse; per default
it is done by pressing F3 while the cursor is on a class/field or by pressing
<emphasis>
<property moreinfo="none">Ctrl</property>
</emphasis> and the mouse button to perform the same
navigation.</para>
-
<para>For java completion and navigation to work the file needs to reside
inside an Eclipse
Java project, otherwise no completion will occur.</para>
<note>
@@ -1904,25 +1701,20 @@
<para>Java completion does not require a Hibernate console configuration to
be used.</para>
</note>
</section>
-
<section>
<title>Table/Column completion</title>
-
<para>Table and column completion is also available for all table and column
attributes. </para>
-
<figure float="0">
<title>Table and Column Completion</title>
<mediaobject>
<imageobject role="fo">
<imagedata align="center"
fileref="images/plugins/plugins_11.png" format="PNG"
scale="80"></imagedata>
</imageobject>
-
<imageobject role="html">
<imagedata align="center"
fileref="images/plugins/plugins_11.png"
format="PNG"></imagedata>
</imageobject>
</mediaobject>
</figure>
-
<important>
<title>Important:</title>
<para>Table/Column completion requires a proper configured hibernate
console configuration
@@ -1930,69 +1722,56 @@
<property moreinfo="none">hbm.xml</property>
</emphasis> resides.</para>
</important>
-
<para>You can check which console configuration is selected under the
Properties of a project
and look under the <emphasis>
<property moreinfo="none">Hibernate Settings</property>
</emphasis> page. When a proper configuration is selected it will be used
to fetch the
table/column names in the background.</para>
-
<note>
<title>Note:</title>
<para>Currently it is not recommended to use this feature on large
databases since it does
not fetch the information iteratively. It will be improved in future
versions.</para>
</note>
</section>
-
<section>
<title>Configuration property completion</title>
-
<para>In <emphasis>
<property moreinfo="none">cfg.xml</property>
- </emphasis> code completion for the value of
<code><property> name</code> attributes is
available.</para>
-
-
+ </emphasis> code completion for the value of
<code><property> name</code><diffmk:wrapper
diffmk:change="changed"> attributes
+ is available.</diffmk:wrapper></para>
<figure float="0">
<title>Property Completion</title>
<mediaobject>
<imageobject role="fo">
<imagedata align="center"
fileref="images/plugins/plugins_12.png" format="PNG"
scale="80"></imagedata>
</imageobject>
-
<imageobject role="html">
<imagedata align="center"
fileref="images/plugins/plugins_12.png"
format="PNG"></imagedata>
</imageobject>
</mediaobject>
</figure>
-
</section>
</section>
-
<section id="map_config_struct_editor">
<title>Structured Hibernate Mapping and Configuration File
Editor</title>
<para>The structured editor represents the file in the tree form. It also
allows to modify the
structure of the file and its elements with the help of tables provided on the
right-hand
area.</para>
-
<para>To open any mapping file in the editor, choose <emphasis>
<property moreinfo="none">Open With > Hibernate 3.0 XML
Editor</property>
</emphasis> option from the context menu of the file. The editor should look
as
follows:</para>
-
<figure float="0">
<title>Structured hbm.xml Editor</title>
-
<mediaobject>
<imageobject>
<imagedata
fileref="images/plugins/plugins_12_a.png"></imagedata>
</imageobject>
</mediaobject>
</figure>
-
<para>For the configuration file you should choose <emphasis>
<property moreinfo="none">Open With > Hibernate
Configuration 3.0 XML Editor</property>
</emphasis>option.</para>
-
<figure float="0">
<title>Structured cfg.xml Editor</title>
<mediaobject>
@@ -2001,98 +1780,85 @@
</imageobject>
</mediaobject>
</figure>
-
</section>
-
- <section id="properties_editor">
- <title>JBoss Tools Properties Editor</title>
-
- <para>The editor is meant for editing <literal
moreinfo="none">.properties</literal> files. It contains two tabs: the
- <property moreinfo="none">Properties</property> (UI) tab and the
- <property moreinfo="none">Source</property> tab for manual
editing.</para>
-
- <para>For <literal
moreinfo="none">hibernate.properties</literal> file <property
moreinfo="none">JBoss Tools Properties Editor</property>
- provides content assist which is available both for hibernate properties and property
values. You can make use of
- the content assist while editing the file in the Source view and in the Properties
view of the editor.</para>
-
-
- <para>To add the property in the
- <property moreinfo="none">Properties</property> view, click the
<emphasis>
- <property moreinfo="none">Add</property></emphasis>
button.</para>
-
- <figure float="0">
- <title>Adding the Property</title>
- <mediaobject>
- <imageobject>
- <imagedata
fileref="images/plugins/add_property1.png"></imagedata>
- </imageobject>
- </mediaobject>
- </figure>
-
- <para>In the <emphasis>
- <property moreinfo="none">Name</property></emphasis> field
press <emphasis>
- <property
moreinfo="none">Ctrl+Space</property></emphasis> to invoke the
content assist.
- It will suggest <emphasis>
- <property
moreinfo="none">'hibernate.'</property></emphasis> which
is the prefix for all hibernate properties. After
- selecting <emphasis>
- <property
moreinfo="none">'hibernate.'</property></emphasis> and
invoking the content assist again,
- other prefixes and properties are displayed as the proposals with a description of
each one.</para>
-
- <figure float="0">
- <title>Content Assist for Properties Names</title>
- <mediaobject>
- <imageobject>
- <imagedata
fileref="images/plugins/add_property2.png"></imagedata>
- </imageobject>
- </mediaobject>
- </figure>
-
- <para>When invoking the content assist in the <emphasis>
- <property moreinfo="none">Value</property></emphasis>
field, it also provides a list of proposals.</para>
-
- <figure float="0">
- <title>Content Assist for Properties Values</title>
- <mediaobject>
- <imageobject>
- <imagedata
fileref="images/plugins/add_property3.png"></imagedata>
- </imageobject>
- </mediaobject>
- </figure>
-
- <para>In the <property moreinfo="none">Source</property>
view of the editor, content assist also could be invoked both for properties names and
values:</para>
-
- <figure float="0">
- <title>Content Assist in the Source view</title>
- <mediaobject>
- <imageobject>
- <imagedata
fileref="images/plugins/add_property4.png"></imagedata>
- </imageobject>
- </mediaobject>
- </figure>
-
- <figure float="0">
- <title>Content Assist in the Source view</title>
- <mediaobject>
- <imageobject>
- <imagedata
fileref="images/plugins/add_property5.png"></imagedata>
- </imageobject>
- </mediaobject>
- </figure>
- </section>
-
+ <section id="properties_editor">
+ <title>JBoss Tools Properties Editor</title>
+ <para>The editor is meant for editing <literal
moreinfo="none">.properties</literal><diffmk:wrapper
diffmk:change="changed"> files. It contains two
+ tabs: the </diffmk:wrapper><property
moreinfo="none">Properties</property><diffmk:wrapper
diffmk:change="changed"> (UI) tab and the </diffmk:wrapper><property
moreinfo="none">Source</property><diffmk:wrapper
diffmk:change="changed"> tab for
+ manual editing.</diffmk:wrapper></para>
+ <para>For <literal
moreinfo="none">hibernate.properties</literal> file <property
moreinfo="none"><diffmk:wrapper diffmk:change="changed">JBoss
Tools Properties
+ Editor</diffmk:wrapper></property><diffmk:wrapper
diffmk:change="changed"> provides content assist which is available both for
hibernate properties
+ and property values. You can make use of the content assist while editing the file
in the
+ Source view and in the Properties view of the
editor.</diffmk:wrapper></para>
+ <para><diffmk:wrapper diffmk:change="changed">To add the
property in the </diffmk:wrapper><property
moreinfo="none">Properties</property> view, click the <emphasis>
+ <property moreinfo="none">Add</property>
+ </emphasis> button.</para>
+ <figure float="0">
+ <title>Adding the Property</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata
fileref="images/plugins/add_property1.png"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+ <para>In the <emphasis>
+ <property moreinfo="none">Name</property>
+ </emphasis> field press <emphasis>
+ <property moreinfo="none">Ctrl+Space</property>
+ </emphasis><diffmk:wrapper diffmk:change="changed"> to invoke
the content assist. It will suggest </diffmk:wrapper><emphasis>
+ <property moreinfo="none">'hibernate.'</property>
+ </emphasis><diffmk:wrapper diffmk:change="changed"> which is
the prefix for all hibernate properties. After selecting
</diffmk:wrapper><emphasis>
+ <property moreinfo="none">'hibernate.'</property>
+ </emphasis><diffmk:wrapper diffmk:change="changed"> and
invoking the content assist again, other prefixes and properties are displayed
+ as the proposals with a description of each
one.</diffmk:wrapper></para>
+ <figure float="0">
+ <title>Content Assist for Properties Names</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata
fileref="images/plugins/add_property2.png"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+ <para>When invoking the content assist in the <emphasis>
+ <property moreinfo="none">Value</property>
+ </emphasis> field, it also provides a list of proposals.</para>
+ <figure float="0">
+ <title>Content Assist for Properties Values</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata
fileref="images/plugins/add_property3.png"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+ <para>In the <property
moreinfo="none">Source</property><diffmk:wrapper
diffmk:change="changed"> view of the editor, content assist also could be
+ invoked both for properties names and values:</diffmk:wrapper></para>
+ <figure float="0">
+ <title>Content Assist in the Source view</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata
fileref="images/plugins/add_property4.png"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+ <figure float="0">
+ <title>Content Assist in the Source view</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata
fileref="images/plugins/add_property5.png"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+ </section>
<section id="rev_xml_editor">
<title>Reveng.xml Editor</title>
-
<para>A <emphasis>
<property moreinfo="none">reveng.xml </property>
</emphasis> file is used to customize and control how reverse engineering is
performed by the
tools. The plugins provide an editor to ease the editing of this file and hence
used to
configure the reverse engineering process.</para>
-
<para>The editor is intended to allow easy definition of type mappings, table
include/excludes
and specific override settings for columns, e.g. define an explicit name for a
column when the
default naming rules are not applicable.</para>
-
<note>
<title>Note:</title>
<para> Not all the features of the <emphasis>
@@ -2103,73 +1869,64 @@
</emphasis>, please see <xref
linkend="hibernaterevengxmlfile"></xref>
</para>
</note>
-
<para>The editor is activated as soon as an <emphasis>
<property moreinfo="none">.reveng.xml </property>
</emphasis> file is opened. To get an initial <emphasis>
<property moreinfo="none">reveng.xml </property>
- </emphasis> file the <property moreinfo="none">Reverse
Engineering File Wizard</property> can be started via <emphasis>
+ </emphasis> file the <property moreinfo="none">Reverse
Engineering File Wizard</property><diffmk:wrapper
diffmk:change="changed"> can be started via
+ </diffmk:wrapper><emphasis>
<property moreinfo="none">Ctrl+N</property>
</emphasis> and <emphasis>
<property moreinfo="none">Hibernate > Hibernate Reverse
Engineering File (reveng.xml)</property>
</emphasis> then.</para>
-
<figure float="0">
<title>ChooseReverse Engineering File Wizard </title>
<mediaobject>
<imageobject role="fo">
<imagedata align="center"
fileref="images/plugins/plugins_22.png" format="PNG"
scale="80"></imagedata>
</imageobject>
-
<imageobject role="html">
<imagedata align="center"
fileref="images/plugins/plugins_22.png"
format="PNG"></imagedata>
</imageobject>
</mediaobject>
</figure>
-
<para>Or you can get it via the <property moreinfo="none">Code
Generation Launcher</property> by checking the
proper section in the <emphasis>
<property moreinfo="none">Main</property>
</emphasis> tab of the <link linkend="hib_code_gen">Hibernate
Code Generation
Wizard</link>.</para>
-
<para>The following screenshot shows the <emphasis>
<property moreinfo="none">Overview</property>
</emphasis> page where the wanted console configuration is selected
(auto-detected if
Hibernate 3 support is enabled for the project)</para>
-
<figure float="0">
<title>Overview Page</title>
<mediaobject>
<imageobject role="fo">
<imagedata align="center"
fileref="images/plugins/plugins_13.png" format="PNG"
scale="80"></imagedata>
</imageobject>
-
<imageobject role="html">
<imagedata align="center"
fileref="images/plugins/plugins_13.png"
format="PNG"></imagedata>
</imageobject>
</mediaobject>
</figure>
-
<para>The <emphasis>
<property moreinfo="none">Table Filter</property>
- </emphasis> page allows you to specify which tables to include and exclude.
Pressing <emphasis>
+ </emphasis><diffmk:wrapper diffmk:change="changed"> page
allows you to specify which tables to include and exclude. Pressing
+ </diffmk:wrapper><emphasis>
<property moreinfo="none">Refresh</property>
</emphasis> shows the tables from the database that have not yet been
excluded.</para>
-
<figure float="0">
<title>Table Filters Page</title>
<mediaobject>
<imageobject role="fo">
<imagedata align="center"
fileref="images/plugins/plugins_14.png" format="PNG"
scale="80"></imagedata>
</imageobject>
-
<imageobject role="html">
<imagedata align="center"
fileref="images/plugins/plugins_14.png"
format="PNG"></imagedata>
</imageobject>
</mediaobject>
</figure>
-
<para>The <emphasis>
<property moreinfo="none">Type Mappings</property>
</emphasis> page is used for specifying type mappings from JBDC types to any
Hibernate type
@@ -2177,78 +1934,62 @@
tables press <emphasis>
<property moreinfo="none">Refresh</property>
</emphasis> button underneath. More about type mappings you can find further
in the <link linkend="type_map">Type Mappings</link>
section.</para>
-
<figure float="0">
<title>Type Mappings Page</title>
<mediaobject>
<imageobject role="fo">
<imagedata align="center"
fileref="images/plugins/plugins_15.png" format="PNG"
scale="80"></imagedata>
</imageobject>
-
<imageobject role="html">
<imagedata align="center"
fileref="images/plugins/plugins_15.png"
format="PNG"></imagedata>
</imageobject>
</mediaobject>
</figure>
-
<para>The <emphasis>
<property moreinfo="none">Table and Columns</property>
</emphasis> page allows you to explicit set e.g. which hibernatetype and
propertyname that
should be used in the reverse engineered model. For more details on how to
configure the
tables while reverse engineering read the <link
linkend="tab_and_col">Specific table
configuration</link> section.</para>
-
<figure float="0">
<title>Table and Columns Page</title>
<mediaobject>
<imageobject role="fo">
<imagedata align="center"
fileref="images/plugins/plugins_16.png" format="PNG"
scale="80"></imagedata>
</imageobject>
-
<imageobject role="html">
<imagedata align="center"
fileref="images/plugins/plugins_16.png"
format="PNG"></imagedata>
</imageobject>
</mediaobject>
</figure>
-
- <para>Now that you have configured all necessary parts, you can learn how to
work with
- <property moreinfo="none">Hibernate Console
Perspective</property>.</para>
+ <para><diffmk:wrapper diffmk:change="changed">Now that you have
configured all necessary parts, you can learn how to work with
</diffmk:wrapper><property moreinfo="none">Hibernate Console
Perspective</property>.</para>
</section>
-
<section id="hib_console">
<title>Hibernate Console Perspective</title>
-
<para>The <property moreinfo="none">Hibernate Console
Perspective</property> combines a set of views which allow
you to see the structure of your mapped entities/classes, edit HQL queries, execute
the
queries, and see the results. To use this perspective you need to create a <link
linkend="console_conf">Console configuration</link>.</para>
-
<section>
<title>Viewing the entity structure</title>
-
<para>To view your new configuration and entity/class structure, switch to
<property moreinfo="none">Hibernate
Configurations View</property>. Expanding the tree allows you to browse
the class/entity
structure and see the relationships.</para>
-
<figure float="0">
<title>Hibernate Console Perspective</title>
<mediaobject>
<imageobject role="fo">
<imagedata align="center"
fileref="images/plugins/plugins_17.png"
scale="80"></imagedata>
</imageobject>
-
<imageobject role="html">
<imagedata align="center"
fileref="images/plugins/plugins_17.png"></imagedata>
</imageobject>
</mediaobject>
-
</figure>
-
<para>The <property moreinfo="none">Console
Configuration</property> does not dynamically adjust to changes
done in mappings and java code. To reload the configuration select the
configuration and
click the <emphasis>
<property moreinfo="none">Reload</property>
</emphasis> button in the view toolbar or in the context
menu.</para>
-
<para>Besides, it's possible to open source and mapping files for objects
showed in
<property moreinfo="none">Hibernate Configurations
View</property>. Just bring up the context menu for a
necessary object and select <emphasis>
@@ -2257,43 +1998,37 @@
<property moreinfo="none">Open Mapping File</property>
</emphasis> to open a proper <emphasis>
<property
moreinfo="none">.hbm.xml</property>.</emphasis></para>
-
<figure float="0">
<title>Opening Source for Objects</title>
-
<mediaobject>
<imageobject>
<imagedata
fileref="images/plugins/plugins_17_a.png"></imagedata>
</imageobject>
</mediaobject>
</figure>
-
<section id="map_diagram">
<title>Mapping Diagram</title>
-
<para>In order to get a visual feel on how entities are related as well as
view their
structures, a <property moreinfo="none">Mapping
Diagram</property> is provided. It is available by right
clicking on the entity you want a mapping diagram for and then choosing
<emphasis>
<property moreinfo="none">Mapping
Diagram</property>.</emphasis></para>
-
<figure float="0">
<title>Mapping Diagram</title>
<mediaobject>
<imageobject role="fo">
<imagedata align="center"
fileref="images/plugins/plugins_18.png"
scale="80"></imagedata>
</imageobject>
-
<imageobject role="html">
<imagedata align="center"
fileref="images/plugins/plugins_18.png"></imagedata>
</imageobject>
</mediaobject>
</figure>
- <para>To make <property moreinfo="none">Mapping
Diagram</property> usage easier you can use <property
moreinfo="none">Rules</property>,
- <property moreinfo="none">Grid</property>,<property
moreinfo="none">Snap to Geometry</property> checkboxes in the
<emphasis>
- <property
moreinfo="none">View</property></emphasis> menu. </para>
+ <para><diffmk:wrapper diffmk:change="changed">To make
</diffmk:wrapper><property moreinfo="none">Mapping
Diagram</property> usage easier you can use <property
moreinfo="none">Rules</property><diffmk:wrapper
diffmk:change="changed">, </diffmk:wrapper><property
moreinfo="none">Grid</property>,<property
moreinfo="none">Snap to Geometry</property><diffmk:wrapper
diffmk:change="changed">
+ checkboxes in the </diffmk:wrapper><emphasis>
+ <property moreinfo="none">View</property>
+ </emphasis><diffmk:wrapper diffmk:change="changed"> menu.
</diffmk:wrapper></para>
<figure float="0">
<title>View menu</title>
-
<mediaobject>
<imageobject>
<imagedata
fileref="images/plugins/map_diagram1.png"></imagedata>
@@ -2301,14 +2036,15 @@
</mediaobject>
</figure>
<para>If you will select <emphasis>
- <property
moreinfo="none">Rules</property></emphasis> checkbox, the view
print page scale will be added to the page.
- The numbers on the scale show its size in inches.If you click on the scale a
<emphasis>
- <property moreinfo="none">Ruler
Guide</property></emphasis> will appear on the diagram.
- You can connect any diagram item to it.To connect the items you should move
their tops
- to the Ruler Guide. And while moving the ruler guide, the items will be moved
together with it as a whole.</para>
+ <property moreinfo="none">Rules</property>
+ </emphasis><diffmk:wrapper diffmk:change="changed">
checkbox, the view print page scale will be added to the page. The numbers on
+ the scale show its size in inches.If you click on the scale a
</diffmk:wrapper><emphasis>
+ <property moreinfo="none">Ruler Guide</property>
+ </emphasis><diffmk:wrapper diffmk:change="changed"> will
appear on the diagram. You can connect any diagram item to it.To connect
+ the items you should move their tops to the Ruler Guide. And while moving the
ruler guide,
+ the items will be moved together with it as a
whole.</diffmk:wrapper></para>
<figure float="0">
<title>Moving the Ruler guide</title>
-
<mediaobject>
<imageobject>
<imagedata
fileref="images/plugins/map_diagram2.png"></imagedata>
@@ -2316,10 +2052,10 @@
</mediaobject>
</figure>
<para>If you'll select <emphasis>
- <property
moreinfo="none">Grid</property></emphasis> checkbox, the grid
will appear on the diagram.</para>
+ <property moreinfo="none">Grid</property>
+ </emphasis> checkbox, the grid will appear on the diagram.</para>
<figure float="0">
<title>Grid on Mapping diagram</title>
-
<mediaobject>
<imageobject>
<imagedata
fileref="images/plugins/map_diagram3.png"></imagedata>
@@ -2327,687 +2063,844 @@
</mediaobject>
</figure>
<para>The checkbox <emphasis>
- <property moreinfo="none">Snap to
Geometry</property></emphasis> helps to put the items of the diagram into
allineation with the grid.</para>
- <para>For better navigating through the diagram use <property
moreinfo="none">Outline view</property> which is
- available in the structural and graphical modes.</para>
+ <property moreinfo="none">Snap to Geometry</property>
+ </emphasis> helps to put the items of the diagram into allineation with
the grid.</para>
+ <para>For better navigating through the diagram use <property
moreinfo="none">Outline view</property><diffmk:wrapper
diffmk:change="changed"> which
+ is available in the structural and graphical
modes.</diffmk:wrapper></para>
<figure float="0">
<title>Navigating in the Structural Mode</title>
-
<mediaobject>
<imageobject>
<imagedata
fileref="images/plugins/plugins_18_a.png"></imagedata>
</imageobject>
</mediaobject>
</figure>
-
<para>To switch over between the modes use the buttons in the top-right
corner of the
<property moreinfo="none">Outline
view</property>.</para>
-
<figure float="0">
<title>Navigating in the Graphical Mode</title>
-
<mediaobject>
<imageobject>
<imagedata
fileref="images/plugins/plugins_18_b.png"></imagedata>
</imageobject>
</mediaobject>
</figure>
-
- <para><diffmk:wrapper diffmk:change="added">The options in
the context menu of the mapping diagram are listed in the next
table.</diffmk:wrapper></para>
-
- <table diffmk:change="added">
- <title><diffmk:wrapper diffmk:change="changed">Context Menu
Options of the Mapping Diagram</diffmk:wrapper></title>
-
- <tgroup cols="3" diffmk:change="added">
- <colspec align="left" colnum="1" colwidth="1*"
diffmk:change="added"></colspec>
- <colspec align="left" colnum="2" colwidth="1*"
diffmk:change="added"></colspec>
- <colspec align="left" colnum="3" colwidth="3*"
diffmk:change="added"></colspec>
-
- <thead diffmk:change="added">
- <row diffmk:change="added">
- <entry align="center" diffmk:change="added">
- <para><diffmk:wrapper
diffmk:change="changed">Icon</diffmk:wrapper></para>
- </entry>
-
- <entry align="center" diffmk:change="added">
- <para><diffmk:wrapper
diffmk:change="added">Command</diffmk:wrapper></para>
- </entry>
-
- <entry align="center" diffmk:change="added">
- <para><diffmk:wrapper
diffmk:change="added">Description</diffmk:wrapper></para>
- </entry>
- </row>
- </thead>
-
- <tbody diffmk:change="added">
- <row diffmk:change="added">
- <entry diffmk:change="added">
- <para
diffmk:change="added"><inlinemediaobject><imageobject>
- <imagedata
fileref="images/plugins/toggleConnections.png"></imagedata>
- </imageobject></inlinemediaobject>
- </para>
- </entry>
- <entry diffmk:change="added">
- <para diffmk:change="added"><diffmk:wrapper
diffmk:change="added">Show|Hide
connections</diffmk:wrapper></para>
- </entry>
- <entry diffmk:change="added">
- <para diffmk:change="added"><diffmk:wrapper
diffmk:change="added">Allows to select what types of connections should be
shown on the diagram:
- </diffmk:wrapper><itemizedlist
diffmk:change="added">
- <listitem diffmk:change="added"><para
diffmk:change="added"><diffmk:wrapper
diffmk:change="added">Property
Mappings</diffmk:wrapper></para></listitem>
- <listitem diffmk:change="added"><para
diffmk:change="added"><diffmk:wrapper
diffmk:change="added">Class
Mappings</diffmk:wrapper></para></listitem>
- <listitem diffmk:change="added"><para
diffmk:change="added"><diffmk:wrapper
diffmk:change="added">Associations</diffmk:wrapper></para></listitem>
- <listitem diffmk:change="added"><para
diffmk:change="added"><diffmk:wrapper
diffmk:change="added">Foreign key
constraints</diffmk:wrapper></para></listitem>
- </itemizedlist><diffmk:wrapper
diffmk:change="added">
- and choose the type of the connection router:
- </diffmk:wrapper><itemizedlist
diffmk:change="added">
- <listitem diffmk:change="added"><para
diffmk:change="added"><diffmk:wrapper
diffmk:change="added">Manhattan Connection
Router</diffmk:wrapper></para></listitem>
- <listitem diffmk:change="added"><para
diffmk:change="added"><diffmk:wrapper
diffmk:change="added">Fan Connection
Router</diffmk:wrapper></para></listitem>
- </itemizedlist>
- </para>
- </entry>
- </row>
-
- <row diffmk:change="added">
- <entry diffmk:change="added">
- <para diffmk:change="added"><inlinemediaobject
diffmk:change="added"><imageobject>
- <imagedata fileref="images/plugins/autoLayout.png"/>
- </imageobject></inlinemediaobject>
- </para>
- </entry>
- <entry diffmk:change="added">
- <para>Auto layout</para>
- </entry>
- <entry diffmk:change="added">
- <para diffmk:change="added"><diffmk:wrapper
diffmk:change="added">Used to dispose all the items of the diagram in a
standard manner</diffmk:wrapper></para>
- </entry>
- </row>
-
- <row diffmk:change="added">
- <entry diffmk:change="added">
- <para diffmk:change="added"></para>
- </entry>
- <entry diffmk:change="added">
- <para diffmk:change="added"><diffmk:wrapper
diffmk:change="added">Collapse All</diffmk:wrapper></para>
- </entry>
- <entry diffmk:change="added">
- <para diffmk:change="added"><diffmk:wrapper
diffmk:change="added">Collapses all the diagram
elements</diffmk:wrapper></para>
- </entry>
- </row>
-
- <row diffmk:change="added">
- <entry diffmk:change="added">
- <para diffmk:change="added"></para>
- </entry>
- <entry diffmk:change="added">
- <para diffmk:change="added"><diffmk:wrapper
diffmk:change="added">Expand All</diffmk:wrapper></para>
- </entry>
- <entry diffmk:change="added">
- <para diffmk:change="added"><diffmk:wrapper
diffmk:change="added">Expands all the diagram
elements</diffmk:wrapper></para>
- </entry>
- </row>
-
- <row diffmk:change="added">
- <entry diffmk:change="added">
- <para diffmk:change="added"></para>
- </entry>
- <entry diffmk:change="added">
- <para diffmk:change="added"><diffmk:wrapper
diffmk:change="added">Select All</diffmk:wrapper></para>
- </entry>
- <entry diffmk:change="added">
- <para diffmk:change="added"><diffmk:wrapper
diffmk:change="added">Makes all the diagram elements
selected</diffmk:wrapper></para>
- </entry>
- </row>
-
- <row diffmk:change="added">
- <entry diffmk:change="added">
- <para
diffmk:change="added"><inlinemediaobject><imageobject>
- <imagedata fileref="images/plugins/exportAsImage.png"/>
- </imageobject></inlinemediaobject>
- </para>
- </entry>
- <entry diffmk:change="added">
- <para diffmk:change="added"><diffmk:wrapper
diffmk:change="added">Export as Image</diffmk:wrapper></para>
- </entry>
- <entry diffmk:change="added">
- <para><diffmk:wrapper diffmk:change="changed">Allows to
export a diagram as </diffmk:wrapper><emphasis><property
moreinfo="none"><diffmk:wrapper diffmk:change="changed">.png
- </diffmk:wrapper></property><diffmk:wrapper
diffmk:change="changed">,</diffmk:wrapper></emphasis>
- <emphasis>
- <property moreinfo="none"><diffmk:wrapper
diffmk:change="changed">.jpeg</diffmk:wrapper></property>
- </emphasis><diffmk:wrapper diffmk:change="changed"> or
</diffmk:wrapper><emphasis><property
moreinfo="none"><diffmk:wrapper diffmk:change="changed">.bmp
</diffmk:wrapper></property></emphasis></para>
- </entry>
- </row>
- </tbody>
- </tgroup>
- </table>
-
- <para>When you open the context menu while clicking an item on the diagram,
it quite differs from the one described before.</para>
+ <para><diffmk:wrapper diffmk:change="changed">The options
in the context menu of the mapping diagram are listed in the next
+ table.</diffmk:wrapper></para>
+ <table>
+ <title>Context Menu Options of the Mapping Diagram</title>
+ <tgroup cols="3">
+ <colspec align="left" colnum="1"
colwidth="1*"></colspec>
+ <colspec align="left" colnum="2"
colwidth="1*"></colspec>
+ <colspec align="left" colnum="3"
colwidth="3*"></colspec>
+ <thead>
+ <row>
+ <entry align="center">
+ <para>Icon</para>
+ </entry>
+ <entry align="center">
+ <para>Command</para>
+ </entry>
+ <entry align="center">
+ <para>Description</para>
+ </entry>
+ </row>
+ </thead>
+ <tbody>
+ <row>
+ <entry>
+ <para>
+ <inlinemediaobject>
+ <imageobject>
+ <imagedata
fileref="images/plugins/toggleConnections.png"></imagedata>
+ </imageobject>
+ </inlinemediaobject>
+ </para>
+ </entry>
+ <entry>
+ <para>Show|Hide connections</para>
+ </entry>
+ <entry><diffmk:wrapper diffmk:change="added">Allows
to select what types of connections should be shown on the diagram:
</diffmk:wrapper><itemizedlist>
+ <listitem>
+ <para>Property Mappings</para>
+ </listitem>
+ <listitem>
+ <para>Class Mappings</para>
+ </listitem>
+ <listitem>
+ <para>Associations</para>
+ </listitem>
+ <listitem>
+ <para>Foreign key constraints</para>
+ </listitem>
+ </itemizedlist></entry>
+ </row>
+ <row>
+ <entry>
+ <para></para>
+ </entry>
+ <entry>
+ <para><diffmk:wrapper
diffmk:change="changed">Select All</diffmk:wrapper></para>
+ </entry>
+ <entry>
+ <para><diffmk:wrapper
diffmk:change="changed">Makes all the diagram elements
selected</diffmk:wrapper></para>
+ </entry>
+ </row>
+ <row>
+ <entry>
+ <para>
+ <inlinemediaobject diffmk:change="added">
+ <imageobject diffmk:change="added">
+ <imagedata diffmk:change="added"
fileref="images/plugins/autoLayout.png"></imagedata>
+ </imageobject>
+ </inlinemediaobject>
+ </para>
+ </entry>
+ <entry>
+ <para><diffmk:wrapper
diffmk:change="changed">Auto layout</diffmk:wrapper></para>
+ </entry>
+ <entry>
+ <para><diffmk:wrapper
diffmk:change="changed">Used to dispose all the items of the diagram in a
standard manner</diffmk:wrapper></para>
+ </entry>
+ </row>
+ <row>
+ <entry>
+ <para>
+ <inlinemediaobject>
+ <imageobject>
+ <imagedata
fileref="images/plugins/exportAsImage.png"></imagedata>
+ </imageobject>
+ </inlinemediaobject>
+ </para>
+ </entry>
+ <entry>
+ <para>Export as Image</para>
+ </entry>
+ <entry>
+ <para>Allows to export a diagram as <emphasis><property
moreinfo="none"><diffmk:wrapper diffmk:change="changed">.png
+ </diffmk:wrapper></property>,</emphasis>
+ <emphasis>
+ <property moreinfo="none">.jpeg</property>
+ </emphasis> or <emphasis>
+ <property moreinfo="none">.bmp </property>
+ </emphasis></para>
+ </entry>
+ </row>
+ </tbody>
+ </tgroup>
+ </table>
+ <para><diffmk:wrapper diffmk:change="changed">When you open
the context menu while clicking an item on the diagram, it quite differs
+ from the one described before.</diffmk:wrapper></para>
<figure float="0">
- <title><diffmk:wrapper diffmk:change="changed">Context
Menu in Mapping Item</diffmk:wrapper></title>
-
+ <title>Context Menu in Mapping Item</title>
<mediaobject>
<imageobject>
<imagedata
fileref="images/plugins/plugins_18_g.png"></imagedata>
</imageobject>
</mediaobject>
</figure>
-
- <para><diffmk:wrapper diffmk:change="added">The next table
describes all the extra options in the menu of mapping
items:</diffmk:wrapper></para>
-
- <table diffmk:change="added">
- <title diffmk:change="added"><diffmk:wrapper
diffmk:change="added">Extra Options in the Context Menu of Mapping
Item</diffmk:wrapper></title>
-
- <tgroup cols="3" diffmk:change="added">
- <colspec align="left" colnum="1" colwidth="1*"
diffmk:change="added"></colspec>
- <colspec align="left" colnum="2" colwidth="1*"
diffmk:change="added"></colspec>
- <colspec align="left" colnum="3" colwidth="3*"
diffmk:change="added"></colspec>
-
- <thead diffmk:change="added">
- <row diffmk:change="added">
- <entry align="center" diffmk:change="added">
- <para><diffmk:wrapper
diffmk:change="added">Icon</diffmk:wrapper></para>
- </entry>
-
- <entry align="center" diffmk:change="added">
- <para diffmk:change="added"><diffmk:wrapper
diffmk:change="added">Command</diffmk:wrapper></para>
- </entry>
-
- <entry align="center" diffmk:change="added">
- <para diffmk:change="added"><diffmk:wrapper
diffmk:change="added">Description</diffmk:wrapper></para>
- </entry>
- </row>
- </thead>
-
- <tbody diffmk:change="added">
- <row diffmk:change="added">
- <entry diffmk:change="added">
- <para
diffmk:change="added"><inlinemediaobject><imageobject>
- <imagedata
fileref="images/plugins/visibleState.png"></imagedata>
- </imageobject></inlinemediaobject>
- </para>
- </entry>
- <entry diffmk:change="added">
- <para><diffmk:wrapper diffmk:change="added">Toggle
Visible State</diffmk:wrapper></para>
- </entry>
- <entry diffmk:change="added">
- <para diffmk:change="added"><diffmk:wrapper
diffmk:change="added">Used to hide/show an item on the mapping
diagram</diffmk:wrapper></para>
- </entry>
- </row>
-
- <row diffmk:change="added">
- <entry diffmk:change="added">
- <para
diffmk:change="added"><inlinemediaobject><imageobject>
- <imagedata
fileref="images/plugins/expandState.png"></imagedata>
- </imageobject></inlinemediaobject>
- </para>
- </entry>
- <entry diffmk:change="added">
- <para diffmk:change="added"><diffmk:wrapper
diffmk:change="added">Expand|Collapse</diffmk:wrapper></para>
- </entry>
- <entry diffmk:change="added">
- <para diffmk:change="added"><diffmk:wrapper
diffmk:change="added">Used for expanding/collapsing fields of the
item</diffmk:wrapper></para>
- </entry>
- </row>
-
- <row diffmk:change="added">
- <entry diffmk:change="added">
- <para diffmk:change="added"><inlinemediaobject
diffmk:change="added"><imageobject diffmk:change="added">
- <imagedata diffmk:change="added"
fileref="images/plugins/openSourceFile_but.png"></imagedata>
- </imageobject></inlinemediaobject>
- </para>
- </entry>
- <entry diffmk:change="added">
- <para diffmk:change="added"><diffmk:wrapper
diffmk:change="added">Open Source File</diffmk:wrapper></para>
- </entry>
- <entry diffmk:change="added">
- <para diffmk:change="added"><diffmk:wrapper
diffmk:change="added">Makes it possible to open a source file for a chosen
- object/element. The selected element will be highlighted in the open
file.</diffmk:wrapper></para>
- </entry>
- </row>
-
- <row diffmk:change="added">
- <entry diffmk:change="added">
- <para diffmk:change="added"><inlinemediaobject
diffmk:change="added"><imageobject diffmk:change="added">
- <imagedata diffmk:change="added"
fileref="images/plugins/openMappingFile_but.png"></imagedata>
- </imageobject></inlinemediaobject>
- </para>
- </entry>
- <entry diffmk:change="added">
- <para diffmk:change="added"><diffmk:wrapper
diffmk:change="added">Open Mapping File</diffmk:wrapper></para>
- </entry>
- <entry diffmk:change="added">
- <para diffmk:change="added"><diffmk:wrapper
diffmk:change="added">Makes it possible to open a mapping file for a chosen
- object/element. The selected element will be highlighted in the open
file.</diffmk:wrapper></para>
- </entry>
- </row>
- </tbody>
- </tgroup>
- </table>
-
- <tip diffmk:change="added">
- <title diffmk:change="added"><diffmk:wrapper
diffmk:change="added">Tip:</diffmk:wrapper></title>
- <para diffmk:change="added"><diffmk:wrapper
diffmk:change="added">All the described types of the context menu are also
available in the </diffmk:wrapper><property diffmk:change="added"
moreinfo="none"><diffmk:wrapper
diffmk:change="added">Outline</diffmk:wrapper></property><diffmk:wrapper
diffmk:change="added"> view.</diffmk:wrapper></para>
- </tip>
-
- <para diffmk:change="added"><diffmk:wrapper
diffmk:change="added">The below table lists the actions that could be
performed using the keyboard keys (or keys
combinations).</diffmk:wrapper></para>
-
- <table diffmk:change="added">
- <title diffmk:change="added"><diffmk:wrapper
diffmk:change="added">Hibernate Mapping Diagram Shortcut
Keys</diffmk:wrapper></title>
-
- <tgroup cols="2" diffmk:change="added">
- <colspec align="left" colnum="1" colwidth="3*"
diffmk:change="added"></colspec>
- <colspec align="left" colnum="2" colwidth="1*"
diffmk:change="added"></colspec>
-
- <thead diffmk:change="added">
- <row diffmk:change="added">
- <entry align="center" diffmk:change="added">
- <para diffmk:change="added"><diffmk:wrapper
diffmk:change="added">Command</diffmk:wrapper></para>
- </entry>
-
- <entry align="center" diffmk:change="added">
- <para diffmk:change="added"><diffmk:wrapper
diffmk:change="added">Binding</diffmk:wrapper></para>
- </entry>
- </row>
- </thead>
-
- <tbody diffmk:change="added">
- <row diffmk:change="added">
- <entry diffmk:change="added">
- <para diffmk:change="added"><diffmk:wrapper
diffmk:change="added">Scroll the diagram
content</diffmk:wrapper></para>
- </entry>
- <entry diffmk:change="added">
- <para diffmk:change="added"><diffmk:wrapper
diffmk:change="added">Ctrl + Shift +
arrows</diffmk:wrapper></para>
- </entry>
- </row>
-
- <row diffmk:change="added">
- <entry diffmk:change="added">
- <para diffmk:change="added"><diffmk:wrapper
diffmk:change="added">Collapse/Expand selected
item(s)</diffmk:wrapper></para>
- </entry>
- <entry diffmk:change="added">
- <para diffmk:change="added"><diffmk:wrapper
diffmk:change="added"> Enter </diffmk:wrapper></para>
- </entry>
- </row>
-
- <row diffmk:change="added">
- <entry diffmk:change="added">
- <para diffmk:change="added"><diffmk:wrapper
diffmk:change="added">Show/Hide selected
item(s)</diffmk:wrapper></para>
- </entry>
- <entry diffmk:change="added">
- <para><diffmk:wrapper diffmk:change="changed"> +
</diffmk:wrapper></para>
- </entry>
- </row>
-
- <row diffmk:change="added">
- <entry diffmk:change="added">
- <para diffmk:change="added"><diffmk:wrapper
diffmk:change="added">Sort items in alphabetical order or return the initial
state</diffmk:wrapper></para>
- </entry>
- <entry diffmk:change="added">
- <para diffmk:change="added"><diffmk:wrapper
diffmk:change="added">Space</diffmk:wrapper></para>
- </entry>
- </row>
-
- <row diffmk:change="added">
- <entry diffmk:change="added">
- <para diffmk:change="added"><diffmk:wrapper
diffmk:change="added">Navigate between the
items</diffmk:wrapper></para>
- </entry>
- <entry diffmk:change="added">
- <para diffmk:change="added"><diffmk:wrapper
diffmk:change="added">Arrows</diffmk:wrapper></para>
- </entry>
- </row>
- </tbody>
- </tgroup>
- </table>
-
- <para diffmk:change="added"><diffmk:wrapper
diffmk:change="added">It's possible to save the diagram in the eclipse
workspace. Click the usual </diffmk:wrapper><emphasis
diffmk:change="added">
- <property diffmk:change="added"
moreinfo="none"><diffmk:wrapper diffmk:change="added">File
> Save
As</diffmk:wrapper></property></emphasis><diffmk:wrapper
diffmk:change="added"> option, the wizard will ask you to set the location
within you project
- where to save the file and give the name for the diagram. The item's names
concatenated with the ampersand
- symbols are set as the default name for a diagram. The file is saved with the
</diffmk:wrapper><literal diffmk:change="added"
moreinfo="none"><diffmk:wrapper
diffmk:change="added">.hibernate</diffmk:wrapper></literal><diffmk:wrapper
diffmk:change="added"> extension.</diffmk:wrapper></para>
-
- <figure diffmk:change="added" float="0">
- <title diffmk:change="added"><diffmk:wrapper
diffmk:change="added">The Diagram saved in the
Workspace</diffmk:wrapper></title>
- <mediaobject diffmk:change="added">
- <imageobject diffmk:change="added">
- <imagedata diffmk:change="added"
fileref="images/plugins/saveDiagram.png"></imagedata>
- </imageobject>
- </mediaobject>
- </figure>
-
- <tip 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">If you restart the Eclipse with the mapping diagram
opened, the mapping diagram will be restored with the
- message like on the figure below. To view the diagram content, you should
perform the refreshing.</diffmk:wrapper></para>
- </tip>
-
- <figure diffmk:change="added" float="0">
- <title diffmk:change="added"><diffmk:wrapper
diffmk:change="added">The Diagram after Restarting the
Eclipse</diffmk:wrapper></title>
- <mediaobject diffmk:change="added">
- <imageobject diffmk:change="added">
- <imagedata diffmk:change="added"
fileref="images/plugins/diagram1.png"></imagedata>
- </imageobject>
- </mediaobject>
- </figure>
-
- <figure diffmk:change="added" float="0">
- <title diffmk:change="added"><diffmk:wrapper
diffmk:change="added">The Diagram after
Refreshing</diffmk:wrapper></title>
- <mediaobject diffmk:change="added">
- <imageobject diffmk:change="added">
- <imagedata diffmk:change="added"
fileref="images/plugins/diagram2.png"></imagedata>
- </imageobject>
- </mediaobject>
- </figure>
+ <para>The next table describes all the extra options in the menu of mapping
items:</para>
+ <table>
+ <title>Extra Options in the Context Menu of Mapping Item</title>
+ <tgroup cols="3">
+ <colspec align="left" colnum="1"
colwidth="1*"></colspec>
+ <colspec align="left" colnum="2"
colwidth="1*"></colspec>
+ <colspec align="left" colnum="3"
colwidth="3*"></colspec>
+ <thead>
+ <row>
+ <entry align="center">
+ <para>Icon</para>
+ </entry>
+ <entry align="center">
+ <para>Command</para>
+ </entry>
+ <entry align="center">
+ <para>Description</para>
+ </entry>
+ </row>
+ </thead>
+ <tbody>
+ <row>
+ <entry>
+ <para>
+ <inlinemediaobject>
+ <imageobject>
+ <imagedata
fileref="images/plugins/openSourceFile_but.png"/>
+ </imageobject>
+ </inlinemediaobject>
+ </para>
+ </entry>
+ <entry>
+ <para><diffmk:wrapper
diffmk:change="changed">Open Source File</diffmk:wrapper></para>
+ </entry>
+ <entry>
+ <para><diffmk:wrapper
diffmk:change="changed">Makes it possible to open a source file for a chosen
object/element. The
+ selected element will be highlighted in the open
file.</diffmk:wrapper></para>
+ </entry>
+ </row>
+ <row>
+ <entry>
+ <para>
+ <inlinemediaobject>
+ <imageobject>
+ <imagedata
fileref="images/plugins/openMappingFile_but.png"/>
+ </imageobject>
+ </inlinemediaobject>
+ </para>
+ </entry>
+ <entry>
+ <para><diffmk:wrapper
diffmk:change="changed">Open Mapping
File</diffmk:wrapper></para>
+ </entry>
+ <entry>
+ <para><diffmk:wrapper
diffmk:change="changed">Makes it possible to open a mapping file for a chosen
object/element. The
+ selected element will be highlighted in the open
file.</diffmk:wrapper></para>
+ </entry>
+ </row>
+ <row>
+ <entry>
+ <para>
+ <inlinemediaobject>
+ <imageobject>
+ <imagedata
fileref="images/plugins/visibleState.png"/>
+ </imageobject>
+ </inlinemediaobject>
+ </para>
+ </entry>
+ <entry>
+ <para><diffmk:wrapper
diffmk:change="changed">Show|Hide
shape(s)</diffmk:wrapper></para>
+ </entry>
+ <entry>
+ <para><diffmk:wrapper
diffmk:change="changed">Used to hide/show an item on the mapping
diagram</diffmk:wrapper></para>
+ </entry>
+ </row>
+ <row>
+ <entry>
+ <para>
+ <inlinemediaobject>
+ <imageobject>
+ <imagedata
fileref="images/plugins/expandState.png"/>
+ </imageobject>
+ </inlinemediaobject>
+ </para>
+ </entry>
+ <entry>
+ <para><diffmk:wrapper
diffmk:change="changed">Expand|Collapse
shape(s)</diffmk:wrapper></para>
+ </entry>
+ <entry>
+ <para><diffmk:wrapper
diffmk:change="changed">Used for expanding/collapsing fields of the
item</diffmk:wrapper></para>
+ </entry>
+ </row>
+ </tbody>
+ </tgroup>
+ </table>
+ <tip>
+ <title>Tip:</title>
+ <para>All the described types of the context menu are also available in
the <property moreinfo="none">Outline</property> view.</para>
+ </tip>
+ <para><diffmk:wrapper diffmk:change="changed">The below
table lists the actions that could be performed using the keyboard keys (or
+ keys combinations).</diffmk:wrapper></para>
+ <table>
+ <title>Hibernate Mapping Diagram Shortcut Keys</title>
+ <tgroup cols="2">
+ <colspec align="left" colnum="1"
colwidth="3*"></colspec>
+ <colspec align="left" colnum="2"
colwidth="1*"></colspec>
+ <thead>
+ <row>
+ <entry align="center">
+ <para>Command</para>
+ </entry>
+ <entry align="center">
+ <para>Binding</para>
+ </entry>
+ </row>
+ </thead>
+ <tbody>
+ <row>
+ <entry>
+ <para>Scroll the diagram content</para>
+ </entry>
+ <entry>
+ <para>Ctrl + Shift + arrows</para>
+ </entry>
+ </row>
+ <row>
+ <entry>
+ <para>Collapse/Expand selected item(s)</para>
+ </entry>
+ <entry>
+ <para> Enter </para>
+ </entry>
+ </row>
+ <row>
+ <entry>
+ <para>Show/Hide selected item(s)</para>
+ </entry>
+ <entry>
+ <para> + </para>
+ </entry>
+ </row>
+ <row>
+ <entry>
+ <para>Sort items in alphabetical order or return the initial
state</para>
+ </entry>
+ <entry>
+ <para>Space</para>
+ </entry>
+ </row>
+ <row>
+ <entry>
+ <para>Navigate between the items</para>
+ </entry>
+ <entry>
+ <para>Arrows</para>
+ </entry>
+ </row>
+ </tbody>
+ </tgroup>
+ </table>
+ <para><diffmk:wrapper diffmk:change="changed">It's
possible to save the diagram in the eclipse workspace. Click the usual
+ </diffmk:wrapper><emphasis>
+ <property moreinfo="none">File > Save
As</property>
+ </emphasis><diffmk:wrapper diffmk:change="changed">
option, the wizard will ask you to set the location within you project where
+ to save the file and give the name for the diagram. The item's names
concatenated
+ with the ampersand symbols are set as the default name for a diagram. The file
is saved
+ with the </diffmk:wrapper><literal
moreinfo="none">.hibernate</literal> extension.</para>
+ <figure float="0">
+ <title>The Diagram saved in the Workspace</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata
fileref="images/plugins/saveDiagram.png"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+ <tip>
+ <title>Note:</title>
+ <para><diffmk:wrapper diffmk:change="changed">If you
restart the Eclipse with the mapping diagram opened, the mapping diagram will
+ be restored with the message like on the figure below. To view the diagram
content, you
+ should perform the refreshing.</diffmk:wrapper></para>
+ </tip>
+ <figure float="0">
+ <title>The Diagram after Restarting the Eclipse</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata
fileref="images/plugins/diagram1.png"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+ <figure float="0">
+ <title>The Diagram after Refreshing</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata
fileref="images/plugins/diagram2.png"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+ <para diffmk:change="added"><diffmk:wrapper
diffmk:change="added">There are some useful commands in the
toolbar.</diffmk:wrapper></para>
+ <figure diffmk:change="added" float="0">
+ <title diffmk:change="added"><diffmk:wrapper
diffmk:change="added">The Diagram View
Toolbar</diffmk:wrapper></title>
+ <mediaobject diffmk:change="added">
+ <imageobject diffmk:change="added">
+ <imagedata diffmk:change="added"
fileref="images/plugins/diagramToolbar.png"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+ <para diffmk:change="added"><diffmk:wrapper
diffmk:change="added">They are described in the table
below.</diffmk:wrapper></para>
+ <table diffmk:change="added">
+ <title diffmk:change="added"><diffmk:wrapper
diffmk:change="added">Command in Diagram View Toolbar
</diffmk:wrapper></title>
+ <tgroup cols="3" diffmk:change="added">
+ <colspec align="left" colnum="1"
colwidth="1*" diffmk:change="added"></colspec>
+ <colspec align="left" colnum="2"
colwidth="1*" diffmk:change="added"></colspec>
+ <colspec align="left" colnum="3"
colwidth="3*" diffmk:change="added"></colspec>
+ <thead diffmk:change="added">
+ <row diffmk:change="added">
+ <entry align="center" diffmk:change="added">
+ <para diffmk:change="added"><diffmk:wrapper
diffmk:change="added">Icon</diffmk:wrapper></para>
+ </entry>
+ <entry align="center" diffmk:change="added">
+ <para diffmk:change="added"><diffmk:wrapper
diffmk:change="added">Command</diffmk:wrapper></para>
+ </entry>
+ <entry align="center" diffmk:change="added">
+ <para diffmk:change="added"><diffmk:wrapper
diffmk:change="added">Description</diffmk:wrapper></para>
+ </entry>
+ </row>
+ </thead>
+ <tbody diffmk:change="added">
+ <row diffmk:change="added">
+ <entry diffmk:change="added">
+ <para diffmk:change="added">
+ <inlinemediaobject diffmk:change="added">
+ <imageobject diffmk:change="added">
+ <imagedata diffmk:change="added"
fileref="images/plugins/toolbarRefresh.png"></imagedata>
+ </imageobject>
+ </inlinemediaobject>
+ </para>
+ </entry>
+ <entry diffmk:change="added">
+ <para diffmk:change="added"><diffmk:wrapper
diffmk:change="added">Refresh Visual
Mapping</diffmk:wrapper></para>
+ </entry>
+ <entry diffmk:change="added">
+ <para diffmk:change="added"><diffmk:wrapper
diffmk:change="added">It update </diffmk:wrapper><property
diffmk:change="added" moreinfo="none"><diffmk:wrapper
diffmk:change="added">Mapping
Diagram</diffmk:wrapper></property><diffmk:wrapper
diffmk:change="added"> if </diffmk:wrapper><property
diffmk:change="added" moreinfo="none"><diffmk:wrapper
diffmk:change="added">Console
+
Configuration</diffmk:wrapper></property><diffmk:wrapper
diffmk:change="added"> was changed. </diffmk:wrapper></para>
+ </entry>
+ </row>
+ <row diffmk:change="added">
+ <entry diffmk:change="added">
+ <para diffmk:change="added">
+ <inlinemediaobject diffmk:change="added">
+ <imageobject diffmk:change="added">
+ <imagedata diffmk:change="added"
fileref="images/plugins/toolbarZoom.png"></imagedata>
+ </imageobject>
+ </inlinemediaobject>
+ </para>
+ </entry>
+ <entry diffmk:change="added">
+ <para diffmk:change="added"><diffmk:wrapper
diffmk:change="added">Zoom Box</diffmk:wrapper></para>
+ </entry>
+ <entry diffmk:change="added">
+ <para diffmk:change="added"><diffmk:wrapper
diffmk:change="added">Used to define scale of the diagram. Also it's used
for </diffmk:wrapper><property diffmk:change="added"
moreinfo="none"><diffmk:wrapper
diffmk:change="added">Mapping
+ Diagram</diffmk:wrapper></property><diffmk:wrapper
diffmk:change="added"> printing. If you want to put the whole
</diffmk:wrapper><property diffmk:change="added"
moreinfo="none"><diffmk:wrapper
diffmk:change="added">diagram</diffmk:wrapper></property><diffmk:wrapper
diffmk:change="added"> to one print page, you need select
</diffmk:wrapper><property diffmk:change="added"
moreinfo="none"><diffmk:wrapper
diffmk:change="added">Page</diffmk:wrapper></property><diffmk:wrapper
diffmk:change="added"> option in the </diffmk:wrapper><property
diffmk:change="added" moreinfo="none"><diffmk:wrapper
diffmk:change="added">Zoom
Box</diffmk:wrapper></property><diffmk:wrapper
diffmk:change="added">.</diffmk:wrapper></para>
+ </entry>
+ </row>
+ <row diffmk:change="added">
+ <entry diffmk:change="added">
+ <para diffmk:change="added">
+ <inlinemediaobject diffmk:change="added">
+ <imageobject diffmk:change="added">
+ <imagedata diffmk:change="added"
fileref="images/plugins/toolbarAutolayout.png"></imagedata>
+ </imageobject>
+ </inlinemediaobject>
+ </para>
+ </entry>
+ <entry diffmk:change="added">
+ <para diffmk:change="added"><diffmk:wrapper
diffmk:change="added">Auto layout</diffmk:wrapper></para>
+ </entry>
+ <entry diffmk:change="added">
+ <para diffmk:change="added"><diffmk:wrapper
diffmk:change="added">Used to arrange all diagram items in a standard
manner.</diffmk:wrapper></para>
+ </entry>
+ </row>
+ <row diffmk:change="added">
+ <entry diffmk:change="added">
+ <para diffmk:change="added">
+ <inlinemediaobject diffmk:change="added">
+ <imageobject diffmk:change="added">
+ <imagedata diffmk:change="added"
fileref="images/plugins/toolbarShowHideConnections.png"></imagedata>
+ </imageobject>
+ </inlinemediaobject>
+ </para>
+ </entry>
+ <entry diffmk:change="added">
+ <para diffmk:change="added"><diffmk:wrapper
diffmk:change="added">Show|Hide
connections</diffmk:wrapper></para>
+ </entry>
+ <entry diffmk:change="added">
+ <para diffmk:change="added"><diffmk:wrapper
diffmk:change="added">Used to show or hide connection on the diagram.
Moreover you can choose what
+ type of connections must be present on the diagram
(</diffmk:wrapper><property diffmk:change="added"
moreinfo="none"><diffmk:wrapper
diffmk:change="added">Property
+ Mappings</diffmk:wrapper></property><diffmk:wrapper
diffmk:change="added">, </diffmk:wrapper><property
diffmk:change="added" moreinfo="none"><diffmk:wrapper
diffmk:change="added">Class
Mappings</diffmk:wrapper></property><diffmk:wrapper
diffmk:change="added">, </diffmk:wrapper><property
diffmk:change="added" moreinfo="none"><diffmk:wrapper
diffmk:change="added">Associations</diffmk:wrapper></property><diffmk:wrapper
diffmk:change="added"> or </diffmk:wrapper><property
diffmk:change="added" moreinfo="none"><diffmk:wrapper
diffmk:change="added">Foreign key
constraints</diffmk:wrapper></property><diffmk:wrapper
diffmk:change="added">)
+ .</diffmk:wrapper></para>
+ </entry>
+ </row>
+ <row diffmk:change="added">
+ <entry diffmk:change="added">
+ <para diffmk:change="added">
+ <inlinemediaobject diffmk:change="added">
+ <imageobject diffmk:change="added">
+ <imagedata diffmk:change="added"
fileref="images/plugins/toolbarExpandCollapse.png"></imagedata>
+ </imageobject>
+ </inlinemediaobject>
+ </para>
+ </entry>
+ <entry diffmk:change="added">
+ <para diffmk:change="added"><diffmk:wrapper
diffmk:change="added">Expand|Collapse</diffmk:wrapper></para>
+ </entry>
+ <entry diffmk:change="added">
+ <para diffmk:change="added"><diffmk:wrapper
diffmk:change="added">Used for expanding/collapsing fields of the
item.</diffmk:wrapper></para>
+ </entry>
+ </row>
+ <row diffmk:change="added">
+ <entry diffmk:change="added">
+ <para diffmk:change="added">
+ <inlinemediaobject diffmk:change="added">
+ <imageobject diffmk:change="added">
+ <imagedata diffmk:change="added"
fileref="images/plugins/toolbarShowHideShapes.png"></imagedata>
+ </imageobject>
+ </inlinemediaobject>
+ </para>
+ </entry>
+ <entry diffmk:change="added">
+ <para diffmk:change="added"><diffmk:wrapper
diffmk:change="added"> Show|Hide
shape(s)</diffmk:wrapper></para>
+ </entry>
+ <entry diffmk:change="added">
+ <para diffmk:change="added"><diffmk:wrapper
diffmk:change="added">Used to hide/show an item on the mapping
diagram.</diffmk:wrapper></para>
+ </entry>
+ </row>
+ </tbody>
+ </tgroup>
+ </table>
</section>
</section>
-
<section>
<title>Prototyping Queries</title>
-
<para>Queries can be prototyped by entering them into the <property
moreinfo="none">HQL</property> or
- <property moreinfo="none">Criteria Editor</property>. To
execute a query you should click the green run button in the editor toolbar or press
<emphasis>
+ <property moreinfo="none">Criteria
Editor</property><diffmk:wrapper diffmk:change="changed">. To
execute a query you should click the green run
+ button in the editor toolbar or press </diffmk:wrapper><emphasis>
<property moreinfo="none">Ctrl+Enter</property>
</emphasis>.</para>
-
- <section id="hql_and_criteria_editors">
- <title>HQL Editor and Hibernate Criteria Editor</title>
- <para>To open the query editors right-click your project
- <property moreinfo="none">Console
Configuration</property> and select <property moreinfo="none">HQL
- Editor</property> (or <property moreinfo="none">Hibernate
Criteria Editor</property>).</para>
-
- <figure float="0">
- <title>Opening HQL Editor</title>
- <mediaobject>
- <imageobject>
- <imagedata
fileref="images/plugins/prototypingQueries.png"></imagedata>
- </imageobject>
- </mediaobject>
- </figure>
-
- <tip><title>Tip:</title>
- <para>If the context menu items are disabled then you need at first to create a
<property moreinfo="none">Session
- Factory</property>. That is done by simply expanding the <property
moreinfo="none">Session
- Factory</property> node.</para>
- </tip>
- <para>When open the editors they should automatically detect the chosen Console
Configuration.</para>
-
- <para>To get a prefill query for any entity (or any entity child node) listed in
the
- <emphasis>
- <property moreinfo="none">Session
Factory</property></emphasis> you should double-click it. This will open the
- <property moreinfo="none">HQL Editor</property> with the
associated query.</para>
-
- <para>Choosing <emphasis>
- <property moreinfo="none">HQL Editor</property>
- </emphasis> in the context menu for any entity (or any entity child node)
will also open the HQL editor
- with the associated query. If you choose <emphasis>
- <property moreinfo="none">Hibernate Criteria
Editor</property>
- </emphasis> in the context menu, it will open <property
moreinfo="none">Hibernate Criteria Editor</property> with the
associated criteria.</para>
-
- <figure float="0">
- <title>Generating Simple Queries</title>
- <mediaobject>
- <imageobject role="fo">
- <imagedata align="center"
fileref="images/plugins/plugins_19.png" format="PNG"
scale="80"></imagedata>
- </imageobject>
-
- <imageobject role="html">
- <imagedata align="center"
fileref="images/plugins/plugins_19.png"
format="PNG"></imagedata>
- </imageobject>
- </mediaobject>
- </figure>
-
- <para>It's also possible to copy a portion of code from <emphasis>
- <property
moreinfo="none">.java</property></emphasis> file into the
<property moreinfo="none">HQL</property> or
- <property moreinfo="none">Criteria editor</property>. To do this
make use of the
- Quick Fix option (<emphasis>
- <property moreinfo="none">Ctrl +
1</property>)</emphasis>.</para>
-
- <figure float="0">
- <title>Quick Fix Option Demonstration</title>
- <mediaobject>
- <imageobject>
- <imagedata
fileref="images/plugins/plugins_19_b.png"></imagedata>
- </imageobject>
- </mediaobject>
- </figure>
-
- <para>You can also update the original java code according to changes in the
HQL or Criteria
- editor. For that you should save your HQL/Criteria query and submit the replacing
in
- appeared confirmation dialog.</para>
-
- <figure float="0">
- <title>Updating Java Code</title>
- <mediaobject>
- <imageobject>
- <imagedata
fileref="images/plugins/plugins_19_c.png"></imagedata>
- </imageobject>
- </mediaobject>
- </figure>
- </section>
-
- <section>
- <title>Error Handling</title>
- <para>Errors during creation of the <property
moreinfo="none">Session Factory</property> or running the
- queries (e.g. if your configuration or query is incorrect) will be shown in a
message dialog
- or inclined in the view that detected the error, you may get more information
about the
- error in the <property moreinfo="none">Error Log
View</property> on the right pane.</para>
-
- <para>Results of a query will be shown in the <property
moreinfo="none">Hibernate Query Result View</property>
- and details of possible errors (syntax errors, database errors, etc.) can be seen
in the
- <property moreinfo="none">Error Log
View</property>.</para>
-
-
- <note>
- <title>Note:</title>
- <para>HQL queries are executed by default using <literal
moreinfo="none">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>
- </note>
- </section>
+ <section id="hql_and_criteria_editors">
+ <title>HQL Editor and Hibernate Criteria Editor</title>
+ <para><diffmk:wrapper diffmk:change="changed">To open the
query editors right-click your project </diffmk:wrapper><property
moreinfo="none"><diffmk:wrapper
diffmk:change="changed">Console
+ Configuration</diffmk:wrapper></property> and select <property
moreinfo="none"><diffmk:wrapper diffmk:change="changed">HQL
Editor</diffmk:wrapper></property> (or <property
moreinfo="none">Hibernate Criteria Editor</property>).</para>
+ <figure float="0">
+ <title>Opening HQL Editor</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata
fileref="images/plugins/prototypingQueries.png"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+ <tip>
+ <title>Tip:</title>
+ <para>If the context menu items are disabled then you need at first to
create a <property moreinfo="none"><diffmk:wrapper
diffmk:change="changed">Session
Factory</diffmk:wrapper></property>. That is done by simply expanding the
<property moreinfo="none"><diffmk:wrapper
diffmk:change="changed">Session
+ Factory</diffmk:wrapper></property> node.</para>
+ </tip>
+ <para><diffmk:wrapper diffmk:change="changed">When open the
editors they should automatically detect the chosen Console
+ Configuration.</diffmk:wrapper></para>
+ <para><diffmk:wrapper diffmk:change="changed">To get a
prefill query for any entity (or any entity child node) listed in the
+ </diffmk:wrapper><emphasis>
+ <property moreinfo="none">Session Factory</property>
+ </emphasis><diffmk:wrapper diffmk:change="changed"> you
should double-click it. This will open the </diffmk:wrapper><property
moreinfo="none">HQL Editor</property><diffmk:wrapper
diffmk:change="changed">
+ with the associated query.</diffmk:wrapper></para>
+ <para>Choosing <emphasis>
+ <property moreinfo="none">HQL Editor</property>
+ </emphasis><diffmk:wrapper diffmk:change="changed"> in
the context menu for any entity (or any entity child node) will also open
+ the HQL editor with the associated query. If you choose
</diffmk:wrapper><emphasis>
+ <property moreinfo="none">Hibernate Criteria
Editor</property>
+ </emphasis> in the context menu, it will open <property
moreinfo="none"><diffmk:wrapper
diffmk:change="changed">Hibernate Criteria
+ Editor</diffmk:wrapper></property><diffmk:wrapper
diffmk:change="changed"> with the associated
criteria.</diffmk:wrapper></para>
+ <figure diffmk:change="added" float="0">
+ <title>Generating Simple Queries</title>
+ <mediaobject diffmk:change="added">
+ <imageobject diffmk:change="added" role="fo">
+ <imagedata align="center"
fileref="images/plugins/plugins_19.png" format="PNG"
scale="80"></imagedata>
+ </imageobject>
+ <imageobject diffmk:change="added" role="html">
+ <imagedata align="center"
fileref="images/plugins/plugins_19.png"
format="PNG"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+ <para>It's also possible to copy a portion of code from
<emphasis>
+ <property moreinfo="none">.java</property>
+ </emphasis> file into the <property
moreinfo="none">HQL</property><diffmk:wrapper
diffmk:change="changed"> or </diffmk:wrapper><property
moreinfo="none"><diffmk:wrapper
diffmk:change="changed">Criteria
+ editor</diffmk:wrapper></property><diffmk:wrapper
diffmk:change="changed">. To do this make use of the Quick Fix option
(</diffmk:wrapper><emphasis>
+ <property moreinfo="none">Ctrl +
1</property>)</emphasis>.</para>
+ <figure diffmk:change="added" float="0">
+ <title>Quick Fix Option Demonstration</title>
+ <mediaobject diffmk:change="added">
+ <imageobject diffmk:change="added">
+ <imagedata
fileref="images/plugins/plugins_19_b.png"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+ <para><diffmk:wrapper diffmk:change="changed">You can also
update the original java code according to changes in the HQL or Criteria
+ editor. For that you should save your HQL/Criteria query and submit the
replacing in
+ appeared confirmation dialog.</diffmk:wrapper></para>
+ <figure diffmk:change="added" float="0">
+ <title>Updating Java Code</title>
+ <mediaobject diffmk:change="added">
+ <imageobject diffmk:change="added">
+ <imagedata
fileref="images/plugins/plugins_19_c.png"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+ <para diffmk:change="added"><diffmk:wrapper
diffmk:change="added">Also you can pin </diffmk:wrapper><property
diffmk:change="added" moreinfo="none"><diffmk:wrapper
diffmk:change="added">HQL
editor</diffmk:wrapper></property><diffmk:wrapper
diffmk:change="added"> and </diffmk:wrapper><property
diffmk:change="added" moreinfo="none"><diffmk:wrapper
diffmk:change="added">Criteria
+ editor</diffmk:wrapper></property><diffmk:wrapper
diffmk:change="added"> for one tab in </diffmk:wrapper><property
diffmk:change="added" moreinfo="none"><diffmk:wrapper
diffmk:change="added">Hibernate Query
Result</diffmk:wrapper></property><diffmk:wrapper
diffmk:change="added"> view. For
+ that you need click on </diffmk:wrapper><property
diffmk:change="added" moreinfo="none"><diffmk:wrapper
diffmk:change="added">Stick result to one
tab</diffmk:wrapper></property><diffmk:wrapper
diffmk:change="added">
+ button(</diffmk:wrapper><inlinemediaobject
diffmk:change="added">
+ <imageobject diffmk:change="added">
+ <imagedata diffmk:change="added"
fileref="images/plugins/sticky_but.png"></imagedata>
+ </imageobject>
+ </inlinemediaobject><diffmk:wrapper
diffmk:change="added"> ). In the issue query executions results will be shown
in one tab (no
+ more will be opened). </diffmk:wrapper></para>
+ <para diffmk:change="added"><diffmk:wrapper
diffmk:change="added"> Moreover you are able to rename tab in
</diffmk:wrapper><property diffmk:change="added"
moreinfo="none"><diffmk:wrapper
diffmk:change="added">Hibernate Query
Result</diffmk:wrapper></property><diffmk:wrapper
diffmk:change="added">.
+ Click the tab, and type a new name in </diffmk:wrapper><property
diffmk:change="added" moreinfo="none"><diffmk:wrapper
diffmk:change="added">Property View->Tab name
field</diffmk:wrapper></property><diffmk:wrapper
diffmk:change="added">. </diffmk:wrapper></para>
+ <figure diffmk:change="added" float="0">
+ <title diffmk:change="added"><diffmk:wrapper
diffmk:change="added">Tab Renaming</diffmk:wrapper></title>
+ <mediaobject diffmk:change="added">
+ <imageobject diffmk:change="added">
+ <imagedata diffmk:change="added"
fileref="images/plugins/plugins_19_d.png"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+ </section>
<section>
+ <title>Error Handling</title>
+ <para>Errors during creation of the <property
moreinfo="none">Session Factory</property><diffmk:wrapper
diffmk:change="changed"> or running the
+ queries (e.g. if your configuration or query is incorrect) will be shown in a
message
+ dialog or inclined in the view that detected the error, you may get more
information about
+ the error in the </diffmk:wrapper><property
moreinfo="none">Error Log View</property> on the right
pane.</para>
+ <para>Results of a query will be shown in the <property
moreinfo="none"><diffmk:wrapper
diffmk:change="changed">Hibernate Query Result
+ View</diffmk:wrapper></property><diffmk:wrapper
diffmk:change="changed"> and details of possible errors (syntax errors,
database errors, etc.)
+ can be seen in the </diffmk:wrapper><property
moreinfo="none">Error Log View</property>.</para>
+ <note diffmk:change="added">
+ <title>Note:</title>
+ <para>HQL queries are executed by default using <literal
moreinfo="none">list()</literal><diffmk:wrapper
diffmk:change="changed"> 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.</diffmk:wrapper></para>
+ </note>
+ </section>
+ <section>
<title>Dynamic Query Translator</title>
-
<para>If the <property moreinfo="none">Hibernate Dynamic
Query Translator View</property> is visible while
writing in the <property moreinfo="none">HQL
Editor</property> it will show the generated SQL for a HQL
query.</para>
-
<figure float="0">
<title>Hibernate Dynamic Query Translator View</title>
<mediaobject>
<imageobject role="fo">
<imagedata align="center"
fileref="images/plugins/plugins_20.png" format="PNG"
scale="80"></imagedata>
</imageobject>
-
<imageobject role="html">
<imagedata align="center"
fileref="images/plugins/plugins_20.png"
format="PNG"></imagedata>
</imageobject>
</mediaobject>
</figure>
-
<para>The translation is done each time you stop typing into the editor, if
there are errors
in the HQL the parse exception will be shown embedded in the
view.</para>
</section>
</section>
-
<section>
<title>Properties View</title>
-
- <para>As you can see on the figure,when clicking on class/entity <property
moreinfo="none">Properties view</property> shows the number of
- query results as well as the time of executing.</para>
-
+ <para>As you can see on the figure,when clicking on class/entity <property
moreinfo="none"><diffmk:wrapper
diffmk:change="changed">Properties
+ view</diffmk:wrapper></property><diffmk:wrapper
diffmk:change="changed"> shows the number of query results as well as the
time of executing.</diffmk:wrapper></para>
<figure float="0">
<title>Properties View</title>
<mediaobject>
<imageobject role="fo">
<imagedata align="center"
fileref="images/plugins/plugins_21_a.png" format="PNG"
scale="80"></imagedata>
</imageobject>
-
<imageobject role="html">
<imagedata align="center"
fileref="images/plugins/plugins_21_a.png"
format="PNG"></imagedata>
</imageobject>
</mediaobject>
</figure>
-
- <para>It also displays the structure of any persistent object selected in
the
- <property moreinfo="none">Hibernate Query Results
View</property>. Editing is not yet supported.</para>
-
+ <para><diffmk:wrapper diffmk:change="changed">It also
displays the structure of any persistent object selected in the
</diffmk:wrapper><property moreinfo="none">Hibernate Query Results
View</property>. Editing is not yet supported.</para>
<figure float="0">
<title>Properties View for Selected Object</title>
<mediaobject>
<imageobject role="fo">
<imagedata align="center"
fileref="images/plugins/plugins_21_b.png" format="PNG"
scale="80"></imagedata>
</imageobject>
-
<imageobject role="html">
<imagedata align="center"
fileref="images/plugins/plugins_21_b.png"
format="PNG"></imagedata>
</imageobject>
</mediaobject>
</figure>
- <para>You can also use <property moreinfo="none">Properties
view</property> when clicking on the configuration
- itself in Hibernate Configuration View( <link
linkend="modif_console_conf">Modifying a Hibernate Console Configuration
section</link>). </para>
+ <para>You can also use <property moreinfo="none">Properties
view</property><diffmk:wrapper diffmk:change="changed"> when
clicking on the configuration
+ itself in Hibernate Configuration View( </diffmk:wrapper><link
linkend="modif_console_conf"><diffmk:wrapper
diffmk:change="changed">Modifying a
+ Hibernate Console Configuration section</diffmk:wrapper></link>).
</para>
</section>
</section>
<section id="jpa_annotations">
- <title>Hibernate:add JPA annotations view
- </title>
- <para>Using this wizard you can add the next Hibernate annotations to the
class:
- <emphasis>
- <property
moreinfo="none">@Column</property></emphasis>,<emphasis>
- <property
moreinfo="none">@Entity</property></emphasis>,<emphasis>
- <property
moreinfo="none">@ManyToOne</property></emphasis>,<emphasis>
- <property
moreinfo="none">@OneToMany</property></emphasis>,<emphasis>
- <property
moreinfo="none">@OneToOne</property></emphasis>,<emphasis>
- <property
moreinfo="none">@ManyToMany</property></emphasis>,<emphasis>
- <property
moreinfo="none">@MappedSuperclass</property></emphasis>,<emphasis>
- <property
moreinfo="none">@Id</property></emphasis>,<emphasis>
- <property
moreinfo="none">@GeneratedValue</property></emphasis>
,<emphasis>
- <property moreinfo="none">@Version
</property></emphasis>
+ <title><diffmk:wrapper diffmk:change="changed">Hibernate:add
JPA annotations refactoring </diffmk:wrapper></title>
+ <para><diffmk:wrapper diffmk:change="changed">Using this wizard
you can add the next Hibernate annotations to the class:
</diffmk:wrapper><emphasis>
+ <property moreinfo="none">@Column</property>
+ </emphasis>,<emphasis>
+ <property moreinfo="none">@Entity</property>
+ </emphasis>,<emphasis>
+ <property moreinfo="none">@ManyToOne</property>
+ </emphasis>,<emphasis>
+ <property moreinfo="none">@OneToMany</property>
+ </emphasis>,<emphasis>
+ <property moreinfo="none">@OneToOne</property>
+ </emphasis>,<emphasis>
+ <property moreinfo="none">@ManyToMany</property>
+ </emphasis>,<emphasis>
+ <property moreinfo="none">@MappedSuperclass</property>
+ </emphasis>,<emphasis>
+ <property moreinfo="none">@Id</property>
+ </emphasis>,<emphasis>
+ <property moreinfo="none">@GeneratedValue</property>
+ </emphasis> ,<emphasis>
+ <property moreinfo="none">@Version </property>
+ </emphasis>
</para>
- <itemizedlist>
+ <itemizedlist>
<listitem>
<para><emphasis>
- <property
moreinfo="none">@Column</property></emphasis> is added to all
String properties.</para>
+ <property moreinfo="none">@Column</property>
+ </emphasis> is added to all String properties.</para>
</listitem>
- <listitem>
- <para><emphasis>
- <property
moreinfo="none">@Entity</property></emphasis> is always declared
before any class where it doesn't present.</para>
- </listitem>
- <listitem>
- <para><emphasis>
- <property
moreinfo="none">@ManyToOne</property></emphasis>,<emphasis>
- <property
moreinfo="none">@OneToMany</property></emphasis>,<emphasis>
- <property
moreinfo="none">@OneToOne</property></emphasis>,<emphasis>
- <property
moreinfo="none">@ManyToMany</property></emphasis> - this
annotations are declared according to the classes hierarchy.</para>
- </listitem>
- <listitem>
- <para><emphasis>
- <property
moreinfo="none">@MappedSuperclass</property></emphasis> is added
to abstract superclasses.</para>
- </listitem>
- <listitem>
- <para><emphasis>
- <property
moreinfo="none">@Id</property></emphasis>,<emphasis>
- <property
moreinfo="none">@GeneratedValue</property></emphasis> are added
automatically only to the properties under the name "Id",where they don't
present.</para>
- </listitem>
-
- <listitem>
- <para><emphasis>
- <property
moreinfo="none">@Version</property></emphasis> is declared in
case you select <link linkend="optim_lock">Enable optimistic
locking</link>.</para>
- </listitem>
- </itemizedlist>
+ <listitem>
+ <para><emphasis>
+ <property moreinfo="none">@Entity</property>
+ </emphasis> is always declared before any class where it doesn't
present.</para>
+ </listitem>
+ <listitem>
+ <para><emphasis>
+ <property moreinfo="none">@ManyToOne</property>
+ </emphasis>,<emphasis>
+ <property moreinfo="none">@OneToMany</property>
+ </emphasis>,<emphasis>
+ <property moreinfo="none">@OneToOne</property>
+ </emphasis>,<emphasis>
+ <property moreinfo="none">@ManyToMany</property>
+ </emphasis><diffmk:wrapper diffmk:change="changed"> -
this annotations are declared according to the classes
hierarchy.</diffmk:wrapper></para>
+ </listitem>
+ <listitem>
+ <para><emphasis>
+ <property moreinfo="none">@MappedSuperclass</property>
+ </emphasis> is added to abstract superclasses.</para>
+ </listitem>
+ <listitem>
+ <para><emphasis>
+ <property moreinfo="none">@Id</property>
+ </emphasis>,<emphasis>
+ <property moreinfo="none">@GeneratedValue</property>
+ </emphasis><diffmk:wrapper diffmk:change="changed"> are
added automatically only to the properties under the name "Id",where they
+ don't present.</diffmk:wrapper></para>
+ </listitem>
+ <listitem>
+ <para><emphasis>
+ <property moreinfo="none">@Version</property>
+ </emphasis> is declared in case you select <link
linkend="optim_lock"><diffmk:wrapper
diffmk:change="changed">Enable optimistic
+ locking</diffmk:wrapper></link>.</para>
+ </listitem>
+ </itemizedlist>
<note>
<title>Note:</title>
- <para>This section doesn't cover the meaning of the <property
moreinfo="none">Hibernate annotations</property>
- , for more information read <ulink
url="http://docs.jboss.org/hibernate/stable/annotations/reference/en...
Annotations Documentation</ulink> .</para>
+ <para><diffmk:wrapper diffmk:change="changed">This section
doesn't cover the meaning of the </diffmk:wrapper><property
moreinfo="none">Hibernate annotations</property>
+ , for more information read <ulink
url="http://docs.jboss.org/hibernate/stable/annotations/reference/en...
diffmk:change="changed">Hibernate
+ Annotations Documentation</diffmk:wrapper></ulink> .</para>
</note>
-
- <para>To open this wizard you should right click the class you want to enrich
with annotations <emphasis>
- <property moreinfo="none">>Source>Generate
Hibernate/JPA annotations</property></emphasis>. You will see the
Hibernate:add JPA annotations dialog.
- </para>
+ <para><diffmk:wrapper diffmk:change="changed">To open this
wizard you should right click the class you want to enrich with annotations
+ </diffmk:wrapper><emphasis>
+ <property moreinfo="none">>Source>Generate
Hibernate/JPA annotations</property>
+ </emphasis><diffmk:wrapper diffmk:change="changed">. You will
see the Hibernate:add JPA annotations dialog. </diffmk:wrapper></para>
<figure float="0">
- <title>Starting Hibernate:add JPA annotations view</title>
+ <title><diffmk:wrapper diffmk:change="changed">Starting
Hibernate:add JPA annotations dialog</diffmk:wrapper></title>
<mediaobject>
<imageobject>
<imagedata
fileref="images/plugins/annotations1.png"></imagedata>
</imageobject>
</mediaobject>
</figure>
- <para> In the top of it you can see the list of all classes that will be passed
through refactoring.
- Besides the class you have selected in this list you can also find its
superclasses and the classes that objects present in the current class as properties.
- </para>
- <para>By default the tags are added to the fields of selected classes. But you
can change this option to <emphasis><property
moreinfo="none">Getters</property></emphasis>in
<emphasis><property moreinfo="none"> Preferred location of
Annotations</property></emphasis> dropdownlist
- and then all the annotations will be added to the getter methods. If you choose
<emphasis><property moreinfo="none">Auto select from class
preference</property></emphasis> then the annotations are added according to
the majority of the already existed ones positions.
- </para>
- <para> If it's nessecary to map your String properties to the columns that
length differ from the default value(255) ,change <emphasis><property
moreinfo="none">Default string length field</property></emphasis>
and <code>@Column(length = your length)</code> will be created before every
String property.
- </para>
- <para id="optim_lock">You can add optimistic locking capability to an
entity bean by selecting <emphasis><property moreinfo="none">Enable
optimistic locking</property></emphasis> checkbox.
- This operation will add version property to all the selected classes. The property
will be also annotated with @Version ,getter and setter will be created. If the property
is already exists,it won't be created ,but the getters,setters will be generated.
- If there is already @MappedSuperclass with version in the base class of the
current class - <emphasis><property
moreinfo="none">"version"</property></emphasis> is not
inserted into the current class.
- </para>
- <para>After defining all necessary settings in the current step press
<emphasis><property
moreinfo="none">Next</property></emphasis> and follow the next
wizard steps.
- </para>
+ <para><diffmk:wrapper diffmk:change="added"> In the top of it
you can see the list of all classes that will be passed through
+ refactoring. Besides the class you have selected in this list you can also find
its
+ superclasses and the classes that objects present in the current class as
properties. If you
+ want to add new classes or package to the list of classes, you should click the
</diffmk:wrapper><property diffmk:change="added"
moreinfo="none"><diffmk:wrapper
diffmk:change="added">Back</diffmk:wrapper></property><diffmk:wrapper
diffmk:change="added"> button. In result you will see
</diffmk:wrapper><property diffmk:change="added"
moreinfo="none"><diffmk:wrapper diffmk:change="added">Add
classes and
+ packages</diffmk:wrapper></property><diffmk:wrapper
diffmk:change="added"> page.</diffmk:wrapper></para>
+ <figure diffmk:change="added" float="0">
+ <title diffmk:change="added"><diffmk:wrapper
diffmk:change="added">Add classes and packages page
</diffmk:wrapper></title>
+ <mediaobject diffmk:change="added">
+ <imageobject diffmk:change="added">
+ <imagedata diffmk:change="added"
fileref="images/plugins/annotations1_a.png"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+ <para diffmk:change="added"><diffmk:wrapper
diffmk:change="added">Here you can add one more classes or whole package,
moreover you can limit dependencies
+ depth by selecting </diffmk:wrapper><property
diffmk:change="added" moreinfo="none"><diffmk:wrapper
diffmk:change="added">depth
control</diffmk:wrapper></property><diffmk:wrapper
diffmk:change="added"> option (more about this option you will
+ find in </diffmk:wrapper><link diffmk:change="added"
linkend="depth_control"><diffmk:wrapper
diffmk:change="added">Creating a Hibernate Mapping
File</diffmk:wrapper></link><diffmk:wrapper
diffmk:change="added">). When finished
+ just press the </diffmk:wrapper><property diffmk:change="added"
moreinfo="none"><diffmk:wrapper
diffmk:change="added">Next</diffmk:wrapper></property><diffmk:wrapper
diffmk:change="added"> button and you will be returned to
</diffmk:wrapper><property diffmk:change="added"
moreinfo="none"><diffmk:wrapper diffmk:change="added">The
+ following classes will be
changed</diffmk:wrapper></property><diffmk:wrapper
diffmk:change="added"> page and will be able to continue work with
+ it.</diffmk:wrapper></para>
+ <para><diffmk:wrapper diffmk:change="changed">By default the
tags are added to the fields of selected classes. But you can change this
+ option to </diffmk:wrapper><emphasis>
+ <property moreinfo="none">Getters</property>
+ </emphasis>in <emphasis>
+ <property moreinfo="none"> Preferred location of
Annotations</property>
+ </emphasis><diffmk:wrapper diffmk:change="changed">
dropdownlist and then all the annotations will be added to the getter methods. If
+ you choose </diffmk:wrapper><emphasis>
+ <property moreinfo="none">Auto select from class
preference</property>
+ </emphasis><diffmk:wrapper diffmk:change="changed"> then the
annotations are added according to the majority of the already existed
+ ones positions. </diffmk:wrapper></para>
+ <para><diffmk:wrapper diffmk:change="changed"> If it's
nessecary to map your String properties to the columns that length differ from
+ the default value(255) ,change </diffmk:wrapper><emphasis>
+ <property moreinfo="none">Default string length
field</property>
+ </emphasis> and <code>@Column(length = your
length)</code><diffmk:wrapper diffmk:change="changed"> will be
created before every String
+ property. </diffmk:wrapper></para>
+ <para id="optim_lock"><diffmk:wrapper
diffmk:change="changed">You can add optimistic locking capability to an
entity bean by selecting
+ </diffmk:wrapper><emphasis>
+ <property moreinfo="none">Enable optimistic
locking</property>
+ </emphasis><diffmk:wrapper diffmk:change="changed"> checkbox.
This operation will add version property to all the selected classes.
+ The property will be also annotated with @Version ,getter and setter will be
created. If the
+ property is already exists,it won't be created ,but the getters,setters will be
generated. If
+ there is already @MappedSuperclass with version in the base class of the current
class -
+ </diffmk:wrapper><emphasis>
+ <property moreinfo="none">"version"</property>
+ </emphasis><diffmk:wrapper diffmk:change="changed"> is not
inserted into the current class. </diffmk:wrapper></para>
+ <para><diffmk:wrapper diffmk:change="changed">After defining
all necessary settings in the current step press </diffmk:wrapper><emphasis>
+ <property moreinfo="none">Next</property>
+ </emphasis><diffmk:wrapper diffmk:change="changed"> and
follow the next wizard steps. </diffmk:wrapper></para>
<figure float="0">
<title>Hibernate:add JPA annotations view</title>
- <mediaobject>
- <imageobject>
- <imagedata
fileref="images/plugins/annotations2.png"></imagedata>
- </imageobject>
- </mediaobject>
+ <mediaobject diffmk:change="added">
+ <imageobject diffmk:change="added">
+ <imagedata
fileref="images/plugins/annotations2.png"></imagedata>
+ </imageobject>
+ </mediaobject>
</figure>
- <para>The view represents two windows: one with the source code and and the
second with refactored one.
- With the help of <inlinemediaobject><imageobject>
- <imagedata fileref="images/plugins/butt1.png"></imagedata>
- </imageobject></inlinemediaobject>
,<inlinemediaobject><imageobject>
- <imagedata fileref="images/plugins/butt2.png"></imagedata>
- </imageobject></inlinemediaobject>
,<inlinemediaobject><imageobject>
- <imagedata fileref="images/plugins/butt3.png"></imagedata>
- </imageobject></inlinemediaobject>
,<inlinemediaobject><imageobject>
- <imagedata fileref="images/plugins/butt4.png"></imagedata>
- </imageobject></inlinemediaobject> buttons you can quickly navigate
between the differences in the code. If you don't agree with some changes you
can't undo them but you can remove the class from the list of classes that need
refactoring.
- </para>
+ <para><diffmk:wrapper diffmk:change="changed">The view
represents two windows: one with the source code and and the second with
+ refactored one. With the help of </diffmk:wrapper><inlinemediaobject>
+ <imageobject diffmk:change="added">
+ <imagedata
fileref="images/plugins/butt1.png"></imagedata>
+ </imageobject>
+ </inlinemediaobject> ,<inlinemediaobject>
+ <imageobject diffmk:change="added">
+ <imagedata
fileref="images/plugins/butt2.png"></imagedata>
+ </imageobject>
+ </inlinemediaobject> ,<inlinemediaobject>
+ <imageobject diffmk:change="added">
+ <imagedata
fileref="images/plugins/butt3.png"></imagedata>
+ </imageobject>
+ </inlinemediaobject> ,<inlinemediaobject>
+ <imageobject diffmk:change="added">
+ <imagedata
fileref="images/plugins/butt4.png"></imagedata>
+ </imageobject>
+ </inlinemediaobject><diffmk:wrapper diffmk:change="changed">
buttons you can quickly navigate between the differences in the code. If
+ you don't agree with some changes you can't undo them but you can remove
the class from the
+ list of classes that need refactoring. </diffmk:wrapper></para>
<figure float="0">
<title>List of classes that need refactoring</title>
- <mediaobject>
- <imageobject>
- <imagedata
fileref="images/plugins/annotations3.png"></imagedata>
- </imageobject>
- </mediaobject>
+ <mediaobject diffmk:change="added">
+ <imageobject diffmk:change="added">
+ <imagedata
fileref="images/plugins/annotations3.png"></imagedata>
+ </imageobject>
+ </mediaobject>
</figure>
<para>To apply the changes click <emphasis>
- <property
moreinfo="none">Finish</property></emphasis>.</para>
-
- </section>
+ <property moreinfo="none">Finish</property>
+ </emphasis>.</para>
+ </section>
<section id="debug_log">
<title>Enable debug logging in the plugins</title>
-
<para>It is possible to configure the eclipse plugin to route all logging made
by the plugins
and hibernate code it self to the <property moreinfo="none">Error
Log View</property> in Eclipse.</para>
-
- <para>This is done by editing the <emphasis>
- <property
moreinfo="none">hibernate-log4j.properties</property>
+ <para><property diffmk:change="added"
moreinfo="none"><diffmk:wrapper diffmk:change="added">Error
Log View</diffmk:wrapper></property><diffmk:wrapper
diffmk:change="added"> is very useful tool to solve any problem which appears
in Hibernate Tools Plugins.
+ You can use if there are troubles with setting up
</diffmk:wrapper><property diffmk:change="added"
moreinfo="none"><diffmk:wrapper
diffmk:change="added">Hibernate Console
Configuration</diffmk:wrapper></property><diffmk:wrapper
diffmk:change="added">.</diffmk:wrapper></para>
+ <para diffmk:change="added">This is done by editing the
<emphasis>
+ <property
moreinfo="none">hibernate-log4j.properties</property>
</emphasis> in <emphasis>
<property moreinfo="none">org.hibernate.eclipse/
directory/jar</property>
</emphasis>. This file includes a default configuration that only logs WARN
and above to a set
of custom appenders (PluginFileAppender and PluginLogAppender). You can change
these settings
to be as verbose or silent as you please - see <ulink
url="http://www.hibernate.org/5.html">Hibernate Documentation</ulink>
for interesting categories and Log4j documentation.</para>
-
<section>
<title>Relevant Resources Links</title>
<para>Find more on how to configure logging via a log4j property file in
<ulink
url="http://supportweb.cs.bham.ac.uk/docs/tutorials/docsystem/build/tutorials/log4j/log4j.html">Log4j
documentation</ulink>.</para>
</section>
</section>
-
<section id="dali_integration">
<title>Hibernate support for Dali plugins in Eclipse WTP</title>
-
<para>Starting from 3.0.0 Alpha1 version of <property
moreinfo="none">JBoss Tools</property> Hibernate plugins
support Eclipse Dali integration what now makes it possible to use a Hibernate as a
complete
JPA development platform.</para>
-
+ <section diffmk:change="added"
id="jpa_project_with_hibernate">
+ <title diffmk:change="added"><diffmk:wrapper
diffmk:change="added">Creating JPA project with Hibernate
support</diffmk:wrapper></title>
<para>When starting a new JPA project from <emphasis>
<property moreinfo="none">New > Other > JPA
> JPA Project</property>
</emphasis> (or simply <emphasis>
<property moreinfo="none">New > JPA
Project</property>
</emphasis> in <property moreinfo="none">JPA
Perspective</property>), the first wizard page looks as
follows.</para>
-
<figure float="0">
<title>Starting JPA Project</title>
<mediaobject>
@@ -3016,19 +2909,15 @@
</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><diffmk:wrapper diffmk:change="changed">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>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 moreinfo="none">Add connection</property>
</emphasis> link.</para>
-
<para>Hitting <emphasis>
<property moreinfo="none">Finish</property>
</emphasis> will generate the project.</para>
-
<figure float="0">
<title>Targeting at Hibernate Platform</title>
<mediaobject>
@@ -3037,21 +2926,20 @@
</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
moreinfo="none">Hibernate Tools</property>
- features without additional setup.</para>
+ <para><diffmk:wrapper diffmk:change="changed">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
moreinfo="none">Hibernate Tools</property><diffmk:wrapper
diffmk:change="changed"> features
+ without additional setup.</diffmk:wrapper></para>
</note>
-
- <para>By enabling Hibernate platform specific features you can now generate DDL
and Entities.
+ </section>
+ <section diffmk:change="added"
id="generate_ddl_entities_with_hibernate">
+ <title diffmk:change="added"><diffmk:wrapper
diffmk:change="added">Generating DDL and
Entities</diffmk:wrapper></title>
+ <para>By enabling Hibernate platform specific features you can now generate
DDL and Entities.
For that find <emphasis>
<property moreinfo="none">JPA Tools > Generate Tables from
Entities/Generate Entities from Tables</property>
- </emphasis> options in the context menu of your JPA project.</para>
-
+ </emphasis> options in the context menu of your JPA project.</para>
<figure float="0">
<title>Generate DDL/Entities</title>
<mediaobject>
@@ -3060,17 +2948,13 @@
</imageobject>
</mediaobject>
</figure>
-
<note>
<title>Note:</title>
-
<para>Please, remember to put the proper database driver to the classpath of
your
project.</para>
</note>
-
- <para>The <property moreinfo="none">Generate Entities
wizard</property> first will ask you to choose the directory where all
- output will be written.</para>
-
+ <para>The <property moreinfo="none">Generate Entities
wizard</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>
@@ -3079,18 +2963,15 @@
</imageobject>
</mediaobject>
</figure>
-
<para>To generate entities you can use:</para>
-
<itemizedlist>
<listitem>
<para>a Hibernate Console Configuration (proposed by default)</para>
<para>Just make sure that the <emphasis>
- <property moreinfo="none">Use Console
Configuration</property>
+ <property moreinfo="none">Use Console
Configuration</property>
</emphasis> checkbox is selected and choose a needed configuration from the
<emphasis>
- <property moreinfo="none">Console
- configurations</property></emphasis> list box.</para>
-
+ <property moreinfo="none"><diffmk:wrapper
diffmk:change="changed">Console
configurations</diffmk:wrapper></property>
+ </emphasis> list box.</para>
<figure float="0">
<title>Generate Entities Wizard</title>
<mediaobject>
@@ -3101,31 +2982,106 @@
</figure>
</listitem>
</itemizedlist>
-
<itemizedlist>
<listitem>
<para>or a DTP connection directly</para>
<para>Just uncheck <emphasis>
- <property moreinfo="none">Use Console
Configuration</property>
- </emphasis> and adjust database settings.</para>
+ <property moreinfo="none">Use Console
Configuration</property>
+ </emphasis> and adjust database settings.</para>
</listitem>
</itemizedlist>
-
-<para>All the same you do with Generate Entities Wizard you can do with Generate
DDL wizard. Special feature for Generate DDL wizard is possible automatic execution of
Generation DDL in the database. </para>
- <figure float="0">
- <title>Generate DDL Wizard</title>
- <mediaobject>
- <imageobject>
- <imagedata
fileref="images/plugins/dali_integration6.png"></imagedata>
- </imageobject>
- </mediaobject>
- </figure>
+ <para><diffmk:wrapper diffmk:change="changed">All the same you
do with Generate Entities Wizard you can do with Generate DDL wizard.
+ Special feature for Generate DDL wizard is possible automatic execution of
Generation DDL in
+ the database. </diffmk:wrapper></para>
+ <figure float="0">
+ <title>Generate DDL Wizard</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata
fileref="images/plugins/dali_integration6.png"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
<para>Thus, you can now have the Hibernate runtime support in Eclipse JPA
projects.</para>
+ </section>
+ <section diffmk:change="added"
id="hibernate_annotations_support">
+ <title diffmk:change="added"><diffmk:wrapper
diffmk:change="added">Hibernate Annotations
Support</diffmk:wrapper></title>
+ <para diffmk:change="added"><diffmk:wrapper
diffmk:change="added">Also Hibernate Annotations are supported in
</diffmk:wrapper><property diffmk:change="added"
moreinfo="none"><diffmk:wrapper diffmk:change="added">Dali
Java Persistence Tools</diffmk:wrapper></property><diffmk:wrapper
diffmk:change="added">.
+ The next annotations are integrated with </diffmk:wrapper><property
diffmk:change="added" moreinfo="none"><diffmk:wrapper
diffmk:change="added">JPA
Details</diffmk:wrapper></property><diffmk:wrapper
diffmk:change="added"> view:</diffmk:wrapper></para>
+ <itemizedlist diffmk:change="added">
+ <listitem diffmk:change="added">
+ <para diffmk:change="added"><diffmk:wrapper
diffmk:change="added">Id Generator annotations -
</diffmk:wrapper><property diffmk:change="added"
moreinfo="none"><diffmk:wrapper
diffmk:change="added">@GenericGenerator</diffmk:wrapper></property><diffmk:wrapper
diffmk:change="added"> and </diffmk:wrapper><property
diffmk:change="added" moreinfo="none"><diffmk:wrapper
diffmk:change="added">@GeneratedValue</diffmk:wrapper></property></para>
+ <figure diffmk:change="added" float="0">
+ <title diffmk:change="added"><diffmk:wrapper
diffmk:change="added">@GenericGenerator support in
Dali</diffmk:wrapper></title>
+ <mediaobject diffmk:change="added">
+ <imageobject diffmk:change="added">
+ <imagedata diffmk:change="added"
fileref="images/plugins/dali_integration7.png"></imagedata>
+
+ </imageobject>
+
+ </mediaobject>
+ </figure>
+ <figure diffmk:change="added" float="0">
+ <title diffmk:change="added"><diffmk:wrapper
diffmk:change="added">@GeneratedValue support in
Dali</diffmk:wrapper></title>
+ <mediaobject diffmk:change="added">
+ <imageobject diffmk:change="added">
+ <imagedata diffmk:change="added"
fileref="images/plugins/dali_integration8.png"></imagedata>
+ </imageobject>
+
+ </mediaobject>
+ </figure>
+ </listitem>
+ <listitem diffmk:change="added">
+ <para diffmk:change="added"><diffmk:wrapper
diffmk:change="added">Property annotations-
</diffmk:wrapper><property diffmk:change="added"
moreinfo="none"><diffmk:wrapper
diffmk:change="added">@DiscriminatorFormula</diffmk:wrapper></property><diffmk:wrapper
diffmk:change="added">, </diffmk:wrapper><property
diffmk:change="added" moreinfo="none"><diffmk:wrapper
diffmk:change="added">@Generated
Annotation</diffmk:wrapper></property><diffmk:wrapper
diffmk:change="added">, </diffmk:wrapper><property
diffmk:change="added" moreinfo="none"><diffmk:wrapper
diffmk:change="added">@Index
annotation</diffmk:wrapper></property></para>
+ <figure diffmk:change="added" float="0">
+ <title diffmk:change="added"><diffmk:wrapper
diffmk:change="added">@Index support in
Dali</diffmk:wrapper></title>
+ <mediaobject diffmk:change="added">
+ <imageobject diffmk:change="added">
+ <imagedata diffmk:change="added"
fileref="images/plugins/dali_integration9.png"></imagedata>
+ </imageobject>
+
+ </mediaobject>
+ </figure>
+
+ </listitem>
+ <listitem diffmk:change="added">
+ <para diffmk:change="added"><diffmk:wrapper
diffmk:change="added">Mapping Queries annotations -
</diffmk:wrapper><property diffmk:change="added"
moreinfo="none"><diffmk:wrapper
diffmk:change="added">@NamedQuery</diffmk:wrapper></property><diffmk:wrapper
diffmk:change="added"> and </diffmk:wrapper><property
diffmk:change="added" moreinfo="none"><diffmk:wrapper
diffmk:change="added">@NamedNativeQuery</diffmk:wrapper></property></para>
+ <figure diffmk:change="added" float="0">
+ <title diffmk:change="added"><diffmk:wrapper
diffmk:change="added">Add New Named Query Dialog with Hibernate
Support</diffmk:wrapper></title>
+ <mediaobject diffmk:change="added">
+ <imageobject diffmk:change="added">
+ <imagedata diffmk:change="added"
fileref="images/plugins/dali_integration10.png"></imagedata>
+ </imageobject>
+
+ </mediaobject>
+ </figure>
+
+
+
+ <figure diffmk:change="added" float="0">
+ <title diffmk:change="added"><diffmk:wrapper
diffmk:change="added">@NamedQuery support in
Dali</diffmk:wrapper></title>
+ <mediaobject diffmk:change="added">
+ <imageobject diffmk:change="added">
+ <imagedata diffmk:change="added"
fileref="images/plugins/dali_integration11.png"></imagedata>
+ </imageobject>
+
+ </mediaobject>
+ </figure>
+ </listitem>
+ </itemizedlist>
+ <para diffmk:change="added"><diffmk:wrapper
diffmk:change="added">More information about Hibernate Annotation you can
find in </diffmk:wrapper><ulink diffmk:change="added"
url="http://docs.jboss.org/hibernate/stable/annotations/reference/en...
diffmk:change="added">Hibernate Annotations Reference
Guide</diffmk:wrapper></ulink><diffmk:wrapper
diffmk:change="added">. </diffmk:wrapper></para>
+
+ </section>
+ <section diffmk:change="added">
+ <title diffmk:change="added"><diffmk:wrapper
diffmk:change="added">Relevant Resources
Links</diffmk:wrapper></title>
+ <para diffmk:change="added"><diffmk:wrapper
diffmk:change="added">There is full information about native Dali plugin
features on </diffmk:wrapper><ulink diffmk:change="added"
url="http://help.eclipse.org/galileo/index.jsp?nav=/8"><d...
diffmk:change="added">Eclipse Documentation
page</diffmk:wrapper></ulink><diffmk:wrapper
diffmk:change="added">.</diffmk:wrapper></para>
+ </section>
+
</section>
+
</chapter>
-<chapter id="ant"
xml:base="file:///home/ochikvina/WORK/for_compare/jbosstools-3.1.0.CR1/hibernatetools/docs/reference/en/modules/ant.xml">
+<chapter id="ant"
xml:base="file:///home/vchukhutsina/repos/ochik_jboss/hibernatetools/docs/reference/en/modules/ant.xml">
<title>Ant Tools</title>
<para>Maybe somebody will find it more preferable to use Ant for generation
purposes. Thus, this
@@ -4363,7 +4319,7 @@
</chapter>
-<chapter id="reverseengineering"
xml:base="file:///home/ochikvina/WORK/for_compare/jbosstools-3.1.0.CR1/hibernatetools/docs/reference/en/modules/reverseengineering.xml">
+<chapter id="reverseengineering"
xml:base="file:///home/vchukhutsina/repos/ochik_jboss/hibernatetools/docs/reference/en/modules/reverseengineering.xml">
<title>Controlling reverse engineering</title>
<para>When using the <code><jdbcconfiguration></code>,
the ant task will read the
@@ -5241,7 +5197,7 @@
</chapter>
-<chapter id="codegen"
xml:base="file:///home/ochikvina/WORK/for_compare/jbosstools-3.1.0.CR1/hibernatetools/docs/reference/en/modules/codegen.xml">
+<chapter id="codegen"
xml:base="file:///home/vchukhutsina/repos/ochik_jboss/hibernatetools/docs/reference/en/modules/codegen.xml">
<title>Controlling POJO code generation</title>
<para>When using <code><hbm2java></code> or the eclipse
plugin to generate POJO java code you have the possibility to control
Modified: branches/jbosstools-3.1.x/hibernatetools/docs/reference/pom.xml
===================================================================
--- branches/jbosstools-3.1.x/hibernatetools/docs/reference/pom.xml 2010-03-03 10:34:07
UTC (rev 20587)
+++ branches/jbosstools-3.1.x/hibernatetools/docs/reference/pom.xml 2010-03-03 11:03:27
UTC (rev 20588)
@@ -23,7 +23,7 @@
<profile>
<id>releaseJBDS</id>
<properties>
- <master>master_output.xml</master>
+ <master>master.xml</master>
<xsl-single>classpath:/xslt/com/jboss/tools/xhtml-single-release.xsl</xsl-single>
<xsl-chunked>classpath:/xslt/com/jboss/tools/xhtml-release.xsl</xsl-chunked>
<xsl-pdf>classpath:/xslt/com/jboss/tools/pdf.xsl</xsl-pdf>
5190
days inactive
5190
days old
jbosstools-commits@lists.jboss.org
0 comments
1 participants
participants (1)
-
jbosstools-commits＠lists.jboss.org