Package com.nomagic.magicdraw.modeltransformations

Interface ModelTransformationInfo

All Known Implementing Classes:
AbstractModelTransformationInfo, AnyToAnyModelTransformationInfo
@OpenApiAll public interface ModelTransformationInfo
Interface for model transformation info
See Also:

  • Method Details

    • getTransformationName

      String getTransformationName()
      Getter for model transformation name
      Returns:
      model transformation name

    • getIcon

      Icon getIcon()
      Returns model transformation icon
      Returns:
      model transformation icon

    • getTransformation

      ModelTransformation getTransformation()
      Returns model transformation for this info
      Returns:
      model transformation

    • getDefaultPropertyManager

      PropertyManager getDefaultPropertyManager()
      Returns property manager with default properties for transformation
      Returns:
      property manager

    • isTypeMappingSupported

      boolean isTypeMappingSupported()
      Getter for type mapping support
      Returns:
      true if type mapping is supported by transformation

    • getDefaulTypeMapProfileName

      String getDefaulTypeMapProfileName()
      Returns name of default type map profile
      Returns:
      name of default type map

    • isDefaulTypeMapProfileMappingOrderForward

      boolean isDefaulTypeMapProfileMappingOrderForward()
      Returns mapping order of default type map profile
      Returns:
      return true for forward mapping

    • prepareTransformation

      boolean prepareTransformation(Project project)
      Prepares transformation
      Parameters:
      project - project
      Returns:
      true if preparation was successful, false in other case

    • isVisibleInBrowser

      boolean isVisibleInBrowser(BaseElement e)
      Is element visible in source selection tree.
      Parameters:
      e - element to check
      Returns:
      true if visible

    • getVisibleClasses

      @CheckForNull default Collection<Class> getVisibleClasses()
      Visible classes that will be displayed in transformation source selection
      Returns:
      visible class types to show in transformation source selection, if null all classes can be visible

    • getDescriptionAsStream

      InputStream getDescriptionAsStream()
      Returns model transformation description as stream
      Returns:
      input stream of model transformation description.

    • isSupportsLeaveIntactModel

      boolean isSupportsLeaveIntactModel()

    • isOnlyInPlace

      boolean isOnlyInPlace()
      Returns:
      true if transformation supports only in place transformation.

    • getSpecificTypeMap

      @CheckForNull TypeMapProfile getSpecificTypeMap()
      In case there is no user selected option to select type map specific type map can be provided.
      Returns:
      TypeMapProfile which should be used in this transformation.

    • canCreateNewElements

      default boolean canCreateNewElements()
      If true, new elements can be created as the result of transformation. This might cause auto-numbers update to be called which can be time consuming Returning false indicates that the transformation only modifies existing elements and updating auto-numbers can be skipped

    • shouldPreloadDiagram

      default boolean shouldPreloadDiagram(DiagramPresentationElement diagram, Collection<BaseElement> elementsInScope)
      Parameters:
      diagram - any not loaded diagram in the project
      elementsInScope - all elements in scope of this transformation
      Returns:
      true if the given diagram should be loaded before executing the transformation