org.polarsys.capella.common.helpers

Class EcoreUtil2

java.lang.Object

org.polarsys.capella.common.helpers.EcoreUtil2

Direct Known Subclasses:

EObjectExt

public class EcoreUtil2
extends java.lang.Object

This class contains convenient static methods for working with EMF objects.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	defaultPattern

Constructor Summary

Constructors

Constructor and Description
EcoreUtil2()

Method Summary

Modifier and Type	Method and Description
static void	attachLikeSourceContainer(org.eclipse.emf.ecore.EObject srcElt, org.eclipse.emf.ecore.EObject tgtElt) Attach 'tgtElt' to the same container as 'srcElt', with the same containment feature.
static void	attachLikeSourceContainmentFeature(org.eclipse.emf.ecore.EObject srcElt, org.eclipse.emf.ecore.EObject tgtElt, org.eclipse.emf.ecore.EObject tgtContainer) Attach 'tgtElt' to its container 'tgtContainer' with the same containment feature as the one between 'srcElt' and its own container.
static java.util.Collection<?>	getAllContents(java.util.Collection<?> elements) Get all contents for given elements. Returned collection contains given elements and their subtree elements.
static org.eclipse.emf.ecore.EObject	getCommonAncestor(java.util.Collection<? extends org.eclipse.emf.ecore.EObject> list)
static org.eclipse.emf.ecore.EObject	getCommonAncestor(org.eclipse.emf.ecore.EObject e1, org.eclipse.emf.ecore.EObject e2)
static int	getContainmentLevel(org.eclipse.emf.ecore.EObject elt, org.eclipse.emf.ecore.EClass cls) This method returns the number of container to be parsed before to reach the specified class type
static org.eclipse.emf.transaction.TransactionalEditingDomain	getEditingDomain(java.util.Collection<org.eclipse.emf.ecore.EObject> elements) If all objects in elements have the same editing domain return that domain, otherwise return null.
static IFile	getFile(org.eclipse.emf.ecore.resource.Resource resource) Return the file where is persisted given EMF object.
static org.eclipse.emf.ecore.EObject	getFirstContainer(org.eclipse.emf.ecore.EObject elt, org.eclipse.emf.ecore.EClass cls) Gets the first container with the specified class type of the specified element.
static org.eclipse.emf.ecore.EObject	getFirstContainer(org.eclipse.emf.ecore.EObject elt, java.util.List<org.eclipse.emf.ecore.EClass> cls) Gets the first container with the specified class type of the specified elements.
static IProject	getProject(org.eclipse.emf.ecore.EObject eObject) Return the project where is persisted given EMF object.
static java.util.Collection<org.eclipse.emf.ecore.EObject>	getReferencingElements(org.eclipse.emf.ecore.EObject referencedElement, org.eclipse.emf.ecore.util.ECrossReferenceAdapter crossReferencer) Collect all elements that reference (containment relationships are not taken into account) given one. In fact that collects Non Navigable Inverse References for given element. Derived features are ignored too.
static org.eclipse.emf.ecore.EObject	getResourceContainer(org.eclipse.emf.ecore.EObject eObject) Get the resource container i.e the first parent container serialized in its own resource.
static org.eclipse.emf.common.util.URI	getResourceURI(org.eclipse.emf.ecore.resource.Resource resource) Get resource URI.
static java.lang.String	getUniqueName(org.eclipse.emf.ecore.EObject namedElement, org.eclipse.emf.ecore.EAttribute attribute, java.lang.String prefix, boolean space, boolean recursive)
static java.lang.String	getUniqueName(org.eclipse.emf.ecore.EObject object, org.eclipse.emf.ecore.EObject container, org.eclipse.emf.ecore.EStructuralFeature feature, org.eclipse.emf.ecore.EAttribute attribute, java.lang.String defaultString) Gets a unique name for the specified object.
static org.eclipse.emf.common.util.URI	getURI(IFile file) Returns the URI from the path (with compatible encoding for EMF.getResource(URI) method)
static boolean	isContainedBy(org.eclipse.emf.ecore.EObject eObject, java.lang.Class<?> containerClass) Is given object contained by an object which is an instance of specified container class.
static boolean	isContainedBy(org.eclipse.emf.ecore.EObject elt, org.eclipse.emf.ecore.EClass cls) Checks if the specified element container class is same as specified class.
static boolean	isContainedBy(org.eclipse.emf.ecore.EObject elt, org.eclipse.emf.ecore.EObject container) Checks if the specified element is contained by the specified container.
static boolean	isEqualOrSuperClass(org.eclipse.emf.ecore.EClass class1, org.eclipse.emf.ecore.EClass class2) Allows to know if an EClass is equal or a super class of another EClass
static boolean	isOrIsContainedBy(org.eclipse.emf.ecore.EObject elt, org.eclipse.emf.ecore.EClass cls)
static boolean	isOrIsContainedBy(org.eclipse.emf.ecore.EObject elt, org.eclipse.emf.ecore.EObject container)
static boolean	isReadOnly(org.eclipse.emf.ecore.resource.Resource resource) Is given file resource in read only ?
static void	removeContainer(org.eclipse.emf.ecore.EObject elt) Removes the element's container.

Methods inherited from class java.lang.Object

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

Field Detail

defaultPattern

public static java.lang.String defaultPattern

Constructor Detail

EcoreUtil2

public EcoreUtil2()

Method Detail

attachLikeSourceContainer

public static void attachLikeSourceContainer(org.eclipse.emf.ecore.EObject srcElt,
                                             org.eclipse.emf.ecore.EObject tgtElt)

Attach 'tgtElt' to the same container as 'srcElt', with the same containment feature.

Parameters:

srcElt -

tgtElt -

attachLikeSourceContainmentFeature

public static void attachLikeSourceContainmentFeature(org.eclipse.emf.ecore.EObject srcElt,
                                                      org.eclipse.emf.ecore.EObject tgtElt,
                                                      org.eclipse.emf.ecore.EObject tgtContainer)

Attach 'tgtElt' to its container 'tgtContainer' with the same containment feature as the one between 'srcElt' and its own container.

Parameters:

srcElt -

tgtElt -

tgtContainer -

getAllContents

public static java.util.Collection<?> getAllContents(java.util.Collection<?> elements)

Get all contents for given elements.
Returned collection contains given elements and their subtree elements.

Parameters:

elements -

Returns:

a not null collection.

getCommonAncestor

public static org.eclipse.emf.ecore.EObject getCommonAncestor(java.util.Collection<? extends org.eclipse.emf.ecore.EObject> list)

getCommonAncestor

public static org.eclipse.emf.ecore.EObject getCommonAncestor(org.eclipse.emf.ecore.EObject e1,
                                                              org.eclipse.emf.ecore.EObject e2)

Parameters:

e1 -

e2 -

Returns:

the common ancestor of e1 and e2

getContainmentLevel

public static int getContainmentLevel(org.eclipse.emf.ecore.EObject elt,
                                      org.eclipse.emf.ecore.EClass cls)

This method returns the number of container to be parsed before to reach the specified class type

Parameters:

elt -

Returns:

getFile

public static IFile getFile(org.eclipse.emf.ecore.resource.Resource resource)

Return the file where is persisted given EMF object.

Parameters:

resource -

Returns:

null if given object is not persisted.

getURI

public static org.eclipse.emf.common.util.URI getURI(IFile file)

Returns the URI from the path (with compatible encoding for EMF.getResource(URI) method)

getProject

public static IProject getProject(org.eclipse.emf.ecore.EObject eObject)

Return the project where is persisted given EMF object.

Parameters:

eObject -

Returns:

null if given object is not persisted.

getFirstContainer

public static org.eclipse.emf.ecore.EObject getFirstContainer(org.eclipse.emf.ecore.EObject elt,
                                                              org.eclipse.emf.ecore.EClass cls)

Gets the first container with the specified class type of the specified element.

Parameters:

elt - The element to check container.

cls - The expected container class.

Returns:

The corresponding container elsewhere null.

getFirstContainer

public static org.eclipse.emf.ecore.EObject getFirstContainer(org.eclipse.emf.ecore.EObject elt,
                                                              java.util.List<org.eclipse.emf.ecore.EClass> cls)

Gets the first container with the specified class type of the specified elements.

Parameters:

elt - The element to check container.

cls - The expected container classes list.

Returns:

The corresponding container elsewhere null.

getReferencingElements

public static java.util.Collection<org.eclipse.emf.ecore.EObject> getReferencingElements(org.eclipse.emf.ecore.EObject referencedElement,
                                                                                         org.eclipse.emf.ecore.util.ECrossReferenceAdapter crossReferencer)

Collect all elements that reference (containment relationships are not taken into account) given one.
In fact that collects Non Navigable Inverse References for given element.
Derived features are ignored too.

Parameters:

referencedElement -

crossReferencer - cross referencer used to retrieve referencing elements.

Returns:

a not null collection.

getResourceContainer

public static org.eclipse.emf.ecore.EObject getResourceContainer(org.eclipse.emf.ecore.EObject eObject)

Get the resource container i.e the first parent container serialized in its own resource.

Parameters:

eObject -

Returns:

should be not null.

getResourceURI

public static org.eclipse.emf.common.util.URI getResourceURI(org.eclipse.emf.ecore.resource.Resource resource)

Get resource URI.

Parameters:

resource -

Returns:

getUniqueName

public static java.lang.String getUniqueName(org.eclipse.emf.ecore.EObject namedElement,
                                             org.eclipse.emf.ecore.EAttribute attribute,
                                             java.lang.String prefix,
                                             boolean space,
                                             boolean recursive)

Parameters:

namedElement -

attribute -

prefix -

space -

recursive -

getUniqueName

public static java.lang.String getUniqueName(org.eclipse.emf.ecore.EObject object,
                                             org.eclipse.emf.ecore.EObject container,
                                             org.eclipse.emf.ecore.EStructuralFeature feature,
                                             org.eclipse.emf.ecore.EAttribute attribute,
                                             java.lang.String defaultString)

Gets a unique name for the specified object.

Parameters:

object - the object to set name.

container - the object container.

feature - the feature.

attribute - The name attribute.

defaultString - The default string.

isContainedBy

public static boolean isContainedBy(org.eclipse.emf.ecore.EObject eObject,
                                    java.lang.Class<?> containerClass)

Is given object contained by an object which is an instance of specified container class.

Parameters:

eObject - the element to check the container.

containerClass - The expected container class.

Returns:

true if the container class matches, false otherwise.

isContainedBy

public static boolean isContainedBy(org.eclipse.emf.ecore.EObject elt,
                                    org.eclipse.emf.ecore.EClass cls)

Checks if the specified element container class is same as specified class.

Parameters:

elt - the element to check the container.

cls - The expected container class.

Returns:

True if the container class is good else false.

isContainedBy

public static boolean isContainedBy(org.eclipse.emf.ecore.EObject elt,
                                    org.eclipse.emf.ecore.EObject container)

Checks if the specified element is contained by the specified container.

Parameters:

elt - the element to check.

container - The container to check.

Returns:

True if the container class is good else false.

isEqualOrSuperClass

public static boolean isEqualOrSuperClass(org.eclipse.emf.ecore.EClass class1,
                                          org.eclipse.emf.ecore.EClass class2)

Allows to know if an EClass is equal or a super class of another EClass

Parameters:

class1 - an EClass

class2 - an EClass

Returns:

true if class1 is equal to class_2 or is a super class of class_2, false otherwise.

isOrIsContainedBy

public static boolean isOrIsContainedBy(org.eclipse.emf.ecore.EObject elt,
                                        org.eclipse.emf.ecore.EClass cls)

Parameters:

elt -

cls -

Returns:

isOrIsContainedBy

public static boolean isOrIsContainedBy(org.eclipse.emf.ecore.EObject elt,
                                        org.eclipse.emf.ecore.EObject container)

Parameters:

elt -

container -

Returns:

isReadOnly

public static boolean isReadOnly(org.eclipse.emf.ecore.resource.Resource resource)

Is given file resource in read only ?

Parameters:

resource -

Returns:

false if given resource is not file-based; otherwise it depends on the underlying file.

removeContainer

public static void removeContainer(org.eclipse.emf.ecore.EObject elt)

Removes the element's container.

Parameters:

elt -

getEditingDomain

public static org.eclipse.emf.transaction.TransactionalEditingDomain getEditingDomain(java.util.Collection<org.eclipse.emf.ecore.EObject> elements)

If all objects in elements have the same editing domain return that domain, otherwise return null.

Parameters:

elements -

Returns:

the common EditingDomain for elements, or null if elements have different editing domains