Notice: this Wiki will be going read only early in 2024 and edits will no longer be possible. Please see: https://gitlab.eclipse.org/eclipsefdn/helpdesk/-/wikis/Wiki-shutdown-plan for the plan.
Difference between revisions of "CDO/Preparing EMF Models"
< CDO
(→Migrate your GenModel Manually) |
(→Create an Ecore Model) |
||
| Line 4: | Line 4: | ||
==Create an Ecore Model== | ==Create an Ecore Model== | ||
| − | There's not much to say about this step. The .ecore file for CDO models is the same as for pure EMF models. | + | There's really not much to say about this step. The .ecore file for CDO models is the same as for pure EMF models. Use the ''Empty EMF Project'' New Wizard to create an initial project for your model: |
| − | The <code>model1</code> example model in the usual Ecore model editor looks like follows: | + | |
| + | [[Image:EmptyEMFProject.png]] | ||
| + | |||
| + | |||
| + | Create an ordinary Ecore model file in the models folder. The <code>model1</code> example model in the usual Ecore model editor looks like follows: | ||
| Line 81: | Line 85: | ||
<br> | <br> | ||
| + | |||
==Use the CDO Migrator Utility== | ==Use the CDO Migrator Utility== | ||
Revision as of 14:08, 1 November 2007
Contents
Create an Ecore Model
There's really not much to say about this step. The .ecore file for CDO models is the same as for pure EMF models. Use the Empty EMF Project New Wizard to create an initial project for your model:
Create an ordinary Ecore model file in the models folder. The model1 example model in the usual Ecore model editor looks like follows:
You can download this Ecore model from here. Its XML form is:
<?xml version="1.0" encoding="UTF-8"?>
<ecore:EPackage 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" name="model1"
nsURI="http://www.eclipse.org/emf/CDO/tests/model1/1.0.0" nsPrefix="model1">
<eClassifiers xsi:type="ecore:EClass" name="Address">
<eStructuralFeatures xsi:type="ecore:EAttribute" name="name" eType="ecore:EDataType http://www.eclipse.org/emf/2002/Ecore#//EString"/>
<eStructuralFeatures xsi:type="ecore:EAttribute" name="street" eType="ecore:EDataType http://www.eclipse.org/emf/2002/Ecore#//EString"/>
<eStructuralFeatures xsi:type="ecore:EAttribute" name="city" eType="ecore:EDataType http://www.eclipse.org/emf/2002/Ecore#//EString"/>
</eClassifiers>
<eClassifiers xsi:type="ecore:EClass" name="Company" eSuperTypes="#//Address">
<eStructuralFeatures xsi:type="ecore:EReference" name="categories" upperBound="-1"
eType="#//Category" containment="true"/>
<eStructuralFeatures xsi:type="ecore:EReference" name="suppliers" upperBound="-1"
eType="#//Supplier" containment="true"/>
<eStructuralFeatures xsi:type="ecore:EReference" name="customers" upperBound="-1"
eType="#//Customer" containment="true"/>
<eStructuralFeatures xsi:type="ecore:EReference" name="purchaseOrders" upperBound="-1"
eType="#//PurchaseOrder" containment="true"/>
<eStructuralFeatures xsi:type="ecore:EReference" name="salesOrders" upperBound="-1"
eType="#//SalesOrder" containment="true"/>
</eClassifiers>
<eClassifiers xsi:type="ecore:EClass" name="Supplier" eSuperTypes="#//Address">
<eStructuralFeatures xsi:type="ecore:EReference" name="purchaseOrders" upperBound="-1"
eType="#//PurchaseOrder" eOpposite="#//PurchaseOrder/supplier"/>
</eClassifiers>
<eClassifiers xsi:type="ecore:EClass" name="Customer" eSuperTypes="#//Address">
<eStructuralFeatures xsi:type="ecore:EReference" name="salesOrders" unique="false"
upperBound="-1" eType="#//SalesOrder" eOpposite="#//SalesOrder/customer"/>
</eClassifiers>
<eClassifiers xsi:type="ecore:EClass" name="Order">
<eStructuralFeatures xsi:type="ecore:EReference" name="orderDetails" upperBound="-1"
eType="#//OrderDetail" containment="true" eOpposite="#//OrderDetail/order"/>
</eClassifiers>
<eClassifiers xsi:type="ecore:EClass" name="OrderDetail">
<eStructuralFeatures xsi:type="ecore:EReference" name="order" lowerBound="1" eType="#//Order"
eOpposite="#//Order/orderDetails"/>
<eStructuralFeatures xsi:type="ecore:EReference" name="product" eType="#//Product"
eOpposite="#//Product/orderDetails"/>
<eStructuralFeatures xsi:type="ecore:EAttribute" name="price" eType="ecore:EDataType http://www.eclipse.org/emf/2002/Ecore#//EFloat"/>
</eClassifiers>
<eClassifiers xsi:type="ecore:EClass" name="PurchaseOrder" eSuperTypes="#//Order">
<eStructuralFeatures xsi:type="ecore:EAttribute" name="date" eType="ecore:EDataType http://www.eclipse.org/emf/2002/Ecore#//EDate"/>
<eStructuralFeatures xsi:type="ecore:EReference" name="supplier" lowerBound="1"
eType="#//Supplier" eOpposite="#//Supplier/purchaseOrders"/>
</eClassifiers>
<eClassifiers xsi:type="ecore:EClass" name="SalesOrder" eSuperTypes="#//Order">
<eStructuralFeatures xsi:type="ecore:EAttribute" name="id" eType="ecore:EDataType http://www.eclipse.org/emf/2002/Ecore#//EInt"/>
<eStructuralFeatures xsi:type="ecore:EReference" name="customer" lowerBound="1"
eType="#//Customer" eOpposite="#//Customer/salesOrders"/>
</eClassifiers>
<eClassifiers xsi:type="ecore:EClass" name="Category">
<eStructuralFeatures xsi:type="ecore:EAttribute" name="name" eType="ecore:EDataType http://www.eclipse.org/emf/2002/Ecore#//EString"/>
<eStructuralFeatures xsi:type="ecore:EReference" name="categories" upperBound="-1"
eType="#//Category" containment="true"/>
<eStructuralFeatures xsi:type="ecore:EReference" name="products" upperBound="-1"
eType="#//Product" containment="true"/>
</eClassifiers>
<eClassifiers xsi:type="ecore:EClass" name="Product">
<eStructuralFeatures xsi:type="ecore:EAttribute" name="name" eType="ecore:EDataType http://www.eclipse.org/emf/2002/Ecore#//EString"/>
<eStructuralFeatures xsi:type="ecore:EReference" name="orderDetails" upperBound="-1"
eType="#//OrderDetail" eOpposite="#//OrderDetail/product"/>
</eClassifiers>
</ecore:EPackage>
Use the CDO Migrator Utility
Migrate your GenModel Manually
If you don't want to use the CDO Migrator Utility to automatically let a proper GenModel be created for you it is still rather easy to migrate an existing GenModel by hand.
Create the GenModel
The EMF generator model for your Ecore model is much like a usual GenModel except for the following four differences:
- The Feature Delegation property must be set to
Reflective - The Model Plug-in Variables property should be set to
CDO=org.eclipse.emf.cdo - The Root Extends Class property must be set to
org.eclipse.emf.internal.cdo.CDOObjectImpl - The Root Extends Interface property can be set to
org.eclipse.emf.cdo.CDOObject
Note that you do not need to generate an editor if you want to use your model with the CDO User Interface. A dedicated model editor is only needed if you plan to use your model with normal XML based files as well. Even in this scenario it could be simpler to use the EMF Reflective Model Editor though.
You can download this generator model from here. Its XML form is:
<?xml version="1.0" encoding="UTF-8"?>
<genmodel:GenModel xmi:version="2.0"
xmlns:xmi="http://www.omg.org/XMI" xmlns:ecore="http://www.eclipse.org/emf/2002/Ecore"
xmlns:genmodel="http://www.eclipse.org/emf/2002/GenModel" modelDirectory="/org.eclipse.emf.cdo.tests.model1/src"
modelPluginID="org.eclipse.emf.cdo.tests.model1" modelName="Model1" rootExtendsInterface="org.eclipse.emf.cdo.CDOObject"
rootExtendsClass="org.eclipse.emf.internal.cdo.CDOObjectImpl" reflectiveDelegation="true"
testsDirectory="" importerID="org.eclipse.emf.importer.ecore" featureDelegation="Reflective"
complianceLevel="5.0">
<foreignModel>model1.ecore</foreignModel>
<modelPluginVariables>CDO=org.eclipse.emf.cdo</modelPluginVariables>
<genPackages prefix="Model1" basePackage="org.eclipse.emf.cdo.tests" disposableProviderFactory="true"
ecorePackage="model1.ecore#/">
<genClasses ecoreClass="model1.ecore#//Address">
<genFeatures createChild="false" ecoreFeature="ecore:EAttribute model1.ecore#//Address/name"/>
<genFeatures createChild="false" ecoreFeature="ecore:EAttribute model1.ecore#//Address/street"/>
<genFeatures createChild="false" ecoreFeature="ecore:EAttribute model1.ecore#//Address/city"/>
</genClasses>
<genClasses ecoreClass="model1.ecore#//Company">
<genFeatures property="None" children="true" createChild="true" ecoreFeature="ecore:EReference model1.ecore#//Company/categories"/>
<genFeatures property="None" children="true" createChild="true" ecoreFeature="ecore:EReference model1.ecore#//Company/suppliers"/>
<genFeatures property="None" children="true" createChild="true" ecoreFeature="ecore:EReference model1.ecore#//Company/customers"/>
<genFeatures property="None" children="true" createChild="true" ecoreFeature="ecore:EReference model1.ecore#//Company/purchaseOrders"/>
<genFeatures property="None" children="true" createChild="true" ecoreFeature="ecore:EReference model1.ecore#//Company/salesOrders"/>
</genClasses>
<genClasses ecoreClass="model1.ecore#//Supplier">
<genFeatures notify="false" createChild="false" propertySortChoices="true" ecoreFeature="ecore:EReference model1.ecore#//Supplier/purchaseOrders"/>
</genClasses>
<genClasses ecoreClass="model1.ecore#//Customer">
<genFeatures notify="false" createChild="false" propertySortChoices="true" ecoreFeature="ecore:EReference model1.ecore#//Customer/salesOrders"/>
</genClasses>
<genClasses ecoreClass="model1.ecore#//Order">
<genFeatures property="None" children="true" createChild="true" ecoreFeature="ecore:EReference model1.ecore#//Order/orderDetails"/>
</genClasses>
<genClasses ecoreClass="model1.ecore#//OrderDetail">
<genFeatures property="None" notify="false" createChild="false" ecoreFeature="ecore:EReference model1.ecore#//OrderDetail/order"/>
<genFeatures notify="false" createChild="false" propertySortChoices="true" ecoreFeature="ecore:EReference model1.ecore#//OrderDetail/product"/>
<genFeatures createChild="false" ecoreFeature="ecore:EAttribute model1.ecore#//OrderDetail/price"/>
</genClasses>
<genClasses ecoreClass="model1.ecore#//PurchaseOrder">
<genFeatures createChild="false" ecoreFeature="ecore:EAttribute model1.ecore#//PurchaseOrder/date"/>
<genFeatures notify="false" createChild="false" propertySortChoices="true" ecoreFeature="ecore:EReference model1.ecore#//PurchaseOrder/supplier"/>
</genClasses>
<genClasses ecoreClass="model1.ecore#//SalesOrder">
<genFeatures createChild="false" ecoreFeature="ecore:EAttribute model1.ecore#//SalesOrder/id"/>
<genFeatures notify="false" createChild="false" propertySortChoices="true" ecoreFeature="ecore:EReference model1.ecore#//SalesOrder/customer"/>
</genClasses>
<genClasses ecoreClass="model1.ecore#//Category">
<genFeatures createChild="false" ecoreFeature="ecore:EAttribute model1.ecore#//Category/name"/>
<genFeatures property="None" children="true" createChild="true" ecoreFeature="ecore:EReference model1.ecore#//Category/categories"/>
<genFeatures property="None" children="true" createChild="true" ecoreFeature="ecore:EReference model1.ecore#//Category/products"/>
</genClasses>
<genClasses ecoreClass="model1.ecore#//Product">
<genFeatures createChild="false" ecoreFeature="ecore:EAttribute model1.ecore#//Product/name"/>
<genFeatures notify="false" createChild="false" propertySortChoices="true" ecoreFeature="ecore:EReference model1.ecore#//Product/orderDetails"/>
</genClasses>
</genPackages>
</genmodel:GenModel>
Create the Marker File
At runtime the CDO client needs to determine whether a given EPackage (your model) has been generated for CDO or not. Create a file META-INF/CDO.MF with arbitrary or no content to signal that all models in your bundle are CDO native models.
Important: Formerly you had to declaratively specify this information by contributing to the org.eclipse.emf.cdo.persistent_package extension point. This method is now deprecated! Only the existence of the META-INF/CDO.MF file is checked at runtime!
Generate The Model
Generate the Java code for your model like you are used to do it:
The result of the generation can look similar to this (some artifacts are hidden to declutter the Package Explorer):
