Difference between revisions of "CDO Development Guidelines"

From Eclipsepedia

Jump to: navigation, search
(Ecore models)
(Ecore models)
Line 19: Line 19:
 
===Ecore models===
 
===Ecore models===
  
* if you write ecore models, make sure that your model's name matches the last segment of the plug-in name (e.g. org.eclipse.emf.cdo.dawn.examples.acore -->acore.ecore)
+
*if you write ecore models, make sure that your model's name matches the last segment of the plug-in name (e.g. org.eclipse.emf.cdo.dawn.examples.acore -->acore.ecore)
* make sure that the gemodels default base packages matches the plugin name (without the last segment)
+
*make sure that the gemodels default base packages matches the plugin name (without the last segment)
  
 
==Legacy Mode==
 
==Legacy Mode==

Revision as of 04:22, 9 June 2010

Contents

Coding Guidlines

This page is not yet finished. Do not take these guidelines for granted until the note is removed!

Basic Coding Guidelines

The following Guide describes the basic requirements for creating CDO source code. Not all of these guidlines can be coverred by the auto-format for Java source Code (Strg+Shift+F). If you like to write an extension that allows comfortably adjusting the code regarding these Guidelines you are welcome.

Members

Methods

Getter and Setter

Guideline for writing test cases

General Requirements

Ecore models

  • if you write ecore models, make sure that your model's name matches the last segment of the plug-in name (e.g. org.eclipse.emf.cdo.dawn.examples.acore -->acore.ecore)
  • make sure that the gemodels default base packages matches the plugin name (without the last segment)

Legacy Mode

In the CDO test suite the Legacy Mode is always activated. This means that you do not need set this mode for every test case. But this also means that you need to deactivate it if you want to execute tests without legacy.

Please always use CDOUtil.getCDOObject() and CDOUtil.getEObject() to get either the CDOObject or the expected internal instance, no matter whether you are using legacy or not. This will make the test compatible to all legacy test cases and avoids ugly ClassCastExceptions.

When using dynamic EObjects please do not use CDOUtil.prepareDynamicEPackage(dynamicMapEPackage) if you want to make this test legacy aware. Otherwise the package will be native even if the Legacy test suite is executed. Please use somtehing like the following statement to make sure that you have prepared dynamic legacy objects.

if(!CDOUtil.isLegacyModeDefault())
{
CDOUtil.prepareDynamicEPackage(dynamicMapEPackage);
}