com.nomagic.uml2.ext.jmi.helpers

Class ModelHelper

java.lang.Object

com.nomagic.uml2.ext.jmi.helpers.CoreHelper

com.nomagic.uml2.ext.jmi.helpers.ValueSpecificationHelper

com.nomagic.uml2.ext.jmi.helpers.ClassifierHelper

com.nomagic.uml2.ext.jmi.helpers.InstanceSpecificationHelper

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

@OpenApiAll
public class ModelHelper
extends InstanceSpecificationHelper

Model Utility class.

Nested Class Summary

Nested classes/interfaces inherited from class com.nomagic.uml2.ext.jmi.helpers.ClassifierHelper

ClassifierHelper.ElementsGetter<T>, ClassifierHelper.PropertyValueGetter, ClassifierHelper.PureAttributesGetter, ClassifierHelper.ShortElementNameResolver

Constructor Summary

Constructors

Constructor and Description
ModelHelper()

Method Summary

Modifier and Type	Method and Description
static boolean	canAssignType(TypedElement typedElement, Type type) Check if given Type can be assigned to a given TypedElement.
static boolean	canChangeNavigability(Property property) Checks if navigability of the association end property can be inverted - navigable to non-navigable and vice versa.
static boolean	canChangeOwnerTo(Property property, boolean toAssociation) Checks if association end can be owned by association or connected element.
static void	changeOwnerTo(Property property, boolean toAssociation) Changes ownership of the association end.
static java.util.List<Connector>	collectConnectors(ConnectableElement connectableElement) Deprecated.
static java.util.List<Classifier>	collectWithName(java.util.Collection<? extends Element> elements, java.util.Collection<java.lang.Class> classifierClassTypes, java.lang.String name, boolean useQualifiedName) Deprecated. use ModelHelperInternal.collectWithName(Collection, Collection, String, boolean, Collection)
static java.lang.String	constructEditCommandName(java.lang.String propertyName) Deprecated.
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 InterfaceRealization	createProvidedInterfaceRelationship(BehavioredClassifier behavioredClassifier, Interface anInterface) Deprecated.
static Behavior	findBehaviorFor(Element element) Finds a defining behavior for a given element.
static Deployment	findDeployment(DeploymentTarget deploymentTarget, DeployedArtifact artifact) Find existing deployment among target and artifact
static Diagram	findDiagram(Element element) 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 <T extends Element> T	findElementWithPath(java.lang.String path) 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 NamedElement	findOwner(Property property, boolean association) Finds preferred owner element for the association end.
static java.util.List<ActivityParameterNode>	getActivityParameterNodes(Activity activity) Gets activity parameter nodes from a given activity.
static java.util.List<State>	getAvailableClassifierStates(Classifier classifier) Deprecated. use StateMachineHelperInternal.getBehavioredClassifierStates(BehavioredClassifier)
static java.util.Collection<StateMachine>	getClassifierStateMachines(Classifier classifier, boolean createIfNotFound) Deprecated. use StateMachineHelperInternal.getBehavioredClassifierStateMachines(BehavioredClassifier, boolean)
static BehavioredClassifier	getContext(Behavior behavior) The classifier that is the context for the execution of the behavior.
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 ConnectorEnd	getFirstEnd(Connector connector) Return a first connector end
static ConnectorEnd	getFirstMemberEnd(Connector connector) Deprecated.
static Property	getOpposite(Property end) Deprecated.
static ConnectorEnd	getOppositeEnd(ConnectorEnd end) Gets opposite connector end for a given connector end.
static java.util.Collection<Element>	getReferencingElementsByTags(Element element, java.lang.String propertyName) Deprecated.
static ConnectorEnd	getSecondEnd(Connector connector) Return a second connector end
static ConnectorEnd	getSecondMemberEnd(Connector connector) Deprecated.
static boolean	isAggregation(Association association, AggregationKind aggregationKind) Determines if association is of specified aggregation kind.
static boolean	isDirectedAssociation(Association association) Check if association is directed
static boolean	isNonNavigableAssociation(Association association) Check if association is non navigable
static boolean	isPropertyEqual(Property p1, Property p2) Compare the two given Property.
static void	setNavigable(Property property, boolean navigable) Sets navigability of the specified association end.
static void	setNavigable(Property property, boolean navigable, boolean automaticOwnership) Sets navigability of the specified association end.

Methods inherited from class com.nomagic.uml2.ext.jmi.helpers.InstanceSpecificationHelper

collectAllInstances, createSlot, createSlotsForDefaultValues, createSlotsForDefaultValues, findSlot, getAssignableAssociationsForLink, getAssociationOfLink, getLinksBetweenInstances, getSlot, getSlot, getValueBySlot, isInstanceSpecificationCompatibleWithType, isInstanceSpecificationCompatibleWithType, isLink, setClassifierForInstanceSpecification, setClassifierForInstanceSpecification, setSlotValue

Methods inherited from class com.nomagic.uml2.ext.jmi.helpers.ClassifierHelper

areEqualParameterTypes, areEqualParameterTypes, associations, associationsIncludingInherited, attributes, checkForDerivedClassifier, collectBaseClassAttributes, collectBaseClassAttributes, collectBaseClassInheritableAttributes, collectBaseClassOperations, collectBaseClassPorts, collectCommonAssociations, collectDerivedClassifiersRecursivelly, collectDerivedClassifiersRecursively, collectGeneralClassifiersAndRealizedInterfacesRecursively, collectGeneralClassifiersRecursivelly, collectGeneralClassifiersRecursively, collectInheritedAttributes, collectInheritedBehaviors, collectInheritedElements, collectInheritedEnumerationLiterals, collectInheritedExtensionPoints, collectInheritedOperations, collectInheritedPorts, collectInheritedPureAttributes, collectInheritedPureAttributes, collectInheritedRealizedInterfaces, collectInheritedReceptions, collectInheritedRelations, collectRealizedInterfaces, findAssociationEndForType, findDataTypeFor, findGeneralization, findInterfaceRealization, getAllLiterals, getAssociationEndOwnedByAssociation, getAssociationEnds, getClassifierFor, getClassifierFor, getClassifierFor, getDerivedClassifiers, getDerivedClassifiers, getDerivedClassifiersRecursivelly, getDerivedClassifiersRecursively, getDerivedClassifiersRecursively, getGeneralClassifiers, getGeneralClassifiersRecursivelly, getGeneralClassifiersRecursivelly, getGeneralClassifiersRecursively, getGeneralClassifiersRecursively, getImplementedClasses, getInheritanceDeep, getOptimizedClassifierHierarchy, getParameters, getPropertiesWithoutRedefined, getProvided, getRealizedInterfaces, getReturnParameter, getReturnParameter, getReturnParameter, getReturnParameters, isBehavioralFeatureEqual, isClassifierOfType, isClassifierOfType, isDerivedClassifier, isDerivedOrRealizes, isLegalInheritance, isLegalInheritance, isLegalInterfaceRealization, isOperationEqual, isReturnParameter, isSameOrRedefined, isSecondTypeCompatibleToFirst, isSecondTypeCompatibleToFirst, operations, ports, pureAttributes, receptions, removeDerivedClassifiers, removeRedefined

Methods inherited from class com.nomagic.uml2.ext.jmi.helpers.ValueSpecificationHelper

cloneValueSpecification, createValueSpecification, createValueSpecification, createValueSpecification, createValueSpecification, createValueSpecification, getValueSpecificationClass, getValueSpecificationClass, getValueSpecificationValue, getValueString, isValueSpecificationClassElementValue, setValueDisposeIfNeeded, setValueSpecificationValue, setValueSpecificationValue, setValueSpecificationValue

Methods inherited from class com.nomagic.uml2.ext.jmi.helpers.CoreHelper

areElementsEditable, canAddChild, canAssignName, canAssignName, canAssignName, canMoveChildInto, canMoveChildInto, configureBeforeParsing, dispose, findAcceptableParentFor, findAcceptableParentFor, findOwnerOfStrictType, findOwnerOfStrictTypeIncludingItself, findOwnerOfType, findOwnerOfTypeIncludingItself, findParent, findParent, findParentOfType, getAdditionalElementsIterator, getClientElement, getComment, getCommentElement, getCommentElementOrCreate, getDependentClients, getDependentSuppliers, getFirstMemberEnd, getMultiplicity, getName, getOppositeEnd, getOwnedElementsIncludingAdditional, getSecondMemberEnd, getSupplierElement, getSupplierElement, getSupplierElements, hasParentIn, isChildOf, isDocumentationComment, isMultiplicityMany, isParentOf, isParentOf, isRelationship, isRelationshipAlwaysInClient, parseMultiplicityString, setClientElement, setComment, setCommentElement, setConstraintText, setConstraintText, setMultiplicity, setMultiplicity, setSupplierElement

Methods inherited from class java.lang.Object

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

Constructor Detail

ModelHelper

public ModelHelper()

Method Detail

collectWithName

@Deprecated
public static java.util.List<Classifier> collectWithName(java.util.Collection<? extends Element> elements,
                                                                     java.util.Collection<java.lang.Class> classifierClassTypes,
                                                                     java.lang.String name,
                                                                     boolean useQualifiedName)

Deprecated. use ModelHelperInternal.collectWithName(Collection, Collection, String, boolean, Collection)

Filters elements from given collection with a given name and given metaclasses.

Parameters:

elements - the collection of given elements

classifierClassTypes - the collection of metaclasses

name - a name of element to filter (simple or qualified)

useQualifiedName - (check qualified name or simple name)

Returns:

found elements

findElementWithPath

@Deprecated
public static <T extends Element> T findElementWithPath(java.lang.String path)

Deprecated.

See Also:

Finder.byQualifiedName()

findElementWithPath

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

Deprecated.

See Also:

Finder.byQualifiedName

findElementWithPath

@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

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

Deprecated.

See Also:

Finder.byTypeRecursively()

getElementsOfTypeS

@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

@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

@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()

getActivityParameterNodes

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

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

Deprecated.

See Also:

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

createImage

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

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

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

Deprecated.

See Also:

StereotypesHelper.getReferencingElementsByTags(Element, String)

findInParent

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

Deprecated.

findInParent

@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

@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

@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

@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()

isPropertyEqual

public static boolean isPropertyEqual(Property p1,
                                      Property p2)

Compare the two given Property.

Parameters:

p1 - First property

p2 - Second property

Returns:

boolean

canChangeNavigability

public static boolean canChangeNavigability(Property property)

Checks if navigability of the association end property can be inverted - navigable to non-navigable and vice versa. Navigability can not be changed when association of association end (property) is not editable or when connected element is not editable and it owns association end. We do not check connected element is can own an association end when it's non-navigable, because association end can be explicitly navigable without changing ownership.

Parameters:

property - association end, can not be null

Returns:

false if association is read-only or connected element owns association end and it's read-only, other wise returns true

setNavigable

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

setNavigable

public static void setNavigable(Property property,
                                boolean navigable,
                                boolean automaticOwnership)

Sets navigability of the specified association end. It may change ownership of the association end when: - association end changes to non-navigable and it's owned by connected element. The association becomes an owner of the association end. - association end changes to navigable and automaticOwnership is set to true and connected element is editable and can own association end. The connected element becomes an owner of the association end. At least association has to be editable in order to change association end navigability.

Parameters:

property - association end. Can not be null

navigable - flag

automaticOwnership - indicates if it should change association end ownership to connected element when its possible

canChangeOwnerTo

public static boolean canChangeOwnerTo(Property property,
                                       boolean toAssociation)

Checks if association end can be owned by association or connected element.

Parameters:

property - association end. Can not be null

toAssociation - indicates what kind of ownership shall be checked - true for association and false for connected element

Returns:

true according to toAssociation argument: if association can own the association end or connected element can own the association end. Returns false if preferred owner is null

changeOwnerTo

public static void changeOwnerTo(Property property,
                                 boolean toAssociation)

Changes ownership of the association end. It can change owner of the property to association or connected element.

Parameters:

property - association end. Can not be null

toAssociation - preferred owner: true for association and false for connected element

findOwner

public static NamedElement findOwner(Property property,
                                     boolean association)

Finds preferred owner element for the association end.

Parameters:

property - association end. Can not be null

association - preferred owner: true for association and false for connected element

Returns:

model element or null if such element does not exist

findBehaviorFor

@CheckForNull
public static Behavior findBehaviorFor(Element element)

Finds a defining behavior for a given element. Only BehaviorClassifier and BehaviorFeature are taken into account

Parameters:

element - element

Returns:

behavior

isAggregation

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

isDirectedAssociation

public static boolean isDirectedAssociation(Association association)

Check if association is directed

Parameters:

association - association

Returns:

true if at least one end is navigable

isNonNavigableAssociation

public static boolean isNonNavigableAssociation(Association association)

Check if association is non navigable

Parameters:

association - association

Returns:

true if both ends are not navigable

findDeployment

@CheckForNull
public static Deployment findDeployment(DeploymentTarget deploymentTarget,
                                                      DeployedArtifact artifact)

Find existing deployment among target and artifact

Parameters:

deploymentTarget - target

artifact - artifact

Returns:

existing deployment or null

getContext

@CheckForNull
public static BehavioredClassifier getContext(Behavior behavior)

The classifier that is the context for the execution of the behavior. A Behavior that is directly owned as a nestedClassifier does not have a context. Otherwise, to determine the context of a Behavior, find the first BehavioredClassifier reached by following the chain of owner relationships from the Behavior, if any. If there is such a BehavioredClassifier, then it is the context, unless it is itself a Behavior with a non-empty context, in which case that is also the context for the original Behavior. For example, following this algorithm, the context of an entry action in a state machine is the classifier that owns the state machine. The features of the context classifier as well as the elements visible to the context classifier are visible to the behavior. (Subsets RedefinableElement::redefinitionContext)

Parameters:

behavior - behavior for which to get the context.

canAssignType

public static boolean canAssignType(TypedElement typedElement,
                                    @CheckForNull
                                    Type type)

Check if given Type can be assigned to a given TypedElement. For example Property owned by Stereotype (Tag definition) can be typed just by Stereotype, DataType or metaclass.

Parameters:

typedElement - typed element

type - type

Returns:

true if type can be changed

createProvidedInterfaceRelationship

@Nonnull
 @Deprecated
public static InterfaceRealization createProvidedInterfaceRelationship(@Nonnull
                                                                                             BehavioredClassifier behavioredClassifier,
                                                                                             @Nonnull
                                                                                             Interface anInterface)

Deprecated.

See Also:

ModelHelperInternal.createProvidedInterfaceRelationship(BehavioredClassifier, Interface)

collectConnectors

@Deprecated
 @Nonnull
public static java.util.List<Connector> collectConnectors(ConnectableElement connectableElement)

Deprecated.

See Also:

ConnectorsCollector.collectDirectConnectors(com.nomagic.uml2.ext.magicdraw.compositestructures.mdinternalstructures.ConnectableElement)

constructEditCommandName

@Deprecated
public static java.lang.String constructEditCommandName(java.lang.String propertyName)

Deprecated.

See Also:

ModelHelperInternal.constructEditCommandName(String)

findDiagram

@Deprecated
 @CheckForNull
public static Diagram findDiagram(Element element)

Deprecated.

See Also:

ModelHelperInternal.findDiagram(Element)

getOpposite

@Deprecated
public static Property getOpposite(Property end)

Deprecated.

See Also:

Property.getOpposite()

getFirstEnd

public static ConnectorEnd getFirstEnd(Connector connector)

Return a first connector end

Parameters:

connector - connector

Returns:

end

getSecondEnd

public static ConnectorEnd getSecondEnd(Connector connector)

Return a second connector end

Parameters:

connector - connector

Returns:

end

getFirstMemberEnd

@Deprecated
public static ConnectorEnd getFirstMemberEnd(Connector connector)

Deprecated.

See Also:

(Connector)

getSecondMemberEnd

@Deprecated
public static ConnectorEnd getSecondMemberEnd(Connector connector)

Deprecated.

See Also:

getSecondEnd(Connector)

getOppositeEnd

public static ConnectorEnd getOppositeEnd(ConnectorEnd end)

Gets opposite connector end for a given connector end.

Parameters:

end - connector end for which to get opposite end

Returns:

opposite connector end for a given connector end

getAvailableClassifierStates

@Deprecated
public static java.util.List<State> getAvailableClassifierStates(Classifier classifier)

Deprecated. use StateMachineHelperInternal.getBehavioredClassifierStates(BehavioredClassifier)

getClassifierStateMachines

@Deprecated
public static java.util.Collection<StateMachine> getClassifierStateMachines(Classifier classifier,
                                                                                        boolean createIfNotFound)

Deprecated. use StateMachineHelperInternal.getBehavioredClassifierStateMachines(BehavioredClassifier, boolean)