[jbosstools-commits] JBoss Tools SVN: r28452 - trunk/hibernatetools/docs/reference/en-US.

Author: mcaspers Date: 2011-01-20 20:02:16 -0500 (Thu, 20 Jan 2011) New Revision: 28452 Modified: trunk/hibernatetools/docs/reference/en-US/plugins.xml Log: General Updates Modified: trunk/hibernatetools/docs/reference/en-US/plugins.xml =================================================================== --- trunk/hibernatetools/docs/reference/en-US/plugins.xml 2011-01-21 00:39:59 UTC (rev 28451) +++ trunk/hibernatetools/docs/reference/en-US/plugins.xml 2011-01-21 01:02:16 UTC (rev 28452) @@ -1324,7 +1324,7 @@ Or you can get it via the <guilabel>Code Generation Launcher</guilabel> by checking the proper section in the <guilabel>Main</guilabel> tab of the <guilabel>Getting Hibernate Code Generation Wizard</guilabel> (see <xref linkend="hib_code_gen"/>). </para> <para> - The following screenshot shows the <guilabel>Overview</guilabel> page where the wanted console configuration is selected (auto-detected if Hibernate 3 support is enabled for the project) + The following screenshot shows the <guilabel>Overview</guilabel> page where the appropriate console configuration is selected (auto-detected if Hibernate 3 support is enabled for the project). </para> <figure> <title>Overview Page</title> @@ -1337,12 +1337,9 @@ </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> + <para> + The <guilabel>Table Filter</guilabel> page allows you to specify which tables to include and exclude. Clicking the <guibutton>Refresh</guibutton> button shows the tables from the database that have not yet been excluded. + </para> <figure> <title>Table Filters Page</title> <mediaobject> @@ -1354,11 +1351,9 @@ </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 the <guibutton>Refresh</guibutton> button underneath. More about type mappings you can find further in the <xref linkend="type_map"/> section.</para> + <para> + The <guilabel>Type Mappings</guilabel> page is used to specify 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 the <guibutton>Refresh</guibutton> button underneath. For more information on type mappings please see the <xref linkend="type_map"/> section. + </para> <figure> <title>Type Mappings Page</title> <mediaobject> @@ -1370,11 +1365,9 @@ </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 <xref linkend="tab_and_col"/> section.</para> + <para> + The <guilabel>Table and Columns</guilabel> page allows you to explicit set which details (e.g. which hibernatetype and propertyname) should be used in the reverse engineered model. For more details on how to configure the tables while reverse engineering read the <xref linkend="tab_and_col"/> section. + </para> <figure> <title>Table and Columns Page</title> <mediaobject> @@ -1386,18 +1379,18 @@ </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> + <para>Now that you have configured all the necessary settings, 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 <xref linkend="console_conf"/>.</para> + <para> + The <guilabel>Hibernate Console Perspective</guilabel> 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 <guilabel>Hibernate Console Configuration</guilabel> (see <xref linkend="console_conf"/>). + </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> + <para> + To view your new configuration and entity/class structure, switch to the <guilabel>Hibernate Configurations View</guilabel>. Expanding the tree allows you to browse the class/entity structure and see the relationships. + </para> <figure> <title>Hibernate Console Perspective</title> <mediaobject> @@ -1409,17 +1402,12 @@ </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 <guibutton>Reload</guibutton> 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 <filename>.hbm.xml</filename>. + <para> + The <guilabel>Console Configuration</guilabel> does not dynamically adjust to changes done in mappings and Java code. To reload the configuration select the configuration and click the <guibutton>Reload</guibutton> button in the view toolbar or in the context menu. </para> + <para> + It is possible to open source and mapping files for objects showed in the <guilabel>Hibernate Configurations View</guilabel>. Just bring up the context menu for a necessary object and select <guimenuitem>Open Source File</guimenuitem> to see appropriate Java class or <guimenuitem>Open Mapping File</guimenuitem> to open a proper <filename>.hbm.xml</filename> file. + </para> <figure> <title>Opening Source for Objects</title> <mediaobject> @@ -1430,10 +1418,8 @@ </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> + In order to visualize on how entities are related as well as view their structures, a <guilabel>Mapping Diagram</guilabel> is provided. It is available by right clicking on the entity you want view a mapping diagram for and then choosing <guilabel>Mapping Diagram</guilabel>. </para> <figure> <title>Mapping Diagram</title> @@ -1446,10 +1432,9 @@ </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> + <para> + To make <guilabel>Mapping Diagram</guilabel> usage easier you can use <guilabel>Rules</guilabel>, <guilabel>Grid</guilabel>, <guilabel>Snap to Geometry</guilabel> checkboxes in the <guimenu>View</guimenu> menu. + </para> <figure> <title>View menu</title> <mediaobject> @@ -1458,14 +1443,9 @@ </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> + <para> + If you will select <guilabel>Rules</guilabel> 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 <guilabel>Ruler Guide</guilabel> 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> @@ -1474,9 +1454,7 @@ </imageobject> </mediaobject> </figure> - <para>If you'll select <emphasis> - <property>Grid</property> - </emphasis> checkbox, the grid will appear on the diagram.</para> + <para>If you select the <guilabel>Grid</guilabel> checkbox, the grid will appear on the diagram.</para> <figure> <title>Grid on Mapping diagram</title> <mediaobject> @@ -1485,11 +1463,8 @@ </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> + <para>The checkbox <guilabel>Snap to Geometry</guilabel> helps to put the items of the diagram into alignment with the grid.</para> + <para>For better navigating through the diagram use <guilabel>Outline view</guilabel> which is available in the structural and graphical modes.</para> <figure> <title>Navigating in the Structural Mode</title> <mediaobject> @@ -1498,8 +1473,7 @@ </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> + <para>To switch over between the modes use the buttons in the top-right corner of the <guilabel>Outline view</guilabel>.</para> <figure> <title>Navigating in the Graphical Mode</title> <mediaobject> @@ -1508,8 +1482,7 @@ </imageobject> </mediaobject> </figure> - <para>The options in the context menu of the mapping diagram are listed in the next - table.</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"> @@ -1601,15 +1574,14 @@ <para>Export as Image</para> </entry> <entry> - <para>Allows to export a diagram as <filename>.png</filename>,<filename>.jpeg</filename> or <filename>.bmp </filename> + <para>Allows the diagram to be exported as a <filename>.png</filename>,<filename>.jpeg</filename> or <filename>.bmp </filename> </para> </entry> </row> </tbody> </tgroup> </table> - <para>When you open the context menu while clicking an item on the diagram, it quite differs - from the one described before.</para> + <para>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> @@ -1653,8 +1625,9 @@ <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> + <para> + Makes it possible to open the source file for a chosen object or element. The selected element will be highlighted in the open file. + </para> </entry> </row> <row> @@ -1671,8 +1644,9 @@ <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> + <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> @@ -1706,7 +1680,7 @@ <para>Expand|Collapse shape(s)</para> </entry> <entry> - <para>Used for expanding/collapsing fields of the item</para> + <para>Used for expanding and collapsing fields of the item</para> </entry> </row> </tbody> @@ -1714,10 +1688,9 @@ </table> <note> <title>Tip:</title> - <para>All the described types of the context menu are also available in the <property>Outline</property> view.</para> + <para>All the described types of the context menu are also available in the <guilabel>Outline</guilabel> view.</para> </note> - <para>The below table lists the actions that could be performed using the keyboard keys (or - keys combinations).</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"> @@ -1750,7 +1723,7 @@ </row> <row> <entry> - <para>Collapse/Expand selected item(s)</para> + <para>Collapse or Expand selected item(s)</para> </entry> <entry> <para> @@ -1760,7 +1733,7 @@ </row> <row> <entry> - <para>Show/Hide selected item(s)</para> + <para>Show or Hide selected item(s)</para> </entry> <entry> <para> @@ -1770,7 +1743,7 @@ </row> <row> <entry> - <para>Sort items in alphabetical order or return the initial state</para> + <para>Sort items in alphabetical order or return to the initial state</para> </entry> <entry> <para> @@ -1791,12 +1764,9 @@ </tbody> </tgroup> </table> - <para>It&apos;s possible to save the diagram in the eclipse workspace. Click the usual <menuchoice><guimenuitem>File</guimenuitem> - <guimenuitem>Save As</guimenuitem> - </menuchoice> 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> + <para> + It is possible to save the diagram in the eclipse workspace. Click the usual <menuchoice><guimenuitem>File</guimenuitem><guimenuitem>Save As</guimenuitem></menuchoice> 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 <filename>.hibernate</filename> extension. + </para> <figure> <title>The Diagram saved in the Workspace</title> <mediaobject> @@ -1807,9 +1777,9 @@ </figure> <note> <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> + <para> + If you restart 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> </note> <figure> <title>The Diagram after Restarting the Eclipse</title> @@ -1871,8 +1841,7 @@ <para>Refresh Visual Mapping</para> </entry> <entry> - <para>It update <property>Mapping Diagram</property> if <property>Console - Configuration</property> was changed. </para> + <para>It will update the <guilabel>Mapping Diagram</guilabel> the if <guilabel>Console Configuration</guilabel> was changed. </para> </entry> </row> <row> @@ -1889,8 +1858,9 @@ <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> + <para> + Used to define scale of the diagram. Also it's used for <guilabel>Mapping Diagram</guilabel> printing. If you want to put the whole <guilabel>diagram</guilabel> to one print page, you need select <guilabel>Page</guilabel> option in the <guilabel>Zoom Box</guilabel>. + </para> </entry> </row> <row> @@ -1924,10 +1894,9 @@ <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> + <para> + Used to show or hide a connection on the diagram. Moreover you can choose what type of connections must be present on the diagram (<guilabel>Property Mappings</guilabel>, <guilabel>Class Mappings</guilabel>, <guilabel>Associations</guilabel> or <guilabel>Foreign key constraints</guilabel>). + </para> </entry> </row> <row> @@ -1961,7 +1930,7 @@ <para> Show|Hide shape(s)</para> </entry> <entry> - <para>Used to hide/show an item on the mapping diagram.</para> + <para>Used to hide or show an item on the mapping diagram.</para> </entry> </row> </tbody> @@ -1971,15 +1940,14 @@ </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 <keycombo><keycap>Ctrl</keycap> - <keycap>Enter</keycap> - </keycombo>.</para> + <para> + Queries can be prototyped by entering them into the <guilabel>HQL</guilabel> or <guilabel>Criteria Editor</guilabel>. To execute a query you should click the green run button in the editor toolbar or press <keycombo><keycap>Ctrl</keycap><keycap>Enter</keycap></keycombo>. + </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> + <para> + To open the query editors right-click your projects <guilabel>Console Configuration</guilabel> and select <guimenuitem>HQL Editor</guimenuitem> (or <guimenuitem>Hibernate Criteria Editor</guimenuitem>). + </para> <figure> <title>Opening HQL Editor</title> <mediaobject> @@ -1990,23 +1958,17 @@ </figure> <note> <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> + <para> + If the context menu items are disabled then you need at first to create a <guilabel>Session Factory</guilabel>. That is done by simply expanding the <guilabel>Session Factory</guilabel> node. + </para> </note> - <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> + <para>When open the editors they should automatically detect the chosen <guilabel>Console Configuration</guilabel>.</para> + <para> + To get a prefill query for any entity (or any entity child node) listed in the <guilabel>Session Factory</guilabel> you should double-click it. This will open the <guilabel>HQL Editor</guilabel> with the associated query. + </para> + <para> + Choosing <guimenuitem>HQL Editor</guimenuitem> 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 <guimenuitem>Hibernate Criteria Editor</guimenuitem> in the context menu, it will open <guilabel>Hibernate Criteria Editor</guilabel> with the associated criteria. + </para> <figure> <title>Generating Simple Queries</title> <mediaobject> @@ -2019,10 +1981,7 @@ </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 (<keycombo><keycap>Ctrl</keycap> - <keycap>1</keycap> - </keycombo>). + It is also possible to copy a portion of code from a <filename>.java</filename> file into the <guilabel>HQL</guilabel> or <guilabel>Criteria editor</guilabel>. To do this make use of the Quick Fix option (<keycombo><keycap>Ctrl</keycap><keycap>1</keycap></keycombo>). </para> <figure> <title>Quick Fix Option Demonstration</title> @@ -2032,9 +1991,9 @@ </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> + <para> + You can also update the original java code with changes made 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> @@ -2043,19 +2002,12 @@ </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 <menuchoice><guimenuitem>Property View</guimenuitem> - <guimenuitem>Tab name field</guimenuitem> - </menuchoice>. </para> + <para> + Also you can pin the <guilabel>HQL editor</guilabel> and <guilabel>Criteria editor</guilabel> as a tab in the <property>Hibernate Query Result</property> view. For that you need click on <guibutton>Stick result to one tab</guibutton> button (<inlinemediaobject><imageobject><imagedata fileref="images/plugins/sticky_but.png"/></imageobject></inlinemediaobject>). In this state query executions results will be shown in one tab (no more will be opened). + </para> + <para> + Moreover you are able to rename tab in <guilabel>Hibernate Query Result</guilabel>. Click the tab, and type a new name in <menuchoice><guimenuitem>Property View</guimenuitem><guimenuitem>Tab name field</guimenuitem></menuchoice>. + </para> <figure> <title>Tab Renaming</title> <mediaobject> @@ -2067,26 +2019,24 @@ </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> + <para> + Errors raised during the creation of the <guilabel>Session Factory</guilabel> 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 <guilabel>Error Log View</guilabel> on the right pane. + </para> + <para> + Results of a query will be shown in the <guilabel>Hibernate Query Result View</guilabel> and details of possible errors (syntax errors, database errors, etc.) can be seen in the <guilabel>Error Log View</guilabel>. + </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> + <para> + HQL queries are executed by default using the <code>list()</code> function thus without any row limit could return a large result set. You might run out of memory. To avoid this you can put a value in the <guilabel>Max</guilabel> 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> + <para> + If the <guilabel>Hibernate Dynamic Query Translator View</guilabel> is visible while writing in the <guilabel>HQL Editor</guilabel> it will show the generated SQL for a HQL query. + </para> <figure> <title>Hibernate Dynamic Query Translator View</title> <mediaobject> @@ -2098,14 +2048,16 @@ </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> + <para> + The translation is performed 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> + <para> + As you can see in the figure below, when clicking on class/entity the <guilabel>Properties view</guilabel> shows the number of query results as well as the execution time. + </para> <figure> <title>Properties View</title> <mediaobject> @@ -2117,7 +2069,9 @@ </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> + <para> + It also displays the structure of any persistent object selected in the <guilabel>Hibernate Query Results View</guilabel>. Editing is not yet supported. + </para> <figure> <title>Properties View for Selected Object</title> <mediaobject> @@ -2129,91 +2083,51 @@ </imageobject> </mediaobject> </figure> - <para>You can also use <property>Properties view</property> when clicking on the configuration - itself in Hibernate Configuration View( <xref linkend="modif_console_conf"/>). </para> + <para> + You can also use <guilabel>Properties view</guilabel> when clicking on the configuration itself in Hibernate Configuration View (see <xref linkend="modif_console_conf"/>). + </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>Using this wizard you can add the next Hibernate annotations to the class: <code>@Column</code>, <code>@Entity</code>, <code>@ManyToOne</code>, <code>@OneToMany</code>, <code>@OneToOne</code>, <code>@ManyToMany</code>, <code>@MappedSuperclass</code>, <code>@Id</code>, <code>@GeneratedValue</code>, <code>@Version </code> </para> <itemizedlist> <listitem> <para> - <emphasis> - <property>@Column</property> - </emphasis> is added to all String properties.</para> + <code>@Column<code> 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> + <code>@Entity</code> 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> + <code>@ManyToOne</code>, <code>@OneToMany</code>, <code>@OneToOne</code>, <code>@ManyToMany</code> - this annotations are declared according to the classes hierarchy. + </para> </listitem> <listitem> <para> - <emphasis> - <property>@MappedSuperclass</property> - </emphasis> is added to abstract superclasses.</para> + <code>@MappedSuperclass</code> 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> + <code>@Id</code>, <code>@GeneratedValue</code> 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 <xref linkend="optim_lock"/>.</para> + <code>@Version</code> is declared in case you select <xref linkend="optim_lock"/>.</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> + <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 and select <menuchoice><guimenuitem>Source</guimenuitem> - <guimenuitem>Generate Hibernate/JPA annotations</guimenuitem> - </menuchoice>. You will see the Hibernate:add JPA annotations dialog. + To open this wizard you should right click the class you want to enrich with annotations and select <menuchoice><guimenuitem>Source</guimenuitem><guimenuitem>Generate Hibernate/JPA annotations</guimenuitem></menuchoice>. You will see the Hibernate:add JPA annotations dialog. </para> <figure> <title>Starting Hibernate:add JPA annotations dialog</title> @@ -2224,7 +2138,7 @@ </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 <guibutton>Back</guibutton> button. In result you will see <property>Add classes and packages</property> page. + 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 <guibutton>Back</guibutton> button. In result you will see <guilabel>Add classes and packages</guilabel> page. </para> <figure> <title>Add classes and packages page </title> @@ -2234,37 +2148,17 @@ </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 <xref linkend="depth_control"/>). When finished - just press the <guibutton>Next</guibutton> 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> + Here you can add one more classes or whole package, moreover you can limit dependencies depth by selecting <guilabel>depth control</guilabel> option (you can find more information on this option in the <xref linkend="depth_control"/> section). When finished just press the <guibutton>Next</guibutton> button and you will be returned to <guilabel>The following classes will be changed</guilabel> page.</para> + <para> + By default the tags are added to the fields of selected classes. But you can change this option to <guilabel>Getters</guilabel> in <guilabel> Preferred location of Annotations</guilabel> drop down list and then all the annotations will be added to the getter methods. If you choose <guilabel>Auto select from class preference</guilabel> then the annotations are added according to the majority of the already existed ones positions. + </para> + <para> + If it is necessary to map your String properties to the columns that length differ from the default value(255), change the <guilabel>Default string length</guilabel> field and <code>@Column(length = your length)</code> will be created for every String property. + </para> + <para id="optim_lock"> + You can add optimistic locking capability to an entity bean by selecting the <guilabel>Enable optimistic locking</guilabel> checkbox. This operation will add version property to all the selected classes. The property will be also annotated with <code>@Version</code>, and a getter and setter will be created. If the property is already exists, it won't be created, but the getters and setters will be generated. If there is already <code>@MappedSuperclass</code> annotation with version in the base class of the current class - <code>version</code> is not inserted into the current class. + </para> <para>After defining all necessary settings in the current step click the <guibutton>Next</guibutton> button and follow the next wizard steps. </para> <figure> <title>Hibernate:add JPA annotations view</title> @@ -2274,26 +2168,9 @@ </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> + <para> + The view represents two windows: one with the source code and and the second with refactored one. With the help of the <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> @@ -2302,15 +2179,14 @@ </imageobject> </mediaobject> </figure> - <para>To apply the changes click <emphasis> - <property>Finish</property> - </emphasis>.</para> + <para>To apply the changes click the <guibutton>Finish</guibutton> button.</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> + It is possible to configure the Eclipse plugin to route all logging made by the plugins and hibernate code it self to the <guilabel>Error Log View</guilabel> 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 <filename>hibernate-log4j.properties</filename> in <filename>org.hibernate.eclipse/ directory/jar</filename>. This file includes a default configuration that only logs WARN and above to a set