com.nomagic.magicdraw.patterns

Class PatternHelper

java.lang.Object

com.nomagic.magicdraw.patterns.PatternHelper

@OpenApiAll
public class PatternHelper
extends java.lang.Object

The class with useful helper methods for patterns applying.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	PatternHelper.PathElementCreationResult Class is used to return info about created or found path element.
static class	PatternHelper.ShapeElementCreationResult Class is used to return info about created or found shape element.

Field Summary

Fields

Modifier and Type	Field and Description
static int	BOTTOM Constant for layouting two presentation elements.
static int	RIGHT Constant for layouting two presentation elements.

Constructor Summary

Constructors

Constructor and Description
PatternHelper()

Method Summary

Methods

Modifier and Type	Method and Description
static void	addDistinctAttribute(Classifier classifier, Property attr) Add Distinct Attribute.
static void	addDistinctConstructor(Classifier classifier, Operation op) Added operations only if they are different from exist ones.
static void	addDistinctOperation(Classifier classifier, Operation op) Add Operation to class.
static void	addDistinctOperations(Classifier classifier, java.util.Collection operations, boolean clone) Add list of Operations to class.
static void	breakPathElement(PathElement path) Breaks the given path according to the path ends.
static java.util.List	collectPublicOperations(Classifier classifier) Collect the public operation from the given class.
static void	copyDistinctOperations(Classifier src, Classifier dst, boolean makeNotAbstract) Copy Distinct Operations form source to destination Classifier.
static PatternHelper.PathElementCreationResult	createAggregation(java.lang.String name, java.lang.String multiplicity, PresentationElement supplierPE, PresentationElement clientPE) Creates Aggregation path.
static PatternHelper.PathElementCreationResult	createBinding(PresentationElement supplierPE, PresentationElement clientPE) Create Binding path.
static PatternHelper.PathElementCreationResult	createGeneralization(PresentationElement parentPE, PresentationElement childPE) Create Generalization path.
static PatternHelper.PathElementCreationResult	createRealization(PresentationElement interfacePE, PresentationElement classPE) Create Realization path.
static PatternHelper.PathElementCreationResult	createRealizationOrGeneralization(PresentationElement parentPE, PresentationElement childPE) Creates Realization or Generalization.
static PatternHelper.ShapeElementCreationResult	createShapeElement(Classifier element, ShapeElement target, int position, int distance, boolean suppressOperations) Creates Shape element of the given class.
static TypeProperty	createTypeProperty(java.lang.String id, java.lang.Object value, boolean canSelectModelClass, boolean canSelectInterface) Created type property.
static Operation	deepClone(Operation old, Classifier classifier) Makes copy of specified element and places under parent.
static Classifier	getClassifier(Element parent, java.lang.Object classifier, java.lang.Class type) Get Classifier
static Classifier	getClassifier(Project project, java.lang.Object classifier, java.lang.Class type) Get Classifier
static boolean	hasAttribute(Classifier classifier, Property another) Tests the given classifier has the given attribute.
static boolean	hasOperation(Classifier classifier, Operation op) Tests The given classifier has the given operation.
static void	renameTarget(Target target, java.lang.String newName) Rename the target.
static void	setException(Classifier classifier, java.lang.String exception) Set The given exception to the given class.
static void	setException(Operation op, java.lang.String exception) Set The exception to the given operation.
static void	setPosition(ShapeElement target, ShapeElement elementToMove, int direction, int space) Sets position for the view2move according to target.

Methods inherited from class java.lang.Object

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

Field Detail

BOTTOM

public static final int BOTTOM

Constant for layouting two presentation elements. An element can be placed in the bottom corresponding to the second element.

See Also:

Constant Field Values

RIGHT

public static final int RIGHT

Constant for layouting two presentation elements. An element can be placed in the right corresponding to the second element.

See Also:

Constant Field Values

Constructor Detail

PatternHelper

public PatternHelper()

Method Detail

hasOperation

public static boolean hasOperation(Classifier classifier,
                   Operation op)

Tests The given classifier has the given operation.

Parameters:

classifier - The given classifier.

op - The given operation.

Returns:

boolean

hasAttribute

public static boolean hasAttribute(Classifier classifier,
                   Property another)

Tests the given classifier has the given attribute.

Parameters:

classifier - The given classifier.

another - The given attribute.

Returns:

boolean

addDistinctOperation

public static void addDistinctOperation(Classifier classifier,
                        Operation op)
                                 throws ReadOnlyElementException

Add Operation to class.

Parameters:

classifier - The given class.

op - Added operation.

Throws:

ReadOnlyElementException

addDistinctOperations

public static void addDistinctOperations(Classifier classifier,
                         java.util.Collection operations,
                         boolean clone)
                                  throws ReadOnlyElementException

Add list of Operations to class.

Parameters:

classifier - The given class.

operations - List of operation.

clone - Clone flag.

Throws:

ReadOnlyElementException

addDistinctAttribute

public static void addDistinctAttribute(Classifier classifier,
                        Property attr)

Add Distinct Attribute.

Parameters:

classifier - Classifier

attr - Property

copyDistinctOperations

public static void copyDistinctOperations(Classifier src,
                          Classifier dst,
                          boolean makeNotAbstract)
                                   throws ReadOnlyElementException

Copy Distinct Operations form source to destination Classifier.

Parameters:

src - Source

dst - Destination

makeNotAbstract -

Throws:

ReadOnlyElementException

getClassifier

public static Classifier getClassifier(Element parent,
                       java.lang.Object classifier,
                       java.lang.Class type)

Get Classifier

Parameters:

parent - Parent Element.

classifier - The given classifier.

type - The Class type.

Returns:

Classifier

getClassifier

public static Classifier getClassifier(Project project,
                       java.lang.Object classifier,
                       java.lang.Class type)

Get Classifier

Parameters:

project - project

classifier - The given classifier.

type - The Class type.

Returns:

Classifier

setPosition

public static void setPosition(ShapeElement target,
               ShapeElement elementToMove,
               int direction,
               int space)
                        throws ReadOnlyElementException

Sets position for the view2move according to target. view2move can be positioned to the right or bottom according to the target. Argument direction can have values PatternHelper.BOTTOM or PatternHelper.RIGHT.

Parameters:

target - the target element.

elementToMove - shape element to move.

direction - the direction from target.

space - space between target and elementToMove.

Throws:

ReadOnlyElementException

createGeneralization

public static PatternHelper.PathElementCreationResult createGeneralization(PresentationElement parentPE,
                                                           PresentationElement childPE)
                                                                    throws ReadOnlyElementException

Create Generalization path.

Parameters:

parentPE - Parent presentation element.

childPE - Child presentation element.

Returns:

PathElementCreationResult

Throws:

ReadOnlyElementException

createRealizationOrGeneralization

public static PatternHelper.PathElementCreationResult createRealizationOrGeneralization(PresentationElement parentPE,
                                                                        PresentationElement childPE)
                                                                                 throws ReadOnlyElementException

Creates Realization or Generalization.

Parameters:

parentPE - Parent of the created path.

childPE - Child of the created path.

Returns:

PathElementCreationResult

Throws:

ReadOnlyElementException

createRealization

public static PatternHelper.PathElementCreationResult createRealization(PresentationElement interfacePE,
                                                        PresentationElement classPE)
                                                                 throws ReadOnlyElementException

Create Realization path.

Parameters:

interfacePE - The supplier of the realization path.

classPE - The client of the realization path.

Returns:

PathElementCreationResult

Throws:

ReadOnlyElementException

createAggregation

public static PatternHelper.PathElementCreationResult createAggregation(java.lang.String name,
                                                        java.lang.String multiplicity,
                                                        PresentationElement supplierPE,
                                                        PresentationElement clientPE)
                                                                 throws ReadOnlyElementException

Creates Aggregation path.

Parameters:

name - Name of created path.

multiplicity - Multiplicity of the created path.

supplierPE - Supplier.

clientPE - Client.

Returns:

PathElementCreationResult

Throws:

ReadOnlyElementException

createBinding

public static PatternHelper.PathElementCreationResult createBinding(PresentationElement supplierPE,
                                                    PresentationElement clientPE)
                                                             throws ReadOnlyElementException

Create Binding path.

Parameters:

supplierPE - Supplier.

clientPE - Client.

Returns:

PathElementCreationResult

Throws:

ReadOnlyElementException

breakPathElement

public static void breakPathElement(PathElement path)
                             throws ReadOnlyElementException

Breaks the given path according to the path ends.

Parameters:

path - link to change break points

Throws:

ReadOnlyElementException

addDistinctConstructor

public static void addDistinctConstructor(Classifier classifier,
                          Operation op)
                                   throws ReadOnlyElementException

Added operations only if they are different from exist ones. The same should be with constructors.

Parameters:

classifier - The given classifier.

op - Operation

Throws:

ReadOnlyElementException

deepClone

public static Operation deepClone(Operation old,
                  Classifier classifier)

Makes copy of specified element and places under parent.

Parameters:

old -

classifier -

Returns:

Operation

setException

public static void setException(Operation op,
                java.lang.String exception)

Set The exception to the given operation.

Parameters:

op - Operation that be set.

exception - The exception name.

setException

public static void setException(Classifier classifier,
                java.lang.String exception)

Set The given exception to the given class.

Parameters:

classifier - The given class.

exception - The given exception.

createShapeElement

public static PatternHelper.ShapeElementCreationResult createShapeElement(Classifier element,
                                                          ShapeElement target,
                                                          int position,
                                                          int distance,
                                                          boolean suppressOperations)
                                                                   throws ReadOnlyElementException

Creates Shape element of the given class.

Parameters:

element - Class.

target - The target of the creation.

position - Created position.

distance - the direction from target.

suppressOperations - If true suppress the operation in presentation element.

Returns:

ShapeElementCreationResult

Throws:

ReadOnlyElementException

createTypeProperty

public static TypeProperty createTypeProperty(java.lang.String id,
                              java.lang.Object value,
                              boolean canSelectModelClass,
                              boolean canSelectInterface)

Created type property.

Parameters:

id - ID of the created element.

value - Value of the created element.

canSelectModelClass - Can Select Model Class flag.

canSelectInterface - Can Select Interface flag.

Returns:

TypeProperty

collectPublicOperations

public static java.util.List collectPublicOperations(Classifier classifier)

Collect the public operation from the given class.

Parameters:

classifier - The given class.

Returns:

List of the public operation.

renameTarget

public static void renameTarget(Target target,
                java.lang.String newName)
                         throws ReadOnlyElementException

Rename the target.

Parameters:

target - the given target.

newName - A new name.

Throws:

ReadOnlyElementException