org.modelio.metamodel.mmextensions.standard.services

Interface IMModelServices

All Known Implementing Classes:

MModelServices

public interface IMModelServices

Services to look for model elements and metamodel extensions.

TODO : to be split in metamodel independent and metamodel dependent parts.

Method Summary

Modifier and Type	Method and Description
java.util.Collection<? extends MObject>	findByAtt(MClass metaclass, java.lang.String att, java.lang.Object value) Get elements in the model from a metaclass, a meta attribute name and its value.
java.util.Collection<? extends MObject>	findByClass(MClass metaclass) Get all elements in the model from their metaclass.
MObject	findById(MClass metaclass, java.lang.String id) Get an element in the model from its id and metaclass.
MObject	findByRef(MRef ref) Get an element in the model from an MRef.
java.util.List<NoteType>	findNoteTypes(java.lang.String moduleName, java.lang.String ownerName, java.lang.String noteTypeName, MClass metaclass) Find note types by name and metaclass
java.util.List<ResourceType>	findResourceTypes(java.lang.String moduleName, java.lang.String ownerName, java.lang.String externDocumentTypeName, MClass metaclass) Find resource types by name and metaclass
java.util.List<Stereotype>	findStereotypes(java.lang.String moduleName, java.lang.String stereotypeName, MClass metaclass) Find stereotypes by name and metaclass
java.util.List<Stereotype>	findStereotypes(java.lang.String moduleName, java.lang.String stereotypeName, java.lang.String metaclass) Deprecated.
java.util.List<TagType>	findTagTypes(java.lang.String moduleName, java.lang.String ownerName, java.lang.String tagTypeName, MClass metaclass) Find tag types by name and metaclass
java.lang.String	getCompositionPath(MObject mObject)
IElementConfigurator	getElementConfigurer()
IElementNamer	getElementNamer()
MMetamodel	getMetamodel()
IModelFactoryService	getModelFactory() Get the model object creation factory.
NoteType	getNoteType(java.lang.String moduleName, java.lang.String ownerName, java.lang.String noteTypeName, MClass metaclass) Find a note type by name and metaclass.
ResourceType	getResourceType(java.lang.String moduleName, java.lang.String ownerName, java.lang.String resourceTypeName, MClass metaclass) Find a resource type by name and metaclass.
Stereotype	getStereotype(java.lang.String moduleName, java.lang.String stereotypeName, MClass metaclass) Find a stereotype by name and metaclass.
Stereotype	getStereotype(java.lang.String moduleName, java.lang.String stereotypeName, java.lang.String metaclass) Deprecated.
TagType	getTagType(java.lang.String moduleName, java.lang.String ownerName, java.lang.String tagTypeName, MClass metaclass) Find a tag type by name and metaclass.

Method Detail

findByAtt

java.util.Collection<? extends MObject> findByAtt(MClass metaclass,
                                                  java.lang.String att,
                                                  java.lang.Object value)

Get elements in the model from a metaclass, a meta attribute name and its value.

If Element is given, every elements in the model will be checked.

Parameters:

metaclass - the metaclass to look for.

att - the name of the meta attribute to check the value in.

value - the value to look for in the attribute.

Returns:

A collection of elements matching the parameters. Might be empty but never null.

findByClass

java.util.Collection<? extends MObject> findByClass(MClass metaclass)

Get all elements in the model from their metaclass.

Parameters:

metaclass - the metaclass to look for.

Returns:

A list of all model elements, or null if no match is found.

findById

MObject findById(MClass metaclass,
                 java.lang.String id)

Get an element in the model from its id and metaclass.

Parameters:

metaclass - the java interface of the metaclass to look for.

id - the id to look for.

Returns:

A model element, or null if no match is found.

findByRef

MObject findByRef(MRef ref)
           throws UnknownMetaclassException

Get an element in the model from an MRef.

Parameters:

ref - a model object reference.

Returns:

A model element, or null if no match is found.

Throws:

org.modelio.vcore.session.UnknownMetaclassException - when the reference's metaclass can't be resolved as a MClass

UnknownMetaclassException

getCompositionPath

java.lang.String getCompositionPath(MObject mObject)

getElementConfigurer

IElementConfigurator getElementConfigurer()

getElementNamer

IElementNamer getElementNamer()

getMetamodel

MMetamodel getMetamodel()

getModelFactory

IModelFactoryService getModelFactory()

Get the model object creation factory.

Returns:

the model factory.

getNoteType

NoteType getNoteType(java.lang.String moduleName,
                     java.lang.String ownerName,
                     java.lang.String noteTypeName,
                     MClass metaclass)
              throws ElementNotUniqueException

Find a note type by name and metaclass.

Parameters:

moduleName - the name of the module owing the note type, or a regular expression for module name matching. null or "" are interpreted as ".*", i.e. any module.

ownerName - the name of the Stereotype or MetaclassReference owning the type. Cannot be null.

noteTypeName - the note type name, or a regular expression. null or "" are interpreted as ".*", i.e. any note type.

metaclass - a metaclass the note type must be applicable to.

Returns:

the found note type. Might be null is no element matches the given parameters.

Throws:

ElementNotUniqueException - when resolution is ambiguous and several note types match the given parameters

findNoteTypes

java.util.List<NoteType> findNoteTypes(java.lang.String moduleName,
                                       java.lang.String ownerName,
                                       java.lang.String noteTypeName,
                                       MClass metaclass)

Find note types by name and metaclass

Parameters:

moduleName - the name of the module owing the note type, or a regular expression for module name matching. null or "" are interpreted as ".*", i.e. any module.

ownerName - the name of the Stereotype or MetaclassReference owning the type. Cannot be null.

noteTypeName - the note type name, or a regular expression. null or "" are interpreted as ".*", i.e. any note type.

metaclass - the metaclass .

Returns:

the found note types. Might be empty.

getResourceType

ResourceType getResourceType(java.lang.String moduleName,
                             java.lang.String ownerName,
                             java.lang.String resourceTypeName,
                             MClass metaclass)
                      throws ElementNotUniqueException

Find a resource type by name and metaclass.

Parameters:

moduleName - the name of the module owing the resource type, or a regular expression for module name matching. null or "" are interpreted as ".*", i.e. any module.

ownerName - the name of the Stereotype or MetaclassReference owning the type. Cannot be null.

resourceTypeName - the resource type name, or a regular expression. null or "" are interpreted as ".*", i.e. any resource type.

metaclass - a metaclass the resource type must be applicable to.

Returns:

the found resource type. Might be null is no element matches the given parameters.

Throws:

ElementNotUniqueException - when resolution is ambiguous and several resource types match the given parameters

findResourceTypes

java.util.List<ResourceType> findResourceTypes(java.lang.String moduleName,
                                               java.lang.String ownerName,
                                               java.lang.String externDocumentTypeName,
                                               MClass metaclass)

Find resource types by name and metaclass

Parameters:

moduleName - the name of the module owing the resource type, or a regular expression for module name matching. null or "" are interpreted as ".*", i.e. any module.

ownerName - the name of the Stereotype or MetaclassReference owning the type. Cannot be null.

externDocumentTypeName - the resource type name, or a regular expression. null or "" are interpreted as ".*", i.e. any resource type.

metaclass - the metaclass .

Returns:

the found resource types. Might be empty.

getStereotype

Stereotype getStereotype(java.lang.String moduleName,
                         java.lang.String stereotypeName,
                         MClass metaclass)
                  throws ElementNotUniqueException

Find a stereotype by name and metaclass.

Parameters:

moduleName - the name of the module owing the stereotype, or a regular expression for module name matching. null or "" are interpreted as ".*", i.e. any module.

stereotypeName - the stereotype name, or a regular expression. null or "" are interpreted as ".*", i.e. any stereotype.

metaclass - a metaclass the stereotype must be applicable to.

Returns:

the found stereotype. Might be null is no element matches the given parameters.

Throws:

ElementNotUniqueException - when resolution is ambiguous and several stereotypes match the given parameters

getStereotype

@Deprecated
Stereotype getStereotype(java.lang.String moduleName,
                                     java.lang.String stereotypeName,
                                     java.lang.String metaclass)
                              throws ElementNotUniqueException,
                                     UnknownMetaclassException

Deprecated.

Find a stereotype by name and metaclass.

Parameters:

moduleName - the name of the module owing the stereotype, or a regular expression for module name matching. null or "" are interpreted as ".*", i.e. any module.

stereotypeName - the stereotype name, or a regular expression. null or "" are interpreted as ".*", i.e. any stereotype.

metaclass - a metaclass the stereotype must be applicable to.

Returns:

the found stereotype. Might be null is no element matches the given parameters.

Throws:

ElementNotUniqueException - when resolution is ambiguous and several stereotypes match the given parameters

org.modelio.vcore.session.UnknownMetaclassException - when metaclass can't be resolved as a MClass

UnknownMetaclassException

findStereotypes

java.util.List<Stereotype> findStereotypes(java.lang.String moduleName,
                                           java.lang.String stereotypeName,
                                           MClass metaclass)

Find stereotypes by name and metaclass

Parameters:

moduleName - the name of the module owing the stereotype, or a regular expression for module name matching. null or "" are interpreted as ".*", i.e. any module.

stereotypeName - the stereotype name, or a regular expression. null or "" are interpreted as ".*", i.e. any stereotype.

metaclass - the metaclass .

Returns:

the found stereotypes. Might be empty.

findStereotypes

@Deprecated
java.util.List<Stereotype> findStereotypes(java.lang.String moduleName,
                                                       java.lang.String stereotypeName,
                                                       java.lang.String metaclass)
                                                throws UnknownMetaclassException

Deprecated.

Find stereotypes by name and metaclass

Parameters:

moduleName - the name of the module owing the stereotype, or a regular expression for module name matching. null or "" are interpreted as ".*", i.e. any module.

stereotypeName - the stereotype name, or a regular expression. null or "" are interpreted as ".*", i.e. any stereotype.

metaclass - the metaclass name. Using a qualified name is strongly recommended.

Returns:

the found stereotypes.

Throws:

org.modelio.vcore.session.UnknownMetaclassException - if the metaclass name does not match an existing metaclass.

UnknownMetaclassException

getTagType

TagType getTagType(java.lang.String moduleName,
                   java.lang.String ownerName,
                   java.lang.String tagTypeName,
                   MClass metaclass)
            throws ElementNotUniqueException

Find a tag type by name and metaclass.

Parameters:

moduleName - the name of the module owing the tag type, or a regular expression for module name matching. null or "" are interpreted as ".*", i.e. any module.

ownerName - the name of the Stereotype or MetaclassReference owning the type. Cannot be null.

tagTypeName - the tag type name, or a regular expression. null or "" are interpreted as ".*", i.e. any tag type.

metaclass - a metaclass the tag type must be applicable to.

Returns:

the found tag type. Might be null is no element matches the given parameters.

Throws:

ElementNotUniqueException - when resolution is ambiguous and several tag types match the given parameters

findTagTypes

java.util.List<TagType> findTagTypes(java.lang.String moduleName,
                                     java.lang.String ownerName,
                                     java.lang.String tagTypeName,
                                     MClass metaclass)

Find tag types by name and metaclass

Parameters:

moduleName - the name of the module owing the tag type, or a regular expression for module name matching. null or "" are interpreted as ".*", i.e. any module.

ownerName - the name of the Stereotype or MetaclassReference owning the type. Cannot be null.

tagTypeName - the tag type name, or a regular expression. null or "" are interpreted as ".*", i.e. any tag type.

metaclass - the metaclass.

Returns:

the found tag types. Might be empty.