From jbosstools-commits at lists.jboss.org Thu Jan 3 07:41:59 2008 Content-Type: multipart/mixed; boundary="===============6343359261536987516==" MIME-Version: 1.0 From: jbosstools-commits at lists.jboss.org To: jbosstools-commits at lists.jboss.org Subject: [jbosstools-commits] JBoss Tools SVN: r5487 - trunk/hibernatetools/docs/reference/en/modules. Date: Thu, 03 Jan 2008 07:41:58 -0500 Message-ID: --===============6343359261536987516== Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: quoted-printable Author: afedosik Date: 2008-01-03 07:41:58 -0500 (Thu, 03 Jan 2008) New Revision: 5487 Modified: trunk/hibernatetools/docs/reference/en/modules/ant.xml trunk/hibernatetools/docs/reference/en/modules/codegen.xml trunk/hibernatetools/docs/reference/en/modules/codegenarchitecture.xml trunk/hibernatetools/docs/reference/en/modules/plugins.xml trunk/hibernatetools/docs/reference/en/modules/reverseengineering.xml Log: http://jira.jboss.com/jira/browse/JBDS-239 - Spelling and grammer in Guide = are corrected. Modified: trunk/hibernatetools/docs/reference/en/modules/ant.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/ant.xml 2007-12-29 15:10= :27 UTC (rev 5486) +++ trunk/hibernatetools/docs/reference/en/modules/ant.xml 2008-01-03 12:41= :58 UTC (rev 5487) @@ -201,10 +201,10 @@ = Each have in common that they are able to build up a Hibernate Configuration object from which a set of exporter= s can be run to generate - various output. Note: output can be anything, e.g. specific files, s= tatments execution against + various output. Note: output can be anything, e.g. specific files, s= tatements execution against a database, error reporting or anything else that can be done in jav= a code. = - The following section decribes what the the various configuratio= n can do, plus list the + The following section describes what the various configuration c= an do, plus list the individual settings they have. =
@@ -265,7 +265,7 @@ = - A standard Ant fileset. Used to include hibernate mapp= ing files.Remember that if + A standard Ant fileset. Used to include hibernate mapp= ing files. Remember that if mappings are already specified in the hibernate.cfg.xml th= en it should not be included via the fileset as it will result in duplicate im= port exceptions. @@ -461,8 +461,8 @@ tables and has no other columns. - detectOptimisticLock (efault:true): If true columns na= med VERSION or TIMESTAMP - with appropriate types will be mapped with the apropriate = optimistic locking + detectOptimisticLock (default:true): If true columns n= amed VERSION or TIMESTAMP + with appropriate types will be mapped with the appropriate= optimistic locking corresponding to <version> or <timestamp> @@ -493,7 +493,7 @@
Exporters = - Exporters is the parts that does the actual job of converting th= e hibernate metamodel into + Exporters are the parts that does the actual job of converting t= he hibernate metamodel into various artifacts, mainly code. The following section describes the = current supported set of exporters in the Hibernate Tool distribution. I= t is also possible for userdefined exporters, that is done through the @@ -568,7 +568,7 @@ = - delimiter (default: ";"): What delimter to use to sepa= rate statements + delimiter (default: ";"): What delimiter to use to sep= arate statements = @@ -602,8 +602,8 @@ POJO java code exporter (<literal><hbm2java></literal>)= = - <hbm2java> is a java codegen= erator. Options for controlling wether JDK 5 - syntax can be used and wether the POJO should be annotated with EJ= B3/Hibernate Annotations. + <hbm2java> is a java codegen= erator. Options for controlling whether JDK 5 + syntax can be used and whether the POJO should be annotated with E= JB3/Hibernate Annotations. = @@ -837,7 +837,7 @@
Using properties to configure Exporters = - Exporters can be controlled by user properties. The user propert= ies is specificed via + Exporters can be controlled by user properties. The user propert= ies are specified via <property> or @@ -860,7 +860,7 @@ <property> is enough for specifying the properties needed for the exporters. Still the ant tools suppo= rts the notion of - <propertyset>. The functionallity of + <propertyset>. The functionality of <propertyset> is explained in detail in the Ant task manual. @@ -881,7 +881,7 @@ <hibernatetool> or inside any exporter will automatically create an instance of x.y.z.NameOfToolClass and= it will be available in - the templates as $sometool. This is usefull to = delegate logic and code + the templates as $sometool. This is useful to d= elegate logic and code generation to java code instead of placing such logic in the templ= ates. =
Modified: trunk/hibernatetools/docs/reference/en/modules/codegen.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/codegen.xml 2007-12-29 1= 5:10:27 UTC (rev 5486) +++ trunk/hibernatetools/docs/reference/en/modules/codegen.xml 2008-01-03 1= 2:41:58 UTC (rev 5487) @@ -177,7 +177,7 @@ default-value = - default initializatioin value for a field + default initialization value for a field = @@ -192,7 +192,7 @@ = include this property in the equals() and hashCode() method. If no use-in-equals = is - specificed, no equals/hashcode will be generated. + specified, no equals/hashcode will be generated. = @@ -265,7 +265,7 @@ "class-scope" to the cu= rrent class, not the subclasses. =
- Recomendations + Recommendations = The following are some good practices when using @@ -408,7 +408,7 @@ = With an <meta attribute=3D"class-code">, - you can add addional methods on a given class, nevertheless such + you can add additional methods on a given class, nevertheless such <meta> attribute can not= be used at property scope level and Hibernate Tools does not prov= ide such @@ -416,7 +416,7 @@ <meta> attributes. = A possibly solution for this is to modify the freemarker - templates responsable for generating the POJO's. If you look inside + templates responsible for generating the POJO's. If you look inside hibernate-tools.jar, you can f= ind the template: @@ -474,7 +474,7 @@ contents will be generated into the body of the relevant set method. = - As an examlpe let us add a pre-condition for property + As an example let us add a pre-condition for property name preventing no Person can have an empty name. So we have to modify the Modified: trunk/hibernatetools/docs/reference/en/modules/codegenarchitectur= e.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/codegenarchitecture.xml = 2007-12-29 15:10:27 UTC (rev 5486) +++ trunk/hibernatetools/docs/reference/en/modules/codegenarchitecture.xml = 2008-01-03 12:41:58 UTC (rev 5487) @@ -70,7 +70,7 @@ = In most projects you will normally use only one of the Core, Ann= otation or JPA configuration and possibly the JDBC configuration if you are using t= he reverse engineering - facilities of Hibernate Tools. The important th= ing to note is that no matter which Hibnerate + facilities of Hibernate Tools. The important th= ing to note is that no matter which Hibernate Configuration type you are using Hibernate Tools supports them. = The following drawing illustrates the core concepts: 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 2007-12-29 1= 5:10:27 UTC (rev 5486) +++ trunk/hibernatetools/docs/reference/en/modules/plugins.xml 2008-01-03 1= 2:41:58 UTC (rev 5487) @@ -85,7 +85,7 @@ Press Finish to create the configuration file, after optionally creat= ing a Console - onfiguration, the + configuration, the hibernate.cfg.xml will be automatically opened in an editor. The last opti= on Create Console Configuration @@ -101,7 +101,7 @@ should configure Hibernate and what configurati= on files, including which classpath is needed to load the POJO's, JDBC drivers etc. It is requ= ired 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 definitly + 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 @@ -137,7 +137,7 @@ Classpath for classpath and Mappings - for additional mappings. The two latter ones is normally= not required if you + for additional mappings. The two latter ones are normall= y not required if you specify a project and it has /hibernate.cfg.xml @@ -516,7 +516,7 @@ = - The first time you create a code generation launcher you shoul= d give it a meaningfull + The first time you create a code generation launcher you shoul= d give it a meaningful name, otherwise the default prefix New_Generation will be used. @@ -633,7 +633,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 - claspath of the Console Configuration, otherwise you wil= l get class not found + classpath of the Console Configuration, otherwise you wi= ll get class not found exceptions. See for details and an example of a custom strategy. @@ -778,7 +778,7 @@ = - Generate a hibernate.cfg.xml file. Used to keep the = hibernate.cfg.xml uptodate + Generate a hibernate.cfg.xml file. Used to keep the = hibernate.cfg.xml update with any new found mapping files. @@ -812,7 +812,7 @@ Each Exporter listens to certain properties and these can be s= etup in the Properties section where you can add/remove predefined or custome= r properties for each of - the exporters. The following table lists the time of writing pre-d= efined properties: + the exporters. The following table lists the time of writing prede= fined properties: = @@ -937,7 +937,7 @@ hbm.xml and cfg.xml - files. The editor is based on the Eclipse WTP tools and = extend its functionallity + files. The editor is based on the Eclipse WTP tools and = extend its functionality to provide Hibernate specific code completion. =
@@ -968,7 +968,7 @@ files to the relevant class/field in java code. =
- Navigation Functionallity + Navigation Functionality @@ -991,7 +991,7 @@
= - This is done via the standard hyperlink navigation functionall= ity in Eclipse; per + This is done via the standard hyperlink navigation functionali= ty in Eclipse; per default it is done by pressing F3 while the cursor is on a class/f= ield or by pressing Ctrl and the mouse button to perform the same navigation. @@ -1079,7 +1079,7 @@ = Note that not all the features of the .reveng.xml file is exposed or fully= implemented in - the editor, but the main functionallity is there. To understand the = full flexibility of the + the editor, but the main functionality is there. To understand the f= ull flexibility of the reveng.xml, please see = @@ -1090,7 +1090,7 @@ Ctrl+N or via the code generation launcher. = - The following screentshot shows the + The following screenshot shows the Overview page where the wanted conso= le configuration is selected (auto-detected if Hibernate 3 support is enabled for the= project) = @@ -1239,7 +1239,7 @@ = 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 - inlined in the view that detected the error, you may get more info= rmation about the error in + 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. = Results of a query will be shown in the Query result view and = details of possible errors Modified: trunk/hibernatetools/docs/reference/en/modules/reverseengineering= .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/reverseengineering.xml 2= 007-12-29 15:10:27 UTC (rev 5486) +++ trunk/hibernatetools/docs/reference/en/modules/reverseengineering.xml 2= 008-01-03 12:41:58 UTC (rev 5487) @@ -41,7 +41,7 @@ filtering. This file can be created by hand (its just basic XML) or you can use the Hibernate plugins which have a specialized editor. = - Many databases is case-sensitive with their names and thus= if + Many databases are case-sensitive with their names and thu= s if you cannot make some table match and you are sure it is not excluded b= y a <table-filter>then check if the case matches; most databases sto= res table names in uppercase. @@ -178,7 +178,7 @@ /> ]]> = - The number of attributes specificed and the sequence of the + The number of attributes specified and the sequence of the sql-type's is important. Meaning that Hibernate will search for the most specific first, and if no specific match is foun= d it will seek from top to bottom when trying to resolve a type @@ -290,7 +290,7 @@ char = Even though there is a generic match for VARCHAR, t= he - more specifc type-mapping for VARCHAR with not-null=3D"fal= se" is + more specific type-mapping for VARCHAR with not-null=3D"fa= lse" is chosen. The first VARCHAR sql-type matches in length but h= as no value for not-null and thus is not considered. @@ -356,9 +356,9 @@ Table filters (<table-filter>) = The - <table-filter> let you speci= fcy matching rules for + <table-filter> let you speci= fy matching rules for performing general filtering/setup for tables, e.g. let you include = or - exclude specific tables based on the schema or even a specifc + exclude specific tables based on the schema or even a specific prefix. = @@ -493,7 +493,7 @@ generator/class (Optional): defines which identifier generator should be used. The class name is any hibernate sh= ort - hand name or fully quailfied class name for an identifier + hand name or fully qualified class name for an identifier strategy. = --===============6343359261536987516==--