Package com.nomagic.magicdraw.magicreport.tools

Class ProfilingTool

  • All Implemented Interfaces:
    com.nomagic.magicreport.engine.ITool, com.nomagic.magicreport.IVariable, java.io.Serializable, java.lang.Cloneable
    @OpenApiAll
public class ProfilingTool
extends com.nomagic.magicreport.engine.Tool
    Contains utilities functions for profiling MagicDraw meta-model. Context name of this class is "profiling".
    Since:
    November 27, 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 
      Modifier and Type Field Description
      static java.lang.String CONTEXT_NAME
      Contains a context name.

      • 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 Description
      ProfilingTool()  

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      java.lang.String getDeclaringElementName​(java.lang.String modelName, java.lang.String propertyName)
      Retrieve the name of meta-model which property name is declared.
      java.util.Collection<java.lang.String> getElementProperties​(Element element)
      Return Collection of element properties name.
      java.util.Collection<java.lang.String> getElementProperties​(java.lang.String modelName)
      Retrieve Collection of element properties name from meta-model name.
      java.lang.Object getElementProperty​(Element element, java.lang.String propertyName)
      Retrieve property value of specified element and property name.
      java.util.Collection<java.lang.String> getGeneralizationName​(java.lang.String modelName)
      Return generalization model of modelName.
      java.lang.String getHumanPropertyName​(java.lang.String propertyName)
      Return text representing property name.
      java.lang.String getPropertyTypeName​(Element element, java.lang.String propertyName)
      Retrieve type of property.
      java.lang.String getPropertyTypeName​(java.lang.String modelName, java.lang.String propertyName)
      Retrieve type of property.

      • 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

      • Methods inherited from interface com.nomagic.magicreport.engine.ITool

        clearTool

    • Field Detail

      • CONTEXT_NAME

        public static final java.lang.String CONTEXT_NAME
        Contains a context name.
        See Also:
        Constant Field Values

    • Constructor Detail

      • ProfilingTool

        public ProfilingTool()

    • Method Detail

      • getGeneralizationName

        public java.util.Collection<java.lang.String> getGeneralizationName​(java.lang.String modelName)
        Return generalization model of modelName.
        Parameters:
        modelName - meta-model name
        Returns:
        generalization model

      • getDeclaringElementName

        public java.lang.String getDeclaringElementName​(java.lang.String modelName,
                                                java.lang.String propertyName)
        Retrieve the name of meta-model which property name is declared.
        Parameters:
        modelName - meta-model name
        propertyName - property name
        Returns:
        name of meta-model

      • getPropertyTypeName

        public java.lang.String getPropertyTypeName​(java.lang.String modelName,
                                            java.lang.String propertyName)
        Retrieve type of property.
        Parameters:
        modelName - meta-model name
        propertyName - property name
        Returns:
        name of property type

      • getPropertyTypeName

        public java.lang.String getPropertyTypeName​(Element element,
                                            java.lang.String propertyName)
        Retrieve type of property.
        Parameters:
        element - target element
        propertyName - property name
        Returns:
        name of property type

      • getElementProperties

        public java.util.Collection<java.lang.String> getElementProperties​(java.lang.String modelName)
        Retrieve Collection of element properties name from meta-model name.
        Parameters:
        modelName - meta-model name
        Returns:
        collection of element properties

      • getElementProperties

        public java.util.Collection<java.lang.String> getElementProperties​(Element element)
        Return Collection of element properties name.
        Parameters:
        element - target element
        Returns:
        collection of element properties

      • getElementProperty

        public java.lang.Object getElementProperty​(Element element,
                                           java.lang.String propertyName)
        Retrieve property value of specified element and property name.
        Parameters:
        element - target element
        propertyName - property name
        Returns:
        an Object of element property name.

      • getHumanPropertyName

        public java.lang.String getHumanPropertyName​(java.lang.String propertyName)
        Return text representing property name.
        Parameters:
        propertyName - property name
        Returns:
        a human name of given propertyName