[jbosstools-commits] JBoss Tools SVN: r22650 - in tags/jbosstools-3.1.1.GA/hibernatetools/docs/reference/en-US: images/plugins and 1 other directory.

Author: irooskov(a)redhat.com Date: 2010-06-08 19:43:43 -0400 (Tue, 08 Jun 2010) New Revision: 22650 Added: tags/jbosstools-3.1.1.GA/hibernatetools/docs/reference/en-US/images/plugins/plugins.xml Modified: tags/jbosstools-3.1.1.GA/hibernatetools/docs/reference/en-US/introduction.xml tags/jbosstools-3.1.1.GA/hibernatetools/docs/reference/en-US/master.xml tags/jbosstools-3.1.1.GA/hibernatetools/docs/reference/en-US/master_output.xml tags/jbosstools-3.1.1.GA/hibernatetools/docs/reference/en-US/plugins.xml Log: updated for 3.0.1 Added: tags/jbosstools-3.1.1.GA/hibernatetools/docs/reference/en-US/images/plugins/plugins.xml =================================================================== --- tags/jbosstools-3.1.1.GA/hibernatetools/docs/reference/en-US/images/plugins/plugins.xml (rev 0) +++ tags/jbosstools-3.1.1.GA/hibernatetools/docs/reference/en-US/images/plugins/plugins.xml 2010-06-08 23:43:43 UTC (rev 22650) @@ -0,0 +1,2569 @@ +<?xml version="1.0" encoding="UTF-8"?> +<chapter id="plugins" role="updated"> + <title>Eclipse Plugins</title> + <para>This chapter will introduce you to the functionality that <property>Hibernate + Tools</property> provide within Eclipse. That is a set of wizards and editors for simplifying + the work with <property>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 + >Hibernate</property>. The tools make working with <property>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 + <property>Hibernate Tools</property> and especially <property>Hibernate</property> it + self.</para> + </note> + </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> + <property>.hbm.xml</property> + </emphasis> files, Hibernate Tools provide a basic wizard which you can bring up by navigating + <emphasis> + <property>New > Hibernate XML mapping file</property>.</emphasis></para> + <para>At first you&apos;ll be asked to select a package or multiple individual classes to map. + It's also possible to create an empty file, don&apos;t select any packages or classes and an + empty .hbm will be created in the specified location</para> + <para id="depth_control">With <property>depth control</property> 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). </para> + <figure> + <title>Hibernate XML Mapping File Wizard</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/plugins/plugins_0.png"/> + </imageobject> + </mediaobject> + </figure> + <para>The next wizard page lists the mappings to be generated. As you see <property>Customers</property>, <property>Orders</property>, <property>Productlines</property> and <property>Products</property> classes added under <property>depth control</property> driving. </para> + <figure> + <title>Mappings to be generated</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/plugins/plugins_0_a.png"/> + </imageobject> + </mediaobject> + </figure> + + <para>This wizard page outputs a generated .hbm files preview.</para> + <figure> + <title>Preview Generated Mapping Files</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/plugins/plugins_0_b.png"/> + </imageobject> + </mediaobject> + </figure> + <para>Pressing <property>Finish</property> creates the files.</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 + >Hibernate Core</property> a <emphasis> + <property>hibernate.properties</property> + </emphasis> or <emphasis> + <property>hibernate.cfg.xml</property> + </emphasis> file is needed. The <property>Hibernate Tools</property> provide a wizard for + generating the <emphasis> + <property>hibernate.cfg.xml</property> + </emphasis> file if you do not already have such one.</para> + <para>Start the wizard by clicking <emphasis> + <property>New > Other (Ctrl+N)</property> + </emphasis>, then <emphasis> + <property>Hibernate > Hibernate Configuration File (cfg.xml)</property> + </emphasis> and press <emphasis> + <property>Next</property> + </emphasis> or on a web Seam project in the <property>Web Projects</property> view <emphasis> + <property> WebContent -> New -> File -> Hibernate Configuration 3.0</property> + </emphasis>. After selecting the wanted location for the <emphasis> + <property>hibernate.cfg.xml</property> + </emphasis> file, you will see the following page:</para> + <figure> + <title>Hibernate Configuration File Wizard</title> + <mediaobject> + <imageobject role="fo"> + <imagedata align="center" fileref="images/plugins/plugins_1.png" format="PNG"/> + </imageobject> + <imageobject role="html"> + <imagedata align="center" fileref="images/plugins/plugins_1.png" format="PNG"/> + </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>Finish</property> + </emphasis> to create the configuration file, after optionally creating a Console + configuration, the <emphasis> + <property>hibernate.cfg.xml</property> + </emphasis> will be automatically opened in an editor. The last option <emphasis> + <property>Create Console Configuration</property> + </emphasis> is enabled by default and when enabled, it will automatically use the <emphasis> + <property>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>Hibernate plugin</property> should + configure <property>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>Console Configuration + Wizard</property>, shown in the following screenshot. The same wizard will also be used if + you are coming from the <emphasis> + <property>hibernate.cfg.xml</property> + </emphasis> wizard and had enabled <emphasis> + <property>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>The dialog consists of five tabs: </para> + <itemizedlist> + <listitem> + <para><emphasis> + <property>Main</property> + </emphasis> for the basic/required settings</para> + </listitem> + </itemizedlist> + <figure> + <title> Creating Hibernate Console Configuration</title> + <mediaobject> + <imageobject role="fo"> + <imagedata align="center" fileref="images/plugins/plugins_2.png" format="PNG"/> + </imageobject> + <imageobject role="html"> + <imagedata align="center" fileref="images/plugins/plugins_2.png" format="PNG"/> + </imageobject> + </mediaobject> + </figure> + <para>The following table describes the available settings on the <emphasis> + <property>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 colnum="1" align="left" colwidth="1*"/> + <colspec colnum="2" colwidth="3*"/> + <colspec colnum="3" align="left" colwidth="1*"/> + <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 &quot;Core&quot;, &quot;Annotations&quot; and &quot;JPA&quot;. + 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&apos;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>No default value (lets Hibernate Entity Manager find the persistence unit or + it can be defined manually using Browse button)</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> + <literal> /hibernate.cfg.xml </literal> + </property> + </emphasis> or <emphasis> + <property> + <literal>/META-INF/persistence.xml</literal> + </property> + </emphasis> in its project classpath.</para> + </tip> + <itemizedlist> + <listitem> + <para> + <emphasis> + <property>Options</property> + </emphasis> for the additional/optional settings</para> + </listitem> + </itemizedlist> + <figure> + <title>Options Tab of the Console Configuration Wizard</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/plugins/plugins_2_a.png"/> + </imageobject> + </mediaobject> + </figure> + <para>The next table describes Hibernate Console Configuration options available on the + <emphasis> + <property>Options</property> + </emphasis> tab.</para> + <table> + <title>Hibernate Console Configuration Options</title> + <tgroup cols="3"> + <colspec colnum="1" align="left" colwidth="1*"/> + <colspec colnum="2" colwidth="3*"/> + <colspec colnum="3" align="left" colwidth="1*"/> + <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>Database dialect</para> + </entry> + <entry> + <para>Define a database dialect. It&apos;s possible either to write your value or choose + from list. </para> + </entry> + <entry> + <para>No default value</para> + </entry> + </row> + <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>Classpath</property> + </emphasis> for classpath</para> + </listitem> + </itemizedlist> + <figure> + <title>Specifying Classpath in Hibernate Console Configuration</title> + <mediaobject> + <imageobject role="fo"> + <imagedata align="center" fileref="images/plugins/plugins_3.png" format="PNG"/> + </imageobject> + <imageobject role="html"> + <imagedata align="center" fileref="images/plugins/plugins_3.png" format="PNG"/> + </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 colnum="1" align="left" colwidth="1*"/> + <colspec colnum="2" colwidth="3*"/> + <colspec colnum="3" colwidth="1*"/> + <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>Mappings</property> + </emphasis> for additional mappings</para> + </listitem> + </itemizedlist> + <figure> + <title>Specifying additional Mappings in Hibernate Console Configuration</title> + <mediaobject> + <imageobject role="fo"> + <imagedata align="center" fileref="images/plugins/plugins_4.png" format="PNG"/> + </imageobject> + <imageobject role="html"> + <imagedata align="center" fileref="images/plugins/plugins_4.png" format="PNG"/> + </imageobject> + </mediaobject> + </figure> + <para>Parameters of the Mappings tab of the <property>Hibernate Console Configuration + wizard</property> are explained below:</para> + <table> + <title>Hibernate Console Configuration Mappings</title> + <tgroup cols="3"> + <colspec colnum="1" align="left" colwidth="1*"/> + <colspec colnum="2" colwidth="3*"/> + <colspec colnum="3" colwidth="1*"/> + <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>Common</property> + </emphasis></para> + </listitem> + </itemizedlist> + <figure> + <title>Common Tab of the Console Configuration Wizard</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/plugins/plugins_4_a.png"/> + </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>Finish</property> + </emphasis> creates the configuration and shows it in the <property>Hibernate Configurations + view</property>.</para> + <figure> + <title>Console Overview</title> + <mediaobject> + <imageobject role="fo"> + <imagedata align="center" fileref="images/plugins/plugins_5.png" format="PNG"/> + </imageobject> + <imageobject role="html"> + <imagedata align="center" fileref="images/plugins/plugins_5.png" format="PNG"/> + </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> + <itemizedlist> + <listitem> + <para>right click on the configuration in <emphasis> + <property>Hibernate Configurations View->Edit Configuration </property> + </emphasis> or just double click on <property>Console Configuration</property> item.</para> + <figure> + <title>Opening Edit Configuration Wizard</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/plugins/plugins_4_c.png"/> + </imageobject> + </mediaobject> + </figure> + <para> After clicking you will see the Edit Configuration Wizard that is similar to + <emphasis> + <property>Create Console Configuration</property> + </emphasis>,described in <link linkend="creat_console_conf">Creating a Hibernate Console + Configuration section</link>. </para> + </listitem> + <listitem> + <para>use Properties view for modifying some of Console Configuration properties.</para> + <figure> + <title>Properties View</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/plugins/plugins_4_b.png"/> + </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 colnum="1" align="left" colwidth="1*"/> + <colspec colnum="2" colwidth="3*"/> + <colspec colnum="3" align="left" colwidth="1*"/> + <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&apos;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 &quot;CORE&quot;, &quot;ANNOTATIONS&quot; and + &quot;JPA&quot; 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> + </listitem> + </itemizedlist> + </section> + <section id='closing_conf_config'> + <title>Closing Hibernate Console Configuration</title> + <para>To close <property>Hibernate Console Configuration</property> you need do right click your configuration + and choose <property>Close Configuration</property> option </para> + <figure> + <title>Close Hibernate Console Configuration</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/plugins/plugins_4_d.png"/> + </imageobject> + </mediaobject> + </figure> + <para>While closing configuration the connection with database will be closed, jar libs will + be unlock (for Windows) and other resources will set as free. </para> + </section> + </section> + <section id="refeng_codegen" role="updated"> + <title>Reverse Engineering and Code Generation</title> + <para>A &quot;click-and-generate&quot; 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> + <property>.hbm.xml</property> + </emphasis>, <emphasis> + <property>hibernate.cfg.xml</property> + </emphasis> generation and schema documentation.</para> + <para>To start working with this process, start the <property>Hibernate Code + Generation</property> which is available in the toolbar via the <property + >Hibernate</property> icon or via the <emphasis> + <property>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>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 id="hib_code_gen"> + <title>Getting Hibernate Code Generation Wizard</title> + <mediaobject> + <imageobject role="fo"> + <imagedata fileref="images/plugins/plugins_6.png" format="PNG"/> + </imageobject> + <imageobject role="html"> + <imagedata align="center" fileref="images/plugins/plugins_6.png" format="PNG"/> + </imageobject> + </mediaobject> + </figure> + <para/> + <figure> + <title>Hibernate Code Generation Wizard</title> + <mediaobject> + <imageobject role="fo"> + <imagedata align="center" scale="80" fileref="images/plugins/plugins_7.png" format="PNG" + /> + </imageobject> + <imageobject role="html"> + <imagedata align="center" fileref="images/plugins/plugins_7.png" format="PNG"/> + </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>New_Generation</property> + </emphasis> will be used.</para> + <tip> + <title>Tip:</title> + <para>The &quot;At least one exporter option must be selected&quot; 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> + </tip> + <para>The dialog also have the standard tabs <emphasis> + <property>Refresh</property> + </emphasis> and <emphasis> + <property>Common</property> + </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>Main</property> + </emphasis> tab you see the following fields:</para> + <table> + <title>Code generation "Main" tab fields</title> + <tgroup cols="2"> + <colspec colnum="1" align="left" colwidth="1*"/> + <colspec colnum="2" colwidth="3*"/> + <colspec colnum="3" colwidth="0.5*"/> + <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. 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.</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 + generate code based on the database schema. If not enabled, the code generation + will just be based on the mappings already specified in the Hibernate Console + 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 + types and especially important which tables are included/excluded from the + process. Clicking "setup" allows you to select an existing reveng.xml file or + create a new one. See more details about the reveng.xml file in <xref + linkend="reverseengineering"/>.</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 + classpath of the Console Configuration, otherwise you will get class not found + exceptions. See <xref linkend="custom-reveng-strategy"/> for details and an + 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 &lt;composite-id&gt; 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>&lt;key-many-to-one&gt;</code> instead. Note: a + <code>&lt;many-to-one&gt;</code> property is still created, but is simply marked + as non-updatable and non-insertable.</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> + <para> The detection is enabled by default (except for Seam 1.2 and Seam 2.0) + reverse engineering. For Hibernate Tools generation there is a checkbox to disable + if not wanted. </para> + </entry> + </row> + <row> + <entry> + <para>Use custom templates</para> + </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> + </row> + </tbody> + </tgroup> + </table> + </section> + <section id="exportes"> + <title>Exporters</title> + <para>The <emphasis> + <property>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> + <title>Selecting Exporters</title> + <mediaobject> + <imageobject role="fo"> + <imagedata align="center" scale="80" fileref="images/plugins/plugins_8.png" format="PNG" + /> + </imageobject> + <imageobject role="html"> + <imagedata align="center" fileref="images/plugins/plugins_8.png" format="PNG"/> + </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 colnum="1" align="left" colwidth="1*"/> + <colspec colnum="2" colwidth="3*"/> + <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>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 colnum="1" align="left" colwidth="1*"/> + <colspec colnum="2" colwidth="3*"/> + <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> + </row> + </tbody> + </tgroup> + </table> + </para> + <para>To add a property to the chosen Exporter click the <emphasis> + <property>Add</property> + </emphasis> button in the <property>Properties</property> section. In the appeared dialog + you should select the property from the proposed list and the value for it.</para> + <figure> + <title>Adding the Property for Schema Export (.ddl)</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/plugins/plugins_8a.png"/> + </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> + <title>Specifying the Property Value</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/plugins/plugins_8b.png"/> + </imageobject> + </mediaobject> + </figure> + </section> + </section> + <section id="map_config_editor"> + <title>Hibernate Mapping and Configuration File Editor</title> + <para>The <property>Hibernate Mapping File editor</property> provides XML editing functionality + for the <emphasis> + <property>hbm.xml </property> + </emphasis> and <emphasis> + <property>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> + <title>XML Editing Functionality</title> + <mediaobject> + <imageobject role="fo"> + <imagedata align="center" scale="80" fileref="images/plugins/plugins_9.png" format="PNG"/> + </imageobject> + <imageobject role="html"> + <imagedata align="center" fileref="images/plugins/plugins_9.png" format="PNG"/> + </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>&lt;property&gt;</code> and only shows the properties/fields available in the + enclosing <code>&lt;class&gt;</code> , <code>&lt;subclass&gt;</code> etc. It is also + possible to navigate from the <emphasis> + <property>hbm.xml</property> + </emphasis> files to the relevant class/field in java code.</para> + <figure> + <title>Navigation Functionality</title> + <mediaobject> + <imageobject role="fo"> + <imagedata align="center" fileref="images/plugins/plugins_10.png" format="PNG" + scale="80"/> + </imageobject> + <imageobject role="html"> + <imagedata align="center" fileref="images/plugins/plugins_10.png" format="PNG"/> + </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>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> + <title>Note:</title> + <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> + <title>Table and Column Completion</title> + <mediaobject> + <imageobject role="fo"> + <imagedata align="center" scale="80" fileref="images/plugins/plugins_11.png" + format="PNG"/> + </imageobject> + <imageobject role="html"> + <imagedata align="center" fileref="images/plugins/plugins_11.png" format="PNG"/> + </imageobject> + </mediaobject> + </figure> + <important> + <title>Important:</title> + <para>Table/Column completion requires a proper configured hibernate console configuration + and this configuration should be the default for the project where the <emphasis> + <property>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>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>cfg.xml</property> + </emphasis> code completion for the value of <code>&lt;property&gt; name</code> attributes + is available.</para> + <figure> + <title>Property Completion</title> + <mediaobject> + <imageobject role="fo"> + <imagedata align="center" scale="80" fileref="images/plugins/plugins_12.png" + format="PNG"/> + </imageobject> + <imageobject role="html"> + <imagedata align="center" fileref="images/plugins/plugins_12.png" format="PNG"/> + </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>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> + <title>Structured hbm.xml Editor</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/plugins/plugins_12_a.png"/> + </imageobject> + </mediaobject> + </figure> + <para>For the configuration file you should choose <emphasis> + <property>Open With > Hibernate Configuration 3.0 XML Editor</property> + </emphasis>option.</para> + <figure> + <title>Structured cfg.xml Editor</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/plugins/plugins_12_b.png"/> + </imageobject> + </mediaobject> + </figure> + </section> + <section id="properties_editor"> + <title>JBoss Tools Properties Editor</title> + <para>The editor is meant for editing <literal>.properties</literal> files. It contains two + tabs: the <property>Properties</property> (UI) tab and the <property>Source</property> tab for + manual editing.</para> + <para>For <literal>hibernate.properties</literal> file <property>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>Properties</property> view, click the <emphasis> + <property>Add</property> + </emphasis> button.</para> + <figure> + <title>Adding the Property</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/plugins/add_property1.png"/> + </imageobject> + </mediaobject> + </figure> + <para>In the <emphasis> + <property>Name</property> + </emphasis> field press <emphasis> + <property>Ctrl+Space</property> + </emphasis> to invoke the content assist. It will suggest <emphasis> + <property>&apos;hibernate.&apos;</property> + </emphasis> which is the prefix for all hibernate properties. After selecting <emphasis> + <property>&apos;hibernate.&apos;</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> + <title>Content Assist for Properties Names</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/plugins/add_property2.png"/> + </imageobject> + </mediaobject> + </figure> + <para>When invoking the content assist in the <emphasis> + <property>Value</property> + </emphasis> field, it also provides a list of proposals.</para> + <figure> + <title>Content Assist for Properties Values</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/plugins/add_property3.png"/> + </imageobject> + </mediaobject> + </figure> + <para>In the <property>Source</property> view of the editor, content assist also could be + invoked both for properties names and values:</para> + <figure> + <title>Content Assist in the Source view</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/plugins/add_property4.png"/> + </imageobject> + </mediaobject> + </figure> + <figure> + <title>Content Assist in the Source view</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/plugins/add_property5.png"/> + </imageobject> + </mediaobject> + </figure> + </section> + <section id="rev_xml_editor"> + <title>Reveng.xml Editor</title> + <para>A <emphasis> + <property>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> + <property>.reveng.xml </property> + </emphasis> file are exposed or fully implemented in the editor, but the main functionality + is there. To understand the full flexibility of the <emphasis> + <property>reveng.xml</property> + </emphasis>, please see <xref linkend="hibernaterevengxmlfile"/> + </para> + </note> + <para>The editor is activated as soon as an <emphasis> + <property>.reveng.xml </property> + </emphasis> file is opened. To get an initial <emphasis> + <property>reveng.xml </property> + </emphasis> file the <property>Reverse Engineering File Wizard</property> can be started via + <emphasis> + <property>Ctrl+N</property> + </emphasis> and <emphasis> + <property>Hibernate > Hibernate Reverse Engineering File (reveng.xml)</property> + </emphasis> then.</para> + <figure> + <title>ChooseReverse Engineering File Wizard </title> + <mediaobject> + <imageobject role="fo"> + <imagedata align="center" scale="80" fileref="images/plugins/plugins_22.png" format="PNG" + /> + </imageobject> + <imageobject role="html"> + <imagedata align="center" fileref="images/plugins/plugins_22.png" format="PNG"/> + </imageobject> + </mediaobject> + </figure> + <para>Or you can get it via the <property>Code Generation Launcher</property> by checking the + proper section in the <emphasis> + <property>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>Overview</property> + </emphasis> page where the wanted console configuration is selected (auto-detected if + Hibernate 3 support is enabled for the project)</para> + <figure> + <title>Overview Page</title> + <mediaobject> + <imageobject role="fo"> + <imagedata align="center" scale="80" fileref="images/plugins/plugins_13.png" format="PNG" + /> + </imageobject> + <imageobject role="html"> + <imagedata align="center" fileref="images/plugins/plugins_13.png" format="PNG"/> + </imageobject> + </mediaobject> + </figure> + <para>The <emphasis> + <property>Table Filter</property> + </emphasis> page allows you to specify which tables to include and exclude. Pressing + <emphasis> + <property>Refresh</property> + </emphasis> shows the tables from the database that have not yet been excluded.</para> + <figure> + <title>Table Filters Page</title> + <mediaobject> + <imageobject role="fo"> + <imagedata align="center" scale="80" fileref="images/plugins/plugins_14.png" format="PNG" + /> + </imageobject> + <imageobject role="html"> + <imagedata align="center" fileref="images/plugins/plugins_14.png" format="PNG"/> + </imageobject> + </mediaobject> + </figure> + <para>The <emphasis> + <property>Type Mappings</property> + </emphasis> page is used for specifying type mappings from JBDC types to any Hibernate type + (including usertypes) if the default rules are not applicable. Here again to see the database + tables press <emphasis> + <property>Refresh</property> + </emphasis> button underneath. More about type mappings you can find further in the <link + linkend="type_map">Type Mappings</link> section.</para> + <figure> + <title>Type Mappings Page</title> + <mediaobject> + <imageobject role="fo"> + <imagedata align="center" scale="80" fileref="images/plugins/plugins_15.png" format="PNG" + /> + </imageobject> + <imageobject role="html"> + <imagedata align="center" fileref="images/plugins/plugins_15.png" format="PNG"/> + </imageobject> + </mediaobject> + </figure> + <para>The <emphasis> + <property>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> + <title>Table and Columns Page</title> + <mediaobject> + <imageobject role="fo"> + <imagedata align="center" scale="80" fileref="images/plugins/plugins_16.png" format="PNG" + /> + </imageobject> + <imageobject role="html"> + <imagedata align="center" fileref="images/plugins/plugins_16.png" format="PNG"/> + </imageobject> + </mediaobject> + </figure> + <para>Now that you have configured all necessary parts, you can learn how to work with <property + >Hibernate Console Perspective</property>.</para> + </section> + <section id="hib_console"> + <title>Hibernate Console Perspective</title> + <para>The <property>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>Hibernate + Configurations View</property>. Expanding the tree allows you to browse the class/entity + structure and see the relationships.</para> + <figure> + <title>Hibernate Console Perspective</title> + <mediaobject> + <imageobject role="fo"> + <imagedata align="center" scale="80" fileref="images/plugins/plugins_17.png"/> + </imageobject> + <imageobject role="html"> + <imagedata align="center" fileref="images/plugins/plugins_17.png"/> + </imageobject> + </mediaobject> + </figure> + <para>The <property>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>Reload</property> + </emphasis> button in the view toolbar or in the context menu.</para> + <para>Besides, it&apos;s possible to open source and mapping files for objects showed in + <property>Hibernate Configurations View</property>. Just bring up the context menu for a + necessary object and select <emphasis> + <property>Open Source File</property> + </emphasis> to see appropriate Java class or <emphasis> + <property>Open Mapping File</property> + </emphasis> to open a proper <emphasis> + <property>.hbm.xml</property>.</emphasis></para> + <figure> + <title>Opening Source for Objects</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/plugins/plugins_17_a.png"/> + </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>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>Mapping Diagram</property>.</emphasis></para> + <figure> + <title>Mapping Diagram</title> + <mediaobject> + <imageobject role="fo"> + <imagedata align="center" scale="80" fileref="images/plugins/plugins_18.png"/> + </imageobject> + <imageobject role="html"> + <imagedata align="center" fileref="images/plugins/plugins_18.png"/> + </imageobject> + </mediaobject> + </figure> + <para>To make <property>Mapping Diagram</property> usage easier you can use <property + >Rules</property>, <property>Grid</property>,<property>Snap to Geometry</property> + checkboxes in the <emphasis> + <property>View</property> + </emphasis> menu. </para> + <figure> + <title>View menu</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/plugins/map_diagram1.png"/> + </imageobject> + </mediaobject> + </figure> + <para>If you will select <emphasis> + <property>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>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> + <figure> + <title>Moving the Ruler guide</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/plugins/map_diagram2.png"/> + </imageobject> + </mediaobject> + </figure> + <para>If you'll select <emphasis> + <property>Grid</property> + </emphasis> checkbox, the grid will appear on the diagram.</para> + <figure> + <title>Grid on Mapping diagram</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/plugins/map_diagram3.png"/> + </imageobject> + </mediaobject> + </figure> + <para>The checkbox <emphasis> + <property>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>Outline view</property> which + is available in the structural and graphical modes.</para> + <figure> + <title>Navigating in the Structural Mode</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/plugins/plugins_18_a.png"/> + </imageobject> + </mediaobject> + </figure> + <para>To switch over between the modes use the buttons in the top-right corner of the + <property>Outline view</property>.</para> + <figure> + <title>Navigating in the Graphical Mode</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/plugins/plugins_18_b.png"/> + </imageobject> + </mediaobject> + </figure> + <para>The options in the context menu of the mapping diagram are listed in the next + table.</para> + <table> + <title>Context Menu Options of the Mapping Diagram</title> + <tgroup cols="3"> + <colspec colnum="1" align="left" colwidth="1*"/> + <colspec colnum="2" align="left" colwidth="1*"/> + <colspec colnum="3" align="left" colwidth="3*"/> + <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"/> + </imageobject> + </inlinemediaobject> + </para> + </entry> + <entry> + <para>Show|Hide connections</para> + </entry> + <entry>Allows to select what types of connections should be shown on the diagram: <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/> + </entry> + <entry> + <para>Select All</para> + </entry> + <entry> + <para>Makes all the diagram elements selected</para> + </entry> + </row> + <row> + <entry> + <para> + <inlinemediaobject> + <imageobject> + <imagedata fileref="images/plugins/autoLayout.png"/> + </imageobject> + </inlinemediaobject> + </para> + </entry> + <entry> + <para>Auto layout</para> + </entry> + <entry> + <para>Used to dispose all the items of the diagram in a standard manner</para> + </entry> + </row> + <row> + <entry> + <para> + <inlinemediaobject> + <imageobject> + <imagedata fileref="images/plugins/exportAsImage.png"/> + </imageobject> + </inlinemediaobject> + </para> + </entry> + <entry> + <para>Export as Image</para> + </entry> + <entry> + <para>Allows to export a diagram as <emphasis><property>.png + </property>,</emphasis> + <emphasis> + <property>.jpeg</property> + </emphasis> or <emphasis> + <property>.bmp </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> + <figure> + <title>Context Menu in Mapping Item</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/plugins/plugins_18_g.png"/> + </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 colnum="1" align="left" colwidth="1*"/> + <colspec colnum="2" align="left" colwidth="1*"/> + <colspec colnum="3" align="left" colwidth="3*"/> + <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>Open Source File</para> + </entry> + <entry> + <para>Makes it possible to open a source file for a chosen object/element. The + selected element will be highlighted in the open file.</para> + </entry> + </row> + <row> + <entry> + <para> + <inlinemediaobject> + <imageobject> + <imagedata fileref="images/plugins/openMappingFile_but.png"/> + </imageobject> + </inlinemediaobject> + </para> + </entry> + <entry> + <para>Open Mapping File</para> + </entry> + <entry> + <para>Makes it possible to open a mapping file for a chosen object/element. The + selected element will be highlighted in the open file.</para> + </entry> + </row> + <row> + <entry> + <para> + <inlinemediaobject> + <imageobject> + <imagedata fileref="images/plugins/visibleState.png"/> + </imageobject> + </inlinemediaobject> + </para> + </entry> + <entry> + <para>Show|Hide shape(s)</para> + </entry> + <entry> + <para>Used to hide/show an item on the mapping diagram</para> + </entry> + </row> + <row> + <entry> + <para> + <inlinemediaobject> + <imageobject> + <imagedata fileref="images/plugins/expandState.png"/> + </imageobject> + </inlinemediaobject> + </para> + </entry> + <entry> + <para>Expand|Collapse shape(s)</para> + </entry> + <entry> + <para>Used for expanding/collapsing fields of the item</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 + >Outline</property> view.</para> + </tip> + <para>The below table lists the actions that could be performed using the keyboard keys (or + keys combinations).</para> + <table> + <title>Hibernate Mapping Diagram Shortcut Keys</title> + <tgroup cols="2"> + <colspec colnum="1" align="left" colwidth="3*"/> + <colspec colnum="2" align="left" colwidth="1*"/> + <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>It&apos;s possible to save the diagram in the eclipse workspace. Click the usual + <emphasis> + <property>File &gt; Save As</property> + </emphasis> 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&apos;s names concatenated + with the ampersand symbols are set as the default name for a diagram. The file is saved + with the <literal>.hibernate</literal> extension.</para> + <figure> + <title>The Diagram saved in the Workspace</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/plugins/saveDiagram.png"/> + </imageobject> + </mediaobject> + </figure> + <tip> + <title>Note:</title> + <para>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.</para> + </tip> + <figure> + <title>The Diagram after Restarting the Eclipse</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/plugins/diagram1.png"/> + </imageobject> + </mediaobject> + </figure> + <figure> + <title>The Diagram after Refreshing</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/plugins/diagram2.png"/> + </imageobject> + </mediaobject> + </figure> + <para>There are some useful commands in the toolbar.</para> + <figure> + <title>The Diagram View Toolbar</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/plugins/diagramToolbar.png"/> + </imageobject> + </mediaobject> + </figure> + <para>They are described in the table below.</para> + <table> + <title>Command in Diagram View Toolbar </title> + <tgroup cols="3"> + <colspec colnum="1" align="left" colwidth="1*"/> + <colspec colnum="2" align="left" colwidth="1*"/> + <colspec colnum="3" align="left" colwidth="3*"/> + <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/toolbarRefresh.png"/> + </imageobject> + </inlinemediaobject> + </para> + </entry> + <entry> + <para>Refresh Visual Mapping</para> + </entry> + <entry> + <para>It update <property>Mapping Diagram</property> if <property>Console + Configuration</property> was changed. </para> + </entry> + </row> + <row> + <entry> + <para> + <inlinemediaobject> + <imageobject> + <imagedata fileref="images/plugins/toolbarZoom.png"/> + </imageobject> + </inlinemediaobject> + </para> + </entry> + <entry> + <para>Zoom Box</para> + </entry> + <entry> + <para>Used to define scale of the diagram. Also it's used for <property>Mapping + Diagram</property> printing. If you want to put the whole <property + >diagram</property> to one print page, you need select <property + >Page</property> option in the <property>Zoom Box</property>.</para> + </entry> + </row> + <row> + <entry> + <para> + <inlinemediaobject> + <imageobject> + <imagedata fileref="images/plugins/toolbarAutolayout.png"/> + </imageobject> + </inlinemediaobject> + </para> + </entry> + <entry> + <para>Auto layout</para> + </entry> + <entry> + <para>Used to arrange all diagram items in a standard manner.</para> + </entry> + </row> + <row> + <entry> + <para> + <inlinemediaobject> + <imageobject> + <imagedata fileref="images/plugins/toolbarShowHideConnections.png"/> + </imageobject> + </inlinemediaobject> + </para> + </entry> + <entry> + <para>Show|Hide connections</para> + </entry> + <entry> + <para>Used to show or hide connection on the diagram. Moreover you can choose what + type of connections must be present on the diagram (<property>Property + Mappings</property>, <property>Class Mappings</property>, <property + >Associations</property> or <property>Foreign key constraints</property>) + .</para> + </entry> + </row> + <row> + <entry> + <para> + <inlinemediaobject> + <imageobject> + <imagedata fileref="images/plugins/toolbarExpandCollapse.png"/> + </imageobject> + </inlinemediaobject> + </para> + </entry> + <entry> + <para>Expand|Collapse</para> + </entry> + <entry> + <para>Used for expanding/collapsing fields of the item.</para> + </entry> + </row> + <row> + <entry> + <para> + <inlinemediaobject> + <imageobject> + <imagedata fileref="images/plugins/toolbarShowHideShapes.png"/> + </imageobject> + </inlinemediaobject> + </para> + </entry> + <entry> + <para> Show|Hide shape(s)</para> + </entry> + <entry> + <para>Used to hide/show an item on the mapping diagram.</para> + </entry> + </row> + </tbody> + </tgroup> + </table> + </section> + </section> + <section> + <title>Prototyping Queries</title> + <para>Queries can be prototyped by entering them into the <property>HQL</property> or + <property>Criteria Editor</property>. To execute a query you should click the green run + button in the editor toolbar or press <emphasis> + <property>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>Console + Configuration</property> and select <property>HQL Editor</property> (or <property + >Hibernate Criteria Editor</property>).</para> + <figure> + <title>Opening HQL Editor</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/plugins/prototypingQueries.png"/> + </imageobject> + </mediaobject> + </figure> + <tip> + <title>Tip:</title> + <para>If the context menu items are disabled then you need at first to create a <property + >Session Factory</property>. That is done by simply expanding the <property>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>Session Factory</property> + </emphasis> you should double-click it. This will open the <property>HQL Editor</property> + with the associated query.</para> + <para>Choosing <emphasis> + <property>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>Hibernate Criteria Editor</property> + </emphasis> in the context menu, it will open <property>Hibernate Criteria + Editor</property> with the associated criteria.</para> + <figure> + <title>Generating Simple Queries</title> + <mediaobject> + <imageobject role="fo"> + <imagedata align="center" scale="80" fileref="images/plugins/plugins_19.png" + format="PNG"/> + </imageobject> + <imageobject role="html"> + <imagedata align="center" fileref="images/plugins/plugins_19.png" format="PNG"/> + </imageobject> + </mediaobject> + </figure> + <para>It&apos;s also possible to copy a portion of code from <emphasis> + <property>.java</property> + </emphasis> file into the <property>HQL</property> or <property>Criteria + editor</property>. To do this make use of the Quick Fix option (<emphasis> + <property>Ctrl + 1</property>)</emphasis>.</para> + <figure> + <title>Quick Fix Option Demonstration</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/plugins/plugins_19_b.png"/> + </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> + <title>Updating Java Code</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/plugins/plugins_19_c.png"/> + </imageobject> + </mediaobject> + </figure> + <para>Also you can pin <property>HQL editor</property> and <property>Criteria + editor</property> for one tab in <property>Hibernate Query Result</property> view. For + that you need click on <property>Stick result to one tab</property> + button(<inlinemediaobject> + <imageobject> + <imagedata fileref="images/plugins/sticky_but.png"/> + </imageobject> + </inlinemediaobject> ). In the issue query executions results will be shown in one tab (no + more will be opened). </para> + <para> Moreover you are able to rename tab in <property>Hibernate Query Result</property>. + Click the tab, and type a new name in <property>Property View->Tab name field</property>. </para> + <figure> + <title>Tab Renaming</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/plugins/plugins_19_d.png"/> + </imageobject> + </mediaobject> + </figure> + </section> + <section> + <title>Error Handling</title> + <para>Errors during creation of the <property>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>Error Log View</property> on the right pane.</para> + <para>Results of a query will be shown in the <property>Hibernate Query Result + View</property> and details of possible errors (syntax errors, database errors, etc.) + can be seen in the <property>Error Log View</property>.</para> + <note> + <title>Note:</title> + <para>HQL queries are executed by default using <literal>list()</literal> thus without any + limit of the size of the output the query could return a large result set. You might run + out of memory. To avoid this you can put a value in the Max results field to reduce the + number of elements returned.</para> + </note> + </section> + <section> + <title>Dynamic Query Translator</title> + <para>If the <property>Hibernate Dynamic Query Translator View</property> is visible while + writing in the <property>HQL Editor</property> it will show the generated SQL for a HQL + query.</para> + <figure> + <title>Hibernate Dynamic Query Translator View</title> + <mediaobject> + <imageobject role="fo"> + <imagedata align="center" scale="80" fileref="images/plugins/plugins_20.png" + format="PNG"/> + </imageobject> + <imageobject role="html"> + <imagedata align="center" fileref="images/plugins/plugins_20.png" format="PNG"/> + </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>Properties + view</property> shows the number of query results as well as the time of executing.</para> + <figure> + <title>Properties View</title> + <mediaobject> + <imageobject role="fo"> + <imagedata align="center" scale="80" fileref="images/plugins/plugins_21_a.png" + format="PNG"/> + </imageobject> + <imageobject role="html"> + <imagedata align="center" fileref="images/plugins/plugins_21_a.png" format="PNG"/> + </imageobject> + </mediaobject> + </figure> + <para>It also displays the structure of any persistent object selected in the <property + >Hibernate Query Results View</property>. Editing is not yet supported.</para> + <figure> + <title>Properties View for Selected Object</title> + <mediaobject> + <imageobject role="fo"> + <imagedata align="center" scale="80" fileref="images/plugins/plugins_21_b.png" + format="PNG"/> + </imageobject> + <imageobject role="html"> + <imagedata align="center" fileref="images/plugins/plugins_21_b.png" format="PNG"/> + </imageobject> + </mediaobject> + </figure> + <para>You can also use <property>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> + </section> + </section> + <section id="jpa_annotations"> + <title>Hibernate:add JPA annotations refactoring </title> + <para>Using this wizard you can add the next Hibernate annotations to the class: <emphasis> + <property>@Column</property> + </emphasis>,<emphasis> + <property>@Entity</property> + </emphasis>,<emphasis> + <property>@ManyToOne</property> + </emphasis>,<emphasis> + <property>@OneToMany</property> + </emphasis>,<emphasis> + <property>@OneToOne</property> + </emphasis>,<emphasis> + <property>@ManyToMany</property> + </emphasis>,<emphasis> + <property>@MappedSuperclass</property> + </emphasis>,<emphasis> + <property>@Id</property> + </emphasis>,<emphasis> + <property>@GeneratedValue</property> + </emphasis> ,<emphasis> + <property>@Version </property> + </emphasis> + </para> + <itemizedlist> + <listitem> + <para><emphasis> + <property>@Column</property> + </emphasis> is added to all String properties.</para> + </listitem> + <listitem> + <para><emphasis> + <property>@Entity</property> + </emphasis> is always declared before any class where it doesn't present.</para> + </listitem> + <listitem> + <para><emphasis> + <property>@ManyToOne</property> + </emphasis>,<emphasis> + <property>@OneToMany</property> + </emphasis>,<emphasis> + <property>@OneToOne</property> + </emphasis>,<emphasis> + <property>@ManyToMany</property> + </emphasis> - this annotations are declared according to the classes hierarchy.</para> + </listitem> + <listitem> + <para><emphasis> + <property>@MappedSuperclass</property> + </emphasis> is added to abstract superclasses.</para> + </listitem> + <listitem> + <para><emphasis> + <property>@Id</property> + </emphasis>,<emphasis> + <property>@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>@Version</property> + </emphasis> is declared in case you select <link linkend="optim_lock">Enable optimistic + locking</link>.</para> + </listitem> + </itemizedlist> + <note> + <title>Note:</title> + <para>This section doesn't cover the meaning of the <property>Hibernate annotations</property> + , for more information read <ulink + url="http://docs.jboss.org/hibernate/stable/annotations/reference/en... + Annotations Documentation</ulink> .</para> + </note> + <para>To open this wizard you should right click the class you want to enrich with annotations + <emphasis> + <property>>Source>Generate Hibernate/JPA annotations</property> + </emphasis>. You will see the Hibernate:add JPA annotations dialog. </para> + <figure> + <title>Starting Hibernate:add JPA annotations dialog</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/plugins/annotations1.png"/> + </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. If you + want to add new classes or package to the list of classes, you should click the <property + >Back</property> button. In result you will see <property>Add classes and + packages</property> page.</para> + <figure> + <title>Add classes and packages page </title> + <mediaobject> + <imageobject> + <imagedata fileref="images/plugins/annotations1_a.png"/> + </imageobject> + </mediaobject> + </figure> + <para>Here you can add one more classes or whole package, moreover you can limit dependencies + depth by selecting <property>depth control</property> option (more about this option you will + find in <link linkend="depth_control">Creating a Hibernate Mapping File</link>). When finished + just press the <property>Next</property> button and you will be returned to <property>The + following classes will be changed</property> page and will be able to continue work with + it.</para> + <para>By default the tags are added to the fields of selected classes. But you can change this + option to <emphasis> + <property>Getters</property> + </emphasis>in <emphasis> + <property> Preferred location of Annotations</property> + </emphasis> dropdownlist and then all the annotations will be added to the getter methods. If + you choose <emphasis> + <property>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>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>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>"version"</property> + </emphasis> is not inserted into the current class. </para> + <para>After defining all necessary settings in the current step press <emphasis> + <property>Next</property> + </emphasis> and follow the next wizard steps. </para> + <figure> + <title>Hibernate:add JPA annotations view</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/plugins/annotations2.png"/> + </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"/> + </imageobject> + </inlinemediaobject> ,<inlinemediaobject> + <imageobject> + <imagedata fileref="images/plugins/butt2.png"/> + </imageobject> + </inlinemediaobject> ,<inlinemediaobject> + <imageobject> + <imagedata fileref="images/plugins/butt3.png"/> + </imageobject> + </inlinemediaobject> ,<inlinemediaobject> + <imageobject> + <imagedata fileref="images/plugins/butt4.png"/> + </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> + <figure> + <title>List of classes that need refactoring</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/plugins/annotations3.png"/> + </imageobject> + </mediaobject> + </figure> + <para>To apply the changes click <emphasis> + <property>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>Error Log View</property> in Eclipse.</para> + <para><property>Error Log View</property> is very useful tool to solve any problem which appears in Hibernate Tools Plugins. + You can use if there are troubles with setting up <property>Hibernate Console Configuration</property>.</para> + <para>This is done by editing the <emphasis> + <property>hibernate-log4j.properties</property> + </emphasis> in <emphasis> + <property>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>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> + <para>When starting a new JPA project from <emphasis> + <property>New &gt; Other &gt; JPA &gt; JPA Project</property> + </emphasis> (or simply <emphasis> + <property>New &gt; JPA Project</property> + </emphasis> in <property>JPA Perspective</property>), the first wizard page looks as + follows.</para> + <figure> + <title>Starting JPA Project</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/plugins/dali_integration1.png"/> + </imageobject> + </mediaobject> + </figure> + <para>It&apos;s possible here to select a target runtime and change the project configuration, + or you can leave everything as it is.</para> + <para>On the JPA Facet page you should choose Hibernate as a target platform. Also select the + proper database connection, if it is defined, or add a new one by clicking the <emphasis> + <property>Add connection</property> + </emphasis> link.</para> + <para>Hitting <emphasis> + <property>Finish</property> + </emphasis> will generate the project.</para> + <figure> + <title>Targeting at Hibernate Platform</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/plugins/dali_integration2.png"/> + </imageobject> + </mediaobject> + </figure> + <note> + <title>Note:</title> + <para>Please note, if you choose Hibernate as a platform while creating a JPA/Dali project, a + Hibernate Console Configuration for the project is created automatically when the wizard + finishes its work. It allows a full usage of <property>Hibernate Tools</property> features + without additional setup.</para> + </note> + <para>By enabling Hibernate platform specific features you can now generate DDL and Entities. + For that find <emphasis> + <property>JPA Tools > Generate Tables from Entities/Generate Entities from Tables</property> + </emphasis> options in the context menu of your JPA project.</para> + <figure> + <title>Generate DDL/Entities</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/plugins/dali_integration3.png"/> + </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>Generate Entities wizard</property> first will ask you to choose the + directory where all output will be written.</para> + <figure> + <title>Generate Entities Wizard</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/plugins/dali_integration4.png"/> + </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>Use Console Configuration</property> + </emphasis> checkbox is selected and choose a needed configuration from the <emphasis> + <property>Console configurations</property> + </emphasis> list box.</para> + <figure> + <title>Generate Entities Wizard</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/plugins/dali_integration5.png"/> + </imageobject> + </mediaobject> + </figure> + </listitem> + </itemizedlist> + <itemizedlist> + <listitem> + <para>or a DTP connection directly</para> + <para>Just uncheck <emphasis> + <property>Use Console Configuration</property> + </emphasis> and adjust database settings.</para> + </listitem> + </itemizedlist> + <para>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> + <title>Generate DDL Wizard</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/plugins/dali_integration6.png"/> + </imageobject> + </mediaobject> + </figure> + <para>Thus, you can now have the Hibernate runtime support in Eclipse JPA projects.</para> + </section> +</chapter> Modified: tags/jbosstools-3.1.1.GA/hibernatetools/docs/reference/en-US/introduction.xml =================================================================== --- tags/jbosstools-3.1.1.GA/hibernatetools/docs/reference/en-US/introduction.xml 2010-06-08 23:38:52 UTC (rev 22649) +++ tags/jbosstools-3.1.1.GA/hibernatetools/docs/reference/en-US/introduction.xml 2010-06-08 23:43:43 UTC (rev 22650) @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="UTF-8"?> -<chapter id="preface"> +<chapter id="introduction"> <title>Introduction</title> Modified: tags/jbosstools-3.1.1.GA/hibernatetools/docs/reference/en-US/master.xml =================================================================== --- tags/jbosstools-3.1.1.GA/hibernatetools/docs/reference/en-US/master.xml 2010-06-08 23:38:52 UTC (rev 22649) +++ tags/jbosstools-3.1.1.GA/hibernatetools/docs/reference/en-US/master.xml 2010-06-08 23:43:43 UTC (rev 22650) @@ -50,7 +50,7 @@ </copyright> <releaseinfo> - Version: 3.3.0.GA + Version: 3.3.1.GA </releaseinfo> Modified: tags/jbosstools-3.1.1.GA/hibernatetools/docs/reference/en-US/master_output.xml =================================================================== --- tags/jbosstools-3.1.1.GA/hibernatetools/docs/reference/en-US/master_output.xml 2010-06-08 23:38:52 UTC (rev 22649) +++ tags/jbosstools-3.1.1.GA/hibernatetools/docs/reference/en-US/master_output.xml 2010-06-08 23:43:43 UTC (rev 22650) @@ -49,7 +49,7 @@ </copyright> <releaseinfo><diffmk:wrapper diffmk:change="changed"> - Version: 3.3.0.GA + Version: 3.3.1.GA </diffmk:wrapper></releaseinfo> @@ -470,23 +470,22 @@ can take advantage of while using the tools within Eclipse.</para> <note> <title>Note:</title> - <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 + <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 <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> + <section id="download_base_project"> + <title>Download base project</title> + <para><diffmk:wrapper diffmk:change="changed">You can download example projects which are used for this chapter.</diffmk:wrapper></para> + <para><property moreinfo="none">JPA base project</property><diffmk:wrapper diffmk:change="added"> is available on </diffmk:wrapper><ulink diffmk:change="added" url="http://docs.jboss.org/tools/resources/"><diffmk:wrapper diffmk:change="added">documentation resources page </diffmk:wrapper></ulink><diffmk:wrapper diffmk:change="added"> + together with </diffmk:wrapper><ulink diffmk:change="added" url="http://docs.jboss.org/tools/resources/TestHibernateproject_for_... diffmk:change="added">base Java project</diffmk:wrapper></ulink>.</para> + <para>Also you need start <ulink url="http://docs.jboss.org/tools/resources/GSG_database.zip">... + <note> + <title>Note:</title> + <para>How to run database you can know in <ulink url="http://docs.jboss.org/tools/3.0.1.GA/en/GettingStartedGuide/htm... Started Guide</ulink>.</para> </note> </section> - </section> <section id="map_file_wizard"> <title>Creating a Hibernate Mapping File</title> @@ -494,15 +493,15 @@ tables.</para> <para>To create basic mappings for properties and associations, i. e. generate <emphasis> <property moreinfo="none">.hbm.xml</property> - </emphasis><diffmk:wrapper diffmk:change="changed"> files, Hibernate Tools provide a basic wizard which you can bring up by navigating - </diffmk:wrapper><emphasis> + </emphasis> files, Hibernate Tools provide a basic wizard which you can bring up by navigating + <emphasis> <property moreinfo="none">New &gt; Hibernate XML mapping file</property>.</emphasis></para> - <para><diffmk:wrapper diffmk:change="changed">At first you'll be asked to select a package or multiple individual classes to map. + <para>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> + empty .hbm will be created in the specified location</para> + <para id="depth_control">With <property moreinfo="none">depth control</property><diffmk:wrapper diffmk:change="changed"> 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> @@ -511,7 +510,9 @@ </imageobject> </mediaobject> </figure> - <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> + <para>The next wizard page lists the mappings to be generated. As you see <property moreinfo="none">Customers</property>, <property moreinfo="none">Orders</property>, <property moreinfo="none">Productlines</property><diffmk:wrapper diffmk:change="changed"> and + </diffmk:wrapper><property moreinfo="none">Products</property> classes added under <property moreinfo="none">depth control</property><diffmk:wrapper diffmk:change="changed"> + driving. </diffmk:wrapper></para> <figure float="0"> <title>Mappings to be generated</title> <mediaobject> @@ -520,21 +521,20 @@ </imageobject> </mediaobject> </figure> - - <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> + <para>This wizard page outputs a generated .hbm files preview.</para> + <figure float="0"> + <title>Preview Generated Mapping Files</title> + <mediaobject> + <imageobject> + <imagedata 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> + <para>Pressing <property moreinfo="none">Finish</property> creates the files.</para> </section> <section id="hib_config_file"> <title>Creating a Hibernate Configuration File</title> - <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> + <para>To be able to reverse engineer, prototype queries, and of course to simply use <property moreinfo="none">Hibernate Core</property> a <emphasis> <property moreinfo="none">hibernate.properties</property> </emphasis> or <emphasis> <property moreinfo="none">hibernate.cfg.xml</property> @@ -548,7 +548,7 @@ <property moreinfo="none">Hibernate &gt; Hibernate Configuration File (cfg.xml)</property> </emphasis> and press <emphasis> <property moreinfo="none">Next</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> + </emphasis> or on a web Seam project in the <property moreinfo="none">Web Projects</property> view <emphasis> <property moreinfo="none"> WebContent -&gt; New -&gt; File -&gt; Hibernate Configuration 3.0</property> </emphasis>. After selecting the wanted location for the <emphasis> <property moreinfo="none">hibernate.cfg.xml</property> @@ -593,407 +593,408 @@ possible if your project requires this.</para> <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> + <para>You can 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 diffmk:change="added"> + <note> <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> + <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 diffmk:change="added"> - <listitem diffmk:change="added"> + <itemizedlist> + <listitem> <para><emphasis> <property moreinfo="none">Main</property> </emphasis> for the basic/required settings</para> </listitem> </itemizedlist> - <figure diffmk:change="added" float="0"> + <figure float="0"> <title> Creating Hibernate Console Configuration</title> - <mediaobject diffmk:change="added"> - <imageobject diffmk:change="added" role="fo"> + <mediaobject> + <imageobject role="fo"> <imagedata align="center" fileref="images/plugins/plugins_2.png" format="PNG"></imagedata> </imageobject> - <imageobject diffmk:change="added" role="html"> + <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><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"> + </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> <title>Hibernate Console Configuration Parameters</title> - <tgroup cols="3" diffmk:change="added"> + <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 diffmk:change="added"> - <row diffmk:change="added"> - <entry align="center" diffmk:change="added"> + <thead> + <row> + <entry align="center"> <para>Parameter</para> </entry> - <entry align="center" diffmk:change="added"> + <entry align="center"> <para>Description</para> </entry> - <entry align="center" diffmk:change="added"> + <entry align="center"> <para>Auto detected value</para> </entry> </row> </thead> - <tbody diffmk:change="added"> - <row diffmk:change="added"> - <entry diffmk:change="added"> + <tbody> + <row> + <entry> <para>Name</para> </entry> - <entry diffmk:change="added"> + <entry> <para>The unique name of the console configuration</para> </entry> - <entry diffmk:change="added"> + <entry> <para>Name of the selected project</para> </entry> </row> - <row diffmk:change="added"> - <entry diffmk:change="added"> + <row> + <entry> <para>Type</para> </entry> - <entry diffmk:change="added"> - <para><diffmk:wrapper diffmk:change="changed">Choose between "Core", "Annotations" and "JPA". + <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.</diffmk:wrapper></para> + otherwise you will get classloading and/or version errors.</para> </entry> - <entry diffmk:change="added"> + <entry> <para>No default value</para> </entry> </row> - <row diffmk:change="added"> - <entry diffmk:change="added"> + <row> + <entry> <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> + <para>The name of a java project which classpath should be used in the console + configuration</para> </entry> - <entry diffmk:change="added"> + <entry> <para>Name of the selected project</para> </entry> </row> - <row diffmk:change="added"> - <entry diffmk:change="added"> + <row> + <entry> <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 + <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.</diffmk:wrapper></para> + JPA connection or specify a new one here.</para> </entry> - <entry diffmk:change="added"> + <entry> <para>[Hibernate Configured connection]</para> </entry> </row> - <row diffmk:change="added"> - <entry diffmk:change="added"> + <row> + <entry> <para>Property file</para> </entry> - <entry diffmk:change="added"> + <entry> <para>Path to a hibernate.properties file</para> </entry> - <entry diffmk:change="added"> + <entry> <para>First hibernate.properties file found in the selected project</para> </entry> </row> - <row diffmk:change="added"> - <entry diffmk:change="added"> + <row> + <entry> <para>Configuration file</para> </entry> - <entry diffmk:change="added"> + <entry> <para>Path to a hibernate.cfg.xml file</para> </entry> - <entry diffmk:change="added"> + <entry> <para>First hibernate.cfg.xml file found in the selected project</para> </entry> </row> - <row diffmk:change="added"> - <entry diffmk:change="added"> + <row> + <entry> <para>Persistence unit</para> </entry> - <entry diffmk:change="added"> + <entry> <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> + <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"> + <tip> <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 + <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"> + <property moreinfo="none"> <literal moreinfo="none"> /hibernate.cfg.xml </literal> </property> </emphasis> or <emphasis> - <property diffmk:change="added" moreinfo="none"> + <property 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"> + <itemizedlist> + <listitem> + <para> + <emphasis> <property moreinfo="none">Options</property> </emphasis> for the additional/optional settings</para> </listitem> </itemizedlist> - <figure diffmk:change="added" float="0"> + <figure float="0"> <title>Options Tab of the Console Configuration Wizard</title> - <mediaobject diffmk:change="added"> - <imageobject diffmk:change="added"> + <mediaobject> + <imageobject> <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> + <para>The next table describes Hibernate Console Configuration options available on the + <emphasis> <property moreinfo="none">Options</property> </emphasis> tab.</para> - <table diffmk:change="added"> + <table> <title>Hibernate Console Configuration Options</title> - <tgroup cols="3" diffmk:change="added"> + <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 diffmk:change="added"> - <row diffmk:change="added"> - <entry align="center" diffmk:change="added"> + <thead> + <row> + <entry align="center"> <para>Parameter</para> </entry> - <entry align="center" diffmk:change="added"> + <entry align="center"> <para>Description</para> </entry> - <entry align="center" diffmk:change="added"> + <entry align="center"> <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> + <tbody> + <row> + <entry> + <para>Database dialect</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> + <para><diffmk:wrapper diffmk:change="changed">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> + <para>No default value</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> + <row> + <entry> + <para>Naming strategy</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> + <para>Fully qualified classname of a custom NamingStrategy. Only required if you use + a special naming strategy.</para> </entry> - <entry diffmk:change="added"> + <entry> <para>No default value</para> </entry> </row> - <row diffmk:change="added"> - <entry diffmk:change="added"> + <row> + <entry> <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> + <para>Fully qualified classname of a custom EntityResolver. Only required if you + have special xml entity includes in your mapping files.</para> </entry> - <entry diffmk:change="added"> + <entry> <para>No default value</para> </entry> </row> </tbody> </tgroup> </table> - <itemizedlist diffmk:change="added"> - <listitem diffmk:change="added"> + <itemizedlist> + <listitem> <para><emphasis> <property moreinfo="none">Classpath</property> </emphasis> for classpath</para> </listitem> </itemizedlist> - <figure diffmk:change="added" float="0"> + <figure float="0"> <title>Specifying Classpath in Hibernate Console Configuration</title> - <mediaobject diffmk:change="added"> - <imageobject diffmk:change="added" role="fo"> + <mediaobject> + <imageobject role="fo"> <imagedata align="center" fileref="images/plugins/plugins_3.png" format="PNG"></imagedata> </imageobject> - <imageobject diffmk:change="added" role="html"> + <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 diffmk:change="added"> + <table> <title>Hibernate Console Configuration Classpath</title> - <tgroup cols="3" diffmk:change="added"> + <tgroup cols="3"> <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"> + <thead> + <row> + <entry align="center"> <para>Parameter</para> </entry> - <entry align="center" diffmk:change="added"> + <entry align="center"> <para>Description</para> </entry> - <entry align="center" diffmk:change="added"> + <entry align="center"> <para>Auto detected value</para> </entry> </row> </thead> - <tbody diffmk:change="added"> - <row diffmk:change="added"> - <entry diffmk:change="added"> + <tbody> + <row> + <entry> <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 + <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.</diffmk:wrapper></para> + directories/jars.</para> </entry> - <entry diffmk:change="added"> + <entry> <para>Empty</para> </entry> </row> - <row diffmk:change="added"> - <entry diffmk:change="added"> + <row> + <entry> <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> + <para>When enabled the project classpath will be appended to the classpath specified + above</para> </entry> - <entry diffmk:change="added"> + <entry> <para>Enabled</para> </entry> </row> </tbody> </tgroup> </table> - <itemizedlist diffmk:change="added"> - <listitem diffmk:change="added"> + <itemizedlist> + <listitem> <para><emphasis> <property moreinfo="none">Mappings</property> </emphasis> for additional mappings</para> </listitem> </itemizedlist> - <figure diffmk:change="added" float="0"> + <figure float="0"> <title>Specifying additional Mappings in Hibernate Console Configuration</title> - <mediaobject diffmk:change="added"> - <imageobject diffmk:change="added" role="fo"> + <mediaobject> + <imageobject role="fo"> <imagedata align="center" fileref="images/plugins/plugins_4.png" format="PNG"></imagedata> </imageobject> - <imageobject diffmk:change="added" role="html"> + <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"><diffmk:wrapper diffmk:change="changed">Hibernate Console Configuration - wizard</diffmk:wrapper></property> are explained below:</para> - <table diffmk:change="added"> + <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" diffmk:change="added"> + <tgroup cols="3"> <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"> + <thead> + <row> + <entry align="center"> <para>Parameter</para> </entry> - <entry align="center" diffmk:change="added"> + <entry align="center"> <para>Description</para> </entry> - <entry align="center" diffmk:change="added"> + <entry align="center"> <para>Auto detected value</para> </entry> </row> </thead> - <tbody diffmk:change="added"> - <row diffmk:change="added"> - <entry diffmk:change="added"> + <tbody> + <row> + <entry> <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 + <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 duplications here, you will get "Duplicate mapping" errors when using the console - configuration.</diffmk:wrapper></para> + configuration.</para> </entry> - <entry diffmk:change="added"> + <entry> <para>empty</para> </entry> </row> </tbody> </tgroup> </table> - <itemizedlist diffmk:change="added"> - <listitem diffmk:change="added"> + <itemizedlist> + <listitem> <para>and the last tab <emphasis> <property moreinfo="none">Common</property> </emphasis></para> </listitem> </itemizedlist> - <figure diffmk:change="added" float="0"> + <figure float="0"> <title>Common Tab of the Console Configuration Wizard</title> - <mediaobject diffmk:change="added"> - <imageobject diffmk:change="added"> + <mediaobject> + <imageobject> <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>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"><diffmk:wrapper diffmk:change="changed">Hibernate Configurations - view</diffmk:wrapper></property>.</para> - <figure diffmk:change="added" float="0"> + </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 diffmk:change="added"> - <imageobject diffmk:change="added" role="fo"> + <mediaobject> + <imageobject role="fo"> <imagedata align="center" fileref="images/plugins/plugins_5.png" format="PNG"></imagedata> </imageobject> - <imageobject diffmk:change="added" role="html"> + <imageobject role="html"> <imagedata align="center" fileref="images/plugins/plugins_5.png" format="PNG"></imagedata> </imageobject> </mediaobject> </figure> </section> <section id="modif_console_conf"> - <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> + <title>Modifying a Hibernate Console Configuration </title> + <para>When you created a hibernate console configuration you can modify it in 2 ways: </para> <itemizedlist> <listitem> - <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-&gt;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> + <para>right-click on the configuration in <emphasis> + <property moreinfo="none">Hibernate Configurations View-&gt;Edit Configuration </property> + </emphasis> or just double-click on <property moreinfo="none">Console Configuration</property><diffmk:wrapper diffmk:change="changed"> + item.</diffmk:wrapper></para> <figure float="0"> <title>Opening Edit Configuration Wizard</title> <mediaobject> @@ -1002,11 +1003,11 @@ </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> + <para> After clicking you will see the Edit Configuration Wizard that is similar to + <emphasis> <property moreinfo="none">Create Console Configuration</property> - </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> + </emphasis>,described in <link linkend="creat_console_conf">Creating a Hibernate Console + Configuration section</link>. </para> </listitem> <listitem> <para>use Properties view for modifying some of Console Configuration properties.</para> @@ -1018,107 +1019,107 @@ </imageobject> </mediaobject> </figure> - <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> + <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" diffmk:change="added"> + <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 diffmk:change="added"> - <row diffmk:change="added"> - <entry align="center" diffmk:change="added"> + <thead> + <row> + <entry align="center"> <para>Property</para> </entry> - <entry align="center" diffmk:change="added"> + <entry align="center"> <para>Description</para> </entry> - <entry align="center" diffmk:change="added"> + <entry align="center"> <para>Is Changeable</para> </entry> </row> </thead> - <tbody diffmk:change="added"> - <row diffmk:change="added"> - <entry diffmk:change="added"> + <tbody> + <row> + <entry> <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> + <para>List of additional mapping files that should be loaded. </para> </entry> - <entry diffmk:change="added"> + <entry> <para>False</para> </entry> </row> - <row diffmk:change="added"> - <entry diffmk:change="added"> + <row> + <entry> <para>Configuration file</para> </entry> - <entry diffmk:change="added"> + <entry> <para>Path to a hibernate.cfg.xml file</para> </entry> - <entry diffmk:change="added"> + <entry> <para>False</para> </entry> </row> - <row diffmk:change="added"> - <entry diffmk:change="added"> + <row> + <entry> <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 + <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.</diffmk:wrapper></para> + hibernate or JPA connection or specify a new one here.</para> </entry> - <entry diffmk:change="added"> + <entry> <para>True</para> </entry> </row> - <row diffmk:change="added"> - <entry diffmk:change="added"> + <row> + <entry> <para>Name</para> </entry> - <entry diffmk:change="added"> + <entry> <para>The unique name of the console configuration</para> </entry> - <entry diffmk:change="added"> + <entry> <para>True</para> </entry> </row> - <row diffmk:change="added"> - <entry diffmk:change="added"> + <row> + <entry> <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> + <para>The name of a java project which classpath should be used in the console + configuration</para> </entry> - <entry diffmk:change="added"> + <entry> <para>True</para> </entry> </row> - <row diffmk:change="added"> - <entry diffmk:change="added"> + <row> + <entry> <para>Properties file</para> </entry> - <entry diffmk:change="added"> + <entry> <para>Path to a hibernate.properties file</para> </entry> - <entry diffmk:change="added"> + <entry> <para>False</para> </entry> </row> - <row diffmk:change="added"> - <entry diffmk:change="added"> + <row> + <entry> <para>Type</para> </entry> - <entry diffmk:change="added"> + <entry> <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> + 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"> + <entry> <para>True</para> </entry> </row> @@ -1128,34 +1129,34 @@ </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> + <section id="closing_conf_config"> + <title>Closing Hibernate Console Configuration</title> + <para>To close <property moreinfo="none">Hibernate Console Configuration</property><diffmk:wrapper diffmk:change="changed"> you need do right-click + your configuration and choose </diffmk:wrapper><property moreinfo="none">Close Configuration</property> option </para> + <figure float="0"> + <title>Close Hibernate Console Configuration</title> + <mediaobject> + <imageobject> + <imagedata 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> + <para>While closing configuration the connection with database will be closed, jar libs will + be unlock (for Windows) and other resources will set as free. </para> </section> </section> <section id="refeng_codegen" role="updated"> <title>Reverse Engineering and Code Generation</title> - <para><diffmk:wrapper diffmk:change="changed">A "click-and-generate" reverse engineering and code generation facility is + <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 </diffmk:wrapper><emphasis> + these are POJO Java source file, Hibernate <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><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> + Generation</property> which is available in the toolbar via the <property moreinfo="none">Hibernate</property> icon or via the <emphasis> <property moreinfo="none">Run &gt; Hibernate Code Generation</property> </emphasis> menu item.</para> <section id="code_gen"> @@ -1193,9 +1194,9 @@ </emphasis> will be used.</para> <tip> <title>Tip:</title> - <para><diffmk:wrapper diffmk:change="changed">The "At least one exporter option must be selected" is just a warning + <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.</diffmk:wrapper></para> + When an exporter has been selected the warning will disappear.</para> </tip> <para>The dialog also have the standard tabs <emphasis> <property moreinfo="none">Refresh</property> @@ -1238,9 +1239,9 @@ <para>Output directory</para> </entry> <entry> - <para><diffmk:wrapper diffmk:change="changed">Path to a directory where all output will be written by default. It's possible + <para>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> + files will be overwritten, so be sure to specify the correct directory.</para> </entry> </row> <row> @@ -1293,13 +1294,13 @@ <para>Generate basic typed composite ids</para> </entry> <entry> - <para><diffmk:wrapper diffmk:change="changed">A table that has a multi-column primary key a &lt;composite-id&gt; mapping + <para>A table that has a multi-column primary key a &lt;composite-id&gt; 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 - </diffmk:wrapper><code>&lt;key-many-to-one&gt;</code><diffmk:wrapper diffmk:change="changed"> instead. Note: a - </diffmk:wrapper><code>&lt;many-to-one&gt;</code><diffmk:wrapper diffmk:change="changed"> property is still created, but is simply marked - as non-updatable and non-insertable.</diffmk:wrapper></para> + <code>&lt;key-many-to-one&gt;</code> instead. Note: a + <code>&lt;many-to-one&gt;</code> property is still created, but is simply marked + as non-updatable and non-insertable.</para> </entry> </row> <row> @@ -1672,11 +1673,11 @@ </figure> <section> <title>Java property/class completion</title> - <para><diffmk:wrapper diffmk:change="changed">Package, class, and field completion is enabled for relevant XML attributes. The + <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. - </diffmk:wrapper><code>&lt;property&gt;</code><diffmk:wrapper diffmk:change="changed"> and only shows the properties/fields available in the - enclosing </diffmk:wrapper><code>&lt;class&gt;</code><diffmk:wrapper diffmk:change="changed"> , </diffmk:wrapper><code>&lt;subclass&gt;</code><diffmk:wrapper diffmk:change="changed"> etc. It is also - possible to navigate from the </diffmk:wrapper><emphasis> + <code>&lt;property&gt;</code> and only shows the properties/fields available in the + enclosing <code>&lt;class&gt;</code> , <code>&lt;subclass&gt;</code> etc. It is also + possible to navigate from the <emphasis> <property moreinfo="none">hbm.xml</property> </emphasis> files to the relevant class/field in java code.</para> <figure float="0"> @@ -1737,8 +1738,8 @@ <title>Configuration property completion</title> <para>In <emphasis> <property moreinfo="none">cfg.xml</property> - </emphasis> code completion for the value of <code>&lt;property&gt; name</code><diffmk:wrapper diffmk:change="changed"> attributes - is available.</diffmk:wrapper></para> + </emphasis> code completion for the value of <code>&lt;property&gt; name</code> attributes + is available.</para> <figure float="0"> <title>Property Completion</title> <mediaobject> @@ -1783,14 +1784,14 @@ </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 + <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.</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> + 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"> @@ -1805,12 +1806,12 @@ <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> + </emphasis> to invoke the content assist. It will suggest <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> + </emphasis> which is the prefix for all hibernate properties. After selecting <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> + </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> @@ -1830,8 +1831,8 @@ </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> + <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> @@ -1873,8 +1874,8 @@ <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><diffmk:wrapper diffmk:change="changed"> can be started via - </diffmk:wrapper><emphasis> + </emphasis> file the <property moreinfo="none">Reverse Engineering File Wizard</property> can be started via + <emphasis> <property moreinfo="none">Ctrl+N</property> </emphasis> and <emphasis> <property moreinfo="none">Hibernate &gt; Hibernate Reverse Engineering File (reveng.xml)</property> @@ -1912,8 +1913,8 @@ </figure> <para>The <emphasis> <property moreinfo="none">Table Filter</property> - </emphasis><diffmk:wrapper diffmk:change="changed"> page allows you to specify which tables to include and exclude. Pressing - </diffmk:wrapper><emphasis> + </emphasis> page allows you to specify which tables to include and exclude. Pressing + <emphasis> <property moreinfo="none">Refresh</property> </emphasis> shows the tables from the database that have not yet been excluded.</para> <figure float="0"> @@ -1962,7 +1963,7 @@ </imageobject> </mediaobject> </figure> - <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> + <para>Now that you have configured all necessary parts, you can learn how to work with <property moreinfo="none">Hibernate Console Perspective</property>.</para> </section> <section id="hib_console"> <title>Hibernate Console Perspective</title> @@ -2023,10 +2024,10 @@ </imageobject> </mediaobject> </figure> - <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> + <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><diffmk:wrapper diffmk:change="changed"> menu. </diffmk:wrapper></para> + </emphasis> menu. </para> <figure float="0"> <title>View menu</title> <mediaobject> @@ -2037,12 +2038,12 @@ </figure> <para>If you will select <emphasis> <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> + </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><diffmk:wrapper diffmk:change="changed"> will appear on the diagram. You can connect any diagram item to it.To connect + </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.</diffmk:wrapper></para> + the items will be moved together with it as a whole.</para> <figure float="0"> <title>Moving the Ruler guide</title> <mediaobject> @@ -2065,8 +2066,8 @@ <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><diffmk:wrapper diffmk:change="changed"> which - is available in the structural and graphical modes.</diffmk:wrapper></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> <figure float="0"> <title>Navigating in the Structural Mode</title> <mediaobject> @@ -2085,8 +2086,8 @@ </imageobject> </mediaobject> </figure> - <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> + <para>The options in the context menu of the mapping diagram are listed in the next + table.</para> <table> <title>Context Menu Options of the Mapping Diagram</title> <tgroup cols="3"> @@ -2120,7 +2121,7 @@ <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> + <entry>Allows to select what types of connections should be shown on the diagram: <itemizedlist> <listitem> <para>Property Mappings</para> </listitem> @@ -2140,27 +2141,27 @@ <para></para> </entry> <entry> - <para><diffmk:wrapper diffmk:change="changed">Select All</diffmk:wrapper></para> + <para>Select All</para> </entry> <entry> - <para><diffmk:wrapper diffmk:change="changed">Makes all the diagram elements selected</diffmk:wrapper></para> + <para>Makes all the diagram elements selected</para> </entry> </row> <row> <entry> <para> - <inlinemediaobject diffmk:change="added"> - <imageobject diffmk:change="added"> - <imagedata diffmk:change="added" fileref="images/plugins/autoLayout.png"></imagedata> + <inlinemediaobject> + <imageobject> + <imagedata fileref="images/plugins/autoLayout.png"></imagedata> </imageobject> </inlinemediaobject> </para> </entry> <entry> - <para><diffmk:wrapper diffmk:change="changed">Auto layout</diffmk:wrapper></para> + <para>Auto layout</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> + <para>Used to dispose all the items of the diagram in a standard manner</para> </entry> </row> <row> @@ -2177,8 +2178,8 @@ <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> + <para>Allows to export a diagram as <emphasis><property moreinfo="none">.png + </property>,</emphasis> <emphasis> <property moreinfo="none">.jpeg</property> </emphasis> or <emphasis> @@ -2189,8 +2190,8 @@ </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> + <para>When you open the context menu while clicking an item on the diagram, it quite differs + from the one described before.</para> <figure float="0"> <title>Context Menu in Mapping Item</title> <mediaobject> @@ -2225,17 +2226,17 @@ <para> <inlinemediaobject> <imageobject> - <imagedata fileref="images/plugins/openSourceFile_but.png"/> + <imagedata fileref="images/plugins/openSourceFile_but.png"></imagedata> </imageobject> </inlinemediaobject> </para> </entry> <entry> - <para><diffmk:wrapper diffmk:change="changed">Open Source File</diffmk:wrapper></para> + <para>Open Source File</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> + <para>Makes it possible to open a source file for a chosen object/element. The + selected element will be highlighted in the open file.</para> </entry> </row> <row> @@ -2243,17 +2244,17 @@ <para> <inlinemediaobject> <imageobject> - <imagedata fileref="images/plugins/openMappingFile_but.png"/> + <imagedata fileref="images/plugins/openMappingFile_but.png"></imagedata> </imageobject> </inlinemediaobject> </para> </entry> <entry> - <para><diffmk:wrapper diffmk:change="changed">Open Mapping File</diffmk:wrapper></para> + <para>Open Mapping File</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> + <para>Makes it possible to open a mapping file for a chosen object/element. The + selected element will be highlighted in the open file.</para> </entry> </row> <row> @@ -2261,16 +2262,16 @@ <para> <inlinemediaobject> <imageobject> - <imagedata fileref="images/plugins/visibleState.png"/> + <imagedata fileref="images/plugins/visibleState.png"></imagedata> </imageobject> </inlinemediaobject> </para> </entry> <entry> - <para><diffmk:wrapper diffmk:change="changed">Show|Hide shape(s)</diffmk:wrapper></para> + <para>Show|Hide shape(s)</para> </entry> <entry> - <para><diffmk:wrapper diffmk:change="changed">Used to hide/show an item on the mapping diagram</diffmk:wrapper></para> + <para>Used to hide/show an item on the mapping diagram</para> </entry> </row> <row> @@ -2278,16 +2279,16 @@ <para> <inlinemediaobject> <imageobject> - <imagedata fileref="images/plugins/expandState.png"/> + <imagedata fileref="images/plugins/expandState.png"></imagedata> </imageobject> </inlinemediaobject> </para> </entry> <entry> - <para><diffmk:wrapper diffmk:change="changed">Expand|Collapse shape(s)</diffmk:wrapper></para> + <para>Expand|Collapse shape(s)</para> </entry> <entry> - <para><diffmk:wrapper diffmk:change="changed">Used for expanding/collapsing fields of the item</diffmk:wrapper></para> + <para>Used for expanding/collapsing fields of the item</para> </entry> </row> </tbody> @@ -2297,8 +2298,8 @@ <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> + <para>The below table lists the actions that could be performed using the keyboard keys (or + keys combinations).</para> <table> <title>Hibernate Mapping Diagram Shortcut Keys</title> <tgroup cols="2"> @@ -2358,13 +2359,13 @@ </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> + <para>It's possible to save the diagram in the eclipse workspace. Click the usual + <emphasis> <property moreinfo="none">File &gt; Save As</property> - </emphasis><diffmk:wrapper diffmk:change="changed"> option, the wizard will ask you to set the location within you project where + </emphasis> 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> + with the <literal moreinfo="none">.hibernate</literal> extension.</para> <figure float="0"> <title>The Diagram saved in the Workspace</title> <mediaobject> @@ -2375,9 +2376,9 @@ </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 + <para>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> + should perform the refreshing.</para> </tip> <figure float="0"> <title>The Diagram after Restarting the Eclipse</title> @@ -2395,141 +2396,141 @@ </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> + <para>There are some useful commands in the toolbar.</para> + <figure float="0"> + <title>The Diagram View Toolbar</title> + <mediaobject> + <imageobject> + <imagedata 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> + <para>They are described in the table below.</para> + <table> + <title>Command in Diagram View Toolbar </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" diffmk:change="added"> - <para diffmk:change="added"><diffmk:wrapper diffmk:change="added">Command</diffmk:wrapper></para> + <entry align="center"> + <para>Command</para> </entry> - <entry align="center" diffmk:change="added"> - <para diffmk:change="added"><diffmk:wrapper diffmk:change="added">Description</diffmk:wrapper></para> + <entry align="center"> + <para>Description</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> + <tbody> + <row> + <entry> + <para> + <inlinemediaobject> + <imageobject> + <imagedata 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> + <para>Refresh Visual Mapping</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> + <para>It update <property moreinfo="none">Mapping Diagram</property> if <property moreinfo="none">Console + Configuration</property> was changed. </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> + <row> + <entry> + <para> + <inlinemediaobject> + <imageobject> + <imagedata 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> + <para>Zoom Box</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> + <para>Used to define scale of the diagram. Also it's used for <property moreinfo="none">Mapping + Diagram</property> printing. If you want to put the whole <property moreinfo="none">diagram</property> to one print page, you need select <property moreinfo="none">Page</property> option in the <property moreinfo="none">Zoom Box</property>.</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> + <row> + <entry> + <para> + <inlinemediaobject> + <imageobject> + <imagedata 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> + <para>Auto layout</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> + <para>Used to arrange all diagram items in a standard manner.</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> + <row> + <entry> + <para> + <inlinemediaobject> + <imageobject> + <imagedata 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> + <para>Show|Hide connections</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> + <para>Used to show or hide connection on the diagram. Moreover you can choose what + type of connections must be present on the diagram (<property moreinfo="none">Property + Mappings</property>, <property moreinfo="none">Class Mappings</property>, <property moreinfo="none">Associations</property> or <property moreinfo="none">Foreign key constraints</property>) + .</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> + <row> + <entry> + <para> + <inlinemediaobject> + <imageobject> + <imagedata 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> + <para>Expand|Collapse</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> + <para>Used for expanding/collapsing fields of the item.</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> + <row> + <entry> + <para> + <inlinemediaobject> + <imageobject> + <imagedata 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> + <para> Show|Hide shape(s)</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> + <para>Used to hide/show an item on the mapping diagram.</para> </entry> </row> </tbody> @@ -2540,14 +2541,14 @@ <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><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">Criteria Editor</property>. To execute a query you should click the green run + button in the editor toolbar or press <emphasis> <property moreinfo="none">Ctrl+Enter</property> </emphasis>.</para> <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> + <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> @@ -2558,93 +2559,93 @@ </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> + <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><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> + <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><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> + </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><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> + </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"><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"> + </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 diffmk:change="added"> - <imageobject diffmk:change="added" role="fo"> + <mediaobject> + <imageobject role="fo"> <imagedata align="center" fileref="images/plugins/plugins_19.png" format="PNG" scale="80"></imagedata> </imageobject> - <imageobject diffmk:change="added" role="html"> + <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><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> + </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 diffmk:change="added" float="0"> + <figure float="0"> <title>Quick Fix Option Demonstration</title> - <mediaobject diffmk:change="added"> - <imageobject diffmk:change="added"> + <mediaobject> + <imageobject> <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 + <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.</diffmk:wrapper></para> - <figure diffmk:change="added" float="0"> + appeared confirmation dialog.</para> + <figure float="0"> <title>Updating Java Code</title> - <mediaobject diffmk:change="added"> - <imageobject diffmk:change="added"> + <mediaobject> + <imageobject> <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> + <para>Also you can pin <property moreinfo="none">HQL editor</property> and <property moreinfo="none">Criteria + editor</property> for one tab in <property moreinfo="none">Hibernate Query Result</property> view. For + that you need click on <property moreinfo="none">Stick result to one tab</property> + button(<inlinemediaobject> + <imageobject> + <imagedata 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-&gt;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> + </inlinemediaobject> ). In the issue query executions results will be shown in one tab (no + more will be opened). </para> + <para> Moreover you are able to rename tab in <property moreinfo="none">Hibernate Query Result</property>. + Click the tab, and type a new name in <property moreinfo="none">Property View-&gt;Tab name field</property>. </para> + <figure float="0"> + <title>Tab Renaming</title> + <mediaobject> + <imageobject> + <imagedata 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 + <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 </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"> + 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><diffmk:wrapper diffmk:change="changed"> thus without any + <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.</diffmk:wrapper></para> + number of elements returned.</para> </note> </section> <section> @@ -2669,8 +2670,8 @@ </section> <section> <title>Properties View</title> - <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> + <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> <figure float="0"> <title>Properties View</title> <mediaobject> @@ -2682,7 +2683,7 @@ </imageobject> </mediaobject> </figure> - <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> + <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> <figure float="0"> <title>Properties View for Selected Object</title> <mediaobject> @@ -2694,14 +2695,14 @@ </imageobject> </mediaobject> </figure> - <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> + <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> </section> </section> <section id="jpa_annotations"> - <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> + <title>Hibernate:add JPA annotations refactoring </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> @@ -2743,7 +2744,7 @@ <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> + </emphasis> - this annotations are declared according to the classes hierarchy.</para> </listitem> <listitem> <para><emphasis> @@ -2755,113 +2756,113 @@ <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> + </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"><diffmk:wrapper diffmk:change="changed">Enable optimistic - locking</diffmk:wrapper></link>.</para> + </emphasis> is declared in case you select <link linkend="optim_lock">Enable optimistic + locking</link>.</para> </listitem> </itemizedlist> <note> <title>Note:</title> - <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> + <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> </note> - <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> + <para>To open this wizard you should right click the class you want to enrich with annotations + <emphasis> <property moreinfo="none">&gt;Source&gt;Generate Hibernate/JPA annotations</property> - </emphasis><diffmk:wrapper diffmk:change="changed">. You will see the Hibernate:add JPA annotations dialog. </diffmk:wrapper></para> + </emphasis>. You will see the Hibernate:add JPA annotations dialog. </para> <figure float="0"> - <title><diffmk:wrapper diffmk:change="changed">Starting Hibernate:add JPA annotations dialog</diffmk:wrapper></title> + <title>Starting Hibernate:add JPA annotations dialog</title> <mediaobject> <imageobject> <imagedata fileref="images/plugins/annotations1.png"></imagedata> </imageobject> </mediaobject> </figure> - <para><diffmk:wrapper diffmk:change="added"> In the top of it you can see the list of all classes that will be passed through + <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. 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> + want to add new classes or package to the list of classes, you should click the <property moreinfo="none">Back</property> button. In result you will see <property moreinfo="none">Add classes and + packages</property> page.</para> + <figure float="0"> + <title>Add classes and packages page </title> + <mediaobject> + <imageobject> + <imagedata 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> + <para>Here you can add one more classes or whole package, moreover you can limit dependencies + depth by selecting <property moreinfo="none">depth control</property> option (more about this option you will + find in <link linkend="depth_control">Creating a Hibernate Mapping File</link>). When finished + just press the <property moreinfo="none">Next</property> button and you will be returned to <property moreinfo="none">The + following classes will be changed</property> page and will be able to continue work with + it.</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><diffmk:wrapper diffmk:change="changed"> dropdownlist and then all the annotations will be added to the getter methods. If - you choose </diffmk:wrapper><emphasis> + </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><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> + </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><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> + </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><diffmk:wrapper diffmk:change="changed"> checkbox. This operation will add version property to all the selected classes. + </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 - - </diffmk:wrapper><emphasis> + <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> + </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><diffmk:wrapper diffmk:change="changed"> and follow the next wizard steps. </diffmk:wrapper></para> + </emphasis> and follow the next wizard steps. </para> <figure float="0"> <title>Hibernate:add JPA annotations view</title> - <mediaobject diffmk:change="added"> - <imageobject diffmk:change="added"> + <mediaobject> + <imageobject> <imagedata fileref="images/plugins/annotations2.png"></imagedata> </imageobject> </mediaobject> </figure> - <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"> + <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 diffmk:change="added"> + <imageobject> <imagedata fileref="images/plugins/butt2.png"></imagedata> </imageobject> </inlinemediaobject> ,<inlinemediaobject> - <imageobject diffmk:change="added"> + <imageobject> <imagedata fileref="images/plugins/butt3.png"></imagedata> </imageobject> </inlinemediaobject> ,<inlinemediaobject> - <imageobject diffmk:change="added"> + <imageobject> <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 + </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. </diffmk:wrapper></para> + list of classes that need refactoring. </para> <figure float="0"> <title>List of classes that need refactoring</title> - <mediaobject diffmk:change="added"> - <imageobject diffmk:change="added"> + <mediaobject> + <imageobject> <imagedata fileref="images/plugins/annotations3.png"></imagedata> </imageobject> </mediaobject> @@ -2874,10 +2875,10 @@ <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><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> + <para><property moreinfo="none">Error Log View</property><diffmk:wrapper diffmk:change="changed"> 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 moreinfo="none">Hibernate Console Configuration</property>.</para> + <para>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 @@ -2893,191 +2894,193 @@ <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 &gt; Other &gt; JPA &gt; JPA Project</property> - </emphasis> (or simply <emphasis> - <property moreinfo="none">New &gt; 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> - <imageobject> - <imagedata fileref="images/plugins/dali_integration1.png"></imagedata> - </imageobject> - </mediaobject> - </figure> - <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> - <imageobject> - <imagedata fileref="images/plugins/dali_integration2.png"></imagedata> - </imageobject> - </mediaobject> - </figure> - <note> - <title>Note:</title> - <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> + <section id="jpa_project_with_hibernate"> + <title>Creating JPA project with Hibernate support</title> + <para>When starting a new JPA project from <emphasis> + <property moreinfo="none">New &gt; Other &gt; JPA &gt; JPA Project</property> + </emphasis> (or simply <emphasis> + <property moreinfo="none">New &gt; JPA Project</property> + </emphasis> in <property moreinfo="none">JPA Perspective</property><diffmk:wrapper diffmk:change="changed">), the first wizard page looks as + follows.</diffmk:wrapper></para> + <figure diffmk:change="added" float="0"> + <title>Starting JPA Project</title> + <mediaobject diffmk:change="added"> + <imageobject diffmk:change="added"> + <imagedata fileref="images/plugins/dali_integration1.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + <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><diffmk:wrapper diffmk:change="changed">On the JPA Facet page you should choose Hibernate as a target platform. Also select the + proper database connection, if it is defined, or add a new one by clicking the </diffmk:wrapper><emphasis> + <property moreinfo="none">Add connection</property> + </emphasis> link.</para> + <para>Hitting <emphasis> + <property moreinfo="none">Finish</property> + </emphasis> will generate the project.</para> + <figure diffmk:change="added" float="0"> + <title>Targeting at Hibernate Platform</title> + <mediaobject diffmk:change="added"> + <imageobject diffmk:change="added"> + <imagedata fileref="images/plugins/dali_integration2.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + <note diffmk:change="added"> + <title>Note:</title> + <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> </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 &gt; Generate Tables from Entities/Generate Entities from Tables</property> - </emphasis> options in the context menu of your JPA project.</para> - <figure float="0"> - <title>Generate DDL/Entities</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/plugins/dali_integration3.png"></imagedata> - </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><diffmk:wrapper diffmk:change="changed"> first will ask you to choose the - directory where all output will be written.</diffmk:wrapper></para> - <figure float="0"> - <title>Generate Entities Wizard</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/plugins/dali_integration4.png"></imagedata> - </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> - </emphasis> checkbox is selected and choose a needed configuration from the <emphasis> - <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> - <imageobject> - <imagedata fileref="images/plugins/dali_integration5.png"></imagedata> - </imageobject> - </mediaobject> - </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> - </listitem> - </itemizedlist> - <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> - + <section id="generate_ddl_entities_with_hibernate"> + <title>Generating DDL and Entities</title> + <para><diffmk:wrapper diffmk:change="changed">By enabling Hibernate platform specific features you can now generate DDL and Entities. + For that find </diffmk:wrapper><emphasis> + <property moreinfo="none"><diffmk:wrapper diffmk:change="changed">JPA Tools &gt; Generate Tables from Entities/Generate Entities from + Tables</diffmk:wrapper></property> + </emphasis> options in the context menu of your JPA project.</para> + <figure diffmk:change="added" float="0"> + <title>Generate DDL/Entities</title> + <mediaobject diffmk:change="added"> + <imageobject diffmk:change="added"> + <imagedata fileref="images/plugins/dali_integration3.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + <note diffmk:change="added"> + <title>Note:</title> + <para><diffmk:wrapper diffmk:change="changed">Please, remember to put the proper database driver to the classpath of your + project.</diffmk:wrapper></para> + </note> + <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 diffmk:change="added" float="0"> + <title>Generate Entities Wizard</title> + <mediaobject diffmk:change="added"> + <imageobject diffmk:change="added"> + <imagedata fileref="images/plugins/dali_integration4.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + <para>To generate entities you can use:</para> + <itemizedlist diffmk:change="added"> + <listitem diffmk:change="added"> + <para>a Hibernate Console Configuration (proposed by default)</para> + <para>Just make sure that the <emphasis> + <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> + <figure diffmk:change="added" float="0"> + <title>Generate Entities Wizard</title> + <mediaobject diffmk:change="added"> + <imageobject diffmk:change="added"> + <imagedata fileref="images/plugins/dali_integration5.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> + </mediaobject> + </figure> + </listitem> + </itemizedlist> + <itemizedlist diffmk:change="added"> + <listitem diffmk:change="added"> + <para>or a DTP connection directly</para> + <para>Just uncheck <emphasis> + <property moreinfo="none">Use Console Configuration</property> + </emphasis> and adjust database settings.</para> + </listitem> + </itemizedlist> + <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 diffmk:change="added" float="0"> + <title>Generate DDL Wizard</title> + <mediaobject diffmk:change="added"> + <imageobject diffmk:change="added"> + <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 id="hibernate_annotations_support"> + <title>Hibernate Annotations Support</title> + <para>Also Hibernate Annotations are supported in <property moreinfo="none"><diffmk:wrapper diffmk:change="changed">Dali Java Persistence + Tools</diffmk:wrapper></property><diffmk:wrapper diffmk:change="changed">. The next annotations are integrated with </diffmk:wrapper><property moreinfo="none"><diffmk:wrapper diffmk:change="changed">JPA + Details</diffmk:wrapper></property> view:</para> + <itemizedlist> + <listitem> + <para>Id Generator annotations - <property moreinfo="none">@GenericGenerator</property> and <property moreinfo="none">@GeneratedValue</property></para> + <figure float="0"> + <title>@GenericGenerator support in Dali</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/plugins/dali_integration7.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + <figure float="0"> + <title>@GeneratedValue support in Dali</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/plugins/dali_integration8.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + </listitem> + <listitem> + <para>Property annotations- <property moreinfo="none">@DiscriminatorFormula</property>, <property moreinfo="none">@Generated Annotation</property>, <property moreinfo="none">@Index annotation</property></para> + <figure float="0"> + <title>@Index support in Dali</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/plugins/dali_integration9.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + </listitem> + <listitem> + <para>Mapping Queries annotations - <property moreinfo="none">@NamedQuery</property> and <property moreinfo="none">@NamedNativeQuery</property></para> + <figure float="0"> + <title>Add New Named Query Dialog with Hibernate Support</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/plugins/dali_integration10.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + <figure float="0"> + <title>@NamedQuery support in Dali</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/plugins/dali_integration11.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + </listitem> + <listitem diffmk:change="added"> + <para diffmk:change="added"><diffmk:wrapper diffmk:change="added">Association annotations in an </diffmk:wrapper><property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">embeddable</diffmk:wrapper></property><diffmk:wrapper diffmk:change="added"> object (</diffmk:wrapper><property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">@OneToOne</diffmk:wrapper></property><diffmk:wrapper diffmk:change="added">, </diffmk:wrapper><property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">@ManyToOne</diffmk:wrapper></property><diffmk:wrapper diffmk:change="added">, </diffmk:wrapper><property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">@OneToMany</diffmk:wrapper></property><diffmk:wrapper diffmk:change="added"> or </diffmk:wrapper><property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">@ManyToMany</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">Hibernate Support for Embeddable Object</diffmk:wrapper></title> + <mediaobject diffmk:change="added"> + <imageobject diffmk:change="added"> + <imagedata diffmk:change="added" fileref="images/plugins/dali_integration12.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + </listitem> + </itemizedlist> + <para>More information about Hibernate Annotation you can find in <ulink url="http://docs.jboss.org/hibernate/stable/annotations/reference/en... diffmk:change="changed">Hibernate + Annotations Reference Guide</diffmk:wrapper></ulink>. </para> + </section> + <section> + <title>Relevant Resources Links</title> + <para>There is full information about native Dali plugin features on <ulink url="http://help.eclipse.org/galileo/index.jsp?nav=/8"><d... diffmk:change="changed">Eclipse Documentation + page</diffmk:wrapper></ulink>.</para> + </section> </section> - </chapter> @@ -5803,9 +5806,9 @@ <para>The rest chapters have shown the aspects of using the <property moreinfo="none">Hibernate Tools</property> via Ant tasks.</para> - - <para>Please, visit <ulink url="http://www.jboss.com/index.html?module=bb&amp;op=viewforum&... - Tools Users Forum</ulink> to leave questions or/and suggestions on the topic. Your + <para>Please, visit <ulink + url="http://www.jboss.com/index.html?module=bb&amp;op=viewforum&... + Tools Users Forum</ulink> to leave questions or/and suggestions on the topic. Your feedback is always appreciated.</para> </section> </section> Modified: tags/jbosstools-3.1.1.GA/hibernatetools/docs/reference/en-US/plugins.xml =================================================================== --- tags/jbosstools-3.1.1.GA/hibernatetools/docs/reference/en-US/plugins.xml 2010-06-08 23:38:52 UTC (rev 22649) +++ tags/jbosstools-3.1.1.GA/hibernatetools/docs/reference/en-US/plugins.xml 2010-06-08 23:43:43 UTC (rev 22650) @@ -23,16 +23,21 @@ </note> <section id="download_base_project"> <title>Download base project</title> - <para>You can download example projects which are used as base for this chapter.</para> - <para><property>JPA base project</property> is available <ulink url="http://anonsvn.jboss.org/repos/jbosstools/trunk//hibernatetools... - and base <property>Java project</property> is situated <ulink url="http://anonsvn.jboss.org/repos/jbosstools/trunk//hibernatetools... - <para>Also you need start <ulink url="http://anonsvn.jboss.org/repos/jbosstools/trunk//hibernatetools... + <para>You can download example projects which are used for this chapter.</para> + <para><property>JPA base project</property> is available on <ulink + url="http://docs.jboss.org/tools/resources/">documentation resources page </ulink> + together with <ulink + url="http://docs.jboss.org/tools/resources/TestHibernateproject_for_... + >base Java project</ulink>.</para> + <para>Also you need start <ulink url="http://docs.jboss.org/tools/resources/GSG_database.zip" + >database</ulink>.</para> <note> <title>Note:</title> - <para>How to run database you can know in <ulink url="http://docs.jboss.org/tools/3.0.1.GA/en/GettingStartedGuide/htm... Started Guide</ulink>.</para> + <para>How to run database you can know in <ulink + url="http://docs.jboss.org/tools/3.0.1.GA/en/GettingStartedGuide/htm... + >Getting Started Guide</ulink>.</para> </note> </section> - </section> <section id="map_file_wizard"> <title>Creating a Hibernate Mapping File</title> @@ -46,9 +51,9 @@ <para>At first you&apos;ll be asked to select a package or multiple individual classes to map. It's also possible to create an empty file, don&apos;t select any packages or classes and an empty .hbm will be created in the specified location</para> - <para id="depth_control">With <property>depth control</property> 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). </para> + <para id="depth_control">With <property>depth control</property> 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). </para> <figure> <title>Hibernate XML Mapping File Wizard</title> <mediaobject> @@ -57,7 +62,10 @@ </imageobject> </mediaobject> </figure> - <para>The next wizard page lists the mappings to be generated. As you see <property>Customers</property>, <property>Orders</property>, <property>Productlines</property> and <property>Products</property> classes added under <property>depth control</property> driving. </para> + <para>The next wizard page lists the mappings to be generated. As you see <property + >Customers</property>, <property>Orders</property>, <property>Productlines</property> and + <property>Products</property> classes added under <property>depth control</property> + driving. </para> <figure> <title>Mappings to be generated</title> <mediaobject> @@ -66,7 +74,6 @@ </imageobject> </mediaobject> </figure> - <para>This wizard page outputs a generated .hbm files preview.</para> <figure> <title>Preview Generated Mapping Files</title> @@ -175,8 +182,8 @@ </figure> <para>The following table describes the available settings on the <emphasis> <property>Main</property> - </emphasis> 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.</para> + </emphasis> 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.</para> <table> <title>Hibernate Console Configuration Parameters</title> <tgroup cols="3"> @@ -276,8 +283,8 @@ <para>Name of the persistence unit to use</para> </entry> <entry> - <para>No default value (let Hibernate Entity Manager find the persistence unit or - it can be defined manually using Browse button)</para> + <para>No default value (let Hibernate Entity Manager find the persistence unit or it + can be defined manually using Browse button)</para> </entry> </row> </tbody> @@ -285,7 +292,7 @@ </table> <tip> <title>Tip:</title> - <para>The two latter settings are usually not required if you specify a project and it has + <para>The two latter settings are usually not required if you specify a project and it has <emphasis> <property> <literal> /hibernate.cfg.xml </literal> @@ -341,8 +348,8 @@ <para>Database dialect</para> </entry> <entry> - <para>Define a database dialect. It&apos;s possible either to write your value or choose - from list. </para> + <para>Define a database dialect. It&apos;s possible either to write your value or + choose from list. </para> </entry> <entry> <para>No default value</para> @@ -541,7 +548,8 @@ <listitem> <para>right-click on the configuration in <emphasis> <property>Hibernate Configurations View->Edit Configuration </property> - </emphasis> or just double-click on <property>Console Configuration</property> item.</para> + </emphasis> or just double-click on <property>Console Configuration</property> + item.</para> <figure> <title>Opening Edit Configuration Wizard</title> <mediaobject> @@ -663,8 +671,8 @@ <entry> <para>Choose between &quot;CORE&quot;, &quot;ANNOTATIONS&quot; and &quot;JPA&quot; 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.</para> + use. Note, 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> @@ -676,10 +684,10 @@ </listitem> </itemizedlist> </section> - <section id='closing_conf_config'> + <section id="closing_conf_config"> <title>Closing Hibernate Console Configuration</title> - <para>To close <property>Hibernate Console Configuration</property> you need do right-click your configuration - and choose <property>Close Configuration</property> option </para> + <para>To close <property>Hibernate Console Configuration</property> you need do right-click + your configuration and choose <property>Close Configuration</property> option </para> <figure> <title>Close Hibernate Console Configuration</title> <mediaobject> @@ -2451,10 +2459,11 @@ <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>Error Log View</property> in Eclipse.</para> - <para><property>Error Log View</property> is very useful tool to solve any problem which appears in Hibernate Tools Plugins. - You can use if there are troubles with setting up <property>Hibernate Console Configuration</property>.</para> + <para><property>Error Log View</property> is very useful tool to solve any problem which appears + in Hibernate Tools Plugins. You can use if there are troubles with setting up <property + >Hibernate Console Configuration</property>.</para> <para>This is done by editing the <emphasis> - <property>hibernate-log4j.properties</property> + <property>hibernate-log4j.properties</property> </emphasis> in <emphasis> <property>org.hibernate.eclipse/ directory/jar</property> </emphasis>. This file includes a default configuration that only logs WARN and above to a set @@ -2475,187 +2484,196 @@ JPA development platform.</para> <section id="jpa_project_with_hibernate"> <title>Creating JPA project with Hibernate support</title> - <para>When starting a new JPA project from <emphasis> - <property>New &gt; Other &gt; JPA &gt; JPA Project</property> - </emphasis> (or simply <emphasis> - <property>New &gt; JPA Project</property> - </emphasis> in <property>JPA Perspective</property>), the first wizard page looks as - follows.</para> - <figure> - <title>Starting JPA Project</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/plugins/dali_integration1.png"/> - </imageobject> - </mediaobject> - </figure> - <para>It&apos;s possible here to select a target runtime and change the project configuration, - or you can leave everything as it is.</para> - <para>On the JPA Facet page you should choose Hibernate as a target platform. Also select the - proper database connection, if it is defined, or add a new one by clicking the <emphasis> - <property>Add connection</property> - </emphasis> link.</para> - <para>Hitting <emphasis> - <property>Finish</property> - </emphasis> will generate the project.</para> - <figure> - <title>Targeting at Hibernate Platform</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/plugins/dali_integration2.png"/> - </imageobject> - </mediaobject> - </figure> - <note> - <title>Note:</title> - <para>Please note, if you choose Hibernate as a platform while creating a JPA/Dali project, a - Hibernate Console Configuration for the project is created automatically when the wizard - finishes its work. It allows a full usage of <property>Hibernate Tools</property> features - without additional setup.</para> - </note> + <para>When starting a new JPA project from <emphasis> + <property>New &gt; Other &gt; JPA &gt; JPA Project</property> + </emphasis> (or simply <emphasis> + <property>New &gt; JPA Project</property> + </emphasis> in <property>JPA Perspective</property>), the first wizard page looks as + follows.</para> + <figure> + <title>Starting JPA Project</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/plugins/dali_integration1.png"/> + </imageobject> + </mediaobject> + </figure> + <para>It&apos;s possible here to select a target runtime and change the project configuration, + or you can leave everything as it is.</para> + <para>On the JPA Facet page you should choose Hibernate as a target platform. Also select the + proper database connection, if it is defined, or add a new one by clicking the <emphasis> + <property>Add connection</property> + </emphasis> link.</para> + <para>Hitting <emphasis> + <property>Finish</property> + </emphasis> will generate the project.</para> + <figure> + <title>Targeting at Hibernate Platform</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/plugins/dali_integration2.png"/> + </imageobject> + </mediaobject> + </figure> + <note> + <title>Note:</title> + <para>Please note, if you choose Hibernate as a platform while creating a JPA/Dali project, + a Hibernate Console Configuration for the project is created automatically when the wizard + finishes its work. It allows a full usage of <property>Hibernate Tools</property> features + without additional setup.</para> + </note> </section> - <section id="generate_ddl_entities_with_hibernate"> - <title>Generating DDL and Entities</title> - <para>By enabling Hibernate platform specific features you can now generate DDL and Entities. - For that find <emphasis> - <property>JPA Tools > Generate Tables from Entities/Generate Entities from Tables</property> - </emphasis> options in the context menu of your JPA project.</para> - <figure> - <title>Generate DDL/Entities</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/plugins/dali_integration3.png"/> - </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>Generate Entities wizard</property> first will ask you to choose the - directory where all output will be written.</para> - <figure> - <title>Generate Entities Wizard</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/plugins/dali_integration4.png"/> - </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>Use Console Configuration</property> - </emphasis> checkbox is selected and choose a needed configuration from the <emphasis> - <property>Console configurations</property> - </emphasis> list box.</para> - <figure> - <title>Generate Entities Wizard</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/plugins/dali_integration5.png"/> - </imageobject> - </mediaobject> - </figure> - </listitem> - </itemizedlist> - <itemizedlist> - <listitem> - <para>or a DTP connection directly</para> - <para>Just uncheck <emphasis> - <property>Use Console Configuration</property> - </emphasis> and adjust database settings.</para> - </listitem> - </itemizedlist> - <para>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> - <title>Generate DDL Wizard</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/plugins/dali_integration6.png"/> - </imageobject> - </mediaobject> - </figure> - <para>Thus, you can now have the Hibernate runtime support in Eclipse JPA projects.</para> - </section> - <section id="hibernate_annotations_support"> + <section id="generate_ddl_entities_with_hibernate"> + <title>Generating DDL and Entities</title> + <para>By enabling Hibernate platform specific features you can now generate DDL and Entities. + For that find <emphasis> + <property>JPA Tools > Generate Tables from Entities/Generate Entities from + Tables</property> + </emphasis> options in the context menu of your JPA project.</para> + <figure> + <title>Generate DDL/Entities</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/plugins/dali_integration3.png"/> + </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>Generate Entities wizard</property> first will ask you to choose the + directory where all output will be written.</para> + <figure> + <title>Generate Entities Wizard</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/plugins/dali_integration4.png"/> + </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>Use Console Configuration</property> + </emphasis> checkbox is selected and choose a needed configuration from the <emphasis> + <property>Console configurations</property> + </emphasis> list box.</para> + <figure> + <title>Generate Entities Wizard</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/plugins/dali_integration5.png"/> + </imageobject> + </mediaobject> + </figure> + </listitem> + </itemizedlist> + <itemizedlist> + <listitem> + <para>or a DTP connection directly</para> + <para>Just uncheck <emphasis> + <property>Use Console Configuration</property> + </emphasis> and adjust database settings.</para> + </listitem> + </itemizedlist> + <para>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> + <title>Generate DDL Wizard</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/plugins/dali_integration6.png"/> + </imageobject> + </mediaobject> + </figure> + <para>Thus, you can now have the Hibernate runtime support in Eclipse JPA projects.</para> + </section> + <section id="hibernate_annotations_support"> <title>Hibernate Annotations Support</title> - <para>Also Hibernate Annotations are supported in <property>Dali Java Persistence Tools</property>. - The next annotations are integrated with <property>JPA Details</property> view:</para> - <itemizedlist> - <listitem> - <para>Id Generator annotations - <property>@GenericGenerator</property> and <property>@GeneratedValue</property></para> - <figure> - <title>@GenericGenerator support in Dali</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/plugins/dali_integration7.png"/> - + <para>Also Hibernate Annotations are supported in <property>Dali Java Persistence + Tools</property>. The next annotations are integrated with <property>JPA + Details</property> view:</para> + <itemizedlist> + <listitem> + <para>Id Generator annotations - <property>@GenericGenerator</property> and <property + >@GeneratedValue</property></para> + <figure> + <title>@GenericGenerator support in Dali</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/plugins/dali_integration7.png"/> </imageobject> - - </mediaobject> - </figure> - <figure> - <title>@GeneratedValue support in Dali</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/plugins/dali_integration8.png"/> - </imageobject> - - </mediaobject> - </figure> - </listitem> - <listitem> - <para>Property annotations- <property>@DiscriminatorFormula</property>, <property>@Generated Annotation</property>, <property>@Index annotation</property></para> - <figure> - <title>@Index support in Dali</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/plugins/dali_integration9.png"/> - </imageobject> - - </mediaobject> - </figure> - - </listitem> - <listitem> - <para>Mapping Queries annotations - <property>@NamedQuery</property> and <property>@NamedNativeQuery</property></para> - <figure> - <title>Add New Named Query Dialog with Hibernate Support</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/plugins/dali_integration10.png"/> - </imageobject> - - </mediaobject> - </figure> - - - - <figure> - <title>@NamedQuery support in Dali</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/plugins/dali_integration11.png"/> - </imageobject> - - </mediaobject> - </figure> - </listitem> - </itemizedlist> - <para>More information about Hibernate Annotation you can find in <ulink url="http://docs.jboss.org/hibernate/stable/annotations/reference/en... Annotations Reference Guide</ulink>. </para> - - </section> + </mediaobject> + </figure> + <figure> + <title>@GeneratedValue support in Dali</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/plugins/dali_integration8.png"/> + </imageobject> + </mediaobject> + </figure> + </listitem> + <listitem> + <para>Property annotations- <property>@DiscriminatorFormula</property>, <property + >@Generated Annotation</property>, <property>@Index annotation</property></para> + <figure> + <title>@Index support in Dali</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/plugins/dali_integration9.png"/> + </imageobject> + </mediaobject> + </figure> + </listitem> + <listitem> + <para>Mapping Queries annotations - <property>@NamedQuery</property> and <property + >@NamedNativeQuery</property></para> + <figure> + <title>Add New Named Query Dialog with Hibernate Support</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/plugins/dali_integration10.png"/> + </imageobject> + </mediaobject> + </figure> + <figure> + <title>@NamedQuery support in Dali</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/plugins/dali_integration11.png"/> + </imageobject> + </mediaobject> + </figure> + </listitem> + <listitem> + <para>Association annotations in an <property>embeddable</property> object (<property + >@OneToOne</property>, <property>@ManyToOne</property>, <property + >@OneToMany</property> or <property>@ManyToMany</property>)</para> + <figure> + <title>Hibernate Support for Embeddable Object</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/plugins/dali_integration12.png"/> + </imageobject> + </mediaobject> + </figure> + </listitem> + </itemizedlist> + <para>More information about Hibernate Annotation you can find in <ulink + url="http://docs.jboss.org/hibernate/stable/annotations/reference/en... + Annotations Reference Guide</ulink>. </para> + </section> <section> <title>Relevant Resources Links</title> - <para>There is full information about native Dali plugin features on <ulink url="http://help.eclipse.org/galileo/index.jsp?nav=/8">Eclipse Documentation page</ulink>.</para> + <para>There is full information about native Dali plugin features on <ulink + url="http://help.eclipse.org/galileo/index.jsp?nav=/8">Eclipse Documentation + page</ulink>.</para> </section> - </section> - </chapter>