From jbosstools-commits at lists.jboss.org Wed Feb 6 10:30:11 2008
Content-Type: multipart/mixed; boundary="===============3704283068295610114=="
MIME-Version: 1.0
From: jbosstools-commits at lists.jboss.org
To: jbosstools-commits at lists.jboss.org
Subject: [jbosstools-commits] JBoss Tools SVN: r6132 -
trunk/hibernatetools/docs/reference/en/modules.
Date: Wed, 06 Feb 2008 10:30:11 -0500
Message-ID:
--===============3704283068295610114==
Content-Type: text/plain; charset="utf-8"
MIME-Version: 1.0
Content-Transfer-Encoding: quoted-printable
Author: ochikvina
Date: 2008-02-06 10:30:11 -0500 (Wed, 06 Feb 2008)
New Revision: 6132
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-238 - making changes according to Sv=
etlana remarks
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-06 1=
5:28:12 UTC (rev 6131)
+++ trunk/hibernatetools/docs/reference/en/modules/plugins.xml 2008-02-06 1=
5:30:11 UTC (rev 6132)
@@ -27,10 +27,11 @@
existing database schema and use the code generation to generate POJ=
O source files and
Hibernate mapping files.
=
- Eclipse JDT integration: Hibe=
rnate Tools integrates into
- the Java code completion and build support of Java in Eclipse. This =
gives you codecompletion
- of HQL inside Java code plus Hibernate Tools wi=
ll add problem markers if
- your queries are not valid against the console configuration associa=
ted with the project.
+ Eclipse JDT integration: Hibernate
+ Tools integrates into the Java code completion and build =
support of Java in
+ Eclipse. This gives you codecompletion of HQL inside Java code plus =
Hibernate
+ Tools will add problem markers if your queries are not va=
lid against the console
+ configuration associated with the project.
=
Please note that these tools do not try to hide any functionalit=
y of
Hibernate. The tools make working with Hibernate
@@ -40,7 +41,7 @@
=
- Creating a Hibernate configuration file
+ Creating a Hibernate Configuration File
=
To be able to reverse engineer, prototype queries, and of course=
to simply use
Hibernate Core a
@@ -53,9 +54,10 @@
file if you do not already have such file.
=
Start the wizard by clicking
- New Wizard
- (Ctrl+N), select the Hibernate/Hibernate Configuration f=
ile (cfg.xml) wizard and
- press
+ New > Other (Ctrl+N)
+ , then
+ Hibernate > Hibernate Configuration File (cfg.xml)
+ and press Next. After selecting the wanted location for the hibernate.cfg.xml
@@ -65,7 +67,8 @@
Hibernate Configuration File Wizard
-
+
=
@@ -80,8 +83,9 @@
=
Enter your configuration information in this dialog. Details abo=
ut the configuration
- options can be found in Hibernate Reference Documentation.
+ options can be found in Hibernate
+ Reference Documentation.
=
Press Finish
@@ -92,21 +96,22 @@
Create Console Configuration is enabled by default and when enabled it will automatic=
ally use the hibernate.cfg.xml
- for the basis of a Console Configuration.
+ for the basis of a Console configuration.
=
- Creating a Hibernate Console configuration
+ Creating a Hibernate Console Configuration
=
- A Console Configuration describes how the Hibernate
plugin =
- should configure Hibernate and what configurati=
on files, including which
+ A Console configuration describes how the Hibernate pl=
ugin should
+ configure Hibernate and what configuration file=
s, including which
classpath are needed to load the POJO's, JDBC drivers etc. It is req=
uired 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.
=
- You create a console configuration by running the Console Config=
uration wizard, shown in
- the following screenshot. The same wizard will also be used if you a=
re coming from the
+ You create a console configuration by running the Cons=
ole Configuration
+ Wizard, shown in the following screenshot. The same wizar=
d will also be used if you
+ are coming from the hibernate.cfg.xml wizard and had enabled Create Console Configuration
@@ -150,8 +155,8 @@
in its project classpath.
=
The following table describes the available settings. The wizard=
can automatically detect
- default values for most of these if you started the Wizard with the =
relevant java project or
- resource selected
+ default values for most of these if you started the wizard with the =
relevant java project or
+ resource selected.
=
Hibernate Console Configuration Parameters
@@ -445,9 +450,8 @@
=
Clicking Finish
- creates the configuration and shows it in the
- Hibernate Configurations
- view
+ creates the configuration and shows it in the =
Hibernate Configurations
+ View.
=
Console Overview
@@ -466,14 +470,16 @@
=
- Reverse engineering and code generation
+ Reverse Engineering and Code Generation
=
A "click-and-generate" reverse engineering and code generation f=
acility is available. This
facility allows you to generate a range of artifacts based on databa=
se or an already existing
Hibernate configuration, be that mapping files or annotated classes.=
Some of these are POJO
Java source file, Hibernate
- *.hbm.xml,
- hibernate.cfg.xml generation and=
schema documentation.
+ .hbm.xml
+ ,
+ hibernate.cfg.xml
+ generation and schema documentation.
=
To start working with this process, start the Hibernat=
e Code
Generation which is available in the toolbar via the Hibernate
@@ -489,7 +495,7 @@
the standard Eclipse launcher dialog will appear. In t=
his dialog you can create,
edit and delete named Hibernate code generation "launchers".
=
-
+ Getting Hibernate Code Generation Wizard
@@ -522,7 +528,8 @@
New_Generation
will be used.
=
- Tip:
+
+ Tip: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 wil=
l disappear.
@@ -633,7 +640,7 @@
=
If reveng.xml does not provide enough customization =
you can provide your own
- implementation of an ReverseEngineeringStrategy. The cla=
ss need to be in the
+ implementation of an ReverseEngineeringStrategy. The cla=
ss needs to be in the
classpath of the Console Configuration, otherwise you wi=
ll get class not found
exceptions. See for details and an
example of a custom strategy.
@@ -657,17 +664,25 @@
=
- Detect optimistic lock columns
+
+ Detect optimistic lock columns
+
=
- Automatically detect optimistic lock columns. C=
ontrollable via reveng.
- strategy; the current default is to use columns named VERS=
ION or TIMESTAMP.
+
+ Automatically detect optimistic lock columns. Contro=
llable via reveng.
+ strategy; the current default is to use columns named VE=
RSION or TIMESTAMP.
+
=
- Detect many-to-many tables
+
+ Detect many-to-many tables
+
=
- Automatically detect many-to-many tables. Contr=
ollable via reveng.
- strategy.
+
+ Automatically detect many-to-many tables. Controllab=
le via reveng.
+ strategy.
+
=
@@ -702,7 +717,7 @@
The Exporters tab is used to specify which type of code that should =
be generated. Each
- selection represents an Exporter that are responsible for generati=
ng the code, hence the
+ selection represents an Exporter that is responsible for generatin=
g the code, hence the
name.
=
@@ -934,7 +949,8 @@
Hibernate Mapping and Configuration File Editor
=
- The Hibernate Mapping File editor provides =
XML editing functionality for the
+ The Hibernate Mapping File editor provides =
XML editing functionality
+ for the hbm.xml and cfg.xml
@@ -971,19 +987,19 @@
Navigation Functionality
- =
+
- =
+
- =
- =
-