Merge pull request #1 from HammerMaximilian/development

development --> master

Author: HammerMaximilian

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 HammerMaximilian
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.md

@@ -1 +1,55 @@
-# fUML-Java
+<img src="logo.png" width="264"/>
+
+# fUML Reference Implementation for *Java*
+This software is an open source reference implementation of the *Semantics of a Foundational Subset for Executable UML Models* (fUML)  specifications by the *Object Management Group* (OMG) (see [fUML](https://www.omg.org/spec/FUML/1.5/About-FUML)). The fUML implementation of this software is a ont-on-one port of the original Java fUML reference implementation developed by
+*Model Driven Solutions* (see [https://github.com/ModelDriven/fUML-Reference-Implementation](https://github.com/ModelDriven/fUML-Reference-Implementation))
+
+## Licensing
+For licensing information, please see the [LICENSE](LICENSE) file.
+
+## Prerequisites
+For detailed information, please see the [User Guide](fUML-Java_User_Guide.pdf) section *1. Prerequisites*.
+### 1. Required Software
+* *Java Runtime Environment*
+* *Eclipse IDE for Java Developers*
+### 2. Recommended but optional Software
+* *Eclipse Modeling Tools* for creating UML models
+* *Eclipse Papyrus* for more sophisticated and graphical modeling of UML models
+* *Acceleo* to be able to use the code generator for executable models
+
+## Setup
+For detailed information, please see the [User Guide](fUML-Java_User_Guide.pdf) section *2. Setup*.
+### 1. Setting up Eclipse
+* Import fUML-Java root project *fUML-Java* into your workspace
+* Import nested projects *uml* and *fuml*
+
+## Building
+For detailed information, please see the [User Guide](fUML-Java_User_Guide.pdf) section *3. Build*.
+* No further build required, compilation is done automatically by the *Eclipse IDE*[^1]
+[^1]: Instructions for external build, i.e., without any IDE, will be added in the future.
+
+## Usage
+For detailed information, please see the [User Guide](fUML-Java_User_Guide.pdf) section *4. Usage*.
+### 1. Creating executable models using source code
+* Create new Java project (see `"<fUML-Java-rootdir>\examples\helloworld"` as a reference project)
+  * NOTE: it is suggested to store user-defined source code projects in common directory `"<fUML-Java-rootdir>\usersrc"`
+  * The *usersrc* directory may contain arbitrary nested subdirectories
+* Add the *uml* and *fuml* projects to the classpath of your project
+* Create a `<model-name>Environment` class by extending class `utils.environmentfuml.Environment`
+* Create a `<model-name>Model` class by extending class `utils.environment.InMemoryModel` (this class will contain all of your model elements)
+* Create a class containing a main method and call `<model-name>Environment.instance().execute("<behavior-name>");` for each behavior you want to execute in subsequent order
+* Run your project as a Java application within the *Eclipse IDE*
+### 2. Generating executable models from *.uml* models (*Acceleo* plugin for Eclipse has to be installed)
+* Create new *.uml* model with a modeling tool of your choice (*Eclipse Papyrus* is suggested)
+  * NOTE: it is suggested to store user-defined models in common directory `"<fUML-Java-rootdir>\usermodels"`
+  * The *usermodels* directory may contain arbitrary nested subdirectories
+* Import nested project *generator* within fUML-Java root project
+* Navigate to file `\generator\src\fuml.generator.main\generate.mtl` in the project explorer
+* Right click `generate.mtl` and choose `Run as`-->`Run configurations...`
+* Configure and run Acceleo Application accordingly:
+  *  Choose `fuml.generator.main.Generate`
+  *  Choose your model file
+  *  Choose a target directory for the generated source code (`"<fUML-Java-rootdir>\usersrc\<model-name>"` is suggested)
+* Import newly generated Java project within fUML-Java root project and configure a run configuration
+* Add program arguments to define behaviors to be executed using `<behavior-name> [<behavior-name> <behavior-name> <behavior-name> <...>]`
+ * Run as Java application within the *Eclipse IDE*

fUML-Java/.gitignore

@@ -0,0 +1,2 @@
+/usermodels/
+/usersrc/

fUML-Java/.project

@@ -0,0 +1,11 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<projectDescription>
+	<name>fUML-Java</name>
+	<comment></comment>
+	<projects>
+	</projects>
+	<buildSpec>
+	</buildSpec>
+	<natures>
+	</natures>
+</projectDescription>

fUML-Java/.settings/org.eclipse.core.resources.prefs

@@ -0,0 +1,2 @@
+eclipse.preferences.version=1
+encoding/<project>=UTF-8

fUML-Java/assets/extensionsprofile/extensions.profile.di

@@ -0,0 +1,2 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<architecture:ArchitectureDescription xmi:version="2.0" xmlns:xmi="http://www.omg.org/XMI" xmlns:architecture="http://www.eclipse.org/papyrus/infra/core/architecture" contextId="org.eclipse.papyrus.uml.architecture.Profile"/>

fUML-Java/assets/extensionsprofile/extensions.profile.notation

@@ -0,0 +1,63 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<notation:Diagram xmi:version="2.0" xmlns:xmi="http://www.omg.org/XMI" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:ecore="http://www.eclipse.org/emf/2002/Ecore" xmlns:notation="http://www.eclipse.org/gmf/runtime/1.0.3/notation" xmlns:style="http://www.eclipse.org/papyrus/infra/gmfdiag/style" xmlns:uml="http://www.eclipse.org/uml2/5.0.0/UML" xmi:id="_-FlOsLSlEe6mgZP5iH_Gzg" type="PapyrusUMLProfileDiagram" name="Profile Diagram" measurementUnit="Pixel">
+  <children xmi:type="notation:Shape" xmi:id="_IOta0LSmEe6mgZP5iH_Gzg" type="Stereotype_Shape">
+    <children xmi:type="notation:DecorationNode" xmi:id="_IOta0rSmEe6mgZP5iH_Gzg" type="Stereotype_NameLabel"/>
+    <children xmi:type="notation:BasicCompartment" xmi:id="_IOuB4LSmEe6mgZP5iH_Gzg" type="Stereotype_AttributeCompartment">
+      <styles xmi:type="notation:TitleStyle" xmi:id="_IOuB4bSmEe6mgZP5iH_Gzg"/>
+      <styles xmi:type="notation:SortingStyle" xmi:id="_IOuB4rSmEe6mgZP5iH_Gzg"/>
+      <styles xmi:type="notation:FilteringStyle" xmi:id="_IOuB47SmEe6mgZP5iH_Gzg"/>
+      <layoutConstraint xmi:type="notation:Bounds" xmi:id="_IOuB5LSmEe6mgZP5iH_Gzg"/>
+    </children>
+    <children xmi:type="notation:BasicCompartment" xmi:id="_IOuB5bSmEe6mgZP5iH_Gzg" type="Stereotype_OperationCompartment">
+      <styles xmi:type="notation:TitleStyle" xmi:id="_IOuB5rSmEe6mgZP5iH_Gzg"/>
+      <styles xmi:type="notation:SortingStyle" xmi:id="_IOuB57SmEe6mgZP5iH_Gzg"/>
+      <styles xmi:type="notation:FilteringStyle" xmi:id="_IOuB6LSmEe6mgZP5iH_Gzg"/>
+      <layoutConstraint xmi:type="notation:Bounds" xmi:id="_IOuB6bSmEe6mgZP5iH_Gzg"/>
+    </children>
+    <element xmi:type="uml:Stereotype" href="extensions.profile.uml#_IOsMsLSmEe6mgZP5iH_Gzg"/>
+    <layoutConstraint xmi:type="notation:Bounds" xmi:id="_IOta0bSmEe6mgZP5iH_Gzg" x="80" y="140"/>
+  </children>
+  <children xmi:type="notation:Shape" xmi:id="_XxzVQbSmEe6mgZP5iH_Gzg" type="Class_MetaclassShape">
+    <eAnnotations xmi:type="ecore:EAnnotation" xmi:id="_XxzVRbSmEe6mgZP5iH_Gzg" source="Stereotype_Annotation">
+      <details xmi:type="ecore:EStringToStringMapEntry" xmi:id="_XxzVRrSmEe6mgZP5iH_Gzg" key="StereotypeWithQualifiedNameList" value=""/>
+      <details xmi:type="ecore:EStringToStringMapEntry" xmi:id="_XxzVR7SmEe6mgZP5iH_Gzg" key="StereotypeList" value="StandardProfile::Metaclass"/>
+      <details xmi:type="ecore:EStringToStringMapEntry" xmi:id="_XxzVSLSmEe6mgZP5iH_Gzg" key="Stereotype_Presentation_Kind" value="HorizontalStereo"/>
+      <details xmi:type="ecore:EStringToStringMapEntry" xmi:id="_XxzVSbSmEe6mgZP5iH_Gzg" key="PropStereoDisplay" value=""/>
+      <details xmi:type="ecore:EStringToStringMapEntry" xmi:id="_XxzVSrSmEe6mgZP5iH_Gzg" key="StereotypePropertyLocation" value="Compartment"/>
+    </eAnnotations>
+    <children xmi:type="notation:DecorationNode" xmi:id="_XxzVQ7SmEe6mgZP5iH_Gzg" type="Class_MetaclassNameLabel"/>
+    <element xmi:type="uml:Class" href="pathmap://UML_METAMODELS/UML.metamodel.uml#CallOperationAction"/>
+    <layoutConstraint xmi:type="notation:Bounds" xmi:id="_XxzVRLSmEe6mgZP5iH_Gzg" x="80" y="20"/>
+  </children>
+  <children xmi:type="notation:Shape" xmi:id="_LivQALSpEe6BLIM139JPJA" type="StereotypeComment">
+    <styles xmi:type="notation:TitleStyle" xmi:id="_LivQAbSpEe6BLIM139JPJA"/>
+    <styles xmi:type="notation:EObjectValueStyle" xmi:id="_LivQA7SpEe6BLIM139JPJA" name="BASE_ELEMENT">
+      <eObjectValue xmi:type="uml:Class" href="pathmap://UML_METAMODELS/UML.metamodel.uml#CallOperationAction"/>
+    </styles>
+    <element xsi:nil="true"/>
+    <layoutConstraint xmi:type="notation:Bounds" xmi:id="_LivQArSpEe6BLIM139JPJA" x="280" y="20"/>
+  </children>
+  <styles xmi:type="notation:StringValueStyle" xmi:id="_-FlOsbSlEe6mgZP5iH_Gzg" name="diagram_compatibility_version" stringValue="1.4.0"/>
+  <styles xmi:type="notation:DiagramStyle" xmi:id="_-FlOsrSlEe6mgZP5iH_Gzg"/>
+  <styles xmi:type="style:PapyrusDiagramStyle" xmi:id="_-FlOs7SlEe6mgZP5iH_Gzg" diagramKindId="org.eclipse.papyrus.uml.diagram.profile">
+    <owner xmi:type="uml:Profile" href="extensions.profile.uml#_-FkAkLSlEe6mgZP5iH_Gzg"/>
+  </styles>
+  <element xmi:type="uml:Profile" href="extensions.profile.uml#_-FkAkLSlEe6mgZP5iH_Gzg"/>
+  <edges xmi:type="notation:Connector" xmi:id="_iDEJsLSmEe6mgZP5iH_Gzg" type="Extension_Edge" source="_IOta0LSmEe6mgZP5iH_Gzg" target="_XxzVQbSmEe6mgZP5iH_Gzg">
+    <styles xmi:type="notation:FontStyle" xmi:id="_iDEJsbSmEe6mgZP5iH_Gzg"/>
+    <element xmi:type="uml:Extension" href="extensions.profile.uml#_iCxOwLSmEe6mgZP5iH_Gzg"/>
+    <bendpoints xmi:type="notation:RelativeBendpoints" xmi:id="_iDEJsrSmEe6mgZP5iH_Gzg" points="[140, 140, -643984, -643984]$[140, 70, -643984, -643984]"/>
+    <sourceAnchor xmi:type="notation:IdentityAnchor" xmi:id="_iDXrsLSmEe6mgZP5iH_Gzg" id="(0.49586776859504134,0.0)"/>
+    <targetAnchor xmi:type="notation:IdentityAnchor" xmi:id="_iDhcsLSmEe6mgZP5iH_Gzg" id="(0.5,1.0)"/>
+  </edges>
+  <edges xmi:type="notation:Connector" xmi:id="_Liv3ELSpEe6BLIM139JPJA" type="StereotypeCommentLink" source="_XxzVQbSmEe6mgZP5iH_Gzg" target="_LivQALSpEe6BLIM139JPJA">
+    <styles xmi:type="notation:FontStyle" xmi:id="_Liv3EbSpEe6BLIM139JPJA"/>
+    <styles xmi:type="notation:EObjectValueStyle" xmi:id="_Liv3FbSpEe6BLIM139JPJA" name="BASE_ELEMENT">
+      <eObjectValue xmi:type="uml:Class" href="pathmap://UML_METAMODELS/UML.metamodel.uml#CallOperationAction"/>
+    </styles>
+    <element xsi:nil="true"/>
+    <bendpoints xmi:type="notation:RelativeBendpoints" xmi:id="_Liv3ErSpEe6BLIM139JPJA" points="[0, 0, 0, 0]$[0, 0, 0, 0]"/>
+    <sourceAnchor xmi:type="notation:IdentityAnchor" xmi:id="_Liv3E7SpEe6BLIM139JPJA"/>
+    <targetAnchor xmi:type="notation:IdentityAnchor" xmi:id="_Liv3FLSpEe6BLIM139JPJA"/>
+  </edges>
+</notation:Diagram>