org.modelio.vcore.smkernel.mapi

Interface MMetamodelFragment

public interface MMetamodelFragment

A metamodel fragment.

The runtime metamodel of Modelio is composed of several fragments:

• Modelio metamodel fragments covering UML and BPMN standards, provided by Modelio application, always present
• extension metamodel fragments provided by application extensions (eg: Modules)

Note the Modelio kernel does not know anything about metamodel fragment providers and that the above description is there only for the sake of clarity. Practically, once initialized with its composing fragments the Metamodel is only a repository for known MClass instances.

Modelio and provider version management

The fragment has a Modelio version and a provider version.

Metamodel fragments are often a port from a tool to Modelio and this porting may be made in several steps.

• Each porting should result in an increase of the Modelio version.
  
• When the source tool metamodel changes, the Modelio version should be modified and the provider version should reflect the new metamodel version from the provider tool.

Metamodel compatibility checking convention

Compatibility checking should be done by looking at the Modelio version as following:

• if major == 0 : old version numbering before Modelio 3.4
• major version different : major migration or migration impossible
• minor version different : migration needed
• release version different : can be opened by newer metamodel

Comparison

Two metamodel fragments are equal if their name and version are equal. The vendor is only informative.

Since:

Modelio 3.4

Author:

cmarin

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj) Two metamodel fragments are equal if their name and version are equal
MExpert	getMExpert()
String	getName() The mandatory name of this metamodel fragment.
String	getProvider() The optional name of the provider of this metamodel fragment, typically the vendor.
String	getProviderVersion() The metamodel version for/from the provider tool.
Version	getVersion() The version of the metamodel fragment for Modelio.
int	hashCode() Two metamodel fragments are equal if their name and version are equal.
boolean	isExtension() Tells whether this metamodel fragment is an extension or a standard Modelio metamodel fragment.

Method Detail

getName

String getName()

The mandatory name of this metamodel fragment. Must be distinct from any other loaded metamodel fragment. Examples: org.modelio.metamodel.standard

Returns:

name of this metamodel fragment.

getMExpert

MExpert getMExpert()

getVersion

Version getVersion()

The version of the metamodel fragment for Modelio.

Compatibility checking must be done as following:

• if major == 0 : old version numbering
• major different : major migration or migration impossible
• minor different : migration needed
• release different : can be opened by newer metamodel

Returns:

The version idnetifier.

getProvider

String getProvider()

The optional name of the provider of this metamodel fragment, typically the vendor. Example: Modeliosoft

Returns:

name of the provider

getProviderVersion

String getProviderVersion()

The metamodel version for/from the provider tool.

This provider metamodel version is purely informative and should reflect the metamodel version from the source tool.

Metamodel fragments are often a port from a tool to Modelio. This porting may be made in several steps. Each porting should result in an increase of the Modelio version. When the source tool metamodel changes, the Modelio version should be modified and the provider version should reflect the new metamodel version from the provider tool.

Returns:

The metamodel version for/from the provider.

equals

boolean equals(Object obj)

Two metamodel fragments are equal if their name and version are equal

Overrides:

equals in class Object

hashCode

int hashCode()

Two metamodel fragments are equal if their name and version are equal.

Only these 2 fields can be used to compute the hash.

Overrides:

hashCode in class Object

isExtension

boolean isExtension()

Tells whether this metamodel fragment is an extension or a standard Modelio metamodel fragment.

By default all metamodel fragments are extension fragments.

Standard Modelio metamodel fragments are guaranteed to have no metaclass name collisions.

Returns:

true if the fragment is an extension, false if it is a Modelio standard fragment.