Debian Codegraph @

doc/org.eclipse.emf.cheatsheets/cheatsheets/GenerateExtendedEMF.xml

raw
1 <?xml version="1.0" encoding="UTF-8" ?>
2 <cheatsheet title="Generating an Extended EMF Model">
3
4 <intro href="/org.eclipse.emf.doc/tutorials/slibmod/slibmod.html">
5 <description>
6 This cheat sheet is a step-by-step description of how to generate an extended EMF
7 model and editor from a Rose class diagram.
8 <br /><br />
9 This cheat sheet continues on from either the &quot;Generating an EMF Model from Rose&quot;
10 or &quot;Generating an EMF Model from Annotated Java&quot; cheat sheet. Ensure that you have
11 completed at least one of them before contining.
12 </description>
13 </intro>
14
15 <item title="Set up the environment">
16 <description>
17 Your environment must be set up before you can perform the steps in this cheat sheet.
18 </description>
19
20 <subitem
21 label="Create an &quot;EMF Cheatsheet Data&quot; project in your workspace with the example &quot;schoollibrary.mdl&quot; file."
22 skip="true" >
23 <action
24 pluginId="org.eclipse.emf.cheatsheets"
25 class="org.eclipse.emf.cheatsheets.actions.CopyFileFromPluginAction"
26 param1="EMF Cheatsheet Data"
27 param2=""
28 param3="org.eclipse.emf.cheatsheets/archive/extended/schoollibrary.mdl"
29 translate="" />
30 </subitem>
31
32 <subitem
33 when="true"
34 label="Ensure that either &quot;library.rose&quot;, &quot;library.rose.edit&quot;, and &quot;library.rose.editor&quot; or &quot;library.java&quot;, &quot;library.java.edit&quot;, and &quot;library.java.editor&quot; exist in your workspace. Otherwise, you will need to complete either the &quot;Generating an EMF Model from Rose&quot; or the &quot;Generating an EMF Model from Annotated Java&quot; cheat sheet before continuing."
35 skip="false" />
36
37 <subitem
38 when="true"
39 label="Delete or rename the following projects if they exist in your workspace: &quot;schoollibrary.rose&quot;,&quot;schoollibrary.rose.edit&quot;,&quot;schoollibrary.rose.editor&quot;"
40 skip="true" />
41 </item>
42
43 <item
44 title="Import the model from Rose"
45 href="/org.eclipse.emf.doc/tutorials/slibmod/slibmod.html#step1a"
46 dialog="true"
47 skip="true">
48 <description>
49 First, you must create a new &quot;schoollibrary.rose&quot; EMF project in your workspace, importing
50 the Rose model to create the EMF model.
51 </description>
52
53 <subitem label="Select &quot;File &gt; New &gt; Project...&quot;. Expand &quot;Eclipse Modeling Framework&quot; and select &quot;EMF Project&quot;. Then, click &quot;Next&quot;." skip="true">
54 <action
55 pluginId="org.eclipse.emf.cheatsheets"
56 class="org.eclipse.emf.cheatsheets.actions.OpenEMFProjectWizardAction"
57 param1="schoollibrary.rose"
58 param2="org.eclipse.emf.importer.rose"
59 translate="" />
60 </subitem>
61 <subitem label="Enter &quot;schoollibrary.rose&quot; as the project name, then click &quot;Next&quot;." skip="false" />
62 <subitem label="Select &quot;Rose class model&quot;, then click &quot;Next&quot;." skip="false" />
63 <subitem label="Click &quot;Browse Workspace...&quot;, and expand &quot;EMF Cheatsheet Data&quot; to select &quot;schoollibrary.mdl&quot;. Then click &quot;Next&quot;." skip="false" />
64 <subitem label="In the &quot;Root packages&quot; table, select the package &quot;org.eclipse.example.schoollibrary&quot;, which will be generated." skip="false" />
65 <subitem label="Click &quot;Browse...&quot; to locate the file containing the library model that will be extended." skip="false" />
66 <subitem label="Expand either the &quot;library.rose&quot; or library.java&quot; project to select the &quot;model/library.genmodel&quot; file within it. Click &quot;OK&quot;." skip="false" />
67 <subitem label="Under &quot;Referenced generator models&quot;, select the &quot;org.eclipse.example.library&quot; package, and click &quot;Finish&quot;." skip="false" />
68 </item>
69
70 <item
71 title="Generate the code"
72 href="/org.eclipse.emf.doc/tutorials/slibmod/slibmod.html#step2"
73 dialog="true"
74 skip="true">
75 <description>
76 Generate the code to implement the model and an editor for it. The generator is automatically opened on completion of the wizard in the previous step.
77 </description>
78
79 <subitem label="In the generator, right click on &quot;Schoollibrary&quot; and select &quot;Generate All&quot;." />
80 <subitem label="If automatic building has been disabled, select &quot;Project &gt; Build All&quot; to compile the generated code." skip="true">
81 <action
82 pluginId="org.eclipse.emf.cheatsheets"
83 class="org.eclipse.emf.cheatsheets.actions.BuildAllProjectsAction" />
84 </subitem>
85 </item>
86
87 <item
88 title="Run the generated editor"
89 href="/org.eclipse.emf.doc/tutorials/slibmod/slibmod.html#step3"
90 dialog="true"
91 skip="true">
92 <description>
93 Now, you are set to run the generated editor and create a new school library instance.
94 </description>
95 <onCompletion>
96 Congratulations! You have succesfully extended an EMF model, generated the code, and created an instance of the extended model.
97 </onCompletion>
98
99 <subitem label="Select the &quot;schoollibrary.rose&quot; project in the package explorer and invoke the &quot;Run &gt; Run As &gt; Eclipse Application&quot; menu item. This starts a runtime instance of Eclipse with the newly generated plug-ins available." />
100 <subitem label="In the runtime instance, create a new general project called &quot;schoollibrarytest&quot;." />
101 <subitem label="Right click &quot;schooollibrarytest&quot; and select &quot;New &gt; Other...&quot;." />
102 <subitem label="Expand &quot;Example EMF Model Creation Wizards&quot; and select &quot;Schoollibrary Model&quot;. Then, click &quot;Next&quot;." />
103 <subitem label="Enter &quot;My.schoollibrary&quot; as the file name, then click &quot;Next&quot;." />
104 <subitem label="Select &quot;School Library&quot;; as the model object, then click &quot;Finish&quot;." />
105 <subitem label="The generated school library editor is opened. Expand &quot;platform:/resource/schoollibrarytest/My.schoollibrary&quot;. Right click &quot;School Library&quot; and select &quot;New Child &gt; School Book&quot; to create a school book object in the library." />
106 <subitem label="Create additional books and writers in the library, and edit the objects' properties in the properties view." />
107 <subitem label="Select &quot;File > Save&quot; to save the instance." />
108 </item>
109 </cheatsheet>