org.eclipse.sphinx.emf.util

Class EcorePlatformUtil

java.lang.Object

org.eclipse.sphinx.emf.util.EcorePlatformUtil

public final class EcorePlatformUtil
extends java.lang.Object

Eclipse platform utility class.

Provides a set of methods allowing to handle resources, to load or save models, to retrieve a file from a resource (and vice-versa), etc.

Method Summary

Modifier and Type	Method and Description
static void	addNewModelResource(org.eclipse.emf.transaction.TransactionalEditingDomain editingDomain, org.eclipse.core.runtime.IPath path, java.lang.String contentTypeId, org.eclipse.emf.ecore.EObject content, boolean async, org.eclipse.core.runtime.IProgressMonitor monitor) Add a new model Resource to the provided TransactionalEditingDomain , created by using content as basis for the containing model.
static void	addNewModelResources(org.eclipse.emf.transaction.TransactionalEditingDomain editingDomain, java.util.Collection<ModelResourceDescriptor> modelResourceDescriptors, boolean async, org.eclipse.core.runtime.IProgressMonitor monitor) * Add a new resources described by modelResourceDescriptors to the provided editingDomain .
static boolean	areModelsLoaded(java.util.Collection<IModelDescriptor> modelDescriptors) Tests if the persisted files of the given collection of model Descriptors are loaded completely.
static org.eclipse.core.runtime.IPath	convertToAbsoluteFileLocation(org.eclipse.core.runtime.IPath path) Converts the given path into an absolute file location.
static org.eclipse.core.runtime.IPath	createAbsoluteFileLocation(org.eclipse.emf.common.util.URI uri) Converts the given uri into an absolute file location, i.e. into a path.
static org.eclipse.emf.common.util.URI	createAbsoluteFileURI(org.eclipse.core.runtime.IPath path) Converts the given path into an absolute file URI.
static org.eclipse.core.runtime.IPath	createPath(org.eclipse.emf.common.util.URI uri)
static org.eclipse.core.runtime.jobs.ISchedulingRule	createSaveNewSchedulingRule(java.util.Collection<ModelResourceDescriptor> modelResourceDescriptors)
static org.eclipse.core.runtime.jobs.ISchedulingRule	createSaveSchedulingRule(java.util.Collection<org.eclipse.emf.ecore.resource.Resource> resources) Creates the scheduling rule that are required for saving the specified resources.
static org.eclipse.core.runtime.jobs.ISchedulingRule	createSaveSchedulingRule(org.eclipse.emf.ecore.resource.Resource resource) Creates the scheduling rule that is required for saving the specified resource.
static org.eclipse.emf.common.util.URI	createURI(org.eclipse.core.runtime.IPath path) Converts given path into a workspace-relative platform resource URI if possible or an absolute file URI otherwise.
static org.eclipse.emf.ecore.EObject	getEObject(org.eclipse.emf.transaction.TransactionalEditingDomain editingDomain, org.eclipse.emf.common.util.URI uri) Retrieves the model object referenced by provided URI from the resource set of given editing domain.
static org.eclipse.emf.ecore.EObject	getEObject(org.eclipse.emf.common.util.URI uri) Retrieves the model object referenced by provided URI from the resource set of the editing domain the URI is mapped to.
static org.eclipse.core.resources.IFile	getFile(org.eclipse.emf.ecore.EObject eObject) Retrieves the file owning to the given EObject.
static org.eclipse.core.resources.IFile	getFile(org.eclipse.emf.ecore.util.FeatureMap.Entry entry) Retrieves the file matching the given entry.
static org.eclipse.core.resources.IFile	getFile(org.eclipse.emf.edit.provider.IWrapperItemProvider provider) Retrieves the file owning the given IWrapperItemProvider.
static org.eclipse.core.resources.IFile	getFile(java.lang.Object object) Returns the file corresponding to the specified object.
static org.eclipse.core.resources.IFile	getFile(org.eclipse.emf.ecore.resource.Resource resource) Retrieves the file corresponding to the given resource.
static org.eclipse.core.resources.IFile	getFile(TransientItemProvider provider) Retrieves the file owning the given TransientItemProvider.
static org.eclipse.core.resources.IFile	getFile(org.eclipse.emf.common.util.URI uri) Retrieves the file corresponding to the given URI.
static org.eclipse.emf.ecore.EObject	getModelRoot(org.eclipse.core.resources.IFile file) Deprecated. Use getResource(IFile) or getEObject(URI) instead.
static org.eclipse.emf.ecore.EObject	getModelRoot(org.eclipse.emf.transaction.TransactionalEditingDomain editingDomain, org.eclipse.core.resources.IFile file) Deprecated. Use getResource(IFile) or getEObject(TransactionalEditingDomain, URI) instead.
static org.eclipse.emf.ecore.resource.Resource	getResource(org.eclipse.emf.ecore.EObject eObject) Retrieves the resource corresponding to the given object.
static org.eclipse.emf.ecore.resource.Resource	getResource(org.eclipse.emf.ecore.util.FeatureMap.Entry entry) Retrieves the resource matching the given entry.
static org.eclipse.emf.ecore.resource.Resource	getResource(org.eclipse.core.resources.IFile file) Retrieves the resource corresponding to the given file.
static org.eclipse.emf.ecore.resource.Resource	getResource(org.eclipse.emf.edit.provider.IWrapperItemProvider provider) Retrieves the resource owning the given provider.
static org.eclipse.emf.ecore.resource.Resource	getResource(java.lang.Object object) Returns the resource corresponding to the specified object.
static org.eclipse.emf.ecore.resource.Resource	getResource(TransientItemProvider provider) Retrieves the resource owning the given provider.
static org.eclipse.emf.ecore.resource.Resource	getResource(org.eclipse.emf.common.util.URI uri) Returns the resource corresponding to the specified uri.
static java.util.Collection<org.eclipse.emf.ecore.resource.Resource>	getResourcesInModel(org.eclipse.emf.ecore.EObject contextEObject, boolean includeReferencedModels) Returns all resources owned by the model descriptor of the context eobject.
static java.util.Collection<org.eclipse.emf.ecore.resource.Resource>	getResourcesInModel(org.eclipse.emf.ecore.util.FeatureMap.Entry contextEntry, boolean includeReferencedModels) Returns all resources owned by the model descriptor of the context feature map entry.
static java.util.Collection<org.eclipse.emf.ecore.resource.Resource>	getResourcesInModel(org.eclipse.core.resources.IFile contextFile, boolean includeReferencedModels) Returns all resources owned by the model descriptor of the context file.
static java.util.Collection<org.eclipse.emf.ecore.resource.Resource>	getResourcesInModel(IModelDescriptor modelDescriptor, boolean includeReferencedModels) Returns all resources owned by the model descriptor provided in argument .
static java.util.Collection<org.eclipse.emf.ecore.resource.Resource>	getResourcesInModel(org.eclipse.emf.edit.provider.IWrapperItemProvider contextProvider, boolean includeReferencedModels) Returns all resources owned by the model descriptor of the context provider.
static java.util.Collection<org.eclipse.emf.ecore.resource.Resource>	getResourcesInModel(java.lang.Object contextObject, boolean includeReferencedModels) Returns all resources owned by the model descriptor of the contextObject.
static java.util.Collection<org.eclipse.emf.ecore.resource.Resource>	getResourcesInModel(org.eclipse.emf.ecore.resource.Resource contextResource, boolean includeReferencedModels) Returns all resources owned by the model descriptor of the context resource.If the given contextResource doesn't belong to any model descriptor, resources in contextResourceSet will be returned
static java.util.Collection<org.eclipse.emf.ecore.resource.Resource>	getResourcesInModel(TransientItemProvider contextProvider, boolean includeReferencedModels) Returns all resources owned by the model descriptor of the context provider.
static java.util.Collection<org.eclipse.emf.ecore.resource.Resource>	getResourcesInModel(org.eclipse.emf.common.util.URI contextURI, boolean includeReferencedModels) Returns all resources owned by the model descriptor of the context uri.
static java.util.Collection<org.eclipse.emf.ecore.resource.Resource>	getResourcesInModels(org.eclipse.core.resources.IContainer contextContainer, IMetaModelDescriptor mmDescriptor, boolean includeReferencedModels) Returns all resources owned by the models of given metamodel in the context container.
static java.util.Collection<org.eclipse.emf.ecore.resource.Resource>	getResourcesInOtherModels(org.eclipse.emf.ecore.resource.Resource contextResource, IMetaModelDescriptor otherMMDescriptor, boolean includeReferencedModels) Returns all resources owned by the model descriptors which are filtered by the other meta model descriptor.
static java.util.Collection<org.eclipse.emf.ecore.resource.Resource>	getResourcesInScope(org.eclipse.emf.ecore.EObject contextEObject, boolean includeReferencedScopes) Returns all resources owned by the model resource scope of the model descriptor of the context eObject.
static java.util.Collection<org.eclipse.emf.ecore.resource.Resource>	getResourcesInScope(org.eclipse.emf.ecore.util.FeatureMap.Entry contextEntry, boolean includeReferencedScopes) Returns all resources owned by the model resource scope of the model descriptor of the context feature map entry.
static java.util.Collection<org.eclipse.emf.ecore.resource.Resource>	getResourcesInScope(org.eclipse.core.resources.IFile contextFile, boolean includeReferencedScopes) Returns all resources owned by the model resource scope of the model descriptor of the context file.
static java.util.Collection<org.eclipse.emf.ecore.resource.Resource>	getResourcesInScope(IModelDescriptor modelDescriptor, boolean includeReferencedScopes) Returns all resources owned by the model resource scope of the model descriptor provided in argument .
static java.util.Collection<org.eclipse.emf.ecore.resource.Resource>	getResourcesInScope(org.eclipse.emf.edit.provider.IWrapperItemProvider contextProvider, boolean includeReferencedScopes) Returns all resources owned by the model resource scope of the model descriptor of the context provider.
static java.util.Collection<org.eclipse.emf.ecore.resource.Resource>	getResourcesInScope(java.lang.Object contextObject, boolean includeReferencedScopes) Returns all resources owned by the model resource scope of the contextObject.
static java.util.Collection<org.eclipse.emf.ecore.resource.Resource>	getResourcesInScope(org.eclipse.emf.ecore.resource.Resource contextResource, boolean includeReferencedScopes) Returns all resources owned by the model resource scope of the model descriptor of the context resource.If the given contextResource does not belong to any model descriptor, resources in context ResourceSet will be returned.
static java.util.Collection<org.eclipse.emf.ecore.resource.Resource>	getResourcesInScope(TransientItemProvider contextProvider, boolean includeReferencedScopes) Returns all resources owned by the model resource scope of the model descriptor of the context provider.
static java.util.Collection<org.eclipse.emf.ecore.resource.Resource>	getResourcesInScope(org.eclipse.emf.common.util.URI contextURI, boolean includeReferencedScopes) Returns all resources owned by the model resource scope of the model descriptor of the context uri.
static java.util.Collection<org.eclipse.emf.ecore.resource.Resource>	getResourcesInScopes(org.eclipse.core.resources.IContainer contextContainer, boolean includeReferencedScopes) Returns all resources owned by the model resource scopes of the model descriptors of the context container.
static boolean	isFileLoaded(org.eclipse.core.resources.IFile file) Tests if the given file is loaded in the resource set of some editingDomain.
static boolean	isFileLoaded(org.eclipse.emf.transaction.TransactionalEditingDomain editingDomain, org.eclipse.core.resources.IFile file) Tests if the given file is loaded in the resource set of the given editingDomain.
static boolean	isModelLoaded(IModelDescriptor modelDescriptor) Tests if the persisted files of the given model Descriptor are loaded completely.
static boolean	isResourceLoaded(org.eclipse.emf.transaction.TransactionalEditingDomain editingDomain, org.eclipse.emf.ecore.resource.Resource resource) Tests if the given resource is loaded in the resource set of given editingDomain.
static org.eclipse.emf.ecore.EObject	loadEObject(org.eclipse.emf.transaction.TransactionalEditingDomain editingDomain, org.eclipse.emf.common.util.URI uri) Retrieves the model object referenced by provided URI from the resource set of given editing domain.
static org.eclipse.emf.ecore.EObject	loadEObject(org.eclipse.emf.common.util.URI uri) Retrieves the model object referenced by provided URI from the resource set of the editing domain the URI is mapped to.
static void	loadModel(IModelDescriptor modelDescriptor, boolean async, org.eclipse.core.runtime.IProgressMonitor monitor) Loads all persisted resources that belong to the model specified by given modelDescriptor.
static org.eclipse.emf.ecore.EObject	loadModelRoot(org.eclipse.core.resources.IFile file) Deprecated. Use loadModelRoot(IFile, Map) instead.
static org.eclipse.emf.ecore.EObject	loadModelRoot(org.eclipse.core.resources.IFile file, java.util.Map<?,?> options) Deprecated. Use loadResource(IFile, Map) or loadEObject(URI) instead.
static org.eclipse.emf.ecore.EObject	loadModelRoot(org.eclipse.emf.transaction.TransactionalEditingDomain editingDomain, org.eclipse.core.resources.IFile file) Deprecated. Use loadModelRoot(TransactionalEditingDomain, IFile, Map) instead.
static org.eclipse.emf.ecore.EObject	loadModelRoot(org.eclipse.emf.transaction.TransactionalEditingDomain editingDomain, org.eclipse.core.resources.IFile file, java.util.Map<?,?> options) Deprecated. Use loadResource(TransactionalEditingDomain, IFile, Map) or loadEObject(TransactionalEditingDomain, URI) instead.
static void	loadModels(java.util.Collection<IModelDescriptor> modelDescriptors, boolean async, org.eclipse.core.runtime.IProgressMonitor monitor) Loads all persisted resources that belong to the models specified by given modelDescriptors.
static org.eclipse.emf.ecore.resource.Resource	loadResource(org.eclipse.core.resources.IFile file, java.util.Map<?,?> options) Loads the resource referred to by given file.
static org.eclipse.emf.ecore.resource.Resource	loadResource(org.eclipse.emf.transaction.TransactionalEditingDomain editingDomain, org.eclipse.core.resources.IFile file, java.util.Map<?,?> options) Loads the resource referred to by given file into the resource set of given editing domain.
static java.lang.String	readModelNamespace(org.eclipse.core.resources.IFile file) Reads the model namespace (i.e.
static java.util.Collection<java.lang.String>	readRootElementComments(org.eclipse.core.resources.IFile file) Retrieves the XML comments located above the root element in given file.
static java.lang.String	readTargetNamespace(org.eclipse.core.resources.IFile file) Reads the target namespace of given file.
static java.lang.String	readTargetNamespace(org.eclipse.core.resources.IFile file, java.lang.String... targetNamespaceExcludePatterns)
static org.eclipse.emf.common.util.URI	resolveURI(org.eclipse.emf.common.util.URI uri, org.eclipse.core.runtime.IPath path) Resolves given fragment-based URI against the specified path.
static void	saveModel(java.lang.Object contextObject, boolean async, org.eclipse.core.runtime.IProgressMonitor monitor) Saves all modified resources of the model behind the specified object (i.e. all resources in the context of the given object).
static void	saveModel(java.lang.Object contextObject, java.util.Map<?,?> options, boolean async, org.eclipse.core.runtime.IProgressMonitor monitor) Saves all modified, writable models from a given context object.
static void	saveNewModelResource(org.eclipse.emf.transaction.TransactionalEditingDomain editingDomain, org.eclipse.core.runtime.IPath path, java.lang.String contentTypeId, org.eclipse.emf.ecore.EObject content, boolean async, org.eclipse.core.runtime.IProgressMonitor monitor)
static void	saveNewModelResource(org.eclipse.emf.transaction.TransactionalEditingDomain editingDomain, org.eclipse.core.runtime.IPath path, java.lang.String contentTypeId, org.eclipse.emf.ecore.EObject content, java.util.Map<?,?> options, boolean async, org.eclipse.core.runtime.IProgressMonitor monitor)
static void	saveNewModelResources(org.eclipse.emf.transaction.TransactionalEditingDomain editingDomain, java.util.Collection<ModelResourceDescriptor> modelResourceDescriptors, boolean async, org.eclipse.core.runtime.IProgressMonitor monitor)
static void	saveNewModelResources(org.eclipse.emf.transaction.TransactionalEditingDomain editingDomain, java.util.Collection<ModelResourceDescriptor> modelResourceDescriptors, java.util.Map<?,?> options, boolean async, org.eclipse.core.runtime.IProgressMonitor monitor)
static void	saveProject(org.eclipse.core.resources.IProject project, boolean async, org.eclipse.core.runtime.IProgressMonitor monitor) Saves all modified resources of all models behind the specified project including all referenced projects ( i.e. all resources in the context of the given project).
static void	saveProject(org.eclipse.core.resources.IProject project, java.util.Map<?,?> options, boolean async, org.eclipse.core.runtime.IProgressMonitor monitor) Saves all modified Resources of all models behind the specified project including all referenced IProjects ( i.e. all resources in the context of the given project).
static void	unloadAllResources(org.eclipse.emf.transaction.TransactionalEditingDomain editingDomain, org.eclipse.core.runtime.IProgressMonitor monitor) Unloads all resources from given editing domain inside a read-only transaction.
static void	unloadFile(org.eclipse.core.resources.IFile file) Unloads the model contained in given file.
static void	unloadFile(org.eclipse.emf.transaction.TransactionalEditingDomain editingDomain, org.eclipse.core.resources.IFile file) Unloads the model contained in given file from given editing domain.
static void	unloadFiles(org.eclipse.emf.transaction.TransactionalEditingDomain editingDomain, java.util.Collection<org.eclipse.core.resources.IFile> files, boolean memoryOptimized, org.eclipse.core.runtime.IProgressMonitor monitor) Unloads the models contained in given files from given editing domain inside a read-only transaction.
static void	unloadResources(org.eclipse.emf.transaction.TransactionalEditingDomain editingDomain, java.util.Collection<org.eclipse.emf.ecore.resource.Resource> resources, boolean memoryOptimized, org.eclipse.core.runtime.IProgressMonitor monitor) Unloads the specified resources from given editing domain inside a read-only transaction.
static void	validate(org.eclipse.core.resources.IFile file, java.net.URL schemaURL) Parses given file and validates it against XSD schema with specified url.

Methods inherited from class java.lang.Object

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

Method Detail

createURI

public static org.eclipse.emf.common.util.URI createURI(org.eclipse.core.runtime.IPath path)

Converts given path into a workspace-relative platform resource URI if possible or an absolute file URI otherwise. Returns given IPath as indeterminate (scheme-less) URI if none of both is possible.

Parameters:

path - The path for which to create the URI; must not be null.

Returns:

Workspace-relative platform resource URI or absolute file URI for given path or given IPath as indeterminate (scheme-less) URI otherwise.

createPath

public static org.eclipse.core.runtime.IPath createPath(org.eclipse.emf.common.util.URI uri)

createAbsoluteFileURI

public static org.eclipse.emf.common.util.URI createAbsoluteFileURI(org.eclipse.core.runtime.IPath path)

Converts the given path into an absolute file URI.

Parameters:

path - The path for which an URI is to be created.

Returns:

The absolute file URI for the given path or an URI corresponding to given path as is if no conversion is possible.

createAbsoluteFileLocation

public static org.eclipse.core.runtime.IPath createAbsoluteFileLocation(org.eclipse.emf.common.util.URI uri)

Converts the given uri into an absolute file location, i.e. into a path.

Parameters:

uri - The file URI for which an absolute file location must be created.

Returns:

The absolute file location for the given file uri.

convertToAbsoluteFileLocation

public static org.eclipse.core.runtime.IPath convertToAbsoluteFileLocation(org.eclipse.core.runtime.IPath path)

Converts the given path into an absolute file location.

Parameters:

path - The file path for which an absolute file location must be created.

Returns:

The absolute file location for the given file path.

resolveURI

public static org.eclipse.emf.common.util.URI resolveURI(org.eclipse.emf.common.util.URI uri,
                                                         org.eclipse.core.runtime.IPath path)

Resolves given fragment-based URI against the specified path. Returns the given URI as is if it is not fragment-based.

A fragment-based URI is a URI that doesn't contain any information about the resource that contains the model object it refers to (e.g., hb:/#//MyComponent/MyParameterValue). By calling this method, such fragment-based URIs will be expanded to a URI that starts with the specified path and is followed by the fragment of the given URI (e.g., platform:/resource/MyProject/MyResource/#//MyComponent/MyParameterValue).

Parameters:

uri - The fragment-based URI to be resolved.

path - The path against which the fragment-based URI is to be resolved.

Returns:

The resolved URI if given URI is a fragment-based URI, or the given URI as is otherwise.

readModelNamespace

public static java.lang.String readModelNamespace(org.eclipse.core.resources.IFile file)

Reads the model namespace (i.e. XML namespace) of given file. Returns a meaningful result only if the file is an XML document.

Parameters:

file - The file to investigate.

Returns:

The model namespace denoted in the specified file or null if the file is either a non-XML file or an XML file which is not well-formed or has no model namespace.

readTargetNamespace

public static java.lang.String readTargetNamespace(org.eclipse.core.resources.IFile file)

Reads the target namespace of given file. Returns a meaningful result only if given file is an XML document.

Parameters:

file - The file to investigate.

Returns:

The target namespace denoted in given file or null if the file is either a not an XML file or an XML file which is not well-formed or has no target namespace.

readTargetNamespace

public static java.lang.String readTargetNamespace(org.eclipse.core.resources.IFile file,
                                                   java.lang.String... targetNamespaceExcludePatterns)

Parameters:

file -

targetNamespaceExcludePatterns -

Returns:

readRootElementComments

public static java.util.Collection<java.lang.String> readRootElementComments(org.eclipse.core.resources.IFile file)

Retrieves the XML comments located above the root element in given file. Returns a meaningful result only if given file is an XML document.

Parameters:

file - The file to investigate.

Returns:

Collection of strings representing the retrieved XML comments or empty collection if no such could be found.

getModelRoot

@Deprecated
public static org.eclipse.emf.ecore.EObject getModelRoot(org.eclipse.core.resources.IFile file)

Deprecated. Use getResource(IFile) or getEObject(URI) instead.

Retrieves the root object of the model contained in given file. Returns null if the file has not been loaded yet or contains no or multiple root objects.

Parameters:

file - The file containing the model.

Returns:

The root object of the model in given file or null if the file has not been loaded yet or contains no or multiple root objects.

See Also:

getModelRoot(TransactionalEditingDomain, IFile)

getModelRoot

@Deprecated
public static org.eclipse.emf.ecore.EObject getModelRoot(org.eclipse.emf.transaction.TransactionalEditingDomain editingDomain,
                                                                     org.eclipse.core.resources.IFile file)

Deprecated. Use getResource(IFile) or getEObject(TransactionalEditingDomain, URI) instead.

Retrieves the root object of the model contained in given file using given editing domain. Returns null if the file has not been loaded yet or contains no or multiple root objects.

Parameters:

editingDomain - The editing domain the specified file belongs to; must not be null.

file - The file containing the model; must not be null.

Returns:

The root object of the model in given file or null if the file has not been loaded yet or contains no or multiple root objects.

loadModelRoot

@Deprecated
public static org.eclipse.emf.ecore.EObject loadModelRoot(org.eclipse.core.resources.IFile file)

Deprecated. Use loadModelRoot(IFile, Map) instead.

Loads the model contained in given file using default load options and returns its root object. Returns null if the file is empty.

Note: Calling this method involves retrieving the editing domain behind the given file. In case that the file has not been loaded yet this is done by analyzing the its content type. However, if it happens that the file's content type is retrieved for the very first time this operation is somewhat costly in terms of runtime performance. Therefore, when the editing domain is already available prior to calling this method it is recommended to use loadModelRoot(TransactionalEditingDomain, IFile) instead.

Parameters:

file - The file containing the model.

Returns:

The root object of the model in given file or null if the file is empty.

See Also:

EcoreResourceUtil.getDefaultLoadOptions(), loadModelRoot(TransactionalEditingDomain, IFile)

loadModelRoot

@Deprecated
public static org.eclipse.emf.ecore.EObject loadModelRoot(org.eclipse.core.resources.IFile file,
                                                                      java.util.Map<?,?> options)

Deprecated. Use loadResource(IFile, Map) or loadEObject(URI) instead.

Loads the model contained in given file using given load options and returns its root object. Returns null if the file contains no or multiple root objects..

Note: Calling this method involves retrieving the editing domain behind the given file. In case that the file has not been loaded yet this is done by analyzing the its content type. However, if it happens that the file's content type is retrieved for the very first time this operation is somewhat costly in terms of runtime performance. Therefore, when the editing domain is already available prior to calling this method it is recommended to use loadModelRoot(TransactionalEditingDomain, IFile, Map) instead.

Parameters:

file - The file containing the model.

options - The options to be used for loading the model.

Returns:

The root object of the model in given file or null if the file contains no or multiple root objects.

See Also:

loadModelRoot(TransactionalEditingDomain, IFile, Map)

loadModelRoot

@Deprecated
public static org.eclipse.emf.ecore.EObject loadModelRoot(org.eclipse.emf.transaction.TransactionalEditingDomain editingDomain,
                                                                      org.eclipse.core.resources.IFile file)

Deprecated. Use loadModelRoot(TransactionalEditingDomain, IFile, Map) instead.

Loads the model contained in given file into given editing domain using default load options and returns its root object. Returns null if the file contains no or multiple root objects.

Parameters:

file - The file containing the model.

editingDomain - The editing domain the file belongs to.

options - The options to be used for loading the model.

Returns:

The root object of the model in given file or null if the file contains no or multiple root objects.

See Also:

EcoreResourceUtil.getDefaultLoadOptions()

loadModelRoot

@Deprecated
public static org.eclipse.emf.ecore.EObject loadModelRoot(org.eclipse.emf.transaction.TransactionalEditingDomain editingDomain,
                                                                      org.eclipse.core.resources.IFile file,
                                                                      java.util.Map<?,?> options)

Deprecated. Use loadResource(TransactionalEditingDomain, IFile, Map) or loadEObject(TransactionalEditingDomain, URI) instead.

Loads the model contained in given file into given editing domain using given load options and returns its root object. Returns null if the file contains no or multiple root objects.

Parameters:

file - The file containing the model; must not be null.

editingDomain - The editing domain the file belongs to; must not be null.

options - The options to be used for loading the model.

Returns:

The root object of the model in given file or null if the file contains no or multiple root objects.

getEObject

public static org.eclipse.emf.ecore.EObject getEObject(org.eclipse.emf.common.util.URI uri)

Retrieves the model object referenced by provided URI from the resource set of the editing domain the URI is mapped to. Returns null if the resource containing the model object referenced by the URI has not yet been loaded into the editing domain's resource set.

Parameters:

uri - The URI that identifies the model object to be retrieved.

Returns:

The model object referenced by provided URI or null if referenced model object does not exist in underlying resource or the latter has not yet been loaded into the editing domain's resource set.

getEObject

public static org.eclipse.emf.ecore.EObject getEObject(org.eclipse.emf.transaction.TransactionalEditingDomain editingDomain,
                                                       org.eclipse.emf.common.util.URI uri)

Retrieves the model object referenced by provided URI from the resource set of given editing domain. Returns null if the resource containing the model object referenced by the URI has not yet been loaded into the editing domain's resource set.

Parameters:

editingDomain - The editing domain from the resource set of which the model object is to be retrieved.

uri - The URI that identifies the model object to be retrieved.

Returns:

The model object from given editing domain's resource set referenced by provided URI or null if the referenced model object does not exist in underlying resource or the latter has not yet been loaded into the editing domain's resource set.

loadEObject

public static org.eclipse.emf.ecore.EObject loadEObject(org.eclipse.emf.common.util.URI uri)

Retrieves the model object referenced by provided URI from the resource set of the editing domain the URI is mapped to. Loads the resource containing the model object referenced by the URI into the editing domain's resource set if this has not yet been done.

Parameters:

uri - The URI that identifies the model object to be retrieved.

Returns:

The model object referenced by provided URI or null if referenced model object does not exist in underlying resource.

loadEObject

public static org.eclipse.emf.ecore.EObject loadEObject(org.eclipse.emf.transaction.TransactionalEditingDomain editingDomain,
                                                        org.eclipse.emf.common.util.URI uri)

Retrieves the model object referenced by provided URI from the resource set of given editing domain. Loads the resource containing the model object referenced by the URI into the editing domain's resource set if this has not yet been done.

Parameters:

editingDomain - The editing domain from the resource set of which the model object is to be retrieved.

uri - The URI that identifies the model object to be retrieved.

Returns:

The model object from given editing domain's resource set referenced by provided URI or null if referenced model object does not exist in underlying resource.

getResource

public static org.eclipse.emf.ecore.resource.Resource getResource(java.lang.Object object)

Returns the resource corresponding to the specified object.

The supported object types are:

• IFile
• URI
• Resource
• EObject
• FeatureMap.Entry
• IWrapperItemProvider

If the type of the specified object does not belongs to that list of supported types, null is returned.

Parameters:

object - The object from which a resource must be returned.

Returns:

The underlying resource from the given object.

getResource

public static org.eclipse.emf.ecore.resource.Resource getResource(org.eclipse.core.resources.IFile file)

Retrieves the resource corresponding to the given file.

Parameters:

file - The file whose resource is to be returned.

Returns:

The resource corresponding to the specified file.

getResource

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

Returns the resource corresponding to the specified uri.

Parameters:

uri - The URI of the resource to return.

Returns:

The resource corresponding to the specified uri.

getResource

public static org.eclipse.emf.ecore.resource.Resource getResource(org.eclipse.emf.ecore.EObject eObject)

Retrieves the resource corresponding to the given object.

Parameters:

eObject - The object whose resource is to be returned.

Returns:

The resource corresponding to the specified object.

getResource

public static org.eclipse.emf.ecore.resource.Resource getResource(org.eclipse.emf.edit.provider.IWrapperItemProvider provider)

Retrieves the resource owning the given provider.

First retrieves the owner of the provider; then, if owner is an EObject returns its resource, else delegates to getResource(Object).

Parameters:

provider - The IWrapperItemProvider whose resource must be returned.

Returns:

The resource containing the specified provider; null if that provider is null.

getResource

public static org.eclipse.emf.ecore.resource.Resource getResource(org.eclipse.emf.ecore.util.FeatureMap.Entry entry)

Retrieves the resource matching the given entry.

First unwraps the entry; then, delegates to getResource(Object).

Parameters:

entry - The FeatureMap.Entry whose underlying resource must be returned.

Returns:

The resource under the specified entry.

getResource

public static org.eclipse.emf.ecore.resource.Resource getResource(TransientItemProvider provider)

Retrieves the resource owning the given provider.

First retrieves the owner of the provider; then, if owner is an EObject returns its resource.

Parameters:

provider - The TransientItemProvider whose resource must be returned.

Returns:

The resource containing the specified provider; null if that provider is null.

loadResource

public static org.eclipse.emf.ecore.resource.Resource loadResource(org.eclipse.core.resources.IFile file,
                                                                   java.util.Map<?,?> options)

Loads the resource referred to by given file.

Parameters:

file - The file from which the resource is to be loaded.

options - Optional custom load options to be used for loading the resource. May be set to null if not such are needed.

Returns:

The resource referred to by given file.

See Also:

loadResource(TransactionalEditingDomain, IFile, Map)

loadResource

public static org.eclipse.emf.ecore.resource.Resource loadResource(org.eclipse.emf.transaction.TransactionalEditingDomain editingDomain,
                                                                   org.eclipse.core.resources.IFile file,
                                                                   java.util.Map<?,?> options)

Loads the resource referred to by given file into the resource set of given editing domain.

Parameters:

file - The file from which the resource is to be loaded.

editingDomain - The editing domain into the resource set of which the file is to be loaded.

options - Optional custom load options to be used for loading the resource. May be set to null if not such are needed.

Returns:

The resource referred to by given file.

See Also:

loadResource(IFile, Map)

isResourceLoaded

public static boolean isResourceLoaded(org.eclipse.emf.transaction.TransactionalEditingDomain editingDomain,
                                       org.eclipse.emf.ecore.resource.Resource resource)

Tests if the given resource is loaded in the resource set of given editingDomain.

Parameters:

editingDomain - The editing domain with the resource set to be investigated.

resource - The resource that may or not be loaded.

Returns:

true if specified resource is loaded in resource set of given editingDomain; false otherwise.

loadModel

public static void loadModel(IModelDescriptor modelDescriptor,
                             boolean async,
                             org.eclipse.core.runtime.IProgressMonitor monitor)

Loads all persisted resources that belong to the model specified by given modelDescriptor.

Parameters:

modelDescriptors - The model whose resources are to be loaded.

async - true if this operation is required to be run asynchronously, or false if synchronous execution is desired.

monitor - A progress monitor, or null if progress reporting is not desired.

loadModels

public static void loadModels(java.util.Collection<IModelDescriptor> modelDescriptors,
                              boolean async,
                              org.eclipse.core.runtime.IProgressMonitor monitor)

Loads all persisted resources that belong to the models specified by given modelDescriptors.

Parameters:

modelDescriptors - The collection of models whose resources are to be loaded.

async - true if this operation is required to be run asynchronously, or false if synchronous execution is desired.

monitor - A progress monitor, or null if progress reporting is not desired.

isModelLoaded

public static boolean isModelLoaded(IModelDescriptor modelDescriptor)

Tests if the persisted files of the given model Descriptor are loaded completely.

Parameters:

modelDescriptor - The model Descriptor that may or not be loaded.

Returns:

true if the persisted files of the specified model Descriptor are all loaded; false otherwise.

areModelsLoaded

public static boolean areModelsLoaded(java.util.Collection<IModelDescriptor> modelDescriptors)

Tests if the persisted files of the given collection of model Descriptors are loaded completely.

Parameters:

modelDescriptors - The collection of model Descriptors that may or not be loaded.

Returns:

true if the persisted files of the specified collection of model Descriptors are all loaded; false otherwise.

getFile

public static org.eclipse.core.resources.IFile getFile(java.lang.Object object)

Returns the file corresponding to the specified object.

The supported object types are:

• IFile
• URI
• Resource
• EObject
• IWrapperItemProvider
• FeatureMap.Entry

Parameters:

object - The object from which a file must be returned.

Returns:

The underlying file from the given object.

getFile

public static org.eclipse.core.resources.IFile getFile(org.eclipse.emf.common.util.URI uri)

Retrieves the file corresponding to the given URI.

Parameters:

uri - The URI of the file to return.

Returns:

The file corresponding to the specified uri.

getFile

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

Retrieves the file corresponding to the given resource.

Parameters:

resource - The resource for which the file is to be returned.

Returns:

The file corresponding to the specified resource.

getFile

public static org.eclipse.core.resources.IFile getFile(org.eclipse.emf.ecore.EObject eObject)

Retrieves the file owning to the given EObject.

Parameters:

eObject - The EObject whose file must be returned.

Returns:

The file containing the specified eObject.

getFile

public static org.eclipse.core.resources.IFile getFile(org.eclipse.emf.edit.provider.IWrapperItemProvider provider)

Retrieves the file owning the given IWrapperItemProvider.

First retrieves the owner of the provider; then, if owner is an EObject delegates to getFile(EObject) else delegates to getFile(Object).

Parameters:

provider - The IWrapperItemProvider whose file must be returned.

Returns:

The file containing the specified provider; null if that provider is null.

getFile

public static org.eclipse.core.resources.IFile getFile(org.eclipse.emf.ecore.util.FeatureMap.Entry entry)

Retrieves the file matching the given entry.

First unwraps the entry; then, delegates to getFile(Object).

Parameters:

entry - The FeatureMap.Entry whose underlying file must be returned.

Returns:

The file under the specified entry.

getFile

public static org.eclipse.core.resources.IFile getFile(TransientItemProvider provider)

Retrieves the file owning the given TransientItemProvider.

First retrieves the owner of the provider; then, if owner is an EObject delegates to getFile(EObject) else delegates to getFile(Object).

Parameters:

provider - The TransientItemProvider whose file must be returned.

Returns:

The file containing the specified provider; null if that provider is null.

isFileLoaded

public static boolean isFileLoaded(org.eclipse.core.resources.IFile file)

Tests if the given file is loaded in the resource set of some editingDomain.

Parameters:

file - The file that may or not be loaded.

Returns:

true if specified file is loaded in resource set of some editingDomain; false otherwise.

isFileLoaded

public static boolean isFileLoaded(org.eclipse.emf.transaction.TransactionalEditingDomain editingDomain,
                                   org.eclipse.core.resources.IFile file)

Tests if the given file is loaded in the resource set of the given editingDomain.

Parameters:

editingDomain - The editing domain with the resource set to be investigated.

file - The file that may or not be loaded.

Returns:

true if specified file is loaded in resource set of given editingDomain; false otherwise.

getResourcesInModel

public static java.util.Collection<org.eclipse.emf.ecore.resource.Resource> getResourcesInModel(java.lang.Object contextObject,
                                                                                                boolean includeReferencedModels)

Returns all resources owned by the model descriptor of the contextObject.

Parameters:

contextObject - The Object used to research resources in the model.

includeReferencedModels - Determines if the model descriptors referenced by the context object's model descriptor must be considered for the research.

Returns:

The resources in the context object's model.

Since:

0.7.0

getResourcesInModel

public static java.util.Collection<org.eclipse.emf.ecore.resource.Resource> getResourcesInModel(IModelDescriptor modelDescriptor,
                                                                                                boolean includeReferencedModels)

Returns all resources owned by the model descriptor provided in argument .

Parameters:

modelDescriptor - The model descriptor used as context object for investigation.

includeReferencedModels - Determines if the model descriptors referenced by the context model descriptor must be considered for the research.

Returns:

The resources owned by the model descriptor.

Since:

0.7.0

getResourcesInModel

public static java.util.Collection<org.eclipse.emf.ecore.resource.Resource> getResourcesInModel(org.eclipse.core.resources.IFile contextFile,
                                                                                                boolean includeReferencedModels)

Returns all resources owned by the model descriptor of the context file. If the given file doesn't belong to any model descriptor, resources in contextResourceSet will be returned

Parameters:

contextFile - The file used as context object for investigation.

includeReferencedModels - Determines if the model descriptors referenced by the context file's model descriptor must be considered for the research.

Returns:

The resources in the context file's model.

Since:

0.7.0

getResourcesInModel

public static java.util.Collection<org.eclipse.emf.ecore.resource.Resource> getResourcesInModel(org.eclipse.emf.common.util.URI contextURI,
                                                                                                boolean includeReferencedModels)

Returns all resources owned by the model descriptor of the context uri.

Parameters:

contextURI - The uri used as context object for investigation.

includeReferencedModels - Determines if the model descriptors referenced by the context uri 's model descriptor must be considered for the research.

Returns:

The resources in the context uri's model.

Since:

0.7.0

getResourcesInModel

public static java.util.Collection<org.eclipse.emf.ecore.resource.Resource> getResourcesInModel(org.eclipse.emf.ecore.resource.Resource contextResource,
                                                                                                boolean includeReferencedModels)

Returns all resources owned by the model descriptor of the context resource.If the given contextResource doesn't belong to any model descriptor, resources in contextResourceSet will be returned

Parameters:

contextResource - The resource used as context object for investigation.

includeReferencedModels - Determines if the model descriptors referenced by the context resource 's model descriptor must be considered for the research.

Returns:

The resources in the context resource's model.

Since:

0.7.0

getResourcesInModel

public static java.util.Collection<org.eclipse.emf.ecore.resource.Resource> getResourcesInModel(org.eclipse.emf.ecore.EObject contextEObject,
                                                                                                boolean includeReferencedModels)

Returns all resources owned by the model descriptor of the context eobject.

Parameters:

contextEObject - The eobject used as context object for investigation.

includeReferencedModels - Determines if the model descriptors referenced by the context eobject's model descriptor must be considered for the research.

Returns:

The resources in the context eobject's model.

Since:

0.7.0

getResourcesInModel

public static java.util.Collection<org.eclipse.emf.ecore.resource.Resource> getResourcesInModel(org.eclipse.emf.edit.provider.IWrapperItemProvider contextProvider,
                                                                                                boolean includeReferencedModels)

Returns all resources owned by the model descriptor of the context provider.

Parameters:

contextProvider - The provider used as context object for investigation.

includeReferencedModels - Determines if the model descriptors referenced by the context provider's model descriptor must be considered for the research.

Returns:

The resources in the context provider's model.

Since:

0.7.0

getResourcesInModel

public static java.util.Collection<org.eclipse.emf.ecore.resource.Resource> getResourcesInModel(org.eclipse.emf.ecore.util.FeatureMap.Entry contextEntry,
                                                                                                boolean includeReferencedModels)

Returns all resources owned by the model descriptor of the context feature map entry.

Parameters:

contextEntry - The feature map entry used as context object for investigation.

includeReferencedModels - Determines if the model descriptors referenced by the context feature map entry's model descriptor must be considered for the research.

Returns:

The resources in the context feature map entry's model.

Since:

0.7.0

getResourcesInModel

public static java.util.Collection<org.eclipse.emf.ecore.resource.Resource> getResourcesInModel(TransientItemProvider contextProvider,
                                                                                                boolean includeReferencedModels)

Returns all resources owned by the model descriptor of the context provider.

Parameters:

contextProvider - The provider used as context object for investigation.

includeReferencedModels - Determines if the model descriptors referenced by the context provider's model descriptor must be considered for the research.

Returns:

The resources in the context provider's model.

Since:

2.1

getResourcesInModels

public static java.util.Collection<org.eclipse.emf.ecore.resource.Resource> getResourcesInModels(org.eclipse.core.resources.IContainer contextContainer,
                                                                                                 IMetaModelDescriptor mmDescriptor,
                                                                                                 boolean includeReferencedModels)

Returns all resources owned by the models of given metamodel in the context container.

Parameters:

contextContainer - The container used as context object for investigation.

includeReferencedModels - Determines if the model descriptors referenced by the context container's model descriptor must be considered for the research.

Returns:

The resources in the context container's models.

Since:

0.7.0

getResourcesInOtherModels

public static java.util.Collection<org.eclipse.emf.ecore.resource.Resource> getResourcesInOtherModels(org.eclipse.emf.ecore.resource.Resource contextResource,
                                                                                                      IMetaModelDescriptor otherMMDescriptor,
                                                                                                      boolean includeReferencedModels)

Returns all resources owned by the model descriptors which are filtered by the other meta model descriptor. These resources reside in the models other than the model of the context resource resides.

Parameters:

contextResource - The resource used as context object for investigation.

otherMMDescriptor - The target meta model descriptor

includeReferencedModels - Determines if the model resource scopes referenced by the context resource's model resource scope must be considered for the research.

getResourcesInScope

public static java.util.Collection<org.eclipse.emf.ecore.resource.Resource> getResourcesInScope(java.lang.Object contextObject,
                                                                                                boolean includeReferencedScopes)

Returns all resources owned by the model resource scope of the contextObject.

Parameters:

contextObject - The Object used to research resources in the model.

includeReferencedScopes - Determines if the model resource scope referenced by the context object's model resource scope must be considered for the research.

Returns:

The resources in the context object's model resource scope.

Since:

0.7.0

getResourcesInScope

public static java.util.Collection<org.eclipse.emf.ecore.resource.Resource> getResourcesInScope(IModelDescriptor modelDescriptor,
                                                                                                boolean includeReferencedScopes)

Returns all resources owned by the model resource scope of the model descriptor provided in argument .

Parameters:

modelDescriptor - The model descriptor used as context object for investigation.

includeReferencedModels - Determines if the model resource scopes referenced by the context model resource scope must be considered for the research.

Returns:

The resources owned by the model resource scope.

Since:

0.7.0

getResourcesInScope

public static java.util.Collection<org.eclipse.emf.ecore.resource.Resource> getResourcesInScope(org.eclipse.core.resources.IFile contextFile,
                                                                                                boolean includeReferencedScopes)

Returns all resources owned by the model resource scope of the model descriptor of the context file. If the given file does not belong to any model descriptor, resources in context ResourceSet will be returned.

Parameters:

contextFile - The file used as context object for investigation.

includeReferencedModels - Determines if the model resource scopes referenced by the context file's model resource scope must be considered for the research.

Returns:

The resources in the context file's model resource scope.

Since:

0.7.0

getResourcesInScope

public static java.util.Collection<org.eclipse.emf.ecore.resource.Resource> getResourcesInScope(org.eclipse.emf.common.util.URI contextURI,
                                                                                                boolean includeReferencedScopes)

Returns all resources owned by the model resource scope of the model descriptor of the context uri.

Parameters:

contextURI - The uri used as context object for investigation.

includeReferencedModels - Determines if the model resource scopes referenced by the context uri's model resource scope must be considered for the research.

Returns:

The resources in the context uri's model resource scope.

Since:

0.7.0

getResourcesInScope

public static java.util.Collection<org.eclipse.emf.ecore.resource.Resource> getResourcesInScope(org.eclipse.emf.ecore.resource.Resource contextResource,
                                                                                                boolean includeReferencedScopes)

Returns all resources owned by the model resource scope of the model descriptor of the context resource.If the given contextResource does not belong to any model descriptor, resources in context ResourceSet will be returned.

Parameters:

contextResource - The resource used as context object for investigation.

includeReferencedModels - Determines if the model resource scopes referenced by the context resource's model resource scope must be considered for the research.

Returns:

The resources in the context resource's model resource scope.

Since:

0.7.0

getResourcesInScope

public static java.util.Collection<org.eclipse.emf.ecore.resource.Resource> getResourcesInScope(org.eclipse.emf.ecore.EObject contextEObject,
                                                                                                boolean includeReferencedScopes)

Returns all resources owned by the model resource scope of the model descriptor of the context eObject.

Parameters:

contextEObject - The eObject used as context object for investigation.

includeReferencedModels - Determines if the model resource scopes referenced by the context eObject's model resource scope must be considered for the research.

Returns:

The resources in the context eObject's model resource scope.

Since:

0.7.0

getResourcesInScope

public static java.util.Collection<org.eclipse.emf.ecore.resource.Resource> getResourcesInScope(org.eclipse.emf.edit.provider.IWrapperItemProvider contextProvider,
                                                                                                boolean includeReferencedScopes)

Returns all resources owned by the model resource scope of the model descriptor of the context provider.

Parameters:

contextProvider - The provider used as context object for investigation.

includeReferencedModels - Determines if the model resource scopes referenced by the context provider's model resource scope must be considered for the research.

Returns:

The resources in the context provider's model resource scope.

Since:

0.7.0

getResourcesInScope

public static java.util.Collection<org.eclipse.emf.ecore.resource.Resource> getResourcesInScope(org.eclipse.emf.ecore.util.FeatureMap.Entry contextEntry,
                                                                                                boolean includeReferencedScopes)

Returns all resources owned by the model resource scope of the model descriptor of the context feature map entry.

Parameters:

contextEntry - The feature map entry used as context object for investigation.

includeReferencedModels - Determines if the model resource scopes referenced by the context feature map entry's model resource scope must be considered for the research.

Returns:

The resources in the context feature map entry's model resource scope.

Since:

0.7.0

getResourcesInScope

public static java.util.Collection<org.eclipse.emf.ecore.resource.Resource> getResourcesInScope(TransientItemProvider contextProvider,
                                                                                                boolean includeReferencedScopes)

Returns all resources owned by the model resource scope of the model descriptor of the context provider.

Parameters:

contextProvider - The provider used as context object for investigation.

includeReferencedModels - Determines if the model resource scopes referenced by the context provider's model resource scope must be considered for the research.

Returns:

The resources in the context provider's model resource scope.

Since:

2.1

getResourcesInScopes

public static java.util.Collection<org.eclipse.emf.ecore.resource.Resource> getResourcesInScopes(org.eclipse.core.resources.IContainer contextContainer,
                                                                                                 boolean includeReferencedScopes)

Returns all resources owned by the model resource scopes of the model descriptors of the context container.

Parameters:

contextContainer - The container used as context object for investigation.

includeReferencedModels - Determines if the model resource scopes referenced by the context container's model resource scope must be considered for the research.

Returns:

The resources in the context container's model resource scope.

Since:

0.7.0

createSaveNewSchedulingRule

public static org.eclipse.core.runtime.jobs.ISchedulingRule createSaveNewSchedulingRule(java.util.Collection<ModelResourceDescriptor> modelResourceDescriptors)

createSaveSchedulingRule

public static org.eclipse.core.runtime.jobs.ISchedulingRule createSaveSchedulingRule(org.eclipse.emf.ecore.resource.Resource resource)

Creates the scheduling rule that is required for saving the specified resource.

Parameters:

resource - The resource to be saved.

Returns:

The scheduling rule required for saving the given resource.

createSaveSchedulingRule

public static org.eclipse.core.runtime.jobs.ISchedulingRule createSaveSchedulingRule(java.util.Collection<org.eclipse.emf.ecore.resource.Resource> resources)

Creates the scheduling rule that are required for saving the specified resources.

Parameters:

resources - The resources to be saved (for which scheduling rules must be created.

Returns:

The scheduling rules required for saving the given resources.

addNewModelResource

public static void addNewModelResource(org.eclipse.emf.transaction.TransactionalEditingDomain editingDomain,
                                       org.eclipse.core.runtime.IPath path,
                                       java.lang.String contentTypeId,
                                       org.eclipse.emf.ecore.EObject content,
                                       boolean async,
                                       org.eclipse.core.runtime.IProgressMonitor monitor)

Add a new model Resource to the provided TransactionalEditingDomain , created by using content as basis for the containing model.

Parameters:

editingDomain - The TransactionalEditingDomain where to add new resource.

path - The relative IPath of the new Resource.

contentTypeId - The contenType ID of the contained model.

content - The root element of the model to include in the new Resource.

async - Boolean parameter to determine if the execution must be synchronous or asynchronous.

monitor - The IProgressMonitor.

addNewModelResources

public static void addNewModelResources(org.eclipse.emf.transaction.TransactionalEditingDomain editingDomain,
                                        java.util.Collection<ModelResourceDescriptor> modelResourceDescriptors,
                                        boolean async,
                                        org.eclipse.core.runtime.IProgressMonitor monitor)

* Add a new resources described by modelResourceDescriptors to the provided editingDomain .

Parameters:

editingDomain - The TransactionalEditingDomain where to add new resource.

modelResourceDescriptors - The list of ModelResourceDescriptor describing new resources to add.

async - Boolean parameter to determine if the execution must be synchronous or asynchronous.

monitor - The IProgressMonitor.

saveNewModelResource

public static void saveNewModelResource(org.eclipse.emf.transaction.TransactionalEditingDomain editingDomain,
                                        org.eclipse.core.runtime.IPath path,
                                        java.lang.String contentTypeId,
                                        org.eclipse.emf.ecore.EObject content,
                                        boolean async,
                                        org.eclipse.core.runtime.IProgressMonitor monitor)

saveNewModelResources

public static void saveNewModelResources(org.eclipse.emf.transaction.TransactionalEditingDomain editingDomain,
                                         java.util.Collection<ModelResourceDescriptor> modelResourceDescriptors,
                                         boolean async,
                                         org.eclipse.core.runtime.IProgressMonitor monitor)

saveNewModelResource

public static void saveNewModelResource(org.eclipse.emf.transaction.TransactionalEditingDomain editingDomain,
                                        org.eclipse.core.runtime.IPath path,
                                        java.lang.String contentTypeId,
                                        org.eclipse.emf.ecore.EObject content,
                                        java.util.Map<?,?> options,
                                        boolean async,
                                        org.eclipse.core.runtime.IProgressMonitor monitor)

saveNewModelResources

public static void saveNewModelResources(org.eclipse.emf.transaction.TransactionalEditingDomain editingDomain,
                                         java.util.Collection<ModelResourceDescriptor> modelResourceDescriptors,
                                         java.util.Map<?,?> options,
                                         boolean async,
                                         org.eclipse.core.runtime.IProgressMonitor monitor)

saveModel

public static void saveModel(java.lang.Object contextObject,
                             boolean async,
                             org.eclipse.core.runtime.IProgressMonitor monitor)

Saves all modified resources of the model behind the specified object (i.e. all resources in the context of the given object).

Parameters:

contextResource - The object resource identifying the model to save.

async - If true, model will be saved within a workspace job.

monitor - The progress monitor to use for showing save process progress.

saveModel

public static void saveModel(java.lang.Object contextObject,
                             java.util.Map<?,?> options,
                             boolean async,
                             org.eclipse.core.runtime.IProgressMonitor monitor)

Saves all modified, writable models from a given context object.

Parameters:

contextObject - The object context identifying the models to save.

options - The save options.

async - When passing true the model will be saved within a workspace job.

monitor - The progress monitor to use for showing save process progress.

saveProject

public static void saveProject(org.eclipse.core.resources.IProject project,
                               boolean async,
                               org.eclipse.core.runtime.IProgressMonitor monitor)

Saves all modified resources of all models behind the specified project including all referenced projects ( i.e. all resources in the context of the given project).

Parameters:

project - The project identifying the models to save.

async - If true, models will be saved within a workspace job.

monitor - The progress monitor to use for showing save process progress.

saveProject

public static void saveProject(org.eclipse.core.resources.IProject project,
                               java.util.Map<?,?> options,
                               boolean async,
                               org.eclipse.core.runtime.IProgressMonitor monitor)

Saves all modified Resources of all models behind the specified project including all referenced IProjects ( i.e. all resources in the context of the given project).

Parameters:

project - The project identifying the models to save.

options - The save options.

async - If true, models will be saved within a workspace job.

monitor - The progress monitor to use for showing save process progress.

unloadFile

public static void unloadFile(org.eclipse.core.resources.IFile file)

Unloads the model contained in given file.

Parameters:

file - The file containing the model.

See Also:

unloadFile(TransactionalEditingDomain, IFile)

unloadFile

public static void unloadFile(org.eclipse.emf.transaction.TransactionalEditingDomain editingDomain,
                              org.eclipse.core.resources.IFile file)

Unloads the model contained in given file from given editing domain.

Parameters:

file - The file containing the model.

editingDomain - The editing domain the file belongs to.

unloadFiles

public static void unloadFiles(org.eclipse.emf.transaction.TransactionalEditingDomain editingDomain,
                               java.util.Collection<org.eclipse.core.resources.IFile> files,
                               boolean memoryOptimized,
                               org.eclipse.core.runtime.IProgressMonitor monitor)
                        throws org.eclipse.core.runtime.OperationCanceledException

Unloads the models contained in given files from given editing domain inside a read-only transaction.

Parameters:

files - The files containing the models.

editingDomain - The editing domain the files belong to.

Throws:

org.eclipse.core.runtime.OperationCanceledException

Since:

0.7.0

unloadResources

public static void unloadResources(org.eclipse.emf.transaction.TransactionalEditingDomain editingDomain,
                                   java.util.Collection<org.eclipse.emf.ecore.resource.Resource> resources,
                                   boolean memoryOptimized,
                                   org.eclipse.core.runtime.IProgressMonitor monitor)
                            throws org.eclipse.core.runtime.OperationCanceledException

Unloads the specified resources from given editing domain inside a read-only transaction.

Parameters:

memoryOptimized -

resources - The resources to unload.

editingDomain - The editing domain owning resources.

Throws:

org.eclipse.core.runtime.OperationCanceledException

Since:

0.7.0

unloadAllResources

public static void unloadAllResources(org.eclipse.emf.transaction.TransactionalEditingDomain editingDomain,
                                      org.eclipse.core.runtime.IProgressMonitor monitor)
                               throws org.eclipse.core.runtime.OperationCanceledException

Unloads all resources from given editing domain inside a read-only transaction.

Parameters:

editingDomain - The editing domain owning resources.

Throws:

org.eclipse.core.runtime.OperationCanceledException

validate

public static void validate(org.eclipse.core.resources.IFile file,
                            java.net.URL schemaURL)
                     throws org.xml.sax.SAXException,
                            java.io.IOException

Parses given file and validates it against XSD schema with specified url. Raises an exception if the file's content is not compliant with respect to XSD schema.

Parameters:

file - The file to be validated.

schemaURL - The url of the XSD schema to be used for validation.

Throws:

org.xml.sax.SAXException

java.io.IOException