com.nomagic.uml2.ext.jmi.helpers

Class ModelHelper

java.lang.Object

com.nomagic.uml2.ext.jmi.helpers.ModelHelper

@OpenApi
public class ModelHelper
extends java.lang.Object

Model Utility class.

Method Summary

Methods

Modifier and Type	Method and Description
static boolean	areEqualParameterTypes(BehavioralFeature feature1, BehavioralFeature feature2) Method compares parameters and returns true if parameters types are equals.
static boolean	areEqualParameterTypes(BehavioralFeature feature1, BehavioralFeature feature2, boolean compareReturnParameter) Method compares parameters and returns true if parameters types are equals.
static java.util.Iterator<Association>	associations(Classifier classifier) Get iterator of association from given classifier.
static java.util.Iterator<Property>	attributes(Classifier classifier) Get iterator of Attribute from given classifier.
static boolean	canMoveChildInto(Element parent, Element child) Returns true, if child can be moved to the parent.
static Image	createImage(ElementsFactory factory, java.io.File file) Creates image model element from a given image found in a file.
static Image	createImage(ElementsFactory factory, java.lang.String url) Creates image model element from a given image found at url.
static Image	createImage(java.io.File file) Deprecated.
static Property	findAssociationEndForType(Classifier classifier, Classifier type, java.lang.String name) Looks for AssociationEnd connected to the given classifier 'classifier' which can be mapped into 'classifier' attribute with name 'name' and type 'type'.
static Classifier	findDataTypeFor(Project project, java.lang.String name, java.util.Collection restricted) Deprecated.
static Element	findElementWithPath(Project project, java.lang.String path, java.lang.Class classType) Deprecated.
static java.util.List<Element>	findElementWithPath(Project project, java.lang.String path, java.lang.Class classType, boolean searchJustOne) Deprecated.
static void	findInParent(Element parent, java.lang.String name, boolean searchRecursively, java.util.Collection<Element> result) Deprecated.
static Element	findInParent(Element parent, java.lang.String name, java.lang.Class classType) Deprecated.
static Element	findInParent(Element parent, java.lang.String name, java.lang.Class classType, boolean searchRecursively) Deprecated.
static void	findInParent(Element parent, java.lang.String name, java.lang.Class classType, boolean searchRecursively, java.util.Collection<Element> result) Deprecated.
static void	findInParent(Element parent, java.lang.String name, java.lang.Class classType, java.util.Collection<Element> result) Deprecated.
static Element	findParent(Element relationship, Element clientME, Element supplierME, Element diagramParent) Looks for a possible parent for given relationship.
static Element	findParent(Element relationship, Element clientME, Element supplierME, Element diagramParent, boolean checkPermissions) Looks for a possible parent for given relationship.
static <T extends Element> T	findParentOfType(Element element, java.lang.Class<? extends T> parentType) Searches for first direct or indirect element of the given type among parents of the given element.
static Slot	findSlot(InstanceSpecification instanceSpecification, Property neededProperty) Looks for existing slot for given property in given instance.
static java.util.List<ActivityParameterNode>	getActivityParameterNodes(Activity activity) Gets activity parameter nodes from a given activity.
static java.util.Iterator<Element>	getAdditionalElementsIterator(Element element) Returns iterator of additional contained elements defined in DSL specification by additionalContentProperty.
static java.util.Collection<TypedElement>	getAssociationEnds(Classifier classifier) Returns a collection of properties connected to given classifier by associations.
static Classifier	getClassifierFor(Element element, java.lang.String classifierName, java.lang.Class type) Deprecated.
static Classifier	getClassifierFor(Element element, java.lang.String elementName, java.lang.Class type, java.util.Collection<java.lang.Class> classifiersType, ClassifierFinder.SimpleNameResolver resolverShort) Deprecated.
static Classifier	getClassifierFor(Element element, java.lang.String elementName, java.lang.Class type, java.util.Collection<java.lang.Class> classifiersType, ClassifierFinder.SimpleNameResolver resolverShort, boolean createIfNotFound) Deprecated.
static Element	getClientElement(Element element) Get client of the relationship.
static java.lang.String	getComment(Element element) Returns documentation of given element.
static java.util.List<NamedElement>	getDependentClients(NamedElement element, java.lang.Class<? extends Dependency> dependencyClass) Collects elements those are connected with Dependencies as clients with a given element
static java.util.List<NamedElement>	getDependentSuppliers(NamedElement element, java.lang.Class<? extends Dependency> dependencyClass) Collects elements those are connected with Dependencies as suppliers with a given element
static java.util.Collection<Classifier>	getDerivedClassifiers(Classifier parent) Return derived elements of parent element
static java.util.Collection<Classifier>	getDerivedClassifiersRecursivelly(Classifier classifier) Get all derived classifiers for given classifier.
static java.util.Collection<? extends Element>	getElementsOfType(Element root, java.lang.Class[] types, boolean checkRoot) Deprecated.
static java.util.Collection<? extends Element>	getElementsOfType(Element root, java.lang.Class[] types, boolean checkRoot, boolean recursively) Deprecated.
static java.util.Collection<? extends Element>	getElementsOfType(Element root, java.lang.Class[] types, boolean checkRoot, boolean recursively, boolean includeAdditionalContents, org.eclipse.core.runtime.IProgressMonitor monitor) Deprecated.
static <T> java.util.Collection<T>	getElementsOfTypeS(Element root, java.lang.Class<T>[] types, boolean checkRoot) Deprecated.
static Property	getFirstMemberEnd(Association assoc) Get first property member end of association.
static java.util.List<BehavioredClassifier>	getImplementedClasses(Interface anInterface) Gets classifiers which realize (implement) a given interface.
static java.lang.String	getMultiplicity(MultiplicityElement el) Returns multiplicity string for specified multiplicity element.
static java.util.List<Element>	getOwnedElementsIncludingAdditional(Element element, boolean includePureOwned) Return owned elements of the given Element including additional owned elements defined in DSL specification by additionalContentProperty.
static java.util.List<Parameter>	getParameters(BehavioralFeature feature) Returns parameters without return parameter
static java.util.List<Interface>	getRealizedInterfaces(BehavioredClassifier classifier) Collects realized interfaces by the given classifier.
static java.util.Collection<Element>	getReferencingElementsByTags(Element element, java.lang.String propertyName) Given an element, finds its usages in stereotype tags of other elements.
static Parameter	getReturnParameter(BehavioralFeature feature) Return parameter of given behaviour feature.
static Parameter	getReturnParameter(BehavioralFeature feature, boolean create) Return parameter of given behaviour feature.
static Parameter	getReturnParameter(Behavior behavior, boolean create) Return parameter of given behaviour.
static java.util.List<Parameter>	getReturnParameters(BehavioralFeature feature) Returns parameters without return parameter
static Property	getSecondMemberEnd(Association assoc) Get second property member end of association.
static Element	getSupplierElement(Element element) Get supplier of the relationship.
static java.lang.String	getValueString(ValueSpecification vs) Return string representation of given ValueSpecification
static boolean	isAggregation(Association association, AggregationKind aggregationKind) Determines if association is of specified aggregation kind.
static boolean	isBehavioralFeatureEqual(BehavioralFeature feature1, BehavioralFeature feature2, boolean compareReturnParameter) Compare the two given features by name and by parameters
static boolean	isLegalInheritance(Classifier parent, Classifier child) Checks if new generalization relationship is legal between given parent and child.
static boolean	isLegalInheritance(Classifier parent, Classifier child, java.util.Collection<? extends Relationship> ignore) Checks if new generalization relationship is legal between given parent and child.
static boolean	isLegalInterfaceRealization(Interface parent, BehavioredClassifier child) Deprecated. always returns true - there can not be cyclic inheritance between different types of classifier
static boolean	isOperationEqual(Operation op1, Operation op2) Compare the two given operation.
static boolean	isParentOf(BaseElement possibleParent, BaseElement possibleChild) Checks if given object is child of given parent object.
static boolean	isPropertyEqual(Property p1, Property p2) Compare the two given Property.
static boolean	isRelationship(Element element)
static boolean	isSecondTypeCompatibleToFirst(Type firstType, Type secondType, boolean checkRealizedInterfaces) Indicates if second parameter type is compatible to the first (is same type or a subtype).
static java.util.Iterator<Operation>	operations(Classifier classifier) Get iterator of operations from given classifier.
static java.util.Iterator<Port>	ports(Classifier classifier) Get iterator of port from given classifier.
static java.util.Iterator<Property>	pureAttributes(Classifier classifier) Get iterator of pure attribute from given classifier.
static java.util.Iterator<Reception>	receptions(Classifier classifier) Get iterator of reception from given classifier.
static void	setClientElement(Element element, Element value) Set client of the relationship.
static void	setComment(Element element, java.lang.String documentation) Set comment (documentation) for element.
static void	setConstraintText(Constraint constraint, java.lang.String text, boolean useName, boolean useExpression) Set text for constraint as name or as expression
static void	setMultiplicity(java.lang.String expression, MultiplicityElement element) Sets multiplicity for specified multiplicity element.
static void	setNavigable(Property property, boolean navigable) Sets navigability of the specified association end.
static void	setSupplierElement(Element element, Element value) Set supplier of the relationship.

Methods inherited from class java.lang.Object

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

Method Detail

getDerivedClassifiersRecursivelly

@OpenApi
public static java.util.Collection<Classifier> getDerivedClassifiersRecursivelly(Classifier classifier)

Get all derived classifiers for given classifier. Result does not include given classifier.

Parameters:

classifier - given classifier

Returns:

collection of all derived classifiers

getDerivedClassifiers

@OpenApi
public static java.util.Collection<Classifier> getDerivedClassifiers(Classifier parent)

Return derived elements of parent element

Parameters:

parent -

Returns:

collection of derived elements (classifiers)

isLegalInheritance

@OpenApi
public static boolean isLegalInheritance(Classifier parent,
                                 Classifier child)

Checks if new generalization relationship is legal between given parent and child. Legal if it does not create cycle and child isKindOf parent.

Parameters:

parent - parent element of generalization.

child - child element of generalization.

Returns:

true - if generalization is legal, otherwise return false.

isLegalInheritance

@OpenApi
public static boolean isLegalInheritance(Classifier parent,
                                 Classifier child,
                                 java.util.Collection<? extends Relationship> ignore)

Checks if new generalization relationship is legal between given parent and child. Legal if it does not create cycle and child isKindOf parent.

Parameters:

parent - parent element of generalization.

child - child element of generalization.

ignore - a collection of classifiers that should be ignored.

Returns:

true - if generalization is legal, otherwise return false.

findParentOfType

@CheckForNull
@OpenApi
public static <T extends Element> T findParentOfType(@CheckForNull
                                                          Element element,
                                                          java.lang.Class<? extends T> parentType)

Searches for first direct or indirect element of the given type among parents of the given element. Checks if this element is an instance of given parentType. If yes, returns it, if no, looks for first parent of given instance in all element's hierarchy. If such parent does not exist, returns null.

Parameters:

element - element.

parentType - the class of parent to find. Found parent must be instance of this class.

Returns:

found parent or null.

isLegalInterfaceRealization

@Deprecated
@OpenApi
public static boolean isLegalInterfaceRealization(Interface parent,
                                                     BehavioredClassifier child)

Deprecated. always returns true - there can not be cyclic inheritance between different types of classifier

Checks if new realize relationship is legal between given parent and child. Legal, if it does not create cycle realize.

Parameters:

parent - parent element of relationship.

child - child element of relationship.

Returns:

true - if realize is legal, otherwise return false.

findAssociationEndForType

@OpenApi
public static Property findAssociationEndForType(Classifier classifier,
                                         Classifier type,
                                         java.lang.String name)

Looks for AssociationEnd connected to the given classifier 'classifier' which can be mapped into 'classifier' attribute with name 'name' and type 'type'.

Parameters:

classifier - the given classifier.

type - the type of the association end.

name - the name of the association end.

Returns:

found AssociationEnd or null.

getReturnParameter

@OpenApi
public static Parameter getReturnParameter(BehavioralFeature feature)

Return parameter of given behaviour feature. A new parameter is created if feature does not have it.

Parameters:

feature - a given feature

Returns:

return parameter (existing one or created)

getReturnParameter

@CheckForNull
@OpenApi
public static Parameter getReturnParameter(BehavioralFeature feature,
                                                boolean create)

Return parameter of given behaviour feature. A new parameter may be created if feature does not have it.

Parameters:

feature - a given feature

create - creates a new parameter if needed

Returns:

return parameter

getReturnParameter

@CheckForNull
@OpenApi
public static Parameter getReturnParameter(Behavior behavior,
                                                boolean create)

Return parameter of given behaviour. A new parameter may be created if behavior does not have it.

Parameters:

behavior - a given behavior

create - creates a new parameter if needed

Returns:

return parameter

operations

@OpenApi
public static java.util.Iterator<Operation> operations(Classifier classifier)

Get iterator of operations from given classifier.

Parameters:

classifier - The given classifier.

Returns:

iterator

receptions

@OpenApi
public static java.util.Iterator<Reception> receptions(Classifier classifier)

Get iterator of reception from given classifier.

Parameters:

classifier - The given classifier.

Returns:

iterator

attributes

@OpenApi
public static java.util.Iterator<Property> attributes(Classifier classifier)

Get iterator of Attribute from given classifier.

Parameters:

classifier - The given classifier.

Returns:

iterator

ports

@OpenApi
public static java.util.Iterator<Port> ports(Classifier classifier)

Get iterator of port from given classifier.

Parameters:

classifier - The given classifier.

Returns:

iterator

pureAttributes

@OpenApi
public static java.util.Iterator<Property> pureAttributes(Classifier classifier)

Get iterator of pure attribute from given classifier.

Parameters:

classifier - The given classifier.

Returns:

iterator

associations

@OpenApi
public static java.util.Iterator<Association> associations(Classifier classifier)

Get iterator of association from given classifier.

Parameters:

classifier - The given classifier.

Returns:

iterator

setMultiplicity

@OpenApi
public static void setMultiplicity(@CheckForNull
                           java.lang.String expression,
                           MultiplicityElement element)

Sets multiplicity for specified multiplicity element.

Parameters:

expression - values that make sense: "0", "1", "*", "0..*", "1..*", "0..1". If null, multiplicity will become unspecified

element - multiplicity element.

getMultiplicity

@OpenApi
public static java.lang.String getMultiplicity(MultiplicityElement el)

Returns multiplicity string for specified multiplicity element.

Parameters:

el - multiplicity element.

Returns:

multiplicity expression : "0", "1", "*", "0..*", "1..*", "0..1". "" is returned if no multiplicity is set.

getSupplierElement

@OpenApi
public static Element getSupplierElement(Element element)

Get supplier of the relationship.

Parameters:

element - relationship model element.

setSupplierElement

@OpenApi
public static void setSupplierElement(Element element,
                              Element value)

Set supplier of the relationship.

Parameters:

element - relationship model element.

value - supplier element that will be set to specified relationship model element.

getClientElement

@OpenApi
public static Element getClientElement(Element element)

Get client of the relationship.

Parameters:

element - relationship model element.

Returns:

client of given relationship

setClientElement

@OpenApi
public static void setClientElement(Element element,
                            Element value)

Set client of the relationship.

Parameters:

element - relationship model element.

value - client element that will be set to specified relationship model element.

findElementWithPath

@OpenApi
@Deprecated
public static Element findElementWithPath(Project project,
                                             java.lang.String path,
                                             @CheckForNull
                                             java.lang.Class classType)

Deprecated.

See Also:

Finder.byQualifiedName

findElementWithPath

@OpenApi
@Deprecated
@Nonnull
public static java.util.List<Element> findElementWithPath(Project project,
                                                                     java.lang.String path,
                                                                     @CheckForNull
                                                                     java.lang.Class classType,
                                                                     boolean searchJustOne)

Deprecated.

See Also:

Finder.byQualifiedName()

getElementsOfType

@OpenApi
@Deprecated
public static java.util.Collection<? extends Element> getElementsOfType(Element root,
                                                                           @CheckForNull
                                                                           java.lang.Class[] types,
                                                                           boolean checkRoot)

Deprecated.

See Also:

Finder.byTypeRecursively()

getElementsOfTypeS

@OpenApi
@Deprecated
public static <T> java.util.Collection<T> getElementsOfTypeS(Element root,
                                                                @CheckForNull
                                                                java.lang.Class<T>[] types,
                                                                boolean checkRoot)

Deprecated.

See Also:

Finder.byTypeRecursively()

getElementsOfType

@OpenApi
@Deprecated
public static java.util.Collection<? extends Element> getElementsOfType(Element root,
                                                                           @CheckForNull
                                                                           java.lang.Class[] types,
                                                                           boolean checkRoot,
                                                                           boolean recursively)

Deprecated.

See Also:

Finder.byType(), Finder.byTypeRecursively()

getElementsOfType

@OpenApi
@Deprecated
public static java.util.Collection<? extends Element> getElementsOfType(Element root,
                                                                           @CheckForNull
                                                                           java.lang.Class[] types,
                                                                           boolean checkRoot,
                                                                           boolean recursively,
                                                                           boolean includeAdditionalContents,
                                                                           @CheckForNull
                                                                           org.eclipse.core.runtime.IProgressMonitor monitor)

Deprecated.

See Also:

Finder.byTypeRecursively(), Finder.byType()

isSecondTypeCompatibleToFirst

@OpenApi
public static boolean isSecondTypeCompatibleToFirst(@CheckForNull
                                            Type firstType,
                                            @CheckForNull
                                            Type secondType,
                                            boolean checkRealizedInterfaces)

Indicates if second parameter type is compatible to the first (is same type or a subtype).

Parameters:

firstType - parameter, to which the 2nd parameter must be compatible.

secondType - parameter, which should be compatible to the 1st.

checkRealizedInterfaces - indicates if realized interfaces should be taken into account when checking type compatibility.

Returns:

true if parameters are compatible, false otherwise.

getActivityParameterNodes

@OpenApi
public static java.util.List<ActivityParameterNode> getActivityParameterNodes(Activity activity)

Gets activity parameter nodes from a given activity.

Parameters:

activity - activity from which parameter nodes must be returned.

Returns:

a list of activity parameter nodes of a given activity.

createImage

@OpenApi
@Deprecated
public static Image createImage(java.io.File file)

Deprecated.

See Also:

createImage(com.nomagic.uml2.impl.ElementsFactory, java.io.File)

createImage

@OpenApi
public static Image createImage(ElementsFactory factory,
                        java.io.File file)

Creates image model element from a given image found in a file. The method does not start or check sessions.

Parameters:

file - file in which to look for an image.

Returns:

created image model element.

createImage

@OpenApi
public static Image createImage(ElementsFactory factory,
                        java.lang.String url)

Creates image model element from a given image found at url. The method does not start or check sessions.

Parameters:

url - url

Returns:

created image model element.

getReferencingElementsByTags

@OpenApi
public static java.util.Collection<Element> getReferencingElementsByTags(Element element,
                                                                 java.lang.String propertyName)

Given an element, finds its usages in stereotype tags of other elements.

Parameters:

element - element to search.

propertyName - tag name to search.

Returns:

collection of referencing elements.

getClassifierFor

@OpenApi
@Deprecated
@CheckForNull
public static Classifier getClassifierFor(Element element,
                                                          java.lang.String classifierName,
                                                          java.lang.Class type)

Deprecated.

See Also:

ClassifierFinder

getClassifierFor

@OpenApi
@Deprecated
@CheckForNull
public static Classifier getClassifierFor(Element element,
                                                          java.lang.String elementName,
                                                          java.lang.Class type,
                                                          java.util.Collection<java.lang.Class> classifiersType,
                                                          ClassifierFinder.SimpleNameResolver resolverShort)

Deprecated.

See Also:

ClassifierFinder

getClassifierFor

@OpenApi
@Deprecated
@CheckForNull
public static Classifier getClassifierFor(@CheckForNull
                                                          Element element,
                                                          java.lang.String elementName,
                                                          java.lang.Class type,
                                                          java.util.Collection<java.lang.Class> classifiersType,
                                                          ClassifierFinder.SimpleNameResolver resolverShort,
                                                          boolean createIfNotFound)

Deprecated.

See Also:

ClassifierFinder

findDataTypeFor

@OpenApi
@Deprecated
@CheckForNull
public static Classifier findDataTypeFor(Project project,
                                                         java.lang.String name,
                                                         @CheckForNull
                                                         java.util.Collection restricted)

Deprecated.

See Also:

ClassifierFinder

canMoveChildInto

@OpenApi
public static boolean canMoveChildInto(Element parent,
                               Element child)

Returns true, if child can be moved to the parent. This can be done if parent can add such child and parent does not have other child with the same name for example.

getFirstMemberEnd

@OpenApi
public static Property getFirstMemberEnd(Association assoc)

Get first property member end of association.

Parameters:

assoc - association model element.

Returns:

first property member end of association.

getSecondMemberEnd

@OpenApi
public static Property getSecondMemberEnd(Association assoc)

Get second property member end of association.

Parameters:

assoc - association model element.

Returns:

second property member end of association.

getAssociationEnds

@OpenApi
public static java.util.Collection<TypedElement> getAssociationEnds(Classifier classifier)

Returns a collection of properties connected to given classifier by associations.

Parameters:

classifier - the given classifier

Returns:

collection of properties

findParent

@OpenApi
public static Element findParent(Element relationship,
                         Element clientME,
                         Element supplierME,
                         @CheckForNull
                         Element diagramParent)

Looks for a possible parent for given relationship. Possible parent is calculated according client/supplier and relationship type.

Parameters:

relationship - relation for which possible parent should be found.

clientME - relationship client element

supplierME - relationship supplier element

diagramParent - can be null if diagram is not important in context

Returns:

possible parent for a given relation if found, null otherwise.

findParent

@OpenApi
public static Element findParent(Element relationship,
                         Element clientME,
                         Element supplierME,
                         @CheckForNull
                         Element diagramParent,
                         boolean checkPermissions)

Looks for a possible parent for given relationship. Possible parent is calculated according client/supplier and relationship type.

Parameters:

relationship - relation for which possible parent should be found.

clientME - relationship client element

supplierME - relationship supplier element

diagramParent - can be null if diagram is not important in context

checkPermissions - indicates if permissions should be checked.

Returns:

possible parent for a given relation if found, null otherwise.

findInParent

@OpenApi
@Deprecated
@CheckForNull
public static Element findInParent(Element parent,
                                                   java.lang.String name,
                                                   java.lang.Class classType)

Deprecated.

findInParent

@OpenApi
@Deprecated
@CheckForNull
public static Element findInParent(Element parent,
                                                   java.lang.String name,
                                                   java.lang.Class classType,
                                                   boolean searchRecursively)

Deprecated.

See Also:

Finder.byNameRecursively(), Finder.byName()

findInParent

@OpenApi
@Deprecated
public static void findInParent(Element parent,
                                   java.lang.String name,
                                   java.lang.Class classType,
                                   java.util.Collection<Element> result)

Deprecated.

See Also:

Finder.byNameAll()

findInParent

@OpenApi
@Deprecated
public static void findInParent(Element parent,
                                   java.lang.String name,
                                   boolean searchRecursively,
                                   java.util.Collection<Element> result)

Deprecated.

See Also:

Finder.byNameAllRecursively(), Finder.byNameAll()

findInParent

@OpenApi
@Deprecated
public static void findInParent(Element parent,
                                   java.lang.String name,
                                   @CheckForNull
                                   java.lang.Class classType,
                                   boolean searchRecursively,
                                   java.util.Collection<Element> result)

Deprecated.

See Also:

Finder.byNameRecursively(), Finder.byName()

getParameters

@OpenApi
public static java.util.List<Parameter> getParameters(BehavioralFeature feature)

Returns parameters without return parameter

Parameters:

feature - the given feature

getReturnParameters

@OpenApi
public static java.util.List<Parameter> getReturnParameters(BehavioralFeature feature)

Returns parameters without return parameter

Parameters:

feature - the given feature

setConstraintText

@OpenApi
public static void setConstraintText(Constraint constraint,
                             java.lang.String text,
                             boolean useName,
                             boolean useExpression)

Set text for constraint as name or as expression

Parameters:

constraint - constraint

text - text

useName - set text as name

useExpression - set text as expression

setComment

@OpenApi
public static void setComment(Element element,
                      java.lang.String documentation)

Set comment (documentation) for element. Comment is set on the first element in owned comments collection. If documentation is null or empty string, removed the comment.

Parameters:

element - element to set documentation.

documentation - documentation text.

getComment

@OpenApi
public static java.lang.String getComment(Element element)

Returns documentation of given element.

Parameters:

element - element to get documentation.

Returns:

element documentation.

isParentOf

@OpenApi
public static boolean isParentOf(BaseElement possibleParent,
                         BaseElement possibleChild)

Checks if given object is child of given parent object.

Parameters:

possibleChild - possible child

possibleParent - possible parent

Returns:

true if possibleChild is child of possibleParent.

isOperationEqual

@OpenApi
public static boolean isOperationEqual(Operation op1,
                               Operation op2)

Compare the two given operation.

Parameters:

op1 - First operation.

op2 - Second operation.

Returns:

boolean

isBehavioralFeatureEqual

@OpenApi
public static boolean isBehavioralFeatureEqual(BehavioralFeature feature1,
                                       BehavioralFeature feature2,
                                       boolean compareReturnParameter)

Compare the two given features by name and by parameters

Parameters:

feature1 - first feature

feature2 - second feature

compareReturnParameter - take into account return parameter(s)

Returns:

true if names are equals and parameters are equals

areEqualParameterTypes

@OpenApi
public static boolean areEqualParameterTypes(BehavioralFeature feature1,
                                     BehavioralFeature feature2)

Method compares parameters and returns true if parameters types are equals.

Parameters:

feature1 - feature to be compared with.

feature2 - feature to be compared with.

Returns:

true if parameters are equals.

areEqualParameterTypes

@OpenApi
public static boolean areEqualParameterTypes(BehavioralFeature feature1,
                                     BehavioralFeature feature2,
                                     boolean compareReturnParameter)

Method compares parameters and returns true if parameters types are equals.

Parameters:

feature1 - feature to be compared with.

feature2 - feature to be compared with.

compareReturnParameter - take into account return parameter(s)

Returns:

true if parameters are equals.

isPropertyEqual

@OpenApi
public static boolean isPropertyEqual(Property p1,
                              Property p2)

Compare the two given Property.

Parameters:

p1 - First property

p2 - Second property

Returns:

boolean

findSlot

@CheckForNull
@OpenApi
public static Slot findSlot(InstanceSpecification instanceSpecification,
                                 Property neededProperty)

Looks for existing slot for given property in given instance.

Parameters:

instanceSpecification - instance

neededProperty - definingFeature of slot

Returns:

found slot or null

isRelationship

@OpenApi
public static boolean isRelationship(Element element)

getImplementedClasses

@OpenApi
public static java.util.List<BehavioredClassifier> getImplementedClasses(Interface anInterface)

Gets classifiers which realize (implement) a given interface.

Parameters:

anInterface - an interface for which to get classifiers.

Returns:

list of classifiers which realize a given interface.

getRealizedInterfaces

@OpenApi
public static java.util.List<Interface> getRealizedInterfaces(BehavioredClassifier classifier)

Collects realized interfaces by the given classifier.

Parameters:

classifier - given classifier

Returns:

a collection of realized interfaces(may be empty)

getDependentClients

@OpenApi
public static java.util.List<NamedElement> getDependentClients(NamedElement element,
                                                       java.lang.Class<? extends Dependency> dependencyClass)

Collects elements those are connected with Dependencies as clients with a given element

Parameters:

element - the given element

dependencyClass - dependency class to filter

Returns:

list of dependent client elements

getDependentSuppliers

@OpenApi
public static java.util.List<NamedElement> getDependentSuppliers(NamedElement element,
                                                         java.lang.Class<? extends Dependency> dependencyClass)

Collects elements those are connected with Dependencies as suppliers with a given element

Parameters:

element - the given element

dependencyClass - dependency class to filter

Returns:

list of dependent supplier elements

setNavigable

@OpenApi
public static void setNavigable(Property property,
                        boolean navigable)

Sets navigability of the specified association end. It automatically changes ownership if possible.

 Example:
  Association assoc = ...;
  Property secondMemberEnd = ModelHelper.getSecondMemberEnd(assoc);
  ModelHelper.setNavigable(secondMemberEnd, secondMemberEnd.isNavigable());
 

Parameters:

property - association end. Can not be null.

navigable - flag.

getValueString

@OpenApi
public static java.lang.String getValueString(ValueSpecification vs)

Return string representation of given ValueSpecification

Parameters:

vs - value specification

Returns:

string representation of given value specification

isAggregation

@OpenApi
public static boolean isAggregation(Association association,
                            AggregationKind aggregationKind)

Determines if association is of specified aggregation kind.

Parameters:

association - association model element.

aggregationKind - AggregationKindEnum.SHARED - aggregation, AggregationKindEnum.COMPOSITE - composition.

Returns:

true if one of association ends has set specified aggregation kind.

getOwnedElementsIncludingAdditional

@OpenApi
public static java.util.List<Element> getOwnedElementsIncludingAdditional(Element element,
                                                                  boolean includePureOwned)

Return owned elements of the given Element including additional owned elements defined in DSL specification by additionalContentProperty.

Parameters:

includePureOwned - include element owned directly in ownedElement UML metaproperty

Returns:

owned elements of the given Element

getAdditionalElementsIterator

@OpenApi
public static java.util.Iterator<Element> getAdditionalElementsIterator(Element element)

Returns iterator of additional contained elements defined in DSL specification by additionalContentProperty.

Returns:

iterator of additional elements