This Developer Guide helps developers of the Mod4j project to get started with coding and modeling. If you are an user of Mod4j you should follow the Getting Started from the user docs. See menu > User Docs > Getting Started.
|Eclise plug-in||Features to select when installing||Update site|
|Eclipse Xtext and Xpand plug-ins|| - TMF XTEXT SDK (Incubation) 0.7.2
- M2T XPAND SDK (Incubation) 0.7.2
- MWE SDK (Incubation) 0.7.2
|Eclipse Xtext Antlr plug-ins||- Xtext Antlr Support 0.7.2||
|Eclipse Maven plug-in: m2eclipse||- Maven Integration for Eclipse 0.12.1 or higher||
|Ecore Tools. (For graphical modeling of our meta-models)||Choose Modeling and then Ecore Tools SDK||
|Subclipse, plug-in for integration with Subversion||Select all features||
While the metamodel and its associated syntax is still under development, you should be prepared to generate the model editors yourself from the metamodel and the syntax definitions, before you can start modeling:
Important to know is, that the Mod4j modules that you are going to checkout from the repository, do have a hybrid nature. Some of the modules are Eclipse plug-ins and some are Maven modules. But the most modules are both: Eclipse plug-in and configured as a Maven module (yes, you can recognize them by the pom.xml file).
This last category, the hybrids, must be treated with extra care. It mainly implies that you as a developer must know that dependencies must be manually managed in two places within the module. In the manifest (Eclipse plug-in) and in the pom.xml file (Maven) of the module. Also, in an equal manner, the versions of the module must be maintained manually twice.
At the moment we do not have a suitable solution for automating this process, maybe in the future we will extend our mod4j-maven-plugin with this functionality or see if the maven-eclipse-plugin can help us out.
mod4jproject from the Subversion URL
https://svn.codehaus.org/mod4j/trunkinto a directory on your file system. See the link Project information for information on how to do this.
../modules/Crossxfolder. After choosing Ok and Finish the following modules are imported in your workspace:
../modules/BusinessDomainDslfolder. After choosing Ok and Finish the following modules are imported in your workspace:
org.mod4j.dsl.businessdomain.mm/model/BusinessDomainDsl.genmodelin the EMF Generator editor.
BusinessDomainDslin the editor pane, and choose
Generate Model Code
Run As -> MWE Workflowfrom the context-menu.
modules/org.mod4j.runtime.commonfolder. Then choose Ok and Finish .
Now you have imported and generated the necessary modules. The DSL editors are ready to use. There for you need to activate the newly created editor in a second Eclipse instance. See next section "Modeling".
-Xms512m -Xmx512m -XX:PermSize=512m -XX:MaxPermSize=512m
Run As -> Eclipse Applicationfrom the context menu.
../modules/Examples/RecordShop-ExampleProject/RecordShop-dslModelsfolder. After choosing Ok and Finish the following modules are imported in your workspace:
../modules/Examples/RecordShop-ExampleProjectfolder. Then choose Ok
RecordShop-dslModels/src/model/businessDomain/businessDomain/model.busmodchange this file as needed and save the file.
mvn clean install
As a new developer of Mod4j you will need to follow the next steps