Package com.nomagic.magicdraw.modeltransformations

Class ModelTransformationsManager

java.lang.Object

com.nomagic.magicdraw.modeltransformations.ModelTransformationsManager

@OpenApiAll
public final class ModelTransformationsManager
extends java.lang.Object

ModelTransformationsManager organizes process of application of model transformation. This class is responsible for Undo/redo commands etc.

Use this class as singleton.

Field Summary

Fields

Modifier and Type	Field	Description
private static ModelTransformationsManager	mInstance	The instance of model transformations manager.
private java.util.List<ModelTransformationInfo>	mTransformations	The collection of registered model transformations.
private static java.lang.String	PROPS_ENCODING
private boolean	updateTransformationTest	resets to false after each invocation of updateTransform

Constructor Summary

Constructors

Modifier	Constructor	Description
private	ModelTransformationsManager()	The private constructor.

Method Summary

Modifier and Type	Method	Description
void	addTransformation(ModelTransformationInfo info)	Adds the given model transformation in registered model transformations collection.
private java.util.List<Element>	collectNumberables(com.nomagic.magicdraw.autoid.AutoIdManager manager, java.util.List<Element> elements)	Collects all owned elements that are customized for auto Numbering
private boolean	doTransform(ModelTransformationsWizardInformation wi, ModelTransformationInfo mti, Task task, Project project)
boolean	doTransformation(ModelTransformationsWizardInformation wi, ModelTransformationInfo mti)
boolean	doUpdateTransformation(ModelTransformationInfo mti_final, Package transformedPackage_final, boolean sync_final, PropertyManager prop)
static ModelTransformationsManager	getInstance()	Returns a shared instance of model transformations manager.
ModelTransformationInfo	getTransformationInfoByName(java.lang.String transformationName)	Returns transformation info by transformation name
java.util.Collection<ModelTransformationInfo>	getTransformations()	Returns all registered model transformations.
private static TypeMapProfile	getTypeMapProfile(Package typeProfilePackage, ModelTransformationsWizardInformation wi)
static void	loadTransformationProperties(Style style, ModelTransformationsWizardInformation wi, Project project)
static Style	loadTransformationProperties(Package transformedPackage, ModelTransformationsWizardInformation wi)
private static void	preLoadDiagrams(java.util.Collection<BaseElement> elementsInScope, ModelTransformationInfo mti)
void	removeTransformation(ModelTransformationInfo info)	Removes the given model transformation from registered collection of model transformations.
void	saveTransformationProperties(ModelTransformationsWizardInformation wizardInformation)
private void	serializePropertyManager(java.io.OutputStream stream, PropertyManager propertiesToSave, java.lang.String transformationName, java.lang.String destinationElementID, boolean syncFinal)
boolean	transform(java.util.List<? extends BaseElement> selectedElements)	Displays transformation wizard and runs transformation
private void	updateNumbers(Package targetPackage, java.util.Collection<Element> filteredElements)	Renumber the elements that were transformed
void	updateProperties(PropertyManager source, PropertyManager propertiesToUpdate)
boolean	updateTransformation(Package transformed)	Checks for already applied transformations, sets the right one and runs transformation update
boolean	updateTransformation(Package transformed, boolean testingMode)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

PROPS_ENCODING

private static final java.lang.String PROPS_ENCODING

See Also:

Constant Field Values

mInstance

private static final ModelTransformationsManager mInstance

The instance of model transformations manager.

mTransformations

private final java.util.List<ModelTransformationInfo> mTransformations

The collection of registered model transformations.

updateTransformationTest

private boolean updateTransformationTest

resets to false after each invocation of updateTransform

Constructor Detail

ModelTransformationsManager

private ModelTransformationsManager()

The private constructor.

Method Detail

getInstance

public static ModelTransformationsManager getInstance()

Returns a shared instance of model transformations manager.

Returns:

instance of model transformations manager.

addTransformation

public void addTransformation(ModelTransformationInfo info)

Adds the given model transformation in registered model transformations collection.

Parameters:

info - the give transformation to add.

removeTransformation

public void removeTransformation(ModelTransformationInfo info)

Removes the given model transformation from registered collection of model transformations.

Parameters:

info - the given transformation to remove.

getTransformations

public java.util.Collection<ModelTransformationInfo> getTransformations()

Returns all registered model transformations.

Returns:

a collection of registered model transformations.

getTransformationInfoByName

@CheckForNull
public ModelTransformationInfo getTransformationInfoByName(java.lang.String transformationName)

Returns transformation info by transformation name

Parameters:

transformationName - transformation name

Returns:

transformation info

transform

public boolean transform(java.util.List<? extends BaseElement> selectedElements)

Displays transformation wizard and runs transformation

Parameters:

selectedElements - list of elements to transform

Returns:

true if transformation was successful

doTransformation

public boolean doTransformation(ModelTransformationsWizardInformation wi,
                                ModelTransformationInfo mti)

doTransform

private boolean doTransform(ModelTransformationsWizardInformation wi,
                            ModelTransformationInfo mti,
                            Task task,
                            Project project)
                     throws ReadOnlyElementException

Parameters:

wi - model wizard info

mti - model transformation info

task - execution task

project - project

Returns:

true if transform was without errors

Throws:

ReadOnlyElementException - if model is read-only

updateTransformation

public boolean updateTransformation(Package transformed,
                                    boolean testingMode)

updateTransformation

public boolean updateTransformation(Package transformed)

Checks for already applied transformations, sets the right one and runs transformation update

Parameters:

transformed - list of elements to transform

Returns:

true if transformation update was successful

doUpdateTransformation

public boolean doUpdateTransformation(ModelTransformationInfo mti_final,
                                      Package transformedPackage_final,
                                      boolean sync_final,
                                      @CheckForNull
                                      PropertyManager prop)

updateProperties

public void updateProperties(PropertyManager source,
                             PropertyManager propertiesToUpdate)

serializePropertyManager

private void serializePropertyManager(java.io.OutputStream stream,
                                      PropertyManager propertiesToSave,
                                      java.lang.String transformationName,
                                      java.lang.String destinationElementID,
                                      boolean syncFinal)
                               throws java.lang.Exception

Throws:

java.lang.Exception

loadTransformationProperties

@CheckForNull
public static Style loadTransformationProperties(Package transformedPackage,
                                                 ModelTransformationsWizardInformation wi)

loadTransformationProperties

public static void loadTransformationProperties(Style style,
                                                ModelTransformationsWizardInformation wi,
                                                Project project)
                                         throws java.lang.Exception

Throws:

java.lang.Exception

getTypeMapProfile

@CheckForNull
private static TypeMapProfile getTypeMapProfile(Package typeProfilePackage,
                                                ModelTransformationsWizardInformation wi)

saveTransformationProperties

public void saveTransformationProperties(ModelTransformationsWizardInformation wizardInformation)
                                  throws java.lang.Exception

Throws:

java.lang.Exception

preLoadDiagrams

private static void preLoadDiagrams(java.util.Collection<BaseElement> elementsInScope,
                                    ModelTransformationInfo mti)

updateNumbers

private void updateNumbers(@CheckForNull
                           Package targetPackage,
                           java.util.Collection<Element> filteredElements)

Renumber the elements that were transformed

Parameters:

targetPackage - the resulting transformation Package, null if in Place

filteredElements - the originally selected elements

collectNumberables

private java.util.List<Element> collectNumberables(com.nomagic.magicdraw.autoid.AutoIdManager manager,
                                                   java.util.List<Element> elements)

Collects all owned elements that are customized for auto Numbering

Parameters:

manager - the autoId Manager

elements - search these elements for children that are numberable

Returns:

the Numberable elements