From jbosstools-commits at lists.jboss.org Fri Feb 8 14:06:24 2008 Content-Type: multipart/mixed; boundary="===============8111380210632697347==" MIME-Version: 1.0 From: jbosstools-commits at lists.jboss.org To: jbosstools-commits at lists.jboss.org Subject: [jbosstools-commits] JBoss Tools SVN: r6219 - trunk/hibernatetools/docs/reference/en/modules. Date: Fri, 08 Feb 2008 14:06:24 -0500 Message-ID: --===============8111380210632697347== Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: quoted-printable Author: ochikvina Date: 2008-02-08 14:06:24 -0500 (Fri, 08 Feb 2008) New Revision: 6219 Modified: trunk/hibernatetools/docs/reference/en/modules/plugins.xml Log: http://jira.jboss.com/jira/browse/JBDS-185 - updating screenshots; http://jira.jboss.com/jira/browse/JBDS-247 - adding info about HQL Editor&H= ibernate Criteria Editor; http://jira.jboss.com/jira/browse/JBDS-238 - adding links to proper docs Modified: trunk/hibernatetools/docs/reference/en/modules/plugins.xml =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D= =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D= =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D --- trunk/hibernatetools/docs/reference/en/modules/plugins.xml 2008-02-08 1= 9:04:17 UTC (rev 6218) +++ trunk/hibernatetools/docs/reference/en/modules/plugins.xml 2008-02-08 1= 9:06:24 UTC (rev 6219) @@ -1222,8 +1222,8 @@ - = - = + + =
@@ -1231,14 +1231,14 @@ = The Hibernate Console perspective combines = a set of views which allow you to see the structure of your mapped entities/classes, edit HQL q= ueries, execute the - queries, and see the results. To use this perspective you need to cr= eate a Console - configuration. + queries, and see the results. To use this perspective you need to cr= eate a Console configuration. =
Viewing the entity structure = - To view your new configuration and entity/class structure, swi= tch to - Hibernate Configurations View. Expanding the = tree allows you to browse the class/entity + To view your new configuration and entity/class structure, swi= tch to Hibernate + Configurations View. Expanding the tree allows you to= browse the class/entity structure and see the relationships. =
@@ -1259,15 +1259,17 @@ and result. = = - The Console Configuration does not dynami= cally adjust to changes done in mappings and - java code. To reload the configuration select the configuration an= d click the + The Console Configuration does not dynami= cally adjust to changes + done in mappings and java code. To reload the configuration select= the configuration and + click the Reload button in the view toolbar or in the context menu.
Mapping Diagram = - A Mapping Diagram for entities are avai= lable by right clicking on the entity you want - a mapping diagram for and then choose + To get a visual feel on how entities are related and view th= eir structure a + Mapping Diagram is provided. It is availa= ble by right clicking on + the entity you want a mapping diagram for and then choose Open Mapping Diagram . = @@ -1290,28 +1292,48 @@
Prototyping Queries = - Queries can be prototyped by entering them in the HQL or Crite= ria editor. The query - editors are opened by right-clicking the Console configuration and= selecting either - HQL Editor - or - Criteria Editor - . + Queries can be prototyped by entering them in the HQ= L or + Criteria Editor. The query editors are open= ed by right-clicking the + Console Configuration and selecting either = HQL + Editor or Hibernate Criteria Editor. The editors + automatically detect the chosen configuration. + = + If the menu item is disabled then you need at first to create = an Session + Factory. That is done by simply expanding the Session + Factory node. = - If the menu item is disabled then you need to first create an = SessionFactory. That is - done by simply expanding the Session Factory node. + Not to enter manually simple queries like 'from + Customer' or like on the figure below, you can do = it with the editors + help by brining up the context menu for a necessary item and choos= ing HQL + Editor or Hibernate Cr= iteria Editor. = +
+ Entering Simple Queries + + + + + + + + + +
+ Executing the query is done by clicking the green run button i= n the toolbar or pressing Ctrl+Enter . = - Errors during creation of the SessionFactory or running the queries - (e.g. if your configuration or query is incorrect) will be shown i= n a message dialog or - inclined in the view that detected the error, you may get more inf= ormation about the error - in the Error Log view on the right pane. + Errors during creation of the Session Factory 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 Error Log View on the right pane= . = - Results of a query will be shown in the Query result view and = details of possible errors - (syntax errors, database errors, etc.) can be seen in the Error Lo= g view. + Results of a query will be shown in the Hibernate Qu= ery Result View + and details of possible errors (syntax errors, database errors, et= c.) can be seen in the + Error Log View. = + HQL queries are executed by default using list() thus without any limit of the size of the output the query could return a large r= esult set. You might run @@ -1322,46 +1344,44 @@
Dynamic Query Translator = - If the - Hibernate Dynamic Query Translator - view is visible while writing in the HQL editor it w= ill show the generated SQL - for a HQL query. + If the Hibernate Dynamic Query Translator View is visible while + writing in the HQL Editor it will show the = generated SQL for a HQL + query. =
Hibernate Dynamic Query Translator View - + = - +
= - The translation is done each time you stop typing into the e= ditor, if there are an - error in the HQL the parse exception will be shown embedded in t= he view. + The translation is done each time you stop typing into the e= ditor, if there are errors + in the HQL the parse exception will be shown embedded in the vie= w.
=
- Properties view + Properties View = - The - Properties - view shows the structure of any selected persistent ob= ject in the results view. - Editing is not yet supported. + The Properties View shows the structure o= f any selected persistent + object in the Hibernate Query Results View. E= diting is not yet + supported. =
Properties View - + = - +
@@ -1372,9 +1392,7 @@ Enable debug logging in the plugins = It is possible to configure the eclipse plugin to route all logg= ing made by the plugins - and hibernate code it self to the - Error log - view in Eclipse. + and hibernate code it self to the Error Log View in Eclipse. = This is done by editing the hibernate-log4j.properties @@ -1382,8 +1400,14 @@ org.hibernate.eclipse/ directory/jar . This file includes a default configuration that only lo= gs 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 hibernate documentati= on for interesting - categories and log4j documentation for how to configure logging via = a log4j property - file. + to be as verbose or silent as you please - see Hibernate Documentation for interesting categories and Lo= g4j documentation. + +
+ Relevant Resources Links + Find more on how to configure logging via a log4j property fil= e in Log4j documentation. +
--===============8111380210632697347==--