Skip to content

Commit ff95b91

Browse files
author
Frédéric Ferran
committed
- Update the Java Designer open-source for Modelio 4.1.
 - Add its documentation in the src/main/doc directory - Add an aggregator pom file in src/main/aggregator directory. Use this pom in order to build the Java Designer documentation and Java Designer module.
1 parent 1c0fb0b commit ff95b91

122 files changed

Lines changed: 2904 additions & 40 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

‎JavaDesigner/.gitignore‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
target

‎JavaDesigner/pom.xml‎

Lines changed: 34 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -5,17 +5,17 @@
55
<!-- definition -->
66
<groupId>org.modelio.module</groupId>
77
<artifactId>javadesigner</artifactId>
8-
<version>3.9.00</version>
8+
<version>3.10.00</version>
99
<name>JavaDesigner</name>
10+
<description>The Java Designer module provides a complete range of features dedicated to Java development, including Java code and Javadoc generation from UML2 models. It also provides an automatic model completion feature, incorporating automatic accessor production and synchronization, and a reverse service used to reverse-engineer existing Java application.</description>
1011

1112
<!-- repositories -->
12-
<repositories>
13+
<repositories>
1314
<repository>
1415
<id>modelio</id>
1516
<url>https://repository.modelio.org</url>
1617
</repository>
1718
</repositories>
18-
1919
<pluginRepositories>
2020
<pluginRepository>
2121
<id>modelio</id>
@@ -33,7 +33,7 @@
3333
<dependency>
3434
<groupId>org.modelio</groupId>
3535
<artifactId>MDAKit</artifactId>
36-
<version>[4.0.0,4.0.1)</version>
36+
<version>[4.1.0,4.2.0)</version>
3737
<type>pom</type>
3838
<scope>provided</scope>
3939
</dependency>
@@ -48,7 +48,7 @@
4848
<groupId>com.modelio.module</groupId>
4949
<artifactId>xmlreverse</artifactId>
5050
<version>3.4.03</version>
51-
<type>jar</type>
51+
<type>jar</type>
5252
</dependency>
5353

5454
<dependency>
@@ -63,21 +63,28 @@
6363
<version>3.4.1</version>
6464
</dependency>
6565

66-
<dependency>
67-
<groupId>org.modelio</groupId>
68-
<artifactId>org.modelio.modelermodule</artifactId>
69-
<version>9.1.00</version>
70-
<type>jar</type>
71-
<scope>provided</scope>
72-
</dependency>
73-
74-
<dependency>
75-
<groupId>org.modelio</groupId>
76-
<artifactId>org.modelio.core.session</artifactId>
77-
<version>[4.0.0,4.0.1)</version>
78-
<type>jar</type>
79-
<scope>provided</scope>
80-
</dependency>
66+
<dependency>
67+
<groupId>org.modelio</groupId>
68+
<artifactId>org.modelio.modelermodule</artifactId>
69+
<version>9.1.00</version>
70+
<type>jar</type>
71+
<scope>provided</scope>
72+
</dependency>
73+
74+
<dependency>
75+
<groupId>org.modelio</groupId>
76+
<artifactId>org.modelio.core.session</artifactId>
77+
<version>[4.1.0,4.2.0)</version>
78+
<type>jar</type>
79+
<scope>provided</scope>
80+
</dependency>
81+
82+
<dependency>
83+
<groupId>org.modelio</groupId>
84+
<artifactId>org.modelio.platform.core</artifactId>
85+
<version>[4.1.0,4.2.0)</version>
86+
<scope>provided</scope>
87+
</dependency>
8188

8289
</dependencies>
8390

@@ -99,10 +106,10 @@
99106
<plugin>
100107
<groupId>org.modelio</groupId>
101108
<artifactId>modelio-maven-plugin</artifactId>
102-
<version>4.0.0.00</version>
109+
<version>4.0.0.00</version>
103110
<executions>
104111
<execution>
105-
<id>ModuleValidation</id>
112+
<id>ModuleValidation</id>
106113
<phase>validate</phase>
107114
<goals>
108115
<goal>module-validation</goal>
@@ -180,8 +187,7 @@
180187
<phase>package</phase>
181188
<configuration>
182189
<target>
183-
<move file="${project.basedir}/target/${project.name}_${project.version}.zip" tofile="${project.basedir}/target/${project.name}_${project.version}.jmdac" />
184-
190+
<move file="${project.basedir}/target/${project.name}_${project.version}.zip" tofile="${project.basedir}/target/${project.name}_${project.version}.jmdac" />
185191
</target>
186192
</configuration>
187193
<goals>
@@ -222,14 +228,14 @@
222228
modelio-maven-plugin
223229
</artifactId>
224230
<versionRange>
225-
[4.0.0.00,)
231+
[4.0.0.00,)
226232
</versionRange>
227233
<goals>
228234
<goal>
229-
module-validation
235+
module-validation
230236
</goal>
231237
<goal>
232-
module-configuration
238+
module-configuration
233239
</goal>
234240
</goals>
235241
</pluginExecutionFilter>
@@ -244,6 +250,6 @@
244250
</plugins>
245251
</pluginManagement>
246252
</build>
247-
<description>The Java Designer module provides a complete range of features dedicated to Java development, including Java code and Javadoc generation from UML2 models. It also provides an automatic model completion feature, incorporating automatic accessor production and synchronization, and a reverse service used to reverse-engineer existing Java application.</description>
253+
248254
</project>
249255

‎JavaDesigner/src/main/aggregator/pom.xml‎

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
<!--
2+
3+
Java designer Maven aggregator
4+
5+
Use this aggregator pom file in order to build the Java Designer module with its documentation.
6+
7+
-->
8+
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
9+
<modelVersion>4.0.0</modelVersion>
10+
11+
<groupId>org.modelio</groupId>
12+
<artifactId>aggregator-javadesigner</artifactId>
13+
<version>0.0.00</version>
14+
<packaging>pom</packaging>
15+
16+
<properties>
17+
<sonar.java.source>1.8</sonar.java.source>
18+
</properties>
19+
20+
<modules>
21+
<module>../../..</module>
22+
<module>../doc</module>
23+
</modules>
24+
25+
</project>
26+

‎JavaDesigner/src/main/conf/module.xml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
2-
<Module id="${project.name}" class="org.modelio.module.javadesigner.impl.JavaDesignerModule" binaryversion="4.0.00" version="${project.version}" schema-level="2" uid="003800a8-0000-022e-0000-000000000000">
2+
<Module id="${project.name}" class="org.modelio.module.javadesigner.impl.JavaDesignerModule" binaryversion="4.1.00" version="${project.version}" schema-level="2" uid="003800a8-0000-022e-0000-000000000000">
33
<ClassPath>
44
<PathEntry path="lib/${project.artifactId}-${project.version}.jar"/>
55
<PathEntry path="lib/org.modelio.documentation.javadesigner-${project.version}.jar"/>

‎JavaDesigner/src/main/doc/.gitignore‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
target

‎JavaDesigner/src/main/doc/META-INF/MANIFEST.MF‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
Bundle-SymbolicName: org.modelio.documentation.javadesigner;singleton=true
2+
Bundle-Version: 3.10.00
3+
Bundle-Name: Java designer documentation
4+
Bundle-Vendor: modelio.org

‎JavaDesigner/src/main/doc/adoc/Classpath_and_external_classes.adoc‎

Lines changed: 44 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,44 @@
1+
[[Project-classpath-types-not-found-and-external-classes]]
2+
3+
[[project-classpath-types-not-found-and-external-classes]]
4+
= Project classpath, types not found and external classes
5+
6+
[[Available-source-files]]
7+
8+
[[available-source-files]]
9+
=== Available source files
10+
11+
Usually a java project is composed of its own model and source files. During a reverse operation (or a round trip mode update), all those files are considered accessible: links are always created in the model to the corresponding classes.
12+
13+
*_Note:_* Each << Java Component >> can define its own source path, meaning a java project can use several source directories at the same time.
14+
15+
[[Defining-classpath]]
16+
17+
[[defining-classpath]]
18+
=== Defining classpath
19+
20+
Sometimes, other elements are needed, which are essential to the project but do not actually belong to it. They usually correspond to external libraries (Jar files), or some other parts of the project not yet in the model.
21+
22+
All used JAR files must be declared in the project configuration. To define them, launch the “Java Designer/Configuration/Edit accessible classes” command on the project’s root package.
23+
24+
image:images/Classpath_and_external_classes_Menu_146.png[image]
25+
26+
[[Type-reverse]]
27+
28+
[[type-reverse]]
29+
=== Type reverse
30+
31+
When a reference to a type (extends link, parameter…) is found and needs to be reversed, Java Designer goes through several steps:
32+
33+
* Is this java type accessible in the project sources (.java) or in the configuration (.jar)?
34+
** Not found means the type *won’t be searched in the model*: all references are replaced by tagged values, making the model partially inaccurate. The configuration may need to be completed, or the model to be generated. A “Type not found” warning is also added to the report.
35+
** Type found in accessible classes, search in the model.
36+
* Is this type found in the model?
37+
** Yes, update its content.
38+
** Not found in the model, it will be created. Is this type part of the files to reverse?
39+
*** Yes, type is created in the model with all its content.
40+
*** No, type is created in the model as an “External element”. An “External element creation” warning is also added to the report.
41+
42+
*_Note:_* An “External Element” is an empty placeholder. It is recommended either to update it, or to use a Model Component that contains it. The Java code of an external element is never generated.
43+
44+
[[footer]]

‎JavaDesigner/src/main/doc/adoc/Index.adoc‎

Lines changed: 92 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,92 @@
1+
[[Modelio-Java-Designer-User-Guide]]
2+
3+
[[modelio-java-designer-user-guide]]
4+
= Modelio Java Designer User Guide
5+
6+
[[Introduction]]
7+
8+
[[introduction]]
9+
== Introduction
10+
11+
* *<<Javadesigner-_javadeveloper_intro_overview.adoc#,Introducing Modelio Java Designer>>*
12+
* *<<Javadesigner-_javadeveloper_intro_main_features.adoc#,Modelio Java Designer main features>>*
13+
* *<<Javadesigner-_javadeveloper_intro_java_designer_property_view.adoc#,Java Designer property view>>*
14+
* *<<Javadesigner-_javadeveloper_intro_using_model_components_with_java.adoc#,Using model components with Modelio Java Designer>>*
15+
* *<<Javadesigner-_javadeveloper_intro_managing_resources.adoc#,Managing resources>>*
16+
* *<<Javadesigner-_javadeveloper_intro_gloss.adoc#,Glossary>>*
17+
18+
[[Functionalities]]
19+
20+
[[functionalities]]
21+
== Functionalities
22+
23+
[[Choosing-your-functional-mode]]
24+
25+
[[choosing-your-functional-mode]]
26+
===== Choosing your functional mode
27+
28+
* *<<Javadesigner-_javadeveloper_choose_functional_mode_java_functioning_modes.adoc#,Java functioning modes>>*
29+
* *<<Javadesigner-_javadeveloper_choose_functional_mode_model_driven_mode.adoc#,Model-driven mode>>*
30+
* *<<Javadesigner-_javadeveloper_choose_functional_mode_round_trip_mode.adoc#,Round-trip mode>>*
31+
32+
[[Generating-Java-code]]
33+
34+
[[generating-java-code]]
35+
===== Generating Java code
36+
37+
* *<<Javadesigner-_javadeveloper_generating_java_code_overview.adoc#,Overview of Java code generation>>*
38+
* *<<Javadesigner-_javadeveloper_generating_java_code_java_code_generation_functions.adoc#,Java code generation functions>>*
39+
* *<<Javadesigner-_javadeveloper_generating_java_code_tagged_value_types.adoc#,Tagged value types for Java>>*
40+
* *<<Javadesigner-_javadeveloper_generating_java_code_note_types.adoc#,Note types for Java>>*
41+
* *<<Javadesigner-_javadeveloper_generating_java_code_stereo_types.adoc#,Stereotypes for Java>>*
42+
* *<<Javadesigner-_javadeveloper_generating_java_code_java_code_and_modeling_correspondence.adoc#,Java code and modeling correspondance>>*
43+
44+
[[Java-documentation-generation]]
45+
46+
[[java-documentation-generation]]
47+
===== Java documentation generation
48+
49+
* *<<Javadesigner-_javadeveloper_java_doc_generation_overview.adoc#,Overview of Java documentation generation>>*
50+
* *<<Javadesigner-_javadeveloper_java_doc_generation_java_doc_generation_functions.adoc#,Java documentation generation functions>>*
51+
* *<<Javadesigner-_javadeveloper_java_doc_generation_java_doc_generation_note_types.adoc#,Java documentation generation note types>>*
52+
53+
[[ANT-generation]]
54+
55+
[[ant-generation]]
56+
===== ANT generation
57+
58+
* *<<Javadesigner-_javadeveloper_ant_generation_gen_build_ant_file.adoc#,Generating and building from a compilation artifact>>*
59+
* *<<Javadesigner-_javadeveloper_ant_generation_running_applications.adoc#,Running applications from a compilation artifact>>*
60+
* *<<Javadesigner-_javadeveloper_ant_generation_creating_targets.adoc#,Creating targets>>*
61+
62+
[[Java-Reverse]]
63+
64+
[[java-reverse]]
65+
===== Java Reverse
66+
67+
* *<<Javadesigner-_javadeveloper_java_reverse_overview_reverse.adoc#,Overview of Java Reverse>>*
68+
* *<<Javadesigner-_javadeveloper_java_reverse_functioning_reverse_tool.adoc#,Functioning of the reverse tool>>*
69+
* *<<Classpath_and_external_classes.adoc#,Project classpath, types not found and external classes>>*
70+
* *<<Javadesigner-_javadeveloper_java_reverse_launching_reverse_command.adoc#,Launching the reverse command>>*
71+
* *<<Javadesigner-_javadeveloper_java_reverse_three_reverse_levels.adoc#,Three reverse levels>>*
72+
* *<<Javadesigner-_javadeveloper_java_reverse_updating_model.adoc#,Updating the UML model>>*
73+
* *<<Javadesigner-_javadeveloper_java_reverse_restrictions_workarounds.adoc#,Restrictions and workarounds>>*
74+
75+
[[Java-automation]]
76+
77+
[[java-automation]]
78+
===== Java automation
79+
80+
* *<<Javadesigner-_javadeveloper_java_automation_access_methods.adoc#,Access methods>>*
81+
* *<<Javadesigner-_javadeveloper_java_automation_interfaces.adoc#,Interface implementation>>*
82+
83+
[[Customizing-Java-generation]]
84+
85+
[[customizing-java-generation]]
86+
== Customizing Java generation
87+
88+
* *<<Javadesigner-_javadeveloper_customizing_java_generation_overview.adoc#,Overview of Java generation customization>>*
89+
* *<<Javadesigner-_javadeveloper_customizing_java_generation_parameters.adoc#,Modelio Java Designer parameters>>*
90+
* *<<Javadesigner-_javadeveloper_customizing_java_generation_customization_file.adoc#,Customization file>>*
91+
92+
[[footer]]

‎JavaDesigner/src/main/doc/adoc/Javadesigner-_java_files_java_1.adoc‎

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
[[The-Introduction-topic]]
2+
3+
[[the-introduction-topic]]
4+
===== The Introduction topic
5+
6+
In the Introduction topic of the Modelio Java Designer user guide, you’ll find a general presentation of Modelio Java Designer, along with information on the main features of the module, the property view, resource management and a handy glossary.
7+
8+
The Introduction topic contains the following sections:
9+
10+
* <<Javadesigner-_javadeveloper_intro_overview.adoc#,Introducing Modelio Java Designer>>
11+
* <<Javadesigner-_javadeveloper_intro_main_features.adoc#,Modelio Java Designer main features>>
12+
* <<Javadesigner-_javadeveloper_intro_java_designer_property_view.adoc#,Java Designer property view>>
13+
* <<Javadesigner-_javadeveloper_intro_using_model_components_with_java.adoc#,Using model components with Modelio Java Designer>>
14+
* <<Javadesigner-_javadeveloper_intro_managing_resources.adoc#,Managing resources>>
15+
* <<Javadesigner-_javadeveloper_intro_gloss.adoc#,Glossary>>
16+
17+
[[footer]]

0 commit comments

Comments
 (0)