equanda-svn-commit Mailing List for equanda Java EE code generator (Page 14)

SourceForge Headquarters 1320 Columbia Street Suite 310 San Diego, CA 92101 +1 (858) 422-6466

Revision: 884
          http://equanda.svn.sourceforge.net/equanda/?rev=884&view=rev
Author:   triathlon98
Date:     2008-12-03 09:23:54 +0000 (Wed, 03 Dec 2008)

Log Message:
-----------
EQ-287 documentation improvements

Modified Paths:
--------------
    trunk/equanda-generate/src/site/site.xml
    trunk/equanda-generate/src/site/wiki/index.wiki
    trunk/equanda-maven-plugin/src/site/site.xml
    trunk/equanda-maven-plugin/src/site/wiki/index.wiki
    trunk/src/site/site.xml

Added Paths:
-----------
    trunk/src/site/wiki/generate.wiki
    trunk/src/site/wiki/plugin/
    trunk/src/site/wiki/plugin/archetype.wiki
    trunk/src/site/wiki/plugin/ddltool.wiki
    trunk/src/site/wiki/plugin/generate.wiki
    trunk/src/site/wiki/plugin/import.wiki
    trunk/src/site/wiki/plugin/translate.wiki
    trunk/src/site/wiki/template.wiki
    trunk/src/site/wiki/templates/

Removed Paths:
-------------
    trunk/equanda-generate/src/site/wiki/template.wiki
    trunk/equanda-generate/src/site/wiki/templates/
    trunk/equanda-maven-plugin/src/site/wiki/archetype.wiki
    trunk/equanda-maven-plugin/src/site/wiki/ddltool.wiki
    trunk/equanda-maven-plugin/src/site/wiki/generate.wiki
    trunk/equanda-maven-plugin/src/site/wiki/import.wiki
    trunk/equanda-maven-plugin/src/site/wiki/translate.wiki

Modified: trunk/equanda-generate/src/site/site.xml
===================================================================

--- trunk/equanda-generate/src/site/site.xml	2008-12-02 10:19:23 UTC (rev 883)
+++ trunk/equanda-generate/src/site/site.xml	2008-12-03 09:23:54 UTC (rev 884)
@@ -9,14 +9,5 @@
         <menu name="generate">
             <item name="Introduction" href="index.html"/>
         </menu>
-
-        <menu name="templates">
-            <item name="ejb3" href="templates/ejb3.html"/>
-            <item name="t5gui" href="templates/t5gui.html"/>
-            <item name="login" href="templates/login.html"/>
-            <item name="import" href="templates/import.html"/>
-            <item name="ddltool" href="templates/ddltool.html"/>
-            <item name="docs" href="templates/docs.html"/>
-        </menu>
     </body>
 </project>

Modified: trunk/equanda-generate/src/site/wiki/index.wiki
===================================================================
--- trunk/equanda-generate/src/site/wiki/index.wiki	2008-12-02 10:19:23 UTC (rev 883)
+++ trunk/equanda-generate/src/site/wiki/index.wiki	2008-12-03 09:23:54 UTC (rev 884)
@@ -1,30 +1,7 @@
-h1. Generating based on domain model
+h1. equanda-generate
 
-This model handled the code generation based on the domain model.
+The equanda-generate module contains the code and templates which are used to generate the equanda applications.
 
-Templates are provided for the following aspects.
-- [ejb3|templates/ejb3.html] : EJB3 persistence layer
-- [t5gui|templates/t5gui.html] : tapestry5 user interface
-- [login|templates/login.html] : user management support
-- [import|templates/import.html] : import data
-- [ddltool|templates/ddltool.html] : ddltool
-- [docs|templates/docs.html] : domain model documentation
+For more information about the the contents of this module can be found on the [project site|http://equanda.org/].
 
-
-h2. Domain model processing
-
-The domain model is parsed using [xstream|http://xstream.codehaus.org/] and then enriched in a couple of steps.
-
-- Handling of includes. The xml files are parsed one by one. And extra steps are need to include the files which are referenced in the model.
-- Enriching the model, this includes things like building the root tables which flatten the inheritance tree.
-- Validation of constraints on the domain model, catching the contradictions.
-
-
-h2. Developing the templates
-
-For the development of the templates, it is recommmended that you first try to make the change in the generated sources and verify that your changes are valid first. This way, the compilation will not require regeneration of the files (as long as you don't clean and don't change the domain model).
-When the changes work, you can then try to incorporate the modifications in the templates. At that point, you have to recompile the module with the templates and then do a clean build on your verification project (the clean build is needed because the changes in the templates are not noticed by the system).
-
-When developing the templates, you can access the processed model. This model (the API of available methods) can be found in the "org.equanda.domain.xml" package.
-
-[Details about the structure of the templates|template.html].
+equanda is a tool which helps you to build enterprise grade (JEE based) applications with minimal effort. Through code generation, a useful and functional base skeleton is created from the domain model. This application can be customized and the customizations remain active when the domain model changes and  the skeleton is regenerated. This way, the cost of maintaining an evolving application is reduced by eliminating repetitive coding and assuring a consistent code base and user interface.

Deleted: trunk/equanda-generate/src/site/wiki/template.wiki
===================================================================
--- trunk/equanda-generate/src/site/wiki/template.wiki	2008-12-02 10:19:23 UTC (rev 883)
+++ trunk/equanda-generate/src/site/wiki/template.wiki	2008-12-03 09:23:54 UTC (rev 884)
@@ -1,97 +0,0 @@
-h1. Template structure
-
-For each target you can have several files which are generated. There is a ini file which contains the list of files which need to be generated.
-This ini file is called "_target-name_.ini" and is searched on the classpath.
-
-The file has the following format (excerpt from the ejb3.ini)
-{code}
-[config]
-path=ejb3
-
-[global]
-
-output1=${outputDir}${packageDir}client/LazyEJBList.java
-template1=LazyEJBList.java.vm
-
-output2=${outputDir}${packageDir}client/LazyProxyList.java
-template2=LazyProxyList.java.vm
-
-
-[root-table]
-
-// build entity bean
-output1=${outputDir}${packageDir}server/pm/DM${table}Bean.java
-template1=DMObjectBean.java.vm
-
-// build session facade bean
-output2=${outputDir}${packageDir}server/${table}Bean.java
-template2=ObjectBean.java.vm
-
-// build session facade root mediator
-output3=${outputDir}${packageDir}server/${table}MediatorRoot.java
-template3=MediatorRoot.java.vm
-
-// build SelectorHelper classes
-output4=${outputDir}${packageDir}server/${table}SelectorHelper.java
-template4=ObjectSelectorHelper.java.vm
-skip-if4=${altOutputDir}${packageDir}server/${table}SelectorHelper.java
-
-
-[table]
-
-// build mediator base class (generated)
-output1=${outputDir}${packageDir}server/${table}MediatorBase.java
-template1=MediatorBase.java.vm
-
-// build mediator class (for manual modification)
-output2=${outputDir}${packageDir}server/${table}Mediator.java
-template2=Mediator.java.vm
-skip-if2=${altOutputDir}${packageDir}server/${table}Mediator.java
-
-
-[multiple-field]
-
-// build entity bean
-output1=${outputDir}${packageDir}server/pm/DM${table}_${field}Bean.java
-template1=DMFieldBean.java.vm
-{code}
-
-The "config" section indicates the path which is prepended to each template file. The templates are all retrieved from the classpath, but the prefix allows you to avoid name collisions (like java packages).
-
-All the other sections indicate the possible groupings in the domain model for which files can be generated.
-The can contain _outputX_, _templateX_ and _skip-ifX_ where X is a number from 1 up to the amount needed (needs to be consecutive). In the parameters, you can use variable replacement using the ant/velocity syntax "${var-name}".
-- output indicates the location where the output file needs to be searched
-- template indicates the template file which needs to be used to produce the output
-- skip-if allows you to skip the template generation if the file with given name already exists.
-
-The sections which can be used (including variables for output names and templates) are
-- global : these templates are invoked once.
-- table : these are generated for each table. "table" is the table name for the filenames, of a _Table_ object for the velocity templates. 
-- root-table : these are generated for each roottable. "table" is the (root) table name for the filenames, of a _RootTable_ object for the velocity templates.
-- root-table-expected-amount-small : same as "root-table" but only when the expected amount on the root is "small".
-- root-table-with-inheritance : same as "root" but only when the inheritance tree has more than one table. 
-- field : each field, has "root-table" variables and "field" name for filenames or _Field_ instance in the templates.
-- field-with-choices : same as "field" but only for fields with choices.
-- select-not-hidden : all selects which are not hidden, has "root-table" variables and "select" name for filenames or _Select_ instance in the templates.
-- action-not-hidden : all actions which are not hidden, has "root-table" variables and "action" name for filenames or _Action_ instance in the templates.
-
-For variable replacement in the filenames, the following are available in all cases.
-- packageName
-- packageDir
-- outputDir
-- altOutputDir
-
-The following variables are always available in te Velocity templates.
-- engine : a reference to the _Generator_ class.
-- name : "equanda'.
-- dollar : "$".
-- dm, data : the actual domain model, instance of the _DomainModel_ class.
-- package : the package name, as passed in the (template specific) configuration. If not defined there, then the "ejb-package" setting from the "extra" sectio is used.
-- generationdate : string representation of the time when the generation started.
-- keyvalue : the keyvalue pairs which are passed in the (template specific) configuration.
-- dbtype : an instance of the convert class as determined in the "database" section.
-
-
-
-
-

Modified: trunk/equanda-maven-plugin/src/site/site.xml
===================================================================
--- trunk/equanda-maven-plugin/src/site/site.xml	2008-12-02 10:19:23 UTC (rev 883)
+++ trunk/equanda-maven-plugin/src/site/site.xml	2008-12-03 09:23:54 UTC (rev 884)
@@ -8,11 +8,6 @@
         
         <menu name="maven-plugin">
             <item name="Introduction" href="index.html"/>
-            <item name="Generate" href="generate.html"/>
-            <item name="Translate" href="translate.html"/>
-            <item name="Archetype" href="archetype.html"/>
-            <item name="Ddltool" href="ddltool.html"/>
-            <item name="Import" href="import.html"/>
         </menu>
     </body>
 </project>
\ No newline at end of file

Deleted: trunk/equanda-maven-plugin/src/site/wiki/archetype.wiki
===================================================================
--- trunk/equanda-maven-plugin/src/site/wiki/archetype.wiki	2008-12-02 10:19:23 UTC (rev 883)
+++ trunk/equanda-maven-plugin/src/site/wiki/archetype.wiki	2008-12-03 09:23:54 UTC (rev 884)
@@ -1,84 +0,0 @@
-h1. Archetype Plugin
-
-h2. Usage
-
-The archetype plugin should be used to generate new equanda project from template.
-
-It can be executed by the following command (all on one line) :
-
-{code}
-mvn equanda:archetype
-    -DgroupId=com.mycompany -DartifactId=example
-    -DarchetypeVersion=0.9 -DarchetypeGroupId=org.equanda -DarchetypeArtifactId=equanda-maven-plugin
-{code}
-
-All the parameters on the last line are used internally by maven.
-
-The other parameters can either be specified on the commandline using the "-Dkey=value" syntax, or you can put them in a file called "equanda-project.properties". This file itself can be changed by using something like "-DpropertiesFile=myprops.properties".
-
-Possible parameters (those in bold are required) are :
-
-- *groupId* : project group id
-- *artifactId* : project base artifact id
-- archetypeVersion : equanda archetype plugin version
-- archetypeGroupId : equanda archetype plugin group id, has to be "org.equanda"
-- archetypeArtifactId : equanda archetype plugin artifact id, has to be "equanda-maven-plugin"
-- basedir : base project directory (default is current directory)
-- remoteRepositories : remote repositories, comma separated values
-- packageName : default java package, defaults to the "groupId" value
-- version : new project version (default is "1.0-SNAPSHOT")
-
-For details see Maven [Archetype|http://maven.apache.org/plugins/maven-archetype-plugin/] Plugin Page.
-
-h2. Features
-
-The archetype creates an empty project with the equanda "standard" modules (as also used by the test suite, equanda-contact and equanda-sport example projects).
-
-h3. main module
-
-The main project groups the other modules to allow one entry point into the project.
-- The domain model should be placed in the "src/dm" directory. There is a very small sample domain model generated.
-- Basis for the project site under "src/site". This contains a "getting started" document which details information to compile the project, how to setup a database for development etc.
-- The "config" directory contains a checkstyle configuration.
-
-This includes two profiles which help you for development and testing.
-- use "mvn -Drun install" or "mvn -Drun clean install" to compile, install the application and start jboss with the latest version installed. This allows you to manually verify the correct working, especially the user interface. Once jboss is started this will just wait for jboss to end (to press CTRL-C in the console window when finished). The database structure is updated before starting the application.
-- use "mvn -Dfulltest clean install" to do a clean compile and installation, including running the integrations tests from the test module starting from and empty (or more correctly "known" database). The database structure is updated before starting the application.
-
-Apart from the usual maven targets, the following (standard equanda) targets can be applied to the project.
-- "mvn equanda:translate" to edit the translations file.
-- "mvn equanda:ddltool" to update the database structure.
-
-h3. core module
-
-The core module builds a jar file which contains the EJB classes, including the database access layer, mediators etc.
-- The persistence.xml file, configuring the EJB3/JPA entity beans is in "src/main/resources/META-INF/persistence.xml".
-- The base translations file can be found in "src/main/resources/translations.txt". Use "mvn equanda:translate" to edit this file.
-- There are a couple of example mediator files in "src/main/java/".
-
-h3. gui module
-
-The gui module builds the war file with the tapestry web user interface for the application.
-- In "src/main/java" you can find some proposed layout components, a start page and the AppModule class which configures Tapestry.
-- In "src/main/resources" you can find some Tapestry templates for the pages and components.
-- The AppModule class includes a service for timing the time takes for each page invocation (can be removed).
-- The AppModule class includes a service for getting the login information (which includes the authorizations for the data in the interface).
-- In "src/main/webapp" you can find resources (css/images/script) and the servlet configuration files ("WEB-INF/web-xml" and "WEB-INF/jboss-web.xml").
-
-h3. ear module
-
-The ear module builds the ear file which combines the core jar, the gui war and all libraries which need to be included for deploying in JBoss.
-
-h3. t5compo module
-
-The t5compo module is used for defining and including customizations to the generated user interface.
-- The "src/main/resources/t5gui/mytemplates/templates.properties" file contains the template overrides.
-- The "src/main/resources/t5gui/mytemplates/example.tml.vm" file contains an example changed template.
-
-h3. ddltool module
-
-This module is used to generate the database description file which used by the "equanda:ddltool" maven target and when doing the database update when deploying in JBoss or running the integration tests.
-
-h3. test module
-
-This is the integration test module. All the test class included in this modul are only included in the build phase when the "fulltest" profile is active. This will assure that the application is running (inside JBoss, starting from an empty database with database structure update) when the tests are run.

Deleted: trunk/equanda-maven-plugin/src/site/wiki/ddltool.wiki
===================================================================
--- trunk/equanda-maven-plugin/src/site/wiki/ddltool.wiki	2008-12-02 10:19:23 UTC (rev 883)
+++ trunk/equanda-maven-plugin/src/site/wiki/ddltool.wiki	2008-12-03 09:23:54 UTC (rev 884)
@@ -1,26 +0,0 @@
-h1. Ddltool plugin
-
-This plugin allows you to automatically do database definition/update as part of your maven build.
-
-{code}
-    <plugin>
-        <groupId>org.equanda</groupId>
-        <artifactId>equanda-maven-plugin</artifactId>
-        <configuration>
-            <database>${synca.db.url}</database>
-            <dblogin>${synca.db.login}</dblogin>
-            <dbpassword>${synca.db.password}</dbpassword>
-            <dbmap>be.synergetics.ca.ddltool.EquandaMap</dbmap>
-            <ddltargets>update defaults</ddltargets>
-        </configuration>
-        <executions>
-            <execution>
-                <id>ddltool</id>
-                <phase>test-compile</phase>
-                <goals>
-                    <goal>ddltool</goal>
-                </goals>
-            </execution>
-        </executions>
-    </plugin>
-{code}

Deleted: trunk/equanda-maven-plugin/src/site/wiki/generate.wiki
===================================================================
--- trunk/equanda-maven-plugin/src/site/wiki/generate.wiki	2008-12-02 10:19:23 UTC (rev 883)
+++ trunk/equanda-maven-plugin/src/site/wiki/generate.wiki	2008-12-03 09:23:54 UTC (rev 884)
@@ -1,30 +0,0 @@
-h1. Generate plugin
-
-The generate plugin should be used to generate the sources based on the [domain model description|../dm.html].
-
-It is for example used in the core module of the application, and there used as follows
-{code}
-    <build>
-        ...
-        <plugins>
-            ...
-            <plugin>
-                <groupId>org.equanda</groupId>
-                <artifactId>equanda-maven-plugin</artifactId>
-                <configuration>
-                    <sourceDirectory>${basedir}/../src/main/om</sourceDirectory>
-                    <template>ejb3,import,login</template>
-                </configuration>
-                <executions>
-                    <execution>
-                        <goals>
-                            <goal>generate</goal>
-                        </goals>
-                    </execution>
-                </executions>
-            </plugin>
-            ...
-        </plugins>
-        ...
-    </build>
-{code}

Deleted: trunk/equanda-maven-plugin/src/site/wiki/import.wiki
===================================================================
--- trunk/equanda-maven-plugin/src/site/wiki/import.wiki	2008-12-02 10:19:23 UTC (rev 883)
+++ trunk/equanda-maven-plugin/src/site/wiki/import.wiki	2008-12-03 09:23:54 UTC (rev 884)
@@ -1,31 +0,0 @@
-h1. Import plugin
-
-This plugin allows you to import data into running instance of your application using the import servlet.
-
-{code}
-<plugin>
-    <groupId>org.equanda</groupId>
-    <artifactId>equanda-maven-plugin</artifactId>
-    <configuration>
-        <url>https://localhost:8443/import</url>
-        <login>local</login>
-        <password>local</password>
-        <locations>
-            <location>organizations.import.txt</location>
-        </locations>
-    </configuration>
-    <executions>
-        <execution>
-            <id>import</id>
-            <phase>test-compile</phase>
-            <goals>
-                <goal>import</goal>
-            </goals>
-        </execution>
-    </executions>
-</plugin>
-{code}
-
-It is possible to define several files to import. THe files themselves are first searched in the classpath (test scope), or if that fails, searched on the file system.
-
-Note that when the several maven plugins with the same group/artifact id are used in one pom, then the configuration is read from the first instance (though the execution itself is correct).

Modified: trunk/equanda-maven-plugin/src/site/wiki/index.wiki
===================================================================
--- trunk/equanda-maven-plugin/src/site/wiki/index.wiki	2008-12-02 10:19:23 UTC (rev 883)
+++ trunk/equanda-maven-plugin/src/site/wiki/index.wiki	2008-12-03 09:23:54 UTC (rev 884)
@@ -1,7 +1,7 @@
-h1. equanda maven plugin
+h1. equanda-maven-plugin
 
-The equanda-maven-plugin module contains several maven targets which can be used to handle some tasks which are important in the compilation and/or maintenance of the application.
+The equanda-maven-plugin module contains maven plugins which help to make optimal use of equanda.
 
-- [generate|generate.html] plugin
-- [translate|translate.html] plugin
-- [archetype|archetype.html] plugin
+For more information about the the contents of this module can be found on the [project site|http://equanda.org/].
+
+equanda is a tool which helps you to build enterprise grade (JEE based) applications with minimal effort. Through code generation, a useful and functional base skeleton is created from the domain model. This application can be customized and the customizations remain active when the domain model changes and  the skeleton is regenerated. This way, the cost of maintaining an evolving application is reduced by eliminating repetitive coding and assuring a consistent code base and user interface.

Deleted: trunk/equanda-maven-plugin/src/site/wiki/translate.wiki
===================================================================
--- trunk/equanda-maven-plugin/src/site/wiki/translate.wiki	2008-12-02 10:19:23 UTC (rev 883)
+++ trunk/equanda-maven-plugin/src/site/wiki/translate.wiki	2008-12-03 09:23:54 UTC (rev 884)
@@ -1,41 +0,0 @@
-h1. translate plugin
-
-To allow easy entering of the translation string for the application, with aid about strings which are not yet translated etc, you can use the translation plugin.
-
-For this to work, shou should edit your .m2/settings.xml file to assure the following bit is included.
-{code}
-    ...
-    <pluginGroups>
-        ...
-        <pluginGroup>org.equanda</pluginGroup>
-        ...
-    </pluginGroups>
-    ...
-{code}
-
-In the pom for the core module, you should add the following (probably merging with the existing equanda-maven-plugin configuration).
-{code}
-    <build>
-        ...
-        <plugins>
-            ...
-            <plugin>
-                <groupId>org.equanda</groupId>
-                <artifactId>equanda-maven-plugin</artifactId>
-                <configuration>
-                    <sourceDirectory>${basedir}/../src/main/om</sourceDirectory>
-                    <translateTarget>${basedir}/src/main/resources/translations.txt</translateTarget>
-                    <verifyLanguages>en;nl</verifyLanguages>
-                </configuration>
-            </plugin>
-            ...
-        </plugins>
-        ...
-    </build>
-{code}
-You may want to change the configuration settings, specifically _verifyLanguages_ as this contains the languages for which translations are needed.
-
-You can now start the translation tool uwing the following maven command.
-{code}
-mvn equanda:translate
-{code}

Modified: trunk/src/site/site.xml
===================================================================
--- trunk/src/site/site.xml	2008-12-02 10:19:23 UTC (rev 883)
+++ trunk/src/site/site.xml	2008-12-03 09:23:54 UTC (rev 884)
@@ -33,6 +33,28 @@
             <item name="License" href="license.html"/>
         </menu>
 
+        <menu name="generate">
+            <item name="Introduction" href="index.html"/>
+        </menu>
+
+        <menu name="templates">
+            <item name="template" href="template.html"/>
+            <item name="ejb3" href="templates/ejb3.html"/>
+            <item name="t5gui" href="templates/t5gui.html"/>
+            <item name="login" href="templates/login.html"/>
+            <item name="import" href="templates/import.html"/>
+            <item name="ddltool" href="templates/ddltool.html"/>
+            <item name="docs" href="templates/docs.html"/>
+        </menu>
+
+        <menu name="maven-plugin">
+            <item name="Generate" href="plugin/generate.html"/>
+            <item name="Translate" href="plugin/translate.html"/>
+            <item name="Archetype" href="plugin/archetype.html"/>
+            <item name="Ddltool" href="plugin/ddltool.html"/>
+            <item name="Import" href="plugin/import.html"/>
+        </menu>
+
         <menu ref="modules" />
         <menu ref="reports" />
     </body>

Added: trunk/src/site/wiki/generate.wiki
===================================================================
--- trunk/src/site/wiki/generate.wiki	                        (rev 0)
+++ trunk/src/site/wiki/generate.wiki	2008-12-03 09:23:54 UTC (rev 884)
@@ -0,0 +1,30 @@
+h1. Generating based on domain model
+
+This model handled the code generation based on the domain model.
+
+Templates are provided for the following aspects.
+- [ejb3|templates/ejb3.html] : EJB3 persistence layer
+- [t5gui|templates/t5gui.html] : tapestry5 user interface
+- [login|templates/login.html] : user management support
+- [import|templates/import.html] : import data
+- [ddltool|templates/ddltool.html] : ddltool
+- [docs|templates/docs.html] : domain model documentation
+
+
+h2. Domain model processing
+
+The domain model is parsed using [xstream|http://xstream.codehaus.org/] and then enriched in a couple of steps.
+
+- Handling of includes. The xml files are parsed one by one. And extra steps are need to include the files which are referenced in the model.
+- Enriching the model, this includes things like building the root tables which flatten the inheritance tree.
+- Validation of constraints on the domain model, catching the contradictions.
+
+
+h2. Developing the templates
+
+For the development of the templates, it is recommmended that you first try to make the change in the generated sources and verify that your changes are valid first. This way, the compilation will not require regeneration of the files (as long as you don't clean and don't change the domain model).
+When the changes work, you can then try to incorporate the modifications in the templates. At that point, you have to recompile the module with the templates and then do a clean build on your verification project (the clean build is needed because the changes in the templates are not noticed by the system).
+
+When developing the templates, you can access the processed model. This model (the API of available methods) can be found in the "org.equanda.domain.xml" package.
+
+[Details about the structure of the templates|template.html].

Copied: trunk/src/site/wiki/plugin/archetype.wiki (from rev 883, trunk/equanda-maven-plugin/src/site/wiki/archetype.wiki)
===================================================================
--- trunk/src/site/wiki/plugin/archetype.wiki	                        (rev 0)
+++ trunk/src/site/wiki/plugin/archetype.wiki	2008-12-03 09:23:54 UTC (rev 884)
@@ -0,0 +1,84 @@
+h1. Archetype Plugin
+
+h2. Usage
+
+The archetype plugin should be used to generate new equanda project from template.
+
+It can be executed by the following command (all on one line) :
+
+{code}
+mvn equanda:archetype
+    -DgroupId=com.mycompany -DartifactId=example
+    -DarchetypeVersion=0.9 -DarchetypeGroupId=org.equanda -DarchetypeArtifactId=equanda-maven-plugin
+{code}
+
+All the parameters on the last line are used internally by maven.
+
+The other parameters can either be specified on the commandline using the "-Dkey=value" syntax, or you can put them in a file called "equanda-project.properties". This file itself can be changed by using something like "-DpropertiesFile=myprops.properties".
+
+Possible parameters (those in bold are required) are :
+
+- *groupId* : project group id
+- *artifactId* : project base artifact id
+- archetypeVersion : equanda archetype plugin version
+- archetypeGroupId : equanda archetype plugin group id, has to be "org.equanda"
+- archetypeArtifactId : equanda archetype plugin artifact id, has to be "equanda-maven-plugin"
+- basedir : base project directory (default is current directory)
+- remoteRepositories : remote repositories, comma separated values
+- packageName : default java package, defaults to the "groupId" value
+- version : new project version (default is "1.0-SNAPSHOT")
+
+For details see Maven [Archetype|http://maven.apache.org/plugins/maven-archetype-plugin/] Plugin Page.
+
+h2. Features
+
+The archetype creates an empty project with the equanda "standard" modules (as also used by the test suite, equanda-contact and equanda-sport example projects).
+
+h3. main module
+
+The main project groups the other modules to allow one entry point into the project.
+- The domain model should be placed in the "src/dm" directory. There is a very small sample domain model generated.
+- Basis for the project site under "src/site". This contains a "getting started" document which details information to compile the project, how to setup a database for development etc.
+- The "config" directory contains a checkstyle configuration.
+
+This includes two profiles which help you for development and testing.
+- use "mvn -Drun install" or "mvn -Drun clean install" to compile, install the application and start jboss with the latest version installed. This allows you to manually verify the correct working, especially the user interface. Once jboss is started this will just wait for jboss to end (to press CTRL-C in the console window when finished). The database structure is updated before starting the application.
+- use "mvn -Dfulltest clean install" to do a clean compile and installation, including running the integrations tests from the test module starting from and empty (or more correctly "known" database). The database structure is updated before starting the application.
+
+Apart from the usual maven targets, the following (standard equanda) targets can be applied to the project.
+- "mvn equanda:translate" to edit the translations file.
+- "mvn equanda:ddltool" to update the database structure.
+
+h3. core module
+
+The core module builds a jar file which contains the EJB classes, including the database access layer, mediators etc.
+- The persistence.xml file, configuring the EJB3/JPA entity beans is in "src/main/resources/META-INF/persistence.xml".
+- The base translations file can be found in "src/main/resources/translations.txt". Use "mvn equanda:translate" to edit this file.
+- There are a couple of example mediator files in "src/main/java/".
+
+h3. gui module
+
+The gui module builds the war file with the tapestry web user interface for the application.
+- In "src/main/java" you can find some proposed layout components, a start page and the AppModule class which configures Tapestry.
+- In "src/main/resources" you can find some Tapestry templates for the pages and components.
+- The AppModule class includes a service for timing the time takes for each page invocation (can be removed).
+- The AppModule class includes a service for getting the login information (which includes the authorizations for the data in the interface).
+- In "src/main/webapp" you can find resources (css/images/script) and the servlet configuration files ("WEB-INF/web-xml" and "WEB-INF/jboss-web.xml").
+
+h3. ear module
+
+The ear module builds the ear file which combines the core jar, the gui war and all libraries which need to be included for deploying in JBoss.
+
+h3. t5compo module
+
+The t5compo module is used for defining and including customizations to the generated user interface.
+- The "src/main/resources/t5gui/mytemplates/templates.properties" file contains the template overrides.
+- The "src/main/resources/t5gui/mytemplates/example.tml.vm" file contains an example changed template.
+
+h3. ddltool module
+
+This module is used to generate the database description file which used by the "equanda:ddltool" maven target and when doing the database update when deploying in JBoss or running the integration tests.
+
+h3. test module
+
+This is the integration test module. All the test class included in this modul are only included in the build phase when the "fulltest" profile is active. This will assure that the application is running (inside JBoss, starting from an empty database with database structure update) when the tests are run.

Copied: trunk/src/site/wiki/plugin/ddltool.wiki (from rev 883, trunk/equanda-maven-plugin/src/site/wiki/ddltool.wiki)
===================================================================
--- trunk/src/site/wiki/plugin/ddltool.wiki	                        (rev 0)
+++ trunk/src/site/wiki/plugin/ddltool.wiki	2008-12-03 09:23:54 UTC (rev 884)
@@ -0,0 +1,26 @@
+h1. Ddltool plugin
+
+This plugin allows you to automatically do database definition/update as part of your maven build.
+
+{code}
+    <plugin>
+        <groupId>org.equanda</groupId>
+        <artifactId>equanda-maven-plugin</artifactId>
+        <configuration>
+            <database>${synca.db.url}</database>
+            <dblogin>${synca.db.login}</dblogin>
+            <dbpassword>${synca.db.password}</dbpassword>
+            <dbmap>be.synergetics.ca.ddltool.EquandaMap</dbmap>
+            <ddltargets>update defaults</ddltargets>
+        </configuration>
+        <executions>
+            <execution>
+                <id>ddltool</id>
+                <phase>test-compile</phase>
+                <goals>
+                    <goal>ddltool</goal>
+                </goals>
+            </execution>
+        </executions>
+    </plugin>
+{code}

Copied: trunk/src/site/wiki/plugin/generate.wiki (from rev 883, trunk/equanda-maven-plugin/src/site/wiki/generate.wiki)
===================================================================
--- trunk/src/site/wiki/plugin/generate.wiki	                        (rev 0)
+++ trunk/src/site/wiki/plugin/generate.wiki	2008-12-03 09:23:54 UTC (rev 884)
@@ -0,0 +1,30 @@
+h1. Generate plugin
+
+The generate plugin should be used to generate the sources based on the [domain model description|../dm.html].
+
+It is for example used in the core module of the application, and there used as follows
+{code}
+    <build>
+        ...
+        <plugins>
+            ...
+            <plugin>
+                <groupId>org.equanda</groupId>
+                <artifactId>equanda-maven-plugin</artifactId>
+                <configuration>
+                    <sourceDirectory>${basedir}/../src/main/om</sourceDirectory>
+                    <template>ejb3,import,login</template>
+                </configuration>
+                <executions>
+                    <execution>
+                        <goals>
+                            <goal>generate</goal>
+                        </goals>
+                    </execution>
+                </executions>
+            </plugin>
+            ...
+        </plugins>
+        ...
+    </build>
+{code}

Copied: trunk/src/site/wiki/plugin/import.wiki (from rev 883, trunk/equanda-maven-plugin/src/site/wiki/import.wiki)
===================================================================
--- trunk/src/site/wiki/plugin/import.wiki	                        (rev 0)
+++ trunk/src/site/wiki/plugin/import.wiki	2008-12-03 09:23:54 UTC (rev 884)
@@ -0,0 +1,31 @@
+h1. Import plugin
+
+This plugin allows you to import data into running instance of your application using the import servlet.
+
+{code}
+<plugin>
+    <groupId>org.equanda</groupId>
+    <artifactId>equanda-maven-plugin</artifactId>
+    <configuration>
+        <url>https://localhost:8443/import</url>
+        <login>local</login>
+        <password>local</password>
+        <locations>
+            <location>organizations.import.txt</location>
+        </locations>
+    </configuration>
+    <executions>
+        <execution>
+            <id>import</id>
+            <phase>test-compile</phase>
+            <goals>
+                <goal>import</goal>
+            </goals>
+        </execution>
+    </executions>
+</plugin>
+{code}
+
+It is possible to define several files to import. THe files themselves are first searched in the classpath (test scope), or if that fails, searched on the file system.
+
+Note that when the several maven plugins with the same group/artifact id are used in one pom, then the configuration is read from the first instance (though the execution itself is correct).

Copied: trunk/src/site/wiki/plugin/translate.wiki (from rev 883, trunk/equanda-maven-plugin/src/site/wiki/translate.wiki)
===================================================================
--- trunk/src/site/wiki/plugin/translate.wiki	                        (rev 0)
+++ trunk/src/site/wiki/plugin/translate.wiki	2008-12-03 09:23:54 UTC (rev 884)
@@ -0,0 +1,41 @@
+h1. translate plugin
+
+To allow easy entering of the translation string for the application, with aid about strings which are not yet translated etc, you can use the translation plugin.
+
+For this to work, shou should edit your .m2/settings.xml file to assure the following bit is included.
+{code}
+    ...
+    <pluginGroups>
+        ...
+        <pluginGroup>org.equanda</pluginGroup>
+        ...
+    </pluginGroups>
+    ...
+{code}
+
+In the pom for the core module, you should add the following (probably merging with the existing equanda-maven-plugin configuration).
+{code}
+    <build>
+        ...
+        <plugins>
+            ...
+            <plugin>
+                <groupId>org.equanda</groupId>
+                <artifactId>equanda-maven-plugin</artifactId>
+                <configuration>
+                    <sourceDirectory>${basedir}/../src/main/om</sourceDirectory>
+                    <translateTarget>${basedir}/src/main/resources/translations.txt</translateTarget>
+                    <verifyLanguages>en;nl</verifyLanguages>
+                </configuration>
+            </plugin>
+            ...
+        </plugins>
+        ...
+    </build>
+{code}
+You may want to change the configuration settings, specifically _verifyLanguages_ as this contains the languages for which translations are needed.
+
+You can now start the translation tool uwing the following maven command.
+{code}
+mvn equanda:translate
+{code}

Copied: trunk/src/site/wiki/template.wiki (from rev 883, trunk/equanda-generate/src/site/wiki/template.wiki)
===================================================================
--- trunk/src/site/wiki/template.wiki	                        (rev 0)
+++ trunk/src/site/wiki/template.wiki	2008-12-03 09:23:54 UTC (rev 884)
@@ -0,0 +1,97 @@
+h1. Template structure
+
+For each target you can have several files which are generated. There is a ini file which contains the list of files which need to be generated.
+This ini file is called "_target-name_.ini" and is searched on the classpath.
+
+The file has the following format (excerpt from the ejb3.ini)
+{code}
+[config]
+path=ejb3
+
+[global]
+
+output1=${outputDir}${packageDir}client/LazyEJBList.java
+template1=LazyEJBList.java.vm
+
+output2=${outputDir}${packageDir}client/LazyProxyList.java
+template2=LazyProxyList.java.vm
+
+
+[root-table]
+
+// build entity bean
+output1=${outputDir}${packageDir}server/pm/DM${table}Bean.java
+template1=DMObjectBean.java.vm
+
+// build session facade bean
+output2=${outputDir}${packageDir}server/${table}Bean.java
+template2=ObjectBean.java.vm
+
+// build session facade root mediator
+output3=${outputDir}${packageDir}server/${table}MediatorRoot.java
+template3=MediatorRoot.java.vm
+
+// build SelectorHelper classes
+output4=${outputDir}${packageDir}server/${table}SelectorHelper.java
+template4=ObjectSelectorHelper.java.vm
+skip-if4=${altOutputDir}${packageDir}server/${table}SelectorHelper.java
+
+
+[table]
+
+// build mediator base class (generated)
+output1=${outputDir}${packageDir}server/${table}MediatorBase.java
+template1=MediatorBase.java.vm
+
+// build mediator class (for manual modification)
+output2=${outputDir}${packageDir}server/${table}Mediator.java
+template2=Mediator.java.vm
+skip-if2=${altOutputDir}${packageDir}server/${table}Mediator.java
+
+
+[multiple-field]
+
+// build entity bean
+output1=${outputDir}${packageDir}server/pm/DM${table}_${field}Bean.java
+template1=DMFieldBean.java.vm
+{code}
+
+The "config" section indicates the path which is prepended to each template file. The templates are all retrieved from the classpath, but the prefix allows you to avoid name collisions (like java packages).
+
+All the other sections indicate the possible groupings in the domain model for which files can be generated.
+The can contain _outputX_, _templateX_ and _skip-ifX_ where X is a number from 1 up to the amount needed (needs to be consecutive). In the parameters, you can use variable replacement using the ant/velocity syntax "${var-name}".
+- output indicates the location where the output file needs to be searched
+- template indicates the template file which needs to be used to produce the output
+- skip-if allows you to skip the template generation if the file with given name already exists.
+
+The sections which can be used (including variables for output names and templates) are
+- global : these templates are invoked once.
+- table : these are generated for each table. "table" is the table name for the filenames, of a _Table_ object for the velocity templates. 
+- root-table : these are generated for each roottable. "table" is the (root) table name for the filenames, of a _RootTable_ object for the velocity templates.
+- root-table-expected-amount-small : same as "root-table" but only when the expected amount on the root is "small".
+- root-table-with-inheritance : same as "root" but only when the inheritance tree has more than one table. 
+- field : each field, has "root-table" variables and "field" name for filenames or _Field_ instance in the templates.
+- field-with-choices : same as "field" but only for fields with choices.
+- select-not-hidden : all selects which are not hidden, has "root-table" variables and "select" name for filenames or _Select_ instance in the templates.
+- action-not-hidden : all actions which are not hidden, has "root-table" variables and "action" name for filenames or _Action_ instance in the templates.
+
+For variable replacement in the filenames, the following are available in all cases.
+- packageName
+- packageDir
+- outputDir
+- altOutputDir
+
+The following variables are always available in te Velocity templates.
+- engine : a reference to the _Generator_ class.
+- name : "equanda'.
+- dollar : "$".
+- dm, data : the actual domain model, instance of the _DomainModel_ class.
+- package : the package name, as passed in the (template specific) configuration. If not defined there, then the "ejb-package" setting from the "extra" sectio is used.
+- generationdate : string representation of the time when the generation started.
+- keyvalue : the keyvalue pairs which are passed in the (template specific) configuration.
+- dbtype : an instance of the convert class as determined in the "database" section.
+
+
+
+
+


This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.




2007	Jan	Feb	Mar	Apr	May	Jun	Jul (6)	Aug (41)	Sep (44)	Oct (31)	Nov (54)	Dec (53)
2008	Jan (71)	Feb (66)	Mar (65)	Apr (73)	May (68)	Jun (69)	Jul (28)	Aug (49)	Sep (44)	Oct (77)	Nov (64)	Dec (78)
2009	Jan (50)	Feb (28)	Mar (41)	Apr (30)	May (5)	Jun (30)	Jul (6)	Aug (2)	Sep (18)	Oct (11)	Nov (6)	Dec (10)
2010	Jan (5)	Feb (8)	Mar (4)	Apr (1)	May	Jun	Jul	Aug	Sep	Oct	Nov	Dec

equanda-svn-commit Mailing List for equanda Java EE code generator (Page 14)

equanda-svn-commit — svn commits