UML Profiles

Identifier:

com.ibm.xtools.uml.msl.UMLProfiles

Description:

Extension point for the definition of a plugin profile.

Configuration Markup:

<!ELEMENT extension (UMLProfile+)>

<!ATTLIST extension

point CDATA #REQUIRED

id CDATA #IMPLIED

name CDATA #IMPLIED>

id - This ID is used internally by model plugins and should not normally used by third party developers

<!ELEMENT UMLProfile (LegacyProfileVersion*)*>

<!ATTLIST UMLProfile

name CDATA #REQUIRED

path CDATA #REQUIRED

required (true | false)

visible (true | false)

id CDATA #IMPLIED

bundle CDATA #IMPLIED>

name - A descriptive name of the profile.
path - the path of the profile relative to the plugin declaring the extension (pathmap URIs could also be used, e.g. pathmap://MY_PATHMAP/MyProfile.epx).
required - defines if the profile is required (required profiles are applied automatically to models when these are loaded or created, normally only system profiles are required).
visible - defines if the profile will be visible in the GUI.
id -
bundle - Internal use only

<!ELEMENT LegacyProfileVersion EMPTY>

<!ATTLIST LegacyProfileVersion

version CDATA #REQUIRED

releaseLabel CDATA #IMPLIED

description CDATA #IMPLIED

migrationNotice CDATA #IMPLIED>

Not all users will want the latest profiles. A legacy profile declaration allows a profile provider to declare which legacy versions are available to the user. Only profiles that do not contain required metaclass extensions will be supported. Profile versions created in 6.x cannot be declared as legacy versions.

version - The internal version number of the legacy profile, in uml profiles this is part of the nsuri of the profile. In Rational profiles this is the released version number.
releaseLabel - The label used to document the profile version, in a released Rational profile this is known as the release label.
description - A human readable description of this legacy version that will be used in the UI
migrationNotice - The message that will be displayed when the user is prompted to migrate from this legacy version to the current version.

Examples:

Here is an example of an extension point used to define a new plugin-based profile:


<extension name="My Custom Profile"
         point="com.ibm.xtools.uml.msl.UMLProfiles">
   <UMLProfile
            id="MyCustomProfile"
            name="My Custom Profile"
            path="pathmap://MY_PATHMAP/MyProfile.epx"
            required="false"
            visible="true">
   </UMLProfile>
</extension>

API Information:

N/A