MClass (Modelio 4.1 API (commercial))

All Known Subinterfaces:

FakeMClass
```
public interface MClass
```
This interface defines the services available to programmers outside 'vcore' for handling SmClass instances.
The MClass services are obviously a subset of those provided by SmClass. This is because external programmers are not expected to modify the metamodel and therefore only limited 'get-like' accessors are provided.
The metaclass qualified name is the concatenation of the metamodel fragment, the '.' character and the metaclass name.
It is advised to use the qualified name when looking for a metaclass in the case several metamodel fragments define a metaclass with the same name.

Author:

phv

Field Summary

Fields
Modifier and Type Field and Description

static char QUALIFIER_SEP
qualified name separator between the fragment name and the metaclass name.

Fields
Modifier and Type	Field and Description
`static char`	`QUALIFIER_SEP` qualified name separator between the fragment name and the metaclass name.

Method Summary

All Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method and Description
`boolean`	`areOrphansAllowed()` Tells whether this metaclass may have orphan model objects.
`MAttribute`	`getAttribute(java.lang.String name)` Get the attribute with the given name.
`java.util.List<MAttribute>`	`getAttributes(boolean includeInherited)` Get the class attributes.
`java.util.List<MDependency>`	`getDependencies(boolean includeInherited)` Get all defined metamodel dependencies
`MDependency`	`getDependency(java.lang.String name)` Get the metamodel dependency with the given name.
`java.lang.Class<? extends MObject>`	`getJavaInterface()` Get the interface implemented by all objects of this metaclass.
`java.util.Collection<MDependency>`	`getLinkMetaclassSources()` Get for a link metaclass all source dependencies.
`java.util.Collection<MDependency>`	`getLinkMetaclassTargets()` Get for a link metaclass all target dependencies.
`MMetamodel`	`getMetamodel()` Return the metamodel owning this metaclass (the metamodel who loaded it and registered its providing fragment)
`java.lang.String`	`getName()`
`MMetamodelFragment`	`getOrigin()` Get the metamodel fragment providing this metaclass.
`java.lang.String`	`getQualifiedName()` Get the metaclass qualified name.
`java.util.List<MClass>`	`getSub(boolean recursive)` Get the sub classes.
`MClass`	`getSuper()` Get the parent metamodel class.
`Version`	`getVersion()` Get the metaclass version.
`boolean`	`hasBase(MClass parent)` Check that `this` metaclass is a sub-metaclass of `parent` metaclass.
`boolean`	`isAbstract()`
`boolean`	`isCmsNode()` Tells whether this metamodel class is a CMS node.
`boolean`	`isEnabled()`
`boolean`	`isFake()` Tells whether this metaclass is a fake metaclass.
`default boolean`	`isInstance(MObject obj)` Tells whether the model object is an instance of this metaclass or a sub metaclass.
`boolean`	`isLinkMetaclass()` Tells whether this metaclass is a relationship metaclass.

- Field Detail
  - QUALIFIER_SEP
```
static final char QUALIFIER_SEP
```
    qualified name separator between the fragment name and the metaclass name.
    
    See Also:
    
    Constant Field Values
- Method Detail
  - areOrphansAllowed
```
boolean areOrphansAllowed()
```
    Tells whether this metaclass may have orphan model objects.
    
    Returns:
    
    true if orphan are allowed.
    
    Since:
    
    3.6
  - getAttribute
```
MAttribute getAttribute(java.lang.String name)
```
    Get the attribute with the given name.
    
    Parameters:
    
    name - an attribute name.
    
    Returns:
    
    the found attribute or null.
  - getAttributes
```
java.util.List<MAttribute> getAttributes(boolean includeInherited)
```
    Get the class attributes.
    
    Parameters:
    
    includeInherited - true to include inherited attributes.
    
    Returns:
    
    the defined attributes.
  - getDependencies
```
java.util.List<MDependency> getDependencies(boolean includeInherited)
```
    Get all defined metamodel dependencies
    
    Parameters:
    
    includeInherited - true to include inherited metamodel dependency.
    
    Returns:
    
    metamodel dependencies.
  - getDependency
```
MDependency getDependency(java.lang.String name)
```
    Get the metamodel dependency with the given name.
    
    Parameters:
    
    name - a metamodel dependency name.
    
    Returns:
    
    the found metamodel dependency or null.
  - getJavaInterface
```
java.lang.Class<? extends MObject> getJavaInterface()
```
    Get the interface implemented by all objects of this metaclass.
    
    Returns:
    
    The java interface.
  - getLinkMetaclassSources
```
java.util.Collection<MDependency> getLinkMetaclassSources()
```
    Get for a link metaclass all source dependencies.
    Also return inherited source dependencies. Returns an empty collection for node metaclasses.
    
    Returns:
    
    all source dependencies.
  - getLinkMetaclassTargets
```
java.util.Collection<MDependency> getLinkMetaclassTargets()
```
    Get for a link metaclass all target dependencies.
    Also return inherited target dependencies. Returns an empty collection for node metaclasses.
    
    Returns:
    
    all target dependencies.
  - getMetamodel
```
MMetamodel getMetamodel()
```
    Return the metamodel owning this metaclass (the metamodel who loaded it and registered its providing fragment)
    
    Returns:
    
    the owning metamodel.
  - getName
```
java.lang.String getName()
```
    Returns:
    
    the metaclass name.
  - getOrigin
```
MMetamodelFragment getOrigin()
```
    Get the metamodel fragment providing this metaclass.
    
    Returns:
    
    the metamodel fragment.
  - getQualifiedName
```
java.lang.String getQualifiedName()
```
    Get the metaclass qualified name.
    The metaclass qualified name is the concatenation of the metamodel fragment, the '.' character and the metaclass name.
    It is advised to use the qualified name when looking for a metaclass in the case several metamodel fragments define a metaclass with the same name.
    
    Returns:
    
    the metaclass qualified name.
  - getSub
```
java.util.List<MClass> getSub(boolean recursive)
```
    Get the sub classes.
    
    Parameters:
    
    recursive - true to include all sub classe recursively.
    
    Returns:
    
    the sub classes.
  - getSuper
```
MClass getSuper()
```
    Get the parent metamodel class.
    
    Returns:
    
    the parent class.
  - getVersion
```
Version getVersion()
```
    Get the metaclass version.
    This may be used to detect changes in the metamodel
    
    Returns:
    
    the metaclass versions.
  - hasBase
```
boolean hasBase(MClass parent)
```
    Check that this metaclass is a sub-metaclass of parent metaclass.
    
    Parameters:
    
    parent - a metamodel class
    
    Returns:
    
    true if this class inherits from the given class. false otherwise.
  - isAbstract
```
boolean isAbstract()
```
    Returns:
    
    true if the class is abstract.
  - isCmsNode
```
boolean isCmsNode()
```
    Tells whether this metamodel class is a CMS node.
    CMS nodes define a structuring unit for some storages implementations. For EXML repositories, a CMS node represents an EXML file.
    
    Returns:
    
    true if the class is a CMS node.
  - isFake
```
boolean isFake()
```
    Tells whether this metaclass is a fake metaclass.
    A fake metaclass is a shell metaclass that represents a missing metaclass. Fake metaclass model objects are all shell objects.
    
    Returns:
    
    true if this metaclass is fake.
  - isLinkMetaclass
```
boolean isLinkMetaclass()
```
    Tells whether this metaclass is a relationship metaclass.
    A relationship metaclass elements represents links between other objects. They have source and target MDependencies.
    
    Returns:
    
    true if this metaclass is fake.
    
    Since:
    
    toutatis
  - isEnabled
```
boolean isEnabled()
```
  - isInstance
```
default boolean isInstance(MObject obj)
```
    Tells whether the model object is an instance of this metaclass or a sub metaclass.
    
    Parameters:
    
    obj - a model object or null.
    
    Returns:
    
    true if the model object is an instance of this metaclass.

Interface MClass

Field Summary

Method Summary

Field Detail

QUALIFIER_SEP

Method Detail

areOrphansAllowed

getAttribute

getAttributes

getDependencies

getDependency

getJavaInterface

getLinkMetaclassSources

getLinkMetaclassTargets

getMetamodel

getName

getOrigin

getQualifiedName

getSub

getSuper

getVersion

hasBase

isAbstract

isCmsNode

isFake

isLinkMetaclass

isEnabled

isInstance