Report tool

On this page

$report is a utility tool enabling a template to get the modeling tool data.

$report.createValueSpecificationText(specification)

Create texts representing the ValueSpecification element.

$report.filterDiagram(diagramList, diagramTypes)

Return a collection of diagrams from a list of diagrams filtered by types.

For example:

#foreach($diagram in $report.filterDiagram($Diagram,["Class Diagram","Communication Diagram"]))
$diagram.name : $diagram.diagramType
#end

$report.filterElement(elementList, humanTypes)

Return a collection of elements from a list of elements filtered by human types.

For example:

#foreach($element in $report.filterElement($elements, ["Use Case", "Actor"]))
$element.name : $element.humanType
#end

$report.filterElementType(elementList, elementType)

Return a collection of elements from a list of elements filtered by element types.

$report.filter(elementList, propertyName, propertyValue)

Return a collection of elements filtered by a specified property name.

For example: 

#foreach ($e in $report.filter($elements, "name", ["foo", "bar"]))
   $e.name
#end

$report.filterElementByStereotypeName(elementList, appliedStereotypeNameList)

Return a collection of elements from a list of elements filtered by applied stereotype names.

For example:

#foreach($element in $report.filterElementByStereotypeName($elements, ["Stereotype A", "Stereotype B"]))
   $element.name
#end

$report.findElementInCollection(elementList, name)

Find an element from a collection of elements by name.

For example:

#set($myClass = $report.findElementInCollection($Class, "MyClass"))
$myClass.humanType $myClass.name

$report.findRelationship(modelPackage)

Search and return a collection of relationship elements inside a package.

$report.findRelationship(modelPackage, recursive)

Search and return a collection of relationship elements inside a package.

$report.getAppliedStereotypeByName(element, stereotypeName)

Return a stereotype assigned to an element.

$report.getBaseClassAssociations(classifier)

Obtain a collection of associations of a classifier.

$report.getBaseClassInheritableAttributes(classifier)

Get a collection of inheritable attributes of a classifier.

$report.getBaseClassInheritableOperations(classifier)

Obtain a collection of inheritable operations of a classifier.

$report.getBaseClassPorts(classifier)

Find a collection of ports of a classifier.

$report.getBaseRealizedInterfaces(behavioredClassifier)

Find a collection of realized interfaces of a behaviored classifier.

$report.getBaseRelations(classifier)

Find a collection of relations of a classifier.

$report.getBaseClassifiers(child)

Return a collection of base elements of a classifier.

$report.getClientElement(element)

Return a client of a relationship.

$report.getComment(element)

Return a documentation of a given element.

$report.getCustomizationProperty(element, stereotypeName, propertyName)

Get a customization property from the specified applied stereotype of the element.

$report.getCustomizationPropertyString(element, stereotypeName, propertyName)

Get a customization property as a String value from the specified applied stereotype of the element.

$report.getDerivedClassifiers(parent)

Return a collection of derived elements of a classifier.

$report.getDiagramElements(diagram)

Get a collection of elements from a diagram.

$report.getDiagramType(diagram)

Return a diagram type.

$report.getElementProperties(element)

Return a list of property names, including UML properties and properties that are customized through DSL customization.

For example:

#foreach($pp in $report.getElementProperties($element))
$pp.name > $pp.value
#end

$report.getElementPropertiesName(element)

Return a list of property names, including UML properties and properties that are customized through DSL customization.

For example:

#foreach($name in $report.getElementPropertiesName($element))
$name
#end

$report.getDSLProperty(element, propertyName)

Return a DSL property.

$report.getElementComment(element)

Return a comment attached to an element. If no comment is attached, it will return a null value.

$report.getElementName(element)

Get an element’s name. If the name is empty, it will return "<unnamed>". This method performs the following procedures:

• If the element is generalized from the NamedElement metaclass, it will return $element.name
• If the element is generalized from the Slot metaclass, it will return $element.definingFeature.name
• If the element is a UML element, it will return $element.humanName
• Else returns $element.toString()

$report.getIconFor(element)

Return an image icon of an element with a default icon filename (“icon_”+element type).

For example:

$report.getIconFor($classObject)

This results in an Image object of a class whose name is “icon_class”.

$report.getImageFor(element, dpi)

Return an image with specified DPI of an element.

$report.getIconFor(element, prefix, suffix, hashCode)

Return an image icon of an element. The icon name depends on the hashCode value if hashCode equals true, the icon’s name is set as ”icon_”+hash code value of the icon. If the hashCode value equals false, the icon name is set as

For example:

$report.getIconFor($classObject, “prefix_”, “_suffix”, true)

This results in an Image object of a class whose name “icon_24676200”. The number in the icon name is hash code, which is regenerated whenever the modeling tool starts.

$report.getIconFor($classObject, “prefix_”, “_suffix”, false)

This results in an Image object of a class whose name is “prefix_class_suffix”.

$report.getIconFor(type)

Return an image icon for an element type with a default icon’s filename ((“icon_”+element type).

For example:

$report.getIconFor("class")

This results in an Image object of a class whose name is “icon_class”.

$report.getIconFor(type, prefix, suffix, hashCode)

Return an image icon for an element type. The icon’s name depends on the hashCode value if hashCode equals true, the icon name is set as “icon_”+hash code value of the icon. If the hashCode value equals false, the icon name is set as prefix + element type + suffix.

For example:

$report.getIconFor(“class”, “prefix_”, “_suffix”, true)

This results in an Image object of a class whose name “icon_24676200”. The number in the icon name is hash code, which is regenerated whenever the modeling tool starts.

$report.getIconFor(“class”, “prefix_”, “_suffix”, false)

This results in an Image object of a class whose name is “prefix_class_suffix”.

$report.getIncludeUseCase(useCase)

Return a collection of included elements of a UseCase.

$report.getInnerElement(element)

Return a collection of inner elements.

$report.getInteractionMessageType(message)

Return an interaction message type.

$report.getMetaClass(stereotype)

Return a stereotype meta class.

$report.getMetaClass(element)

Return an element meta class.

$report.getPresentationDiagramElements(diagram)

Return presentation elements in a diagram. This method will return all presentation elements from the diagram, except non-manipulator symbols.

For example:

#foreach($symbol in $report.getPresentationDiagramElements($diagram))
#set($element = $symbol.getElement())
$element.humanType $element.name
#end

$report.getPresentationDiagramElements(diagram, includeNonManipulator)

Return presentation elements in a diagram.

$report.getPresentationElementBounds(diagram, element)

Return the polygonal bounds of an element. The bounds specify the component coordinates to its diagram.

$report.getPresentationElementBounds(element)

Return the polygonal bounds of an element. The bounds specify this component's coordinate to its diagram.

$report.getPresentationElementRectangle(diagram, element)

Return the rectangular bounds of an element. The bounds specify the component coordinates to its diagram.

$report.getQualifiedName(namedElement, separator)

Get a qualified name. A qualified name is the name that allows a NamedElement to be identified within a hierarchy of nested Namespaces. It is constructed from the names of the containing namespaces starting at the root of the hierarchy and ending with the name of the NamedElement itself.

$report.getPackageQualifiedName(namedElement, separator)

Get a qualified name by considering only Packages and a given element. Models and Profiles will not be included in the qualified name.

For example, given the element hierarchy:

Design : Model -> com : Package -> nomagic : Package -> ui -> Package -> BaseDialog : Class

$report.getPackageQualifiedName($class, ".")

If $class is a “BaseDialog” element, the result from the above template code will be as follows.

com.nomagic.ui.BaseDialog

$report.getReceivingOperationalNode(element)

Get the needline association ends.

$report.getRelationship(element)

Return an element’s relationship.

For example:

#foreach($relationship in $report.getRelationship($element))
Name: $relationship.name
#end

$report.getRelationship(element, recursive)

Return a collection of element relationships.

$report.getRelativeActor(element)

Return an element’s relative actor.

$report.getSendingOperationalNode(element)

Return the needline’s association ends.

$report.getSlotValue(element, ClassifierName, DefiningFeatureName)

Find and retrieve the values of a slot whose name and classifier’s name are DefiningFeatureName and ClassifierName respectively. The code enables case-sensitivity queries such that only those case-sensitive matches will return.

For example:

#foreach($instance in $InstanceSpecification)
Slot value is $report.getSlotValue($instance, "Personal Data", "Name")
#end

• “Personal Data” is the name of the classifier.
• Name” is the name of the slot.

$report.getStereotypeProperty(element, stereotypeName, propertyName)

Get a stereotype property.

For example:

#set($obj = $report.getStereotypeProperty($element, "MyStereotype", "myObject"))
$obj.name

$report.getStereotypeProperty(element, profileName, stereotypeName, propertyName)

Get a stereotype property.

$report.getStereotypePropertyString(element, stereotypeName, propertyName)

Return a stereotype property as a String value.

For example:

#set($str = $report.getStereotypePropertyString($element, "MyStereotype", "myString"))
$str

$report.getStereotypePropertyString(element, profileName, stereotypeName, propertyName)

Get a stereotype property as a String value.

$report.getPropertyGroupsByStereotype(stereotype)

Return a collection of property groups for the given stereotype.

For example:

#foreach($stereotype in $report.getStereotypes($element))
#foreach($propertyGroup in $report.getPropertyGroupsByStereotype($stereotype))
Group: $propertyGroup.name
#end
#end

$report.getPropertyGroupsByElement(element, addAlwaysVisible)

Return a set of property groups for the given element.

For example:

#foreach($propertyGroup in $report.getPropertyGroupsByStereotype($element, true))
Group: $propertyGroup.name
#end

$report.getQProperty(element, propertyName)

Get a property for an element with DSL property groups, and each property group has its own property.

For example:

#foreach($stereotype in $report.getStereotypes($element))
Stereotype: $stereotype.name
#foreach($propertyGroup in $report.getPropertyGroupsByStereotype($stereotype))
Group: $propertyGroup.name
#foreach($propertyName in $propertyGroup.getPropertyList())
#set($property = $report.getQProperty($element, $propertyName))
Property name: $property.name
Property value: $property.value
--------------------------------
#end
#end
#end

$report.getStereotypes(element)

Return all stereotypes applied to an element. This method is replaced by $element.appliedStereotype.

$report.getSupplierElement(element)

Return the supplier of a relationship.

$report.getUsageElements(usagesMap, element)

Return the usage of a specified element.

$report.getUsages(selectedObjects)

Return the Usage Map of the modeling tool. It uses the getUsageElements method to return the usage of a specified element.

$report.hasStereotype(element)

Check if an element has stereotypes.

$report.containsStereotype(element, stereotypeName)

Return true if an element contains a stereotype (including all derived stereotypes) for a specified stereotype name.

For example:

#if($report.containsStereotype($element, "MyStereotype"))
$element.name has been applied <<MyStereotype>>.
#end

$report.containsStereotype(element, stereotypeName, includeDerived)

Return true if an element contains a stereotype for a specified stereotype name.

$report.isDerivedClassifier(parent, child)

Check if a child is derived from the parent by generalization.

$report.isNamedElement(element)

Return whether an element is a NamedElement.

$report.isNull(obj)

Test and return true if an object is null.

$report.isRelationship(element)

Test and return true if an element is a relationship.

$report.serialize(hyperlink)

Convert com.nomagic.magicdraw.hyperlinks.Hyperlink to com.nomagic.magicdraw.plugins.impl.magicreport.helper.Hyperlink. Report Wizard needs the com.nomagic.magicdraw.plugins.impl.magicreport.helper.Hyperlink class wrapper to return com.nomagic.magicdraw.hyperlinks.Hyperlink data.

$report.getUsedBy(element)

Return a list of element(s) used by this element (except diagrams).

$report.hasProperty(element, propertyName)

Return true when a property with a given name is specified in this element, otherwise returns false.

For example:

#foreach($element in $elements)
$report.hasProperty($element, "name")
#end

• $element is the element.
• data is the name of the property.

$report.getProperty(element, propertyName)

Get element property.

For example:

#foreach($element in $elements)
$report.getProperty($element, "name")
#end

• $element is the element.
• name is the name of the property.

$report.findElementByName(source, regex)

Search and return elements that match the name using a regular expression.

For example:

#foreach($ele in $report.findElementByName($elements, "[A]+.*"))
$ele.name
#end

• $elements is a collection of elements to be found.
• “[A]+.*” is a regular expression to find which element matches the name. In this example, the following are the names that match, such as Auxiliary, AppServer, and Alternative Fragment.

$report.getPresentationElements(diagram)

Get a presentation element in a diagram. This method is equivalent to $report.getPresentationDiagramElements(diagram).

For example:

#foreach($diagram in $Diagram)
$foreach($d in $report.getPresentationElements($diagram))
$d.name
#end
#end

• $diagram is the diagram instance.

$report.getUsageRepresentationText(baseElement, bool)

Format the usage subject. The output string is the same as the Result column of Used by table in Magic Draw.

For example:

#foreach($baseElement in $Elements)
$report.getUsageRepresentationText($baseElement, false)
#end

• $baseElement is the model element to be formatted.
• false if a full path is not used. In this example, a full path is not used.

$report.getUseCaseNumber(element)

Return a use case number of an element.

For example:

#foreach ($uc in $RequirementsUseCase)
$report.getUseCaseNumber($uc) $uc.name
#end

$report.getElementURL(element)

Return a modeling tool's element URL.

For example:

#foreach ($element in $elements)
$report.getElementURL($element)
#end

$report.isEmpty(obj)

Test and return true if an object is null, empty string, or empty collection.

For example:

#if ($report.isEmpty($var))
Object is null, empty string or empty collection
#end 

$report.getBasicFlows(usecase:UseCase) : List<FlowStep>

Find and return a list of basic flows from a given use case. If a use case scenario is not being used, it will retrieve the value from "requirementUseCase" stereotype tags.

The <FlowStep> is a "com.nomagic.magicdraw.usecasescenarios.scenarios.FlowStep" class.

The important properties of <FlowStep> are as follows:

• name prints a name of a current step, for example: $flowStep.name.
• element returns an element associates with a current step, for example: #set ($e = $flowStep.element).
• alternativeConditions returns a list of alternative steps <AlternativeCondition> from a current step, for example: #foreach ($alter in $flowStep.alternativeConditions) #end.
• exceptionTypes returns a list of exception steps <ExceptionType> from a current step, for example: #foreach ($alter in $flowStep.exceptionTypes) #end.

For example:

#set ($basicFlowList = $report.getBasicFlows($useCase))
#foreach ($flowStep in $basicFlowList)
   $flowStep.name
   #foreach ($alter in $flowStep.alternativeConditions)
      - $alter.name
   #end
#end

$report.getAlternativeFlows(usecase:UseCase) : List<FlowStep>

Find and return all alternative flows from a given use case. The alternative flows will be listed from all possible branches of basic flows. If a use case scenario is not being used, it will retrieve the value from "requirementUseCase" stereotype tags.

For example:

#set ($alternativeFlowList = $report.getAlternativeFlows($useCase))
$useCase.name
 #foreach ($flowStep in $alternativeFlowList)
   $flowStep.name
   #foreach ($alternative in $flowStep.alternativeConditions)
      $alternative.name
         #foreach ($alternativeFlow in $alternative.alternativeFlowSteps)
         $alternativeFlow.name
         #end
   #end
 #end

$report.getExceptionalFlows(usecase:UseCase) : List<FlowStep>

Find and return all exceptional flows from a given use case. The alternative flows will be listed from all possible branches of basic flows. If the use case scenario is not being used, it will retrieve the value from "requirementUseCase" stereotype tags.

For example:

#set ($exceptionFlowList = $report.getExceptionalFlows($useCase))
     #foreach ($flowStep in $exceptionFlowList)
         $flowStep.name
         #foreach (#exception in $flowStep.exceptionTypes)
             $exception.name
             #foreach ($exceptionalFlow in $exception.exceptionalFlowSteps)
                  $exceptionalFlow.name
             #end
         #end
     #end

$report.getOwnedElementsIncludingAdditional(element, includePureOwned) : List<Element>

This code returns owned elements of a given element including additional owned elements defined in the DSL specification by additionalContentProperty.

The following are the examples of using the code.

#foreach($e in $elements)
$e.name : $e.humanType
  #foreach($child in $report.getOwnedElementsIncludingAdditional($e, true))
    $child.name : $child.humanType
  #end
#end

#foreach($e in $SmartPackage)
$e.name : $e.humanType
    #foreach($child in $report.getOwnedElementsIncludingAdditional($e, true))
       $child.name : $child.humanType
    #end
#end

#set($packages = $array.createArray())
#set($void = $array.addCollection($packages, $Package))
#set($void = $array.addCollection($packages, $SmartPackage))
#foreach($e in $packages)
$e.name : $e.humanType
    #foreach($child in $report.getOwnedElementsIncludingAdditional($e, true))
        $child.name : $child.humanType
    #end
#end