MMetamodelFragment (Modelio 4.1 API (commercial))

```
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

All Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method and Description
`default void`	`addDynamicBehavior(java.lang.String key, java.lang.Object value)` Add a dynamic behavior for the specified key.
`default <T> T`	`getDynamicBehavior(java.lang.String key, java.lang.Class<T> type)` Returns the dynamic behavior to which the specified key is mapped, or `null` if this key has no mapping.
`java.lang.String`	`getName()` The mandatory name of this metamodel fragment.
`java.util.Collection<VersionedItem<MMetamodelFragment>>`	`getNeededFragments()`
`java.lang.String`	`getProvider()` The optional name of the provider of this metamodel fragment, typically the vendor.
`java.lang.String`	`getProviderVersion()` The metamodel version for/from the provider tool.
`Version`	`getVersion()` The version of the metamodel fragment for Modelio.
`boolean`	`isExtension()` Tells whether this metamodel fragment is an extension or a standard Modelio metamodel fragment.
`boolean`	`isFake()` Tells whether this metamodel fragment is a fake metamodel fragment.
`default void`	`removeDynamicBehavior(java.lang.String key, java.lang.Object value)` Removes the dynamic behavior for the specified key only if it is currently mapped to the specified value.

- Method Detail
  - getName
```
java.lang.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.
  - 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 identifier.
  - getProvider
```
java.lang.String getProvider()
```
    The optional name of the provider of this metamodel fragment, typically the vendor. Example: Modeliosoft
    
    Returns:
    
    name of the provider
  - getProviderVersion
```
java.lang.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.
  - 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.
  - getNeededFragments
```
java.util.Collection<VersionedItem<MMetamodelFragment>> getNeededFragments()
```
    Returns:
    
    the metamodel fragments needed by this fragment.
    
    Since:
    
    3.6
  - isFake
```
boolean isFake()
```
    Tells whether this metamodel fragment is a fake metamodel fragment. A fake metamodel fragment represents a missing metamodel fragment. Fake metamodel model metaclasses are all fake metaclasses.
    
    Returns:
    
    true if this metamodel fragment is fake.
  - getDynamicBehavior
```
default <T> T getDynamicBehavior(java.lang.String key,
                                 java.lang.Class<T> type)
```
    Returns the dynamic behavior to which the specified key is mapped, or null if this key has no mapping.
    
    Parameters:
    
    key - the key whose associated behavior is to be returned
    
    type - the class of the dynamic behavior to get
    
    Returns:
    
    the dynamic behavior to which the specified key is mapped, or null if key has no mapping
    
    Throws:
    
    java.lang.ClassCastException - if the mapped behavior does not match the given type
    
    Since:
    
    3.8
  - addDynamicBehavior
```
default void addDynamicBehavior(java.lang.String key,
                                java.lang.Object value)
```
    Add a dynamic behavior for the specified key.
    
    Parameters:
    
    key - key with which the specified behavior is to be associated
    
    value - behavior to be associated with the specified key
    
    Since:
    
    3.8
  - removeDynamicBehavior
```
default void removeDynamicBehavior(java.lang.String key,
                                   java.lang.Object value)
```
    Removes the dynamic behavior for the specified key only if it is currently mapped to the specified value.
    
    Parameters:
    
    key - key with which the specified behavior is associated
    
    value - behavior expected to be associated with the specified key
    
    Since:
    
    3.8

Interface MMetamodelFragment

Modelio and provider version management

Metamodel compatibility checking convention

Comparison

Method Summary

Method Detail

getName

getVersion

getProvider

getProviderVersion

isExtension

getNeededFragments

isFake

getDynamicBehavior

addDynamicBehavior

removeDynamicBehavior