Jump to: navigation, search

MoDisco/DeveloperGuide

Plug-ins naming

Infrastructure plug-ins naming

For common components:

  • a plug-in org.eclipse.gmt.modisco.infra.common.core
    • contains non-graphical components
  • a plug-in org.eclipse.gmt.modisco.infra.common.ui (if necessary)
    • if necessary, contains graphical components (except editor features)

For each infrastructure component named x (except OMG standards implementation):

  • a plug-in org.eclipse.gmt.modisco.infra.x
    • contains the meta-model implementation of the component x (if necessary)
  • a plug-in org.eclipse.gmt.modisco.infra.x.core
    • contains non-graphical components
  • a plug-in org.eclipse.gmt.modisco.infra.x.editor
    • if necessary, contains the component allowing to execute the Eclipse’s edit action.
  • a plug-in org.eclipse.gmt.modisco.infra.x.ui (if necessary)
    • if necessary, contains the graphical components.

For each subcomponent y of the infrastructure’s component x

  • a plug-in org.eclipse.gmt.modisco.infra.x.y
  • a plug-in org.eclipse.gmt.modisco.infra.x.y.core
  • a plug-in org.eclipse.gmt.modisco.infra.x.y.editor
  • a plug-in org.eclipse.gmt.modisco.infra.x.y.ui (if necessary)

Technology plug-ins naming

For each component dedicated to the technology x :

  • a plug-in org.eclipse.gmt.modisco.x : contains the meta-model implementation
  • a plug-in org.eclipse.gmt.modisco.x.discoverer : contains the basic discoverers
  • a plug-in org.eclipse.gmt.modisco.x.discoverer.y : for each additional discoverer
  • a plug-in org.eclipse.gmt.modisco.x.edit : EMF edit classes
  • a plug-in org.eclipse.gmt.modisco.x.editor : EMF editor classes and reflexive editor customization
  • a plug-in org.eclipse.gmt.modisco.x.custom : UICustom + facet + queries
  • a plug-in org.eclipse.gmt.modisco.x.zconverter : converter from x to z

Use-cases plug-ins naming

For each component dedicated to a use-case x:

  • a plug-in org.eclipse.gmt.modisco.usecase.x

For each component
For each component or sub-component x :

  • a plug-in x.doc referred by the parent component
  • a plug-in x.tests

Feature naming

  • The feature name suffixed by ".feature"
  • Feature id: not suffixed by ".feature" (can have the same name as a plug-in)

Package naming

  • Prefixed by the name of the plug-in containing the package
  • The EMF generation parameters must be changed to conform to this rule

Coding conventions

Coding conventions

APIs visibility

MoDisco API Visibility

Java Compliance Level

Java 5 compliance level is required. Tale care of :

  • checking compilation, at least one time, with Java5 compiler compliance level and using a JRE5 library
  • indicating on plugin Manifest "Bundle-RequiredExecutionEnvironment: J2SE-1.5"