com.nomagic.magicdraw.modeltransformations

Interface ModelTransformation

All Known Implementing Classes:

AnyToAnyModelTransformation

@OpenApiAll
public interface ModelTransformation

Interface for model transformation.

Method Summary

Modifier and Type	Method and Description
void	setTask(Task task) Sets task for transformation.
Package	transform(java.util.Collection objects, ModelTransformationInfo info, TypeMapProfile typeMap, PropertyManager propertyManager, Package destination) Performs transformation on specific set of objects
void	updateTransform(Package transformationPackage, TypeMapProfile typeMap, PropertyManager propertyManager, boolean syncDestination) Updates transformation on specific set of objects

Method Detail

transform

Package transform(@CheckForNull
                  java.util.Collection objects,
                  @CheckForNull
                  ModelTransformationInfo info,
                  TypeMapProfile typeMap,
                  PropertyManager propertyManager,
                  Package destination)
           throws ReadOnlyElementException

Performs transformation on specific set of objects

Parameters:

objects - set of objects to transform

info - model transformation info

typeMap - type map profile to use for transformation, null for none

propertyManager - transformation properties

destination - destination model packages, null for transformation in place

Returns:

transformation model package (where transformation links are stored)

Throws:

ReadOnlyElementException - in case target model elements are read-only

updateTransform

void updateTransform(Package transformationPackage,
                     TypeMapProfile typeMap,
                     PropertyManager propertyManager,
                     boolean syncDestination)
              throws ReadOnlyElementException

Updates transformation on specific set of objects

Parameters:

transformationPackage - package containing transformation links

typeMap - type map profile to use for transformation, null for none

propertyManager - transformation properties

syncDestination - true for destination overwrite

Throws:

ReadOnlyElementException - in case target model elements are read-only

setTask

void setTask(Task task)

Sets task for transformation. Transformation can use Task for accesing progress status and etc.

Parameters:

task - transformation task