org.modelio.api.modelio.model

Interface IMetamodelExtensions

public interface IMetamodelExtensions

This interface is used to get the module extensions.
It's not possible to add or update such extensions using this class.

The known extensions are the following:

• Stereotypes (Stereotype)
• Tag types (TagType)
• Note types (NoteType)
• Resource types (ResourceType)

Also provides i18n for all those extensions.

Method Summary

Modifier and Type	Method and Description
java.util.List<ResourceType>	findExternDocumentTypes(java.lang.String externDocumentTypeName, MClass metaclass) Find resource types by name
java.util.List<ResourceType>	findExternDocumentTypes(java.lang.String moduleName, java.lang.String externDocumentTypeName, MClass metaclass) Find resource types by name and metaclass
java.util.List<NoteType>	findNoteTypes(java.lang.String noteTypeName, MClass metaclass) Find note types by metaclass
java.util.List<NoteType>	findNoteTypes(java.lang.String moduleName, java.lang.String noteTypeName, MClass metaclass) Find note types by name and metaclass
java.util.List<Stereotype>	findStereotypes(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, MClass metaclass) Find stereotypes by name and metaclass
java.util.List<TagType>	findTagTypes(java.lang.String tagTypeName, MClass metaclass) Find note types by name
java.util.List<TagType>	findTagTypes(java.lang.String moduleName, java.lang.String tagTypeName, MClass metaclass) Find note types by name and metaclass
java.lang.String	getDescription(PropertyDefinition pdef)
ResourceType	getExternDocumentType(Stereotype stereotype, java.lang.String externDocumentTypeName)
ResourceType	getExternDocumentType(java.lang.String moduleName, java.lang.String externDocumentTypeName, MClass metaclass)
java.lang.String	getLabel(NoteType noteType) Get the I18n'ed label for a NoteType.
java.lang.String	getLabel(PropertyDefinition pdef) Get the I18n'ed label for a PropertyDefinition.
java.lang.String	getLabel(ResourceType resourceType) Get the I18n'ed label for a ResourceType.
java.lang.String	getLabel(Stereotype stereotype) Get the I18n'ed label for a Stereotype.
java.lang.String	getLabel(TagType tagType) Get the I18n'ed label for a TagType.
NoteType	getNoteType(Stereotype stereotype, java.lang.String noteTypeName)
NoteType	getNoteType(java.lang.String moduleName, java.lang.String noteTypeName, MClass metaclass)
Stereotype	getStereotype(java.lang.String stereotypeName, MClass metaclass)
Stereotype	getStereotype(java.lang.String moduleName, java.lang.String stereotypeName, MClass metaclass)
TagType	getTagType(Stereotype stereotype, java.lang.String tagTypeName)
TagType	getTagType(java.lang.String moduleName, java.lang.String tagTypeName, MClass metaclass)

Method Detail

findStereotypes

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

Find stereotypes by name and metaclass

Parameters:

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.

getStereotype

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

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.

getStereotype

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

findNoteTypes

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

Find note types by metaclass

Parameters:

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.

getNoteType

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

findNoteTypes

java.util.List<NoteType> findNoteTypes(java.lang.String moduleName,
                                       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.

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.

getNoteType

NoteType getNoteType(Stereotype stereotype,
                     java.lang.String noteTypeName)

findExternDocumentTypes

java.util.List<ResourceType> findExternDocumentTypes(java.lang.String externDocumentTypeName,
                                                     MClass metaclass)

Find resource types by name

Parameters:

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.

findExternDocumentTypes

java.util.List<ResourceType> findExternDocumentTypes(java.lang.String moduleName,
                                                     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.

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.

getExternDocumentType

ResourceType getExternDocumentType(java.lang.String moduleName,
                                   java.lang.String externDocumentTypeName,
                                   MClass metaclass)

getExternDocumentType

ResourceType getExternDocumentType(Stereotype stereotype,
                                   java.lang.String externDocumentTypeName)

findTagTypes

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

Find note types by name

Parameters:

tagTypeName - 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.

findTagTypes

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

Find note 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.

tagTypeName - 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.

getTagType

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

getTagType

TagType getTagType(Stereotype stereotype,
                   java.lang.String tagTypeName)

getLabel

java.lang.String getLabel(Stereotype stereotype)

Get the I18n'ed label for a Stereotype.

Parameters:

stereotype - the stereotype to get the label for.

Returns:

the stereotype's label, computed by its module.

getLabel

java.lang.String getLabel(TagType tagType)

Get the I18n'ed label for a TagType.

Parameters:

tagType - the tag type to get the label for.

Returns:

the tag type's label, computed by its module.

getLabel

java.lang.String getLabel(NoteType noteType)

Get the I18n'ed label for a NoteType.

Parameters:

noteType - the note type to get the label for.

Returns:

the note type's label, computed by its module.

getLabel

java.lang.String getLabel(ResourceType resourceType)

Get the I18n'ed label for a ResourceType.

Parameters:

resourceType - the resource type to get the label for.

Returns:

the resource type's label, computed by its module.

getLabel

java.lang.String getLabel(PropertyDefinition pdef)

Get the I18n'ed label for a PropertyDefinition.

Parameters:

pdef - the property definition to get the label for.

Returns:

the property definition's label, computed by its module.

getDescription

java.lang.String getDescription(PropertyDefinition pdef)