org.eclipse.ocl.uml.util

Class OCLUMLUtil

java.lang.Object

org.eclipse.uml2.common.util.UML2Util

org.eclipse.uml2.uml.util.UMLUtil

org.eclipse.ocl.uml.util.OCLUMLUtil

public class OCLUMLUtil
extends org.eclipse.uml2.uml.util.UMLUtil

Utilities for resolving references to packages against a resource set and finding the Ecore definitions of UML packages and classifiers in support of evaluation of OCL expressions.

Author:

Christian W. Damus (cdamus)

Nested Class Summary

Nested classes/interfaces inherited from class org.eclipse.uml2.uml.util.UMLUtil

org.eclipse.uml2.uml.util.UMLUtil.Ecore2UMLConverter, org.eclipse.uml2.uml.util.UMLUtil.PackageMerger, org.eclipse.uml2.uml.util.UMLUtil.Profile2EPackageConverter, org.eclipse.uml2.uml.util.UMLUtil.ProfileApplicationHelper, org.eclipse.uml2.uml.util.UMLUtil.QualifiedTextProvider, org.eclipse.uml2.uml.util.UMLUtil.StereotypeApplicationHelper, org.eclipse.uml2.uml.util.UMLUtil.TemplateExpander, org.eclipse.uml2.uml.util.UMLUtil.UML2EcoreConverter

Nested classes/interfaces inherited from class org.eclipse.uml2.common.util.UML2Util

org.eclipse.uml2.common.util.UML2Util.Converter, org.eclipse.uml2.common.util.UML2Util.EClassMatcher, org.eclipse.uml2.common.util.UML2Util.EObjectMatcher, org.eclipse.uml2.common.util.UML2Util.EStructuralFeatureMatcher

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	PLUGIN_ID The shared UML binding plugin identification.

Fields inherited from class org.eclipse.uml2.uml.util.UMLUtil

ANNOTATION__DUPLICATES, ANNOTATION__REDEFINES, ANNOTATION__SUBSETS, ANNOTATION__UNION, ANNOTATION_DETAIL__BODY, ANNOTATION_DETAIL__DERIVATION, ANNOTATION_DETAIL__INITIAL, ANNOTATION_DETAIL__URI, EMF_GEN_MODEL_PACKAGE_NS_URI, ENUMERATION__CONTENT_KIND, ENUMERATION__FEATURE_KIND, ENUMERATION__VISIBILITY_KIND, ENUMERATION_LITERAL__ATTRIBUTE, ENUMERATION_LITERAL__ATTRIBUTE_WILDCARD, ENUMERATION_LITERAL__ELEMENT, ENUMERATION_LITERAL__ELEMENT_ONLY, ENUMERATION_LITERAL__ELEMENT_WILDCARD, ENUMERATION_LITERAL__EMPTY, ENUMERATION_LITERAL__GROUP, ENUMERATION_LITERAL__MIXED, ENUMERATION_LITERAL__NONE, ENUMERATION_LITERAL__READ_ONLY, ENUMERATION_LITERAL__READ_ONLY_UNSETTABLE, ENUMERATION_LITERAL__READ_WRITE, ENUMERATION_LITERAL__READ_WRITE_UNSETTABLE, ENUMERATION_LITERAL__SIMPLE, ENUMERATION_LITERAL__UNSPECIFIED, LANGUAGE__JAVA, LANGUAGE__OCL, OPTION__DISCARD, OPTION__IGNORE, OPTION__PROCESS, OPTION__REPORT, PROFILE__ECORE, STEREOTYPE__E_ATTRIBUTE, STEREOTYPE__E_CLASS, STEREOTYPE__E_DATA_TYPE, STEREOTYPE__E_ENUM, STEREOTYPE__E_ENUM_LITERAL, STEREOTYPE__E_GENERIC_TYPE, STEREOTYPE__E_OPERATION, STEREOTYPE__E_PACKAGE, STEREOTYPE__E_PARAMETER, STEREOTYPE__E_REFERENCE, STEREOTYPE__E_TYPE_PARAMETER, TAG_DEFINITION__ANNOTATIONS, TAG_DEFINITION__ATTRIBUTE_NAME, TAG_DEFINITION__BASE_PACKAGE, TAG_DEFINITION__BOUNDS, TAG_DEFINITION__CLASS_NAME, TAG_DEFINITION__DATA_TYPE_NAME, TAG_DEFINITION__ENUM_LITERAL_NAME, TAG_DEFINITION__ENUM_NAME, TAG_DEFINITION__INSTANCE_CLASS_NAME, TAG_DEFINITION__IS_ID, TAG_DEFINITION__IS_RESOLVE_PROXIES, TAG_DEFINITION__IS_TRANSIENT, TAG_DEFINITION__IS_UNSETTABLE, TAG_DEFINITION__IS_VOLATILE, TAG_DEFINITION__KEYS, TAG_DEFINITION__LITERAL, TAG_DEFINITION__LOWER_BOUND, TAG_DEFINITION__NS_PREFIX, TAG_DEFINITION__NS_URI, TAG_DEFINITION__OPERATION_NAME, TAG_DEFINITION__PACKAGE_NAME, TAG_DEFINITION__PARAMETER_NAME, TAG_DEFINITION__PREFIX, TAG_DEFINITION__REFERENCE_NAME, TAG_DEFINITION__UPPER_BOUND, TAG_DEFINITION__VISIBILITY, TAG_DEFINITION__XML_CONTENT_KIND, TAG_DEFINITION__XML_FEATURE_KIND, TAG_DEFINITION__XML_NAME, TAG_DEFINITION__XML_NAMESPACE, UML2_GEN_MODEL_PACKAGE_1_1_NS_URI, UML2_GEN_MODEL_PACKAGE_NS_URI, UML2_TYPES_PACKAGE_4_0_NS_URI, UML2_UML_PACKAGE_2_0_NS_URI, UML2_UML_PACKAGE_2_0_NS_URI_COMPATIBILITY, UML2_UML_PACKAGE_4_0_NS_URI, UML2_UML_PACKAGE_4_1_NS_URI

Fields inherited from class org.eclipse.uml2.common.util.UML2Util

DEFAULT_URI_CONVERTER, EMPTY_STRING, LINE_SEPARATOR, PROPERTIES_FILE_EXTENSION, RESOURCE_BUNDLES, URI_SCHEME_PLATFORM, URI_SEGMENT_PLUGIN, URI_SEGMENT_RESOURCE

Method Summary

Modifier and Type	Method and Description
static org.eclipse.uml2.uml.Namespace	findNamespace(java.util.List<java.lang.String> qualifiedName, org.eclipse.emf.ecore.resource.ResourceSet rset) Searches the specified resource set for a UML namespace (not necessarily a package).
protected static org.eclipse.emf.ecore.EPackage	findPackage(java.util.List<java.lang.String> packageNames, org.eclipse.emf.ecore.EPackage.Registry registry) Looks in the given registry for a package with the specified qualified package name.
static org.eclipse.uml2.uml.Package	findPackage(java.util.List<java.lang.String> packageNames, org.eclipse.emf.ecore.resource.ResourceSet rset) Searches the specified resource set for a UML package.
static org.eclipse.emf.common.util.EList<org.eclipse.uml2.uml.Property>	getAllAttributes(org.eclipse.uml2.uml.Classifier classifier) A foreign method for the Classifier that obtains all attributes regardless of visibility, for OCL purposes.
static org.eclipse.emf.common.util.EList<org.eclipse.uml2.uml.Operation>	getAllOperations(org.eclipse.uml2.uml.Classifier classifier) A foreign method for the Classifier that obtains all operations regardless of visibility, for OCL purposes.
static java.util.List<org.eclipse.uml2.uml.Reception>	getAllReceptions(org.eclipse.uml2.uml.Class clazz) Foreign method for the getAllReceptions() query that is missing from the UML metamodel.
static org.eclipse.uml2.uml.Classifier	getClassifier(org.eclipse.emf.ecore.EClassifier eclassifier, org.eclipse.emf.ecore.resource.ResourceSet rset) Obtains the UML classifier corresponding to the specified Ecore classifier, which is the type of some object in an OCL expression evaluation.
static org.eclipse.emf.ecore.EClassifier	getEClassifier(org.eclipse.uml2.uml.Classifier umlClassifier, java.lang.Object element, org.eclipse.emf.ecore.EPackage.Registry registry) Looks up the Ecore definition of the specified UML classifier, using the specified element as a context for finding profile applications in the case that the classifier is a stereotype or some other type in a Profile.
static org.eclipse.emf.ecore.EPackage	getEPackage(org.eclipse.uml2.uml.Package pkg, org.eclipse.emf.ecore.EPackage.Registry registry) Searches the specified package registry set for an Ecore definition of the specified UML package.
static org.eclipse.uml2.uml.Class	getMetaclass(org.eclipse.uml2.uml.Element element) Obtains the UML metaclass of the specified model element.
static org.eclipse.uml2.uml.Package	getUMLMetamodel(org.eclipse.emf.ecore.resource.ResourceSet resourceSet) Obtains the UML metamodel library loaded in the specified resource set, loading it if necessary.
static boolean	isNonNavigableAssocationEndOf(org.eclipse.uml2.uml.Property associationEnd, org.eclipse.uml2.uml.Classifier endClassifier) A foreign method for the Property that queries whether it is a non-navigable association end of a given classifier.

Methods inherited from class org.eclipse.uml2.uml.util.UMLUtil

applyStereotype, convertFromEcore, convertFromEcore, convertToEcore, convertToEcore, convertToEcore, convertToEcore, expand, expand, findNamedElements, findNamedElements, findNamedElements, findNamedElements, findNamedElements, findNamedElements, findNamedElements, findValidRedefinitions, findValidRedefinitions, findValidSubsets, findValidSubsets, getBaseElement, getBaseElement, getEClassifier, getEClassifier, getEcoreName, getEPackage, getETypeParameters, getNamedElement, getNamedElement, getNearestBaseElement, getOCLBody, getOwnedAttributes, getOwnedOperations, getOwningElement, getProfile, getProfile, getQualifiedName, getQualifiedText, getRedefinedFeatures, getStereotype, getStereotype, getStereotype, getStereotypeApplication, getTagDefinition, getTaggedValue, init, isBoolean, isInteger, isReal, isRedefinitionValid, isString, isSubsetValid, isUnlimitedNatural, merge, merge, safeApplyStereotype, setBaseElement, setTaggedValue

Methods inherited from class org.eclipse.uml2.common.util.UML2Util

addConstraint, addDocumentation, addDocumentation, addInvocationDelegate, addSettingDelegate, addValidationDelegate, createEAnnotation, destroy, destroyAll, findENamedElements, findENamedElements, findEObject, findEObject, getAllContents, getCommonEType, getContainingEObject, getEAnnotation, getGreaterUpperBound, getInstanceCount, getInverseReferences, getLesserLowerBound, getMessageSubstitution, getMessageSubstitutions, getMessageSubstitutions, getMessageSubstitutions, getNonNavigableInverseReferences, getQualifiedName, getQualifiedText, getQualifiedText, getQualifiedTextSegment, getResourceBundle, getResourceBundle, getResourceBundleURIs, getResourceBundleURIs, getResourceSet, getRootContainers, getString, getValidJavaIdentifier, getValidJavaIdentifier, getValidNCName, getValidNCName, getXMIIdentifier, getXMIIdentifier, intersect, isEmpty, isNCNamePart, isNCNameStart, load, loadClassFromSystemProperty, removeReferences, safeEquals

Methods inherited from class java.lang.Object

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

Field Detail

PLUGIN_ID

public static final java.lang.String PLUGIN_ID

The shared UML binding plugin identification.

Since:

4.0

See Also:

Constant Field Values

Method Detail

getAllReceptions

public static java.util.List<org.eclipse.uml2.uml.Reception> getAllReceptions(org.eclipse.uml2.uml.Class clazz)

Foreign method for the getAllReceptions() query that is missing from the UML metamodel.

Parameters:

clazz - a UML class

Returns:

the receptions that it defines and/or inherits

getMetaclass

public static org.eclipse.uml2.uml.Class getMetaclass(org.eclipse.uml2.uml.Element element)

Obtains the UML metaclass of the specified model element. The specified element must be in a resource set, otherwise the UML metamodel is not available.

Parameters:

element - an element in a UML model

Returns:

the element's metaclass, or null if the element is not in a resource set

getClassifier

public static org.eclipse.uml2.uml.Classifier getClassifier(org.eclipse.emf.ecore.EClassifier eclassifier,
                                                            org.eclipse.emf.ecore.resource.ResourceSet rset)

Obtains the UML classifier corresponding to the specified Ecore classifier, which is the type of some object in an OCL expression evaluation.

Parameters:

eclassifier - an Ecore definition of a UML classifier

rset - the resource set in which to look for the corresponding UML classifier

Returns:

the corresponding UML classifier, or null if not found

findPackage

public static org.eclipse.uml2.uml.Package findPackage(java.util.List<java.lang.String> packageNames,
                                                       org.eclipse.emf.ecore.resource.ResourceSet rset)

Searches the specified resource set for a UML package.

Parameters:

packageNames - the qualified package name

rset - the resource set to search

Returns:

the matching package, or null if not found

findNamespace

public static org.eclipse.uml2.uml.Namespace findNamespace(java.util.List<java.lang.String> qualifiedName,
                                                           org.eclipse.emf.ecore.resource.ResourceSet rset)

Searches the specified resource set for a UML namespace (not necessarily a package).

Parameters:

qualifiedName - the qualified namespace name

rset - the resource set to search

Returns:

the matching namespace, or null if not found

getEPackage

public static org.eclipse.emf.ecore.EPackage getEPackage(org.eclipse.uml2.uml.Package pkg,
                                                         org.eclipse.emf.ecore.EPackage.Registry registry)

Searches the specified package registry set for an Ecore definition of the specified UML package. If this package registry doesn't have it and is not the global package registry, then the global registry is also searched.

Parameters:

pkg - the UML package

registry - the registry in which to look for the Ecore definition

Returns:

the matching Ecore definition, or null if not found

getEClassifier

public static org.eclipse.emf.ecore.EClassifier getEClassifier(org.eclipse.uml2.uml.Classifier umlClassifier,
                                                               java.lang.Object element,
                                                               org.eclipse.emf.ecore.EPackage.Registry registry)

Looks up the Ecore definition of the specified UML classifier, using the specified element as a context for finding profile applications in the case that the classifier is a stereotype or some other type in a Profile. Finding the Ecore definition of a profile type requires finding the actual applied version of the profile.

Parameters:

umlClassifier - a UML classifier

element - an element in the context of which the OCL evaluation is being performed

registry - the package registry in which to search for the Ecore definition

Returns:

the corresponding Ecore classifier, or null if not found

findPackage

protected static org.eclipse.emf.ecore.EPackage findPackage(java.util.List<java.lang.String> packageNames,
                                                            org.eclipse.emf.ecore.EPackage.Registry registry)

Looks in the given registry for a package with the specified qualified package name.

Parameters:

packageNames - the qualified package name

Returns:

the matching EPackage, or null if not found

getUMLMetamodel

public static org.eclipse.uml2.uml.Package getUMLMetamodel(org.eclipse.emf.ecore.resource.ResourceSet resourceSet)

Obtains the UML metamodel library loaded in the specified resource set, loading it if necessary.

Parameters:

resourceSet - a resource set

Returns:

the UML metamodel

getAllAttributes

public static org.eclipse.emf.common.util.EList<org.eclipse.uml2.uml.Property> getAllAttributes(org.eclipse.uml2.uml.Classifier classifier)

A foreign method for the Classifier that obtains all attributes regardless of visibility, for OCL purposes.

Parameters:

classifier - a classifier

Returns:

all of its attributes, including inheritable and non-inheritable attributes (private attributes of general types) except for those that are redefined

Since:

1.2

isNonNavigableAssocationEndOf

public static boolean isNonNavigableAssocationEndOf(org.eclipse.uml2.uml.Property associationEnd,
                                                    org.eclipse.uml2.uml.Classifier endClassifier)

A foreign method for the Property that queries whether it is a non-navigable association end of a given classifier. This means that the end is association-owned and opposite to a classifier-owned end whose type is a supertype of the specified classifier.

Parameters:

associationEnd - the purported non-navigable association end

endClassifier - a classifier from which we purport to navigate the association

Returns:

true if the association-end is a non-navigable end of the classifier; false, otherwise

Since:

2.0

getAllOperations

public static org.eclipse.emf.common.util.EList<org.eclipse.uml2.uml.Operation> getAllOperations(org.eclipse.uml2.uml.Classifier classifier)

A foreign method for the Classifier that obtains all operations regardless of visibility, for OCL purposes.

Parameters:

classifier - a classifier

Returns:

all of its operations, including inheritable and non-inheritable operations (private operations of general types) except for those that are redefined

Since:

1.2