Managing Stereotypes

A Stereotype 'S' from a Profile 'P' is applicable on an Element 'E':

• If 'S' extends a Metaclass compatible with 'E'.
• If 'P' is defined.
• If 'E' or one of its owner applies 'P'.

Reading Stereotypes

Here are sample codes that show how to read Stereotypes.

• To list the Applicable Stereotypes

  for (Stereotype myStereotype : myElement.getApplicableStereotypes()) {
  	...
  }
  

• To list the Applied Stereotypes

  for (Stereotype myStereotype : myElement.getAppliedStereotypes()) {
  	...
  }
  

• To get the qualified Stereotype

  Here is a sample code that shows how to get the Stereotype "Requirement" on a Class:

  Stereotype myStereotype = myClass.getAppliedStereotype("SysML::Requirements::Requirement");
  if(myStereotype!=null){
  	...
  }
  

  SysML::Requirements::Requirement represents the qualified name of the Stereotype "Requirement", in the SysML Profile.
• To get the Tagged Values of a qualified Stereotype Here is a sample code that shows how to list the Tagged Values on a Stereotyped Element:

  Stereotype myStereotype = myClass.getAppliedStereotype("SysML::Requirements::Requirement");
  if(myStereotype!=null){
  	String textValue = (String) upiaElement.getValue(myStereotype, "text");
  	...
  }
  

Applying Stereotypes

Here are sample codes that show how to apply Stereotypes.

• To apply a Profile

  Profile profile = stereotype.getProfile();
  if (profile != null) {
  	if (profile.isDefined()) {
  		com.sodius.mdw.metamodel.uml21.Package owner = element.getNearestPackage();
  		if (!owner.isProfileApplied(profile)) {
  			owner.applyProfile(profile);
  		}
  	}
  }
  

• To apply a Stereotype

  if (!element.isStereotypeApplied(stereotype)) {
  	if (element.isStereotypeApplicable(stereotype)) {
  		element.applyStereotype(stereotype);
  	}
  }
  

• To set a Tagged Value To set a tagged value for a Stereotype, it is important to check to type of the value.
  Here is a sample code that shows how to get the corresponding Property for the Tagged Value:

  public static Property getProperty(Classifier stereotype, String name) {
  	// lookup on stereotype
  	{
  		Property property = stereotype.getAllAttributes().detect(UMLPackage.Literals.NAMED_ELEMENT__NAME, name);
  		if (property != null) {
  			return property;
  		}
  	}
  
  	// lookup on generals
  	for (Classifier parent : stereotype.getGenerals()) {
  		Property property = getProperty(parent, name);
  		if (property != null) {
  			return property;
  		}
  	}
  	return null;
  }
  

  To get its Type :

  property.getType();
  

  Here are samples code that shows how to set a Tagged Value for a Stereotype:
  • If the Property of the Stereotype is a PrimitiveType (String, Boolean...), the simple case

    if(type instanceof PrimitiveType){
    	element.setValue(stereotype, property.getName(), value);
    }
    

  • If the Property of the Stereotype is a Stereotype
    • If the value to set is an Element

      if(type instanceof Stereotype){
      	EObject theApplication = null;
      	// exact stereotype?
      	EObject application = element.getStereotypeApplication(stereotype);
      	if (application != null) {
      		theApplication=application;
      	}
      	// sub stereotype?
      	EClass eStereotype = stereotype.getDefinition();
      	if (eStereotype != null) {
      		for (EObject application : element.getStereotypeApplications()) {
      			if (eStereotype.isInstance(application)) {
      				theApplication = application;
      			}
      		}   
      	}
      }
      if (theApplication != null) {
      	element.setValue(stereotype, property.getName(), application);
      }
      

  • If the Property of the Stereotype is an Enumeration
    • If the value to set is a String

      if(type instanceof Enumeration){
      	if(value instanceof String)
      		EnumerationLiteral literal = ((Enumeration) type).getOwnedLiteral((String) value);
      		if (literal != null) {
      			element.setValue(stereotype, property.getName(), stringValue);
      		}
      	}
      }
      

    • If the value to set is an EnumerationLiteral

      if(type instanceof Enumeration){
      	if(value instanceof EnumerationLiteral)
      		if (((Enumeration) type).getOwnedLiterals().contains((EnumerationLiteral) value)) {
      			element.setValue(stereotype, property.getName(), enumerationLiteralValue);
      		}
      	}
      }
      

Unapplying a Stereotype

element.unapplyStereotype(stereotype);

Profile and Stereotypes

MDAcces for UML API Reference