-
Notifications
You must be signed in to change notification settings - Fork 35
/
readme.txt
290 lines (205 loc) · 12.3 KB
/
readme.txt
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
A n d r o M D A - 3.4-SNAPSHOT
AndroMDA is an open-source MDA framework distributed under the BSD license.
Go to http://www.andromda.org/ for more information.
The project located in this directory has been generated by Rene Krenn
using the andromdapp:generate Maven plugin.
You should at least be running Maven 2.0.10 if you want to build your
project without any Maven-related problems, below is a summary of what has
been generated and a list of example goals to call from the command line.
Version 2.0.10 has the fewest known significant bugs.
More info on maven is available at http://maven.apache.org.
An excellent guide (Better Builds with Maven) pdf download is available at
http://www.devzuz.com/web/guest/products/resources#BBWM.
The standard lifecycle goals (each goal depends on all previous goals) are:
generate-sources, process-sources, compile, generate-test-*, test-compile,
test, package, install, deploy. install is the default goal.
If you want to import each subdirectory into Eclipse as an individual project,
follow the instructions in mda/eclipse.bat. The pom.xml files are set up for this
option to work by default.
The generated project structure is well-tailored for use in the development
of J2EE projects. The build process itself makes use of Maven, dependencies
and often-used goals have been added for your convenience.
Custom configuration can be done by updating the root pom.xml file.
pom.xml files in directories under the root inherit the root configuration.
Magic Draw 11.5 (or above) is supported via its 'Export to EMF-UML2' feature. You'll notice
that the andromda.xml is already configured to load these exported files. It expects
that a model called 'ctsms' has been created within your Magic Draw model.
Important: before launching AndroMDA, be sure to have exported your model.
/ctsms J2EE project
|
| The root of the project contains a few files that control the overall
| build process and common properties (in the pom.xml).
|
|-- pom.xml
| contains information about this project, you may add more information
| as long as you do not violate the Maven POM schema, see
| http://maven.apache.org/ref/current/maven-model/maven.html
|
| Generated sources are in target/src/main/java in each subdirectory
| Implementation sources are under /src in each subdirectory
|
+-- /mda
| |
| | The MDA module is the heart of this project, this is where
| | AndroMDA is configured to generate the files needed to
| | assemble the application
| |
| +-- pom.xml
| | contains the AndroMDA dependencies and configuration (cartridges, translation-libraries, etc)
| +-- /src
| | additional sources such as merge-mappings can be
| | placed here, check out the /main/uml directory, it contains
| | the UML model from which AndroMDA will generate code
| +-- /src/main/config/andromda.xml
| configures AndroMDA and its components, most
| importantly the cartridges which are listed in
| their own namespace; global settings are done in the
| 'default' namespace
|
+-- /common
| |
| | The COMMON module collects those resources and classes
| | that are shared between the other modules.
| |
| +-- pom.xml
| | lists common dependencies
| +-- /target
| shared resources and java classes are generated here,
| such as value objects and exceptions
|
+-- /core
| |
| | The CORE module collects those resources and classes
| | that use the Spring framework, optionally making
| | use of Hibernate and/or EJB under the hood.
| |
| +-- pom.xml
| | lists Spring and services dependencies
| +-- /src/main/java
| | Spring classes that need manual implementation are
| | generated here, they will not be overwritten upon
| | regeneration; this includes the service, DAO and
| | entity implementations
| +-- /target
| the Spring resources and classes here will be
| overwriten each time AndroMDA generates new code
| using the Spring cartridge; this includes both
| the Hibernate entities and the correponding
| *.hbm.xml mapping files as well as the service
| and DAO base classes. You'll also find the DDL
| for creating and dropping your schema within this
| directory.
|
+-- /web
| |
| | The WEB module collects all resources and classes
| | that make up the presentation layer, as well as
| | bundling all other modules to create a deployable war.
| |
| +-- pom.xml
| | lists WebApp dependencies
| +-- /src/main/java
| | controller implementations and editable resource bundles
| | will be generated here,
| | you might consider putting your own JSPs here to
| | be copied over the generated ones when bundling the
| | .war file
| +-- /target
| a deployable war is bundled here
|
In order to succesfully build your project you will need to know
how to invoke the build process for the existing modules, here's a
list of examples:
Please note that you may use the '-o' flag at any time to avoid
having Maven downloading any SNAPSHOT dependencies.
edit: summary of important mvn commands:
mvn install -DskipTests
mvn dependency:tree
mvn -f core/pom.xml -Dmaven.test.skip=true
mvn -f common/pom.xml -Dmaven.test.skip=true
mvn -f core/pom.xml org.andromda.maven.plugins:andromdapp-maven-plugin:schema -Dtasks=create
mvn -f core/pom.xml org.andromda.maven.plugins:andromdapp-maven-plugin:schema -Dtasks=drop
%> mvn
simply builds all modules
%> mvn -o
builds all modules in offline mode - does not check remote repositories for updates or downloads
%> mvn -Peclipse
builds all modules and updates the .project and .classpath files (Eclipse project information).
Must be used after dependency changes.
%> mvn -Peclipse -Dmaven.test.skip=true
builds all modules and skips all automatic tests (i.e. surefire expected/actual)
%> mvn -Dmaven.test.failure.ignore=true
builds all modules and run all automatic tests but does not stop if a test failure
%> mvn -Dmaven.test.failure.ignore=true
builds all modules and run all automatic tests but does not stop if a test failure
%> mvn -f web/pom.xml -Ddeploy
collects all artifacts and builds a deployable .war which is then
deployed
%> mvn clean
cleans (recursively removes) all files from each target directory
%> mvn -f mda/pom.xml install
Generates the source files, without compilation or deployment. Or run 'mvn install' from the mda subdirectory.
%> mvn -Ddeploy
rebuilds the entire application and deploys
%> mvn -Denv=prod
builds the entire application for the production environment, possible 'env' property values
are 'prod' for production, 'val' for validation and 'dev' for development; not specifying
any value for this property will build the application for the local configuration
(more info at http://maven.apache.org/guides/introduction/introduction-to-profiles.html)
%> mvn -f web/pom.xml andromdapp:undeploy -o
undeploys the war from your app server
%> mvn -N andromdapp:build -Dmodules=core (or mvn -f core/pom.xml)
only build the core module
%> mvn -N andromdapp:build -Dmodules=web (or mvn -f web/pom.xml)
only build the web module
%> mvn -f core/pom.xml org.andromda.maven.plugins:andromdapp-maven-plugin:schema -Dtasks=create
generates the DDL create code and subsequently tells the database
to create the schema for the entities under app/target/schema*.sql
%> mvn -f core/pom.xml org.andromda.maven.plugins:andromdapp-maven-plugin:schema -Dtasks=drop
generates the DDL drop code and subsequently tells the database
to drop the schema for the entities
%> mvn -f core/pom.xml org.andromda.maven.plugins:andromdapp-maven-plugin:schema -Dtasks=drop,create
generates the drop and create DDL code and subsequently tells the database
to drop and then create the schema for the entities
%> mvn -f core/pom.xml org.andromda.maven.plugins:andromdapp-maven-plugin:schema -Dtasks=update
attempts to update the database schema with incremental changes, might not work with all JDBC drivers
see http://www.hibernate.org/hib_docs/v3/reference/en/html_single/#toolsetguide-s1-6
%> mvn -f core/pom.xml org.andromda.maven.plugins:andromdapp-maven-plugin:schema -Dtasks=validate
validates the current Hibernate mappings against the database, you can also use this to simply
check whether or not the mappings have been properly generated (in case of customizations)
%> mvn -N andromdapp:build -Dmodules=mda:[andromda:start-server] (or mvn -f mda/pom.xml andromda:start-server)
starts the AndroMDA server, with this server running you will be able
to significantly speedup the generation process although it will require
you to use another console while it is running
%> mvn -N andromdapp:build -Dmodules=mda:[andromda:stop-server] (or mvn -f mda/pom.xml andromda:stop-server)
stops the AndroMDA server
%> mvn -N andromdapp:build -Dmodules=mda (or mvn -f mda/pom.xml)
runs AndroMDA on your model and thereby generating files in
the subdirectories of the existing modules
%> mvn -N andromdapp:build -Dmodules=mda -Dfilter=java,hibernate (or mvn -f mda/pom.xml -Dfilter=java,hibernate)
runs AndroMDA, but this time only using the Java and Hibernate
cartridges (in that order)
%> mvn -N andromdapp:build -Dmodules=mda -Dfilter=~java,hibernate (or mvn -f mda/pom.xml -Dfilter=~java,hibernate)
runs AndroMDA, but this time using all cartridges *except*
the Java and Hibernate cartridges
%> mvn -N andromdapp:build -Dmodules=mda,core,web -Dfilter=java -Ddeploy
runs AndroMDA using only the Java cartridge, rebuilds the core
module and web module and deploys afterwards
%> mvn -N andromdapp:build -Dconsole
runs the AndroMDApp build goal in 'console' mode, once running, this allows you to execute any goal or subproject
goal in the manner described above without having to specify the andromdapp:build goal or
restarting maven (i.e. you can run the mda goal by typing 'mda', build the core module by type 'core', etc).
%> mvn compile:compile
compile all sources
%> mvn process-sources
generates and compiles all sources from the model(s) without installing/deploying
Each module will install its artifact into the local Maven repository,
this might be a directory looking like this:
(Windows)
C:\Documents and Settings${author}\.m2\repository${applicationId}\
(*nix)
/home/Rene Krenn/.m2/repository/ctsms/
For questions or feature requests please use our forum:
http://forum.andromda.org/
Good luck!
-- The AndroMDA Team