ReportHelper

java.lang.Object
- java.util.Observable
- - com.nomagic.magicreport.engine.Tool
  - - com.nomagic.magicdraw.magicreport.helper.ReportHelper

All Implemented Interfaces:

com.nomagic.magicreport.engine.ITool, com.nomagic.magicreport.IVariable, java.io.Serializable, java.lang.Cloneable
```
@OpenApiAll
public class ReportHelper
extends com.nomagic.magicreport.engine.Tool
```
Contains utilities functions for template report. Context name of this class is "report". Public functions of this class are able to access via template by using $report
For example:
```
 <code>
    #foreach ($rel in $report.getRelationships($package))
       $rel.name
    #end
 </code>
 
```
Since:

Jun 13, 2007

See Also:

Serialized Form

Nested Class Summary
- Nested classes/interfaces inherited from interface com.nomagic.magicreport.engine.ITool
  com.nomagic.magicreport.engine.ITool.HTMLString, com.nomagic.magicreport.engine.ITool.RetainedString, com.nomagic.magicreport.engine.ITool.Void

Field Summary
- Fields inherited from class com.nomagic.magicreport.engine.Tool
  context, properties
- Fields inherited from interface com.nomagic.magicreport.engine.ITool
  VOID

Constructor Summary

Constructors
Constructor and Description

ReportHelper()

Constructors
Constructor and Description
`ReportHelper()`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`boolean`	`containsStereotype(Element element, java.lang.String stereotypeName)` Returns true if element contains a stereotype (include all derived stereotype) for the specified stereotype name.
`boolean`	`containsStereotype(Element element, java.lang.String stereotypeName, boolean includeDerived)` Returns true if element contains a stereotype for the specified stereotype name.
`java.lang.String`	`createValueSpecificationText(ValueSpecification specification)` Create text represents the ValueSpecification element.
`java.util.Collection<Element>`	`filter(java.util.Collection<Element> elementList, java.lang.String propertyName, java.util.Collection<?> propertyValue)` Return the collection from the element list filtered by specified property name.
`java.util.Collection<BaseElement>`	`filterClassName(java.util.Collection<BaseElement> elementList, java.util.Collection<java.lang.String> shortNameForClassTypes)` Return the collection from the element list filtered by short name for class types.
`java.util.Collection<Diagram>`	`filterDiagram(java.util.Collection<Diagram> diagramList, java.util.Collection<java.lang.String> digramTypes)` Return the collection from the diagram list filtered by types.
`java.util.Collection<BaseElement>`	`filterElement(java.util.Collection<BaseElement> elementList, java.util.Collection<java.lang.String> humanTypes)` Return the collection from the element list filtered by human types.
`java.util.Collection<BaseElement>`	`filterElementType(java.util.Collection<BaseElement> elementList, java.util.Collection<java.lang.String> elementTypes)` Return the collection from the element list filtered by element types.
`java.util.Collection<Element>`	`findElementByName(java.util.Collection<Element> source, java.lang.String regex)` Search and return the elements from name by regular expression.
`Element`	`findElementInCollection(java.util.Collection<? extends Element> col, java.lang.String elementName)` Search and return the element in the collection by element name.
`java.util.Collection<Element>`	`findRelationship(Package modelPackage)` Search and return a collection of relationship element inside package.
`java.util.Collection<Element>`	`findRelationship(Package modelPackage, boolean recursive)` Search and return a collection of relationship element inside package.
`java.lang.String`	`getActorNumber(Element element)` Return the actor ID of Actor.
`java.util.List<FlowStep>`	`getAlternativeFlows(UseCase useCase)` Find and return all alternative flows from given use case.
`Stereotype`	`getAppliedStereotypeByName(Element element, java.lang.String stereotypeName)` Returns stereotype assigned to element.
`Stereotype`	`getAppliedStereotypeByString(Element element, java.lang.String stereotype)` Deprecated. See `getAppliedStereotypeByName(Element, String)`
`java.util.Collection`	`getBaseClassAssociations(Classifier classifier)` Gets the classifier associations.
`java.util.List<Classifier>`	`getBaseClassifiers(Classifier classifier)` Return classifier based elements.
`java.util.Collection`	`getBaseClassInheritableAttributes(Classifier classifier)` Gets the classifier inheritable attributes.
`java.util.Collection`	`getBaseClassInheritableOperations(Classifier classifier)` Gets the classifier inheritable operations.
`java.util.Collection`	`getBaseClassPorts(Classifier classifier)` Gets the classifier port.
`java.util.Collection`	`getBaseRealizedInterfaces(BehavioredClassifier behavioredClassifier)` Gets the behavior classifier realized interfaces.
`java.util.Collection`	`getBaseRelations(Classifier classifier)` Gets the classifier relations.
`java.util.List<FlowStep>`	`getBasicFlows(UseCase useCase)` Find and return a list of basic flows from given use case.
`Element`	`getClientElement(Element element)` Gets relationship client.
`java.lang.String`	`getComment(Element element)` Returns documentation of given element.
`com.nomagic.magicreport.Image`	`getCustomImage(Element element)` Return original image of Image property
`com.nomagic.magicreport.Image`	`getCustomImage(PresentationElement presentationElement)` Return original image of Image property from presentationElement
`ElementImageHelper.ImageInformation`	`getCustomImageInformation(Element element)` Return a CustomImageHolder information
`java.util.Collection<Classifier>`	`getDerivedClassifiers(Classifier parentClassifier)` Returns classifier derived elements.
`java.util.Collection<Element>`	`getDiagramElements(Diagram diagram)` Gets elements from this diagram.
`java.util.Collection<Element>`	`getDiagramElements(DiagramPresentationElement diagram)` Gets presentation elements from this diagram.
`java.lang.String`	`getDiagramType(Diagram diagram)` Gets diagram type.
`java.lang.Object`	`getDSLProperty(Element element, java.lang.String propertyName)` Get DSL Property.
`Comment`	`getElementComment(Element element)` Returns comment annotated to this element.
`java.lang.String`	`getElementName(java.lang.Object element)` Gets name of the element.
`java.lang.String`	`getElementURL(Element element)` Retrieve MagicDraw's element URL.
`java.util.List<FlowStep>`	`getExceptionalFlows(UseCase useCase)` Find and return a basic flow from given use case.
`com.nomagic.magicreport.Image`	`getIconFor(BaseElement element)` Return image icon for element.
`com.nomagic.magicreport.Image`	`getIconFor(BaseElement element, java.lang.String prefix, java.lang.String suffix, boolean hashCode)` Return image icon for element.
`com.nomagic.magicreport.Image`	`getIconFor(java.lang.String type)` Return image icon for element.
`com.nomagic.magicreport.Image`	`getIconFor(java.lang.String type, java.lang.String prefix, java.lang.String suffix, boolean hashCode)` Return image icon for element.
`java.util.Collection<Element>`	`getIncludeUseCase(UseCase useCase)` Gets use case included element.
`java.util.Collection<Element>`	`getInnerElement(Element element)` Return a collection of inner element.
`java.lang.String`	`getInteractionMessageType(Message message)` Gets interaction message type.
`java.util.Collection<Class>`	`getMetaClass(Stereotype stereotype)` Get stereotype meta class.
`java.util.List<Element>`	`getOwnedElementsIncludingAdditional(Element element, boolean includePureOwned)` Return owned elements of the given Element including additional owned elements defined in DSL specification by additionalContentProperty.
`static java.lang.String`	`getPackageQualifiedName(NamedElement namedElement, java.lang.String separator)` Get a qualified name by consider only Package and given element.
`java.util.Collection<Element>`	`getPackages(boolean includeSmartPacakge)`
`java.util.Collection<PresentationElement>`	`getPresentationDiagramElements(Diagram diagram)` Gets presentation element in the diagram.
`java.util.Collection<PresentationElement>`	`getPresentationDiagramElements(Diagram diagram, boolean includeNonManipulator)` Gets presentation element in the diagram.
`java.util.List<com.nomagic.magicdraw.magicreport.helper.Polygon>`	`getPresentationElementBounds(Diagram diagram, Element element)` Gets the bounds of this element in the form of a Polygon object.
`com.nomagic.magicdraw.magicreport.helper.Polygon`	`getPresentationElementBounds(PresentationElement element)` Gets the bounds of this element in the form of a Polygon object.
`java.util.List<java.awt.Rectangle>`	`getPresentationElementRectangle(Diagram diagram, Element element)` Gets the bounds of this element in the form of a Rectangle object.
`java.util.Collection<PresentationElement>`	`getPresentationElements(Diagram diagram)` Deprecated.
`java.lang.Object`	`getProperty(Element element, java.lang.String propertyName)` Get the element property.
`static java.lang.String`	`getQualifiedName(NamedElement namedElement, java.lang.String separator)` Get a qualified name.
`java.lang.String`	`getQualifiedOwnerName(NamedElement obj)` Deprecated. result from this method is incorrect. Use $element.owner.qualifiedName
`Element`	`getRecievingOperationalNode(Element element)` Get needline association ends.
`java.util.Collection<Element>`	`getRelationship(Element element)` Gets element relationship.
`java.util.Collection<Element>`	`getRelationship(Element element, boolean recursive)` Return relationship of this element.
`java.util.Collection<Actor>`	`getRelativeActor(Element element)` Gets element relative actor.
`Element`	`getSendingOperationalNode(Element element)` Get needline association ends.
`java.lang.Object`	`getSlotProperty(Element element, java.lang.String classifierName)` Get slot property by classifier name If there are more than one classifier matching with specified parameters, return only the property of first matching classifier.
`java.util.List<java.lang.Object>`	`getSlotValue(Element element, java.lang.String classifierName, java.lang.String definingFeatureName)` Get slot value by classifier name and definingFeature name.
`java.lang.Object`	`getStereotypeProperty(Element element, Stereotype stereotype, java.lang.String propertyName)` Gets stereotype property.
`java.lang.Object`	`getStereotypeProperty(Element element, java.lang.String stereotypeName, java.lang.String propertyName)` Gets stereotype property.
`static java.lang.Object`	`getStereotypeProperty(Element element, java.lang.String profileName, java.lang.String stereotypeName, java.lang.String propertyName)` Get Stereotype Property.
`java.util.List<java.lang.Object>`	`getStereotypePropertyList(Element element, java.lang.String stereotypeName, java.lang.String propertyName)` Deprecated. value return from this method is improperly converted.
`java.lang.String`	`getStereotypePropertyString(Element element, java.lang.String stereotypeName, java.lang.String propertyName)` Gets stereotype property as String value.
`java.lang.String`	`getStereotypePropertyString(Element element, java.lang.String profileName, java.lang.String stereotypeName, java.lang.String propertyName)` Gets stereotype property as String value.
`java.lang.String`	`getStereotypePropertyStringValue(java.lang.Object o)` Deprecated. value return from this method is improperly converted.
`java.util.List<Stereotype>`	`getStereotypes(Element element)` Gets all stereotypes applied to element.
`Element`	`getSupplierElement(Element element)` Gets relationship supplier.
`java.lang.String`	`getUCOwnerNumber(Element element)` Return the use case number or use case ID of element.
`java.util.Collection<BaseElement>`	`getUsageElements(java.util.Map<BaseElement,java.util.ArrayList<com.nomagic.magicdraw.uml.DependencyType>> usagesMap, Element element)` Gets the element usages from usage map.
`java.lang.String`	`getUsageRepresentationText(BaseElement be, boolean addFullPath)` Formats the usage subject.
`java.util.Map<BaseElement,java.util.ArrayList<com.nomagic.magicdraw.uml.DependencyType>>`	`getUsages(java.lang.Object selectedObjects)` Returns Usage Map of MD and then use getUsageElements method for returning the usage of the specified element.
`java.util.Collection<Element>`	`getUseCaseAssociatedElement(Element obj)` Deprecated.
`java.lang.String`	`getUseCaseNumber(Element element)` Return the use case number or use case ID of element.
`java.util.Collection<BaseElement>`	`getUsedBy(Element element)` Return a list of element used by this element (except diagram).
`boolean`	`hasBaseClassifier(Classifier classifier, java.lang.String baseClassifier)` Checks if element has base classifier with given name.
`boolean`	`hasProperty(Element element, java.lang.String propertyName)` Returns true when a property with a given name is specified on this element, false otherwise.
`boolean`	`hasStereotype(Element element)` Checks if element has stereotypes.
`boolean`	`hasStereotype(Element element, java.lang.String stereotype)` Deprecated. See `containsStereotype(Element, String)`
`boolean`	`isDerivedClassifier(Classifier parent, Classifier child)` Checks if child is derived from parent by generalization.
`boolean`	`isEmpty(java.lang.Object obj)` Test and return true if object is null, empty string or empty collection.
`boolean`	`isNamedElement(Element element)` Returns whether the element an `NamedElement`.
`boolean`	`isNull(java.lang.Object obj)` Test and return true if object is null.
`boolean`	`isRelationship(Element element)` Test and return true if element is relationship.
`static java.lang.Object`	`parseObjectForPrinting(java.lang.Object value)` Parses Strings and Collections of Strings
`com.nomagic.magicdraw.magicreport.helper.Hyperlink`	`serialize(Hyperlink hyperlink)` Convert `com.nomagic.magicdraw.hyperlinks.Hyperlink` to `Hyperlink`.
`java.lang.String`	`trimString(java.lang.String s)` Deprecated. replaced with $s.trim()

Methods inherited from class com.nomagic.magicreport.engine.Tool
clone, getContext, getProperties, getProperty, getProperty, notifyObservers, setContext, setProperties

Methods inherited from class java.util.Observable
addObserver, clearChanged, countObservers, deleteObserver, deleteObservers, hasChanged, notifyObservers, setChanged

Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - ReportHelper
```
public ReportHelper()
```
- Method Detail
  - getDSLProperty
```
public java.lang.Object getDSLProperty(Element element,
                                       java.lang.String propertyName)
```
    Get DSL Property.
    
    Parameters:
    
    element - the element.
    
    propertyName - the property name.
    
    Returns:
    
    the property value.
  - getStereotypeProperty
```
public java.lang.Object getStereotypeProperty(Element element,
                                              java.lang.String stereotypeName,
                                              java.lang.String propertyName)
```
    Gets stereotype property.
    
    Parameters:
    
    element - the element.
    
    stereotypeName - the stereotype name.
    
    propertyName - the property name.
    
    Returns:
    
    the property value.
    
    See Also:
    
    getStereotypeProperty(Element, Stereotype, String), getStereotypeProperty(Element, String, String, String)
  - parseObjectForPrinting
```
public static java.lang.Object parseObjectForPrinting(java.lang.Object value)
```
    Parses Strings and Collections of Strings
  - getStereotypeProperty
```
public java.lang.Object getStereotypeProperty(Element element,
                                              Stereotype stereotype,
                                              java.lang.String propertyName)
```
    Gets stereotype property.
    
    Parameters:
    
    element - the element.
    
    stereotype - the stereotype.
    
    propertyName - the property name.
    
    Returns:
    
    the property value.
    
    See Also:
    
    getStereotypeProperty(Element, String, String), getStereotypeProperty(Element, String, String, String)
  - getStereotypeProperty
```
public static java.lang.Object getStereotypeProperty(Element element,
                                                     java.lang.String profileName,
                                                     java.lang.String stereotypeName,
                                                     java.lang.String propertyName)
```
    Get Stereotype Property.
    
    Parameters:
    
    element - the element.
    
    profileName - profile name
    
    stereotypeName - the stereotype name.
    
    propertyName - the property name.
    
    Returns:
    
    the property value.
  - getStereotypePropertyList
```
@Deprecated
public java.util.List<java.lang.Object> getStereotypePropertyList(Element element,
                                                                              java.lang.String stereotypeName,
                                                                              java.lang.String propertyName)
```
    Deprecated. value return from this method is improperly converted.
    
    Gets stereotype property value as list of strings.
    
    Parameters:
    
    element - element with assigned stereotype
    
    stereotypeName - stereotype name
    
    propertyName - name of the property
    
    Returns:
    
    List of the property name.
  - getStereotypePropertyString
```
public java.lang.String getStereotypePropertyString(Element element,
                                                    java.lang.String stereotypeName,
                                                    java.lang.String propertyName)
```
    Gets stereotype property as String value.
    
    Parameters:
    
    element - the element instance
    
    stereotypeName - the stereotype name
    
    propertyName - the property name
    
    Returns:
    
    the value as String
  - getStereotypePropertyString
```
public java.lang.String getStereotypePropertyString(Element element,
                                                    java.lang.String profileName,
                                                    java.lang.String stereotypeName,
                                                    java.lang.String propertyName)
```
    Gets stereotype property as String value.
    
    Parameters:
    
    element - the element instance
    
    profileName - profile name
    
    stereotypeName - the stereotype name
    
    propertyName - the property name
    
    Returns:
    
    the value as String
  - getStereotypePropertyStringValue
```
@Deprecated
public java.lang.String getStereotypePropertyStringValue(java.lang.Object o)
```
    Deprecated. value return from this method is improperly converted.
    
    Gets Stereotype Property As String value.
    
    Parameters:
    
    o - the property
    
    Returns:
    
    the value as String
  - isNamedElement
```
public boolean isNamedElement(Element element)
```
    Returns whether the element an NamedElement.
    
    Parameters:
    
    element - element to test
    
    Returns:
    
    true if given element is NamedElement; otherwise false
  - getAppliedStereotypeByString
```
@Deprecated
public Stereotype getAppliedStereotypeByString(Element element,
                                                           java.lang.String stereotype)
```
    Deprecated. See getAppliedStereotypeByName(Element, String)
    
    Returns stereotype assigned to element.
    
    Parameters:
    
    element - element
    
    stereotype - name of stereotype
    
    Returns:
    
    assigned stereotype with that name.
  - getAppliedStereotypeByName
```
public Stereotype getAppliedStereotypeByName(Element element,
                                             java.lang.String stereotypeName)
```
    Returns stereotype assigned to element.
    
    Parameters:
    
    element - element
    
    stereotypeName - name of stereotype
    
    Returns:
    
    assigned stereotype with that name.
  - hasStereotype
```
@Deprecated
public boolean hasStereotype(Element element,
                                         java.lang.String stereotype)
```
    Deprecated. See containsStereotype(Element, String)
    
    Checks if element has assigned stereotype with given name.
    
    Parameters:
    
    element - element to check
    
    stereotype - stereotype name to check
    
    Returns:
    
    true if element has assigned stereotype with given name
  - containsStereotype
```
public boolean containsStereotype(Element element,
                                  java.lang.String stereotypeName)
```
    Returns true if element contains a stereotype (include all derived stereotype) for the specified stereotype name.
    
    Parameters:
    
    element - element to test
    
    stereotypeName - stereotype name to be tested
    
    Returns:
    
    true if element contains a stereotype for the specified stereotype name.
    
    See Also:
    
    containsStereotype(Element, String, boolean)
  - containsStereotype
```
public boolean containsStereotype(Element element,
                                  java.lang.String stereotypeName,
                                  boolean includeDerived)
```
    Returns true if element contains a stereotype for the specified stereotype name.
    
    Parameters:
    
    element - element to test
    
    stereotypeName - stereotype name to be tested
    
    includeDerived - true if search target include all derived stereotypes; otherwise false
    
    Returns:
    
    true if element contains a stereotype for the specified stereotype name.
    
    See Also:
    
    containsStereotype(Element, String)
  - hasProperty
```
public boolean hasProperty(Element element,
                           java.lang.String propertyName)
```
    Returns true when a property with a given name is specified on this element, false otherwise.
    
    Parameters:
    
    element - element to test
    
    propertyName - property name
    
    Returns:
    
    true when a property with a given name is specified on this element, false otherwise.
  - getProperty
```
public java.lang.Object getProperty(Element element,
                                    java.lang.String propertyName)
                             throws com.nomagic.magicdraw.magicreport.helper.PropertyNotFoundException
```
    Get the element property.
    
    Parameters:
    
    element - the object that will be gotten that data.
    
    propertyName - the field of the element.
    
    Returns:
    
    the data of that field in the element.
    
    Throws:
    
    PropertyNotFoundException - when a request property name is not found on target element.
  - getStereotypes
```
public java.util.List<Stereotype> getStereotypes(Element element)
                                          throws java.lang.IllegalArgumentException
```
    Gets all stereotypes applied to element. This method is replaced with $element.appliedStereotype.
    
    Parameters:
    
    element - the element
    
    Returns:
    
    the stereotype instances
    
    Throws:
    
    java.lang.IllegalArgumentException - from StereotypesHelper.getStereotypes
  - hasStereotype
```
public boolean hasStereotype(Element element)
                      throws java.lang.IllegalArgumentException
```
    Checks if element has stereotypes.
    
    Parameters:
    
    element - element to check
    
    Returns:
    
    true if has
    
    Throws:
    
    java.lang.IllegalArgumentException - if element is null
  - findElementInCollection
```
public Element findElementInCollection(java.util.Collection<? extends Element> col,
                                       java.lang.String elementName)
```
    Search and return the element in the collection by element name.
    
    Parameters:
    
    col - the collection of elements
    
    elementName - the name of element
    
    Returns:
    
    the element instance, If it does not find, it will return null.
  - findElementByName
```
public java.util.Collection<Element> findElementByName(java.util.Collection<Element> source,
                                                       java.lang.String regex)
```
    Search and return the elements from name by regular expression.
    
    Parameters:
    
    source - source
    
    regex - the regular expression to which name is to be matched
    
    Returns:
    
    collection of matches element
  - getDerivedClassifiers
```
public java.util.Collection<Classifier> getDerivedClassifiers(Classifier parentClassifier)
```
    Returns classifier derived elements.
    
    Parameters:
    
    parentClassifier - the parent class
    
    Returns:
    
    collection of derived elements (classifiers)
  - hasBaseClassifier
```
public boolean hasBaseClassifier(Classifier classifier,
                                 java.lang.String baseClassifier)
```
    Checks if element has base classifier with given name.
    
    Parameters:
    
    classifier - the classifier
    
    baseClassifier - base classifier name
    
    Returns:
    
    true if the element contains specific base classifiers.
  - getBaseClassifiers
```
public java.util.List<Classifier> getBaseClassifiers(Classifier classifier)
```
    Return classifier based elements. The list contains all base classifiers include all its derived classifiers.
    
    Parameters:
    
    classifier - the classifier
    
    Returns:
    
    collection of based elements (classifiers)
  - getComment
```
public java.lang.String getComment(Element element)
```
    Returns documentation of given element.
    
    Parameters:
    
    element - the element which will be gotten the name.
    
    Returns:
    
    the document
  - getElementComment
```
public Comment getElementComment(Element element)
```
    Returns comment annotated to this element. If comment is attached to this element, returns null.
    
    Parameters:
    
    element - the element which will be gotten the Comment.
    
    Returns:
    
    Comment instance of this element.
  - getRelativeActor
```
public java.util.Collection<Actor> getRelativeActor(Element element)
```
    Gets element relative actor.
    
    Parameters:
    
    element - the element
    
    Returns:
    
    the collection of Actor.
  - getUseCaseAssociatedElement
```
@Deprecated
public java.util.Collection<Element> getUseCaseAssociatedElement(Element obj)
```
    Deprecated.
    
    Gets associated Element.
    
    Parameters:
    
    obj - the element that we would like to find the other part
    
    Returns:
    
    the other parts
  - getIncludeUseCase
```
public java.util.Collection<Element> getIncludeUseCase(UseCase useCase)
```
    Gets use case included element.
    
    Parameters:
    
    useCase - the UseCase instance
    
    Returns:
    
    the collection of included use case.
  - trimString
```
@Deprecated
public java.lang.String trimString(java.lang.String s)
```
    Deprecated. replaced with $s.trim()
    
    Trim string.
    
    Parameters:
    
    s - the String
    
    Returns:
    
    the trimmed String
  - createValueSpecificationText
```
public java.lang.String createValueSpecificationText(ValueSpecification specification)
```
    Create text represents the ValueSpecification element.
    
    Parameters:
    
    specification - The given ValueSpecification.
    
    Returns:
    
    the String value for ValueSpecification
  - getPresentationElements
```
@Deprecated
public java.util.Collection<PresentationElement> getPresentationElements(Diagram diagram)
```
    Deprecated.
    
    Gets presentation element in the diagram. This method equivalent to getPresentationDiagramElements(Diagram).
    
    Parameters:
    
    diagram - the diagram instance.
    
    Returns:
    
    the collection of elements.
    
    See Also:
    
    getPresentationDiagramElements(Diagram)
  - getPresentationDiagramElements
```
public java.util.Collection<PresentationElement> getPresentationDiagramElements(Diagram diagram)
```
    Gets presentation element in the diagram. This method will return all presentation elements from diagram except non-manipulator symbols.
    
    Parameters:
    
    diagram - the diagram instance.
    
    Returns:
    
    the collection of elements.
    
    See Also:
    
    getPresentationDiagramElements(Diagram, boolean)
  - getPresentationDiagramElements
```
public java.util.Collection<PresentationElement> getPresentationDiagramElements(Diagram diagram,
                                                                                boolean includeNonManipulator)
```
    Gets presentation element in the diagram.
    
    Parameters:
    
    diagram - the diagram instance.
    
    includeNonManipulator - true for include all non-manipulator element.
    
    Returns:
    
    the collection of elements.
    
    See Also:
    
    getPresentationDiagramElements(Diagram)
  - getPresentationElementBounds
```
public com.nomagic.magicdraw.magicreport.helper.Polygon getPresentationElementBounds(PresentationElement element)
```
    Gets the bounds of this element in the form of a Polygon object. The bounds specify this component's coordinate to its diagram.
    
    Parameters:
    
    element - the presentation element on diagram.
    
    Returns:
    
    the bound of element as Polygon
  - getPresentationElementRectangle
```
public java.util.List<java.awt.Rectangle> getPresentationElementRectangle(Diagram diagram,
                                                                          Element element)
```
    Gets the bounds of this element in the form of a Rectangle object. The bounds specify this component's coordinate to its diagram.
    
    Parameters:
    
    diagram - the target diagram.
    
    element - the presentation element on given diagram.
    
    Returns:
    
    the bound of element as Rectangle. If element is not found in the diagram, it will return null.
  - getPresentationElementBounds
```
public java.util.List<com.nomagic.magicdraw.magicreport.helper.Polygon> getPresentationElementBounds(Diagram diagram,
                                                                                                     Element element)
```
    Gets the bounds of this element in the form of a Polygon object. The bounds specify this component's coordinate to its diagram.
    
    Parameters:
    
    diagram - the target diagram.
    
    element - the presentation element on given diagram.
    
    Returns:
    
    the bound of element as Polygon. If element is not found in the diagram, it will return null.
  - getDiagramType
```
public java.lang.String getDiagramType(Diagram diagram)
```
    Gets diagram type.
    
    Parameters:
    
    diagram - the diagram instance.
    
    Returns:
    
    the type of diagram.
  - getMetaClass
```
public java.util.Collection<Class> getMetaClass(Stereotype stereotype)
```
    Get stereotype meta class.
    
    Parameters:
    
    stereotype - the stereotype
    
    Returns:
    
    the collection of Meta Class
  - getDiagramElements
```
public java.util.Collection<Element> getDiagramElements(Diagram diagram)
```
    Gets elements from this diagram.
    
    Parameters:
    
    diagram - the target diagram.
    
    Returns:
    
    the collection of elements.
  - getDiagramElements
```
public java.util.Collection<Element> getDiagramElements(DiagramPresentationElement diagram)
```
    Gets presentation elements from this diagram.
    
    Parameters:
    
    diagram - the target diagram.
    
    Returns:
    
    the collection of elements.
  - getQualifiedOwnerName
```
@Deprecated
public java.lang.String getQualifiedOwnerName(NamedElement obj)
```
    Deprecated. result from this method is incorrect. Use $element.owner.qualifiedName
    
    Get qualified owner name.
    
    Parameters:
    
    obj - the object instance
    
    Returns:
    
    the qualified owner name
  - getQualifiedName
```
public static java.lang.String getQualifiedName(NamedElement namedElement,
                                                java.lang.String separator)
```
    Get a qualified name. Qualified is a name which allows the 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.
    
    Parameters:
    
    namedElement - NamedElement
    
    separator - separator symbol. If value is null or empty string, the '::' will be used.
    
    Returns:
    
    a qualified name.
  - getPackageQualifiedName
```
public static java.lang.String getPackageQualifiedName(NamedElement namedElement,
                                                       java.lang.String separator)
```
    Get a qualified name by consider only Package and given element. Model and Profile will not be included on the qualified name.
    For example: The element hierarchy is
```
 
        Design : Model -> com : Package -> nomagic : Package -> ui -> Package -> BaseDialog : Class
 
```
    When template code is: $report.getPackageQualifiedName($class, ".") Where $class is "BaseDialog" element, the result from above code will be: com.nomagic.ui.BaseDialog
    Parameters:
    
    namedElement - NamedElement
    
    separator - separator symbol. If value is null or empty string, the '::' will be used.
    
    Returns:
    
    a qualified name.
  - serialize
```
public com.nomagic.magicdraw.magicreport.helper.Hyperlink serialize(Hyperlink hyperlink)
```
    Convert com.nomagic.magicdraw.hyperlinks.Hyperlink to Hyperlink.
    
    Parameters:
    
    hyperlink - the magicdraw hyperlink
    
    Returns:
    
    the magic report hyperlink instance
  - getSendingOperationalNode
```
public Element getSendingOperationalNode(Element element)
```
    Get needline association ends.
    
    Parameters:
    
    element - element
    
    Returns:
    
    needline association ends
  - getRecievingOperationalNode
```
public Element getRecievingOperationalNode(Element element)
```
    Get needline association ends.
    
    Parameters:
    
    element - element
    
    Returns:
    
    needline association ends
  - findRelationship
```
public java.util.Collection<Element> findRelationship(Package modelPackage)
```
    Search and return a collection of relationship element inside package.
    
    Parameters:
    
    modelPackage - package element
    
    Returns:
    
    Collection of relationship in this package
  - findRelationship
```
public java.util.Collection<Element> findRelationship(Package modelPackage,
                                                      boolean recursive)
```
    Search and return a collection of relationship element inside package.
    
    Parameters:
    
    modelPackage - package element
    
    recursive - if true, perform recursively
    
    Returns:
    
    Collection of relationship in this package
  - getRelationship
```
public java.util.Collection<Element> getRelationship(Element element)
```
    Gets element relationship.
    
    Parameters:
    
    element - Element element to be collect
    
    Returns:
    
    Collection of relationship
  - getRelationship
```
public java.util.Collection<Element> getRelationship(Element element,
                                                     boolean recursive)
```
    Return relationship of this element.
    
    Parameters:
    
    element - Element element to be collect
    
    recursive - if true, perform recursively
    
    Returns:
    
    Collection of relationship
  - getClientElement
```
public Element getClientElement(Element element)
```
    Gets relationship client.
    
    Parameters:
    
    element - relationship model element.
    
    Returns:
    
    client element
  - getSupplierElement
```
public Element getSupplierElement(Element element)
```
    Gets relationship supplier.
    
    Parameters:
    
    element - relationship model element.
    
    Returns:
    
    supplier element
  - getInnerElement
```
public java.util.Collection<Element> getInnerElement(Element element)
```
    Return a collection of inner element.
    
    Parameters:
    
    element - Element element to be collect
    
    Returns:
    
    Collection of inner
  - getIconFor
```
public com.nomagic.magicreport.Image getIconFor(BaseElement element)
```
    Return image icon for element.
    
    Parameters:
    
    element - a Magic Draw element
    
    Returns:
    
    Image object for element's icon
  - getIconFor
```
public com.nomagic.magicreport.Image getIconFor(BaseElement element,
                                                java.lang.String prefix,
                                                java.lang.String suffix,
                                                boolean hashCode)
```
    Return image icon for element. In case of hashCode equals true, icon's name format is set to "icon_"+hash code and doesn't include prefix/suffix.
    
    Parameters:
    
    element - a MagicDraw element
    
    prefix - prefix for icon's name
    
    suffix - suffix for icon's name
    
    hashCode - uses hash code in icon's name
    
    Returns:
    
    Image object for element's icon
  - getIconFor
```
public com.nomagic.magicreport.Image getIconFor(java.lang.String type)
```
    Return image icon for element.
    
    Parameters:
    
    type - element type
    
    Returns:
    
    Image object for element's icon
  - getIconFor
```
public com.nomagic.magicreport.Image getIconFor(java.lang.String type,
                                                java.lang.String prefix,
                                                java.lang.String suffix,
                                                boolean hashCode)
```
    Return image icon for element. In case of hashCode equals true, icon's name format is set to "icon_"+hash code and doesn't include prefix/suffix.
    
    Parameters:
    
    type - element type
    
    prefix - prefix for icon's name
    
    suffix - suffix for icon's name
    
    hashCode - uses hash code in icon's name
    
    Returns:
    
    Image object for element's icon
  - getCustomImage
```
public com.nomagic.magicreport.Image getCustomImage(PresentationElement presentationElement)
```
    Return original image of Image property from presentationElement
    
    Parameters:
    
    presentationElement - a presentationElement
    
    Returns:
    
    original image in Image property
  - getCustomImage
```
public com.nomagic.magicreport.Image getCustomImage(Element element)
```
    Return original image of Image property
    
    Parameters:
    
    element - an element
    
    Returns:
    
    original image in Image property
  - getCustomImageInformation
```
public ElementImageHelper.ImageInformation getCustomImageInformation(Element element)
```
    Return a CustomImageHolder information
    
    Parameters:
    
    element - element
    
    Returns:
    
    CustomImageHolder
  - isNull
```
public boolean isNull(java.lang.Object obj)
```
    Test and return true if object is null.
    
    Parameters:
    
    obj - object being tested.
    
    Returns:
    
    true if object is null
  - isEmpty
```
public boolean isEmpty(java.lang.Object obj)
```
    Test and return true if object is null, empty string or empty collection.
    
    Parameters:
    
    obj - object being tested.
    
    Returns:
    
    true if object is null, empty string or empty collection.
  - isRelationship
```
public boolean isRelationship(Element element)
```
    Test and return true if element is relationship.
    
    Parameters:
    
    element - element being tested.
    
    Returns:
    
    true if object is relationship
  - getInteractionMessageType
```
public java.lang.String getInteractionMessageType(Message message)
```
    Gets interaction message type.
    
    Parameters:
    
    message - Message
    
    Returns:
    
    type of message
  - getUsageRepresentationText
```
public java.lang.String getUsageRepresentationText(BaseElement be,
                                                   boolean addFullPath)
```
    Formats the usage subject. The output string is the same as Result column of Used by table in Magic Draw.
    
    Parameters:
    
    be - ModelElement to format.
    
    addFullPath - use full path.
    
    Returns:
    
    formatted element, String.
  - getUsedBy
```
public java.util.Collection<BaseElement> getUsedBy(Element element)
```
    Return a list of element used by this element (except diagram).
    
    Parameters:
    
    element - the the element which will be gotten the list of element name that uses the specified element.
    
    Returns:
    
    Collection of elements used by input element.
  - getUsages
```
public java.util.Map<BaseElement,java.util.ArrayList<com.nomagic.magicdraw.uml.DependencyType>> getUsages(java.lang.Object selectedObjects)
```
    Returns Usage Map of MD and then use getUsageElements method for returning the usage of the specified element.
    
    Parameters:
    
    selectedObjects - the elements that this method will find the usage.
    
    Returns:
    
    Map of Usages of elements
  - getUsageElements
```
public java.util.Collection<BaseElement> getUsageElements(java.util.Map<BaseElement,java.util.ArrayList<com.nomagic.magicdraw.uml.DependencyType>> usagesMap,
                                                          Element element)
```
    Gets the element usages from usage map.
    
    Parameters:
    
    usagesMap - the Usages Map of MagicDraw.
    
    element - the element which will be gotten the list of element name that uses the specified element.
    
    Returns:
    
    Collection of usage name of elements.
  - getElementName
```
public java.lang.String getElementName(java.lang.Object element)
```
    Gets name of the element. If the name of element is empty, it will return "<unnamed>". This method performs the following procedures:
    1. If element is generalized from NamedElement, return $element.name
    2. If element is generalized from Slot, return $element.definingFeature.name
    3. If element is an UML element, return $element.humanName
    4. else return $element.toString()
    Parameters:
    
    element - the element.
    
    Returns:
    
    element name
  - filterDiagram
```
public java.util.Collection<Diagram> filterDiagram(java.util.Collection<Diagram> diagramList,
                                                   java.util.Collection<java.lang.String> digramTypes)
```
    Return the collection from the diagram list filtered by types.
    Example:
```
 #foreach ($d in $report.filterElement($Diagram, ['Use Case Diagram', 'Class Diagram'])
    $d.name
 #end    
 
```
    Parameters:
    
    diagramList - the collection of diagrams.
    
    digramTypes - the collection of diagram types which is used to filter.
    
    Returns:
    
    the collection of filtered diagrams.
  - filterElement
```
public java.util.Collection<BaseElement> filterElement(java.util.Collection<BaseElement> elementList,
                                                       java.util.Collection<java.lang.String> humanTypes)
```
    Return the collection from the element list filtered by human types.
    Example:
```
 #foreach ($e in $report.filterElement($elements, ['Class', 'Interface'])
    $e.name $e.humanType
 #end    
 
```
    Parameters:
    
    elementList - the collection of element.
    
    humanTypes - the collection of human types which is used to filter.
    
    Returns:
    
    the collection of filtered elements.
  - filterElementType
```
public java.util.Collection<BaseElement> filterElementType(java.util.Collection<BaseElement> elementList,
                                                           java.util.Collection<java.lang.String> elementTypes)
```
    Return the collection from the element list filtered by element types.
    Example:
```
 #foreach ($e in $report.filterElementType($elements, ['class', 'interface'])
    $e.name $e.elementType
 #end    
 
```
    Parameters:
    
    elementList - the collection of element.
    
    elementTypes - the collection of element types which is used to filter.
    
    Returns:
    
    the collection of filtered elements.
  - filterClassName
```
public java.util.Collection<BaseElement> filterClassName(java.util.Collection<BaseElement> elementList,
                                                         java.util.Collection<java.lang.String> shortNameForClassTypes)
```
    Return the collection from the element list filtered by short name for class types.
    Example:
```
 #foreach ($e in $report.filterClassName($elements, ['Diagram', 'UseCase'])
    $e.name $e.className
 #end    
 
```
    Parameters:
    
    elementList - the collection of element.
    
    shortNameForClassTypes - the collection of short name for class type which is used to filter.
    
    Returns:
    
    the collection of filtered elements.
  - filter
```
public java.util.Collection<Element> filter(java.util.Collection<Element> elementList,
                                            java.lang.String propertyName,
                                            java.util.Collection<?> propertyValue)
```
    Return the collection from the element list filtered by specified property name.
    Example:
```
 #foreach ($e in $report.filter($elements, 'name', ['foo', 'bar'])
    $e.name
 #end    
 
```
    Parameters:
    
    elementList - the collection of element.
    
    propertyName - the property name which is used to filter.
    
    propertyValue - the collection of element property values which is used to filter.
    
    Returns:
    
    the collection of filtered elements.
  - getBaseClassInheritableAttributes
```
public java.util.Collection getBaseClassInheritableAttributes(Classifier classifier)
```
    Gets the classifier inheritable attributes.
    
    Parameters:
    
    classifier - the Classifier.
    
    Returns:
    
    the Collection of Attributes.
  - getBaseClassInheritableOperations
```
public java.util.Collection getBaseClassInheritableOperations(Classifier classifier)
```
    Gets the classifier inheritable operations.
    
    Parameters:
    
    classifier - the Classifier.
    
    Returns:
    
    the Collection of Operations.
  - getBaseClassAssociations
```
public java.util.Collection getBaseClassAssociations(Classifier classifier)
```
    Gets the classifier associations.
    
    Parameters:
    
    classifier - the Classifier.
    
    Returns:
    
    the Collection of Associations.
  - getBaseRelations
```
public java.util.Collection getBaseRelations(Classifier classifier)
```
    Gets the classifier relations.
    
    Parameters:
    
    classifier - the Classifier.
    
    Returns:
    
    the Collection of Relations.
  - getBaseClassPorts
```
public java.util.Collection getBaseClassPorts(Classifier classifier)
```
    Gets the classifier port.
    
    Parameters:
    
    classifier - the Classifier.
    
    Returns:
    
    the Collection of Ports.
  - getBaseRealizedInterfaces
```
public java.util.Collection getBaseRealizedInterfaces(BehavioredClassifier behavioredClassifier)
```
    Gets the behavior classifier realized interfaces.
    
    Parameters:
    
    behavioredClassifier - the BehavioredClassifier.
    
    Returns:
    
    the Collection of RealizedInterfaces.
  - isDerivedClassifier
```
public boolean isDerivedClassifier(Classifier parent,
                                   Classifier child)
```
    Checks if child is derived from parent by generalization.
    
    Parameters:
    
    parent - parent
    
    child - possible parent
    
    Returns:
    
    true if derived
  - getUseCaseNumber
```
public java.lang.String getUseCaseNumber(Element element)
```
    Return the use case number or use case ID of element.
    
    Parameters:
    
    element - the element
    
    Returns:
    
    the use case number.
  - getActorNumber
```
public java.lang.String getActorNumber(Element element)
```
    Return the actor ID of Actor.
    
    Parameters:
    
    element - element
    
    Returns:
    
    the actor ID
  - getUCOwnerNumber
```
public java.lang.String getUCOwnerNumber(Element element)
```
    Return the use case number or use case ID of element.
    
    Parameters:
    
    element - the element
    
    Returns:
    
    the use case owner number or ID.
  - getElementURL
```
public java.lang.String getElementURL(Element element)
```
    Retrieve MagicDraw's element URL.
    
    Parameters:
    
    element - element object
    
    Returns:
    
    MagicDraw's element URL
  - getBasicFlows
```
public java.util.List<FlowStep> getBasicFlows(UseCase useCase)
```
    Find and return a list of basic flows from given use case. If use case scenario is not being used, it will retrieve the value from "requirementUseCase" stereotype tags.
    
    Parameters:
    
    useCase - a use case.
    
    Returns:
    
    a list of flow step FlowStep
  - getAlternativeFlows
```
public java.util.List<FlowStep> getAlternativeFlows(UseCase useCase)
```
    Find and return all alternative flows from given use case. The alternative flows will be listed from all possible branches of basic flows. If use case scenario is not being used, it will the retrieve value from "requirementUseCase" stereotype tags.
    
    Parameters:
    
    useCase - a use case.
    
    Returns:
    
    a list of flow step FlowStep
  - getExceptionalFlows
```
public java.util.List<FlowStep> getExceptionalFlows(UseCase useCase)
```
    Find and return a basic flow from given use case. If use case scenario is not being used, it will the retrieve value from "requirementUseCase" stereotype tags.
    
    Parameters:
    
    useCase - a use case.
    
    Returns:
    
    a list of flow step FlowStep
  - getSlotValue
```
public java.util.List<java.lang.Object> getSlotValue(Element element,
                                                     java.lang.String classifierName,
                                                     java.lang.String definingFeatureName)
```
    Get slot value by classifier name and definingFeature name. If there are more than one slots matching with specified parameters, return only the value of first matching slot.
    
    Parameters:
    
    element - an element.
    
    classifierName - classifier name. [case-sensitive]
    
    definingFeatureName - defining feature name. [case-sensitive]
    
    Returns:
    
    result value in ValueSpecification or value in array of ValueSpecification, up to multiplicity.
  - getSlotProperty
```
public java.lang.Object getSlotProperty(Element element,
                                        java.lang.String classifierName)
```
    Get slot property by classifier name If there are more than one classifier matching with specified parameters, return only the property of first matching classifier.
    
    Parameters:
    
    element - an element.
    
    classifierName - classifier name. [case-sensitive]
    
    Returns:
    
    slot property
  - getOwnedElementsIncludingAdditional
```
public java.util.List<Element> getOwnedElementsIncludingAdditional(Element element,
                                                                   boolean includePureOwned)
```
    Return owned elements of the given Element including additional owned elements defined in DSL specification by additionalContentProperty.
    
    Parameters:
    
    includePureOwned - include element owned directly in ownedElement UML metaproperty
    
    Returns:
    
    owned elements of the given Element
  - getPackages
```
public java.util.Collection<Element> getPackages(boolean includeSmartPacakge)
```

Class ReportHelper

Nested Class Summary

Nested classes/interfaces inherited from interface com.nomagic.magicreport.engine.ITool

Field Summary

Fields inherited from class com.nomagic.magicreport.engine.Tool

Fields inherited from interface com.nomagic.magicreport.engine.ITool

Constructor Summary

Method Summary

Methods inherited from class com.nomagic.magicreport.engine.Tool

Methods inherited from class java.util.Observable

Methods inherited from class java.lang.Object

Constructor Detail

ReportHelper

Method Detail

getDSLProperty

getStereotypeProperty

parseObjectForPrinting

getStereotypeProperty

getStereotypeProperty

getStereotypePropertyList

getStereotypePropertyString

getStereotypePropertyString

getStereotypePropertyStringValue

isNamedElement

getAppliedStereotypeByString

getAppliedStereotypeByName

hasStereotype

containsStereotype

containsStereotype

hasProperty

getProperty

getStereotypes

hasStereotype

findElementInCollection

findElementByName

getDerivedClassifiers

hasBaseClassifier

getBaseClassifiers

getComment

getElementComment

getRelativeActor

getUseCaseAssociatedElement

getIncludeUseCase

trimString

createValueSpecificationText

getPresentationElements

getPresentationDiagramElements

getPresentationDiagramElements

getPresentationElementBounds

getPresentationElementRectangle

getPresentationElementBounds

getDiagramType

getMetaClass

getDiagramElements

getDiagramElements

getQualifiedOwnerName

getQualifiedName

getPackageQualifiedName

serialize

getSendingOperationalNode

getRecievingOperationalNode

findRelationship

findRelationship

getRelationship

getRelationship

getClientElement

getSupplierElement

getInnerElement

getIconFor

getIconFor

getIconFor

getIconFor

getCustomImage

getCustomImage

getCustomImageInformation

isNull

isEmpty

isRelationship

getInteractionMessageType

getUsageRepresentationText