org.eclipse.sphinx.emf.resource

Class ScopingResourceSetImpl

java.lang.Object

org.eclipse.emf.common.notify.impl.BasicNotifierImpl

org.eclipse.emf.common.notify.impl.NotifierImpl

org.eclipse.emf.ecore.resource.impl.ResourceSetImpl

org.eclipse.sphinx.emf.resource.ExtendedResourceSetImpl

org.eclipse.sphinx.emf.resource.ScopingResourceSetImpl

All Implemented Interfaces:

org.eclipse.emf.common.notify.Notifier, org.eclipse.emf.ecore.resource.ResourceSet, ExtendedResourceSet, ScopingResourceSet

public class ScopingResourceSetImpl
extends ExtendedResourceSetImpl
implements ScopingResourceSet

A default implementation of the ScopingResourceSet interface.

Nested Class Summary

Nested classes/interfaces inherited from class org.eclipse.sphinx.emf.resource.ExtendedResourceSetImpl

ExtendedResourceSetImpl.ExtendedResourcesEList<E extends java.lang.Object & org.eclipse.emf.ecore.resource.Resource>, ExtendedResourceSetImpl.ResourceFilter

Nested classes/interfaces inherited from class org.eclipse.emf.ecore.resource.impl.ResourceSetImpl

org.eclipse.emf.ecore.resource.impl.ResourceSetImpl.MappedResourceLocator, org.eclipse.emf.ecore.resource.impl.ResourceSetImpl.ResourceLocator, org.eclipse.emf.ecore.resource.impl.ResourceSetImpl.ResourcesEList<E extends java.lang.Object & org.eclipse.emf.ecore.resource.Resource>

Nested classes/interfaces inherited from class org.eclipse.emf.common.notify.impl.BasicNotifierImpl

org.eclipse.emf.common.notify.impl.BasicNotifierImpl.EAdapterList<E extends java.lang.Object & org.eclipse.emf.common.notify.Adapter>, org.eclipse.emf.common.notify.impl.BasicNotifierImpl.EObservableAdapterList

Field Summary

Fields inherited from class org.eclipse.sphinx.emf.resource.ExtendedResourceSetImpl

contextAwareProxyURIHelper, proxyHelper

Fields inherited from class org.eclipse.emf.ecore.resource.impl.ResourceSetImpl

adapterFactories, loadOptions, packageRegistry, resourceFactoryRegistry, resourceLocator, resources, uriConverter, uriResourceMap

Fields inherited from class org.eclipse.emf.common.notify.impl.NotifierImpl

eAdapters, EDELIVER, eFlags, ELAST_NOTIFIER_FLAG

Fields inherited from interface org.eclipse.emf.ecore.resource.ResourceSet

RESOURCE_SET__RESOURCES

Constructor Summary

Constructors

Constructor and Description
ScopingResourceSetImpl() Default constructor.

Method Summary

Methods

Modifier and Type	Method and Description
protected IResourceScope	createOutsideWorkspaceScope() Creates the resource scope used to encompass all resources that are located outside of the workspace.
protected java.util.Map<IResourceScope,java.util.Set<IMetaModelDescriptor>>	getContextResourceScopes(java.lang.Object contextObject) Retrieves a map that is keyed by the resource scopes behind given context object and yields the descriptors of the metamodels using them.
protected org.eclipse.emf.ecore.EObject	getEObject(org.eclipse.emf.common.util.URI uri, IMetaModelDescriptor targetMetaModelDescriptor, java.lang.Object contextObject, boolean loadOnDemand) Retrieves the object from specified target metamodel that corresponds to given URI.
protected IResourceScope	getOutsideWorkspaceScope() Returns the resource scope used to encompass all resources that are located outside of the workspace.
java.util.List<org.eclipse.emf.ecore.resource.Resource>	getResourcesInModel(java.lang.Object contextObject) Retrieves all resources in this resourceset owned by the model containing the context object and its referenced models.
java.util.List<org.eclipse.emf.ecore.resource.Resource>	getResourcesInModel(java.lang.Object contextObject, boolean includeReferencedScopes) Retrieves all resources in this resourceset owned by the model containing the context object.
java.util.List<org.eclipse.emf.ecore.resource.Resource>	getResourcesInScope(java.lang.Object contextObject) Retrieves all resources in this resourceset owned by the resource scope containing the context object and its referenced resource scopes.
java.util.List<org.eclipse.emf.ecore.resource.Resource>	getResourcesInScope(java.lang.Object contextObject, boolean includeReferencedScopes) Retrieves all resources in this resourceset owned by the resource scope containing the context object.
protected java.util.List<org.eclipse.emf.ecore.resource.Resource>	getResourcesInScope(java.lang.Object contextObject, boolean includeReferencedScopes, boolean ignoreMetaModel) Retrieves the resources contained by this resource set that belong to the resource scope(s) behind provided contextObject.
protected java.util.List<org.eclipse.emf.ecore.resource.Resource>	getResourcesToSearchIn(org.eclipse.emf.common.util.URI uri, boolean loadOnDemand, org.eclipse.emf.ecore.EObject contextObject) Deprecated. Use ExtendedResourceSetImpl.getResourcesToSearchIn(List, URI, IMetaModelDescriptor) instead.
protected boolean	hasMatchingMetaModel(java.util.Set<IMetaModelDescriptor> mmDescriptors, org.eclipse.emf.ecore.resource.Resource resource)
boolean	isResourceInScope(org.eclipse.emf.ecore.resource.Resource resource, java.lang.Object contextObject) Tests if given resource belongs to the resource scope(s) behind provided contextObject.
boolean	isResourceInScope(org.eclipse.emf.ecore.resource.Resource resource, java.lang.Object contextObject, boolean includeReferencedScopes) Tests if given resource belongs to the resource scope(s) behind provided contextObject.
protected boolean	isResourceInScope(org.eclipse.emf.ecore.resource.Resource resource, java.lang.Object contextObject, boolean includeReferencedScopes, boolean ignoreMetaModel) Tests if given resource belongs to the resource scope(s) behind provided contextObject.

Methods inherited from class org.eclipse.sphinx.emf.resource.ExtendedResourceSetImpl

augmentToContextAwareProxy, createContextAwareURIHelper, createProxyHelper, demandCreateResource, demandLoad, getContextContainer, getDelegateResourceSet, getEObject, getEObject, getFilteredResources, getModCount, getProxyResolverService, getResource, getResources, getResourcesToSearchIn, loadModels, safeFindEObjectInResources, safeGetEObjectFromResource, safeGetResource, trimProxyContextInfo

Methods inherited from class org.eclipse.emf.ecore.resource.impl.ResourceSetImpl

createResource, createResource, delegatedGetResource, demandLoadHelper, getAdapterFactories, getAllContents, getLoadOptions, getPackageRegistry, getResourceFactoryRegistry, getURIConverter, getURIResourceMap, handleDemandLoadException, setPackageRegistry, setResourceFactoryRegistry, setURIConverter, setURIResourceMap, toString

Methods inherited from class org.eclipse.emf.common.notify.impl.NotifierImpl

eAdapters, eBasicAdapters, eDeliver, eSetDeliver

Methods inherited from class org.eclipse.emf.common.notify.impl.BasicNotifierImpl

eBasicAdapterArray, eBasicHasAdapters, eNotificationRequired, eNotify

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.eclipse.sphinx.emf.resource.ExtendedResourceSet

augmentToContextAwareProxy, getEObject, trimProxyContextInfo

Methods inherited from interface org.eclipse.emf.ecore.resource.ResourceSet

createResource, createResource, getAdapterFactories, getAllContents, getEObject, getLoadOptions, getPackageRegistry, getResource, getResourceFactoryRegistry, getResources, getURIConverter, setPackageRegistry, setResourceFactoryRegistry, setURIConverter

Methods inherited from interface org.eclipse.emf.common.notify.Notifier

eAdapters, eDeliver, eNotify, eSetDeliver

Constructor Detail

ScopingResourceSetImpl

public ScopingResourceSetImpl()

Default constructor.

Method Detail

getOutsideWorkspaceScope

protected IResourceScope getOutsideWorkspaceScope()

Returns the resource scope used to encompass all resources that are located outside of the workspace.

Returns:

The scope used to encompass all resources that are located outside of the workspace.

createOutsideWorkspaceScope

protected IResourceScope createOutsideWorkspaceScope()

Creates the resource scope used to encompass all resources that are located outside of the workspace.

Returns:

The scope used to encompass all resources that are located outside of the workspace.

getResourcesInModel

public java.util.List<org.eclipse.emf.ecore.resource.Resource> getResourcesInModel(java.lang.Object contextObject)

Description copied from interface: ScopingResourceSet

Retrieves all resources in this resourceset owned by the model containing the context object and its referenced models.

Specified by:

getResourcesInModel in interface ScopingResourceSet

Parameters:

contextObject - A context object for which a list of resources should be retrieved.

Returns:

A list of resources for the given context object.

getResourcesInModel

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

Description copied from interface: ScopingResourceSet

Retrieves all resources in this resourceset owned by the model containing the context object.

Specified by:

getResourcesInModel in interface ScopingResourceSet

Parameters:

contextObject - A context object for which a list of resources should be retrieved.

includeReferencedScopes - A boolean value that let to decide if resources must be retrieved under depending roots of the concerned model

Returns:

A list of resources for the given context object.

getResourcesInScope

public java.util.List<org.eclipse.emf.ecore.resource.Resource> getResourcesInScope(java.lang.Object contextObject)

Description copied from interface: ScopingResourceSet

Retrieves all resources in this resourceset owned by the resource scope containing the context object and its referenced resource scopes.

Specified by:

getResourcesInScope in interface ScopingResourceSet

Parameters:

contextObject - A context object for which a list of resources should be retrieved.

Returns:

getResourcesInScope

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

Description copied from interface: ScopingResourceSet

Retrieves all resources in this resourceset owned by the resource scope containing the context object.

Specified by:

getResourcesInScope in interface ScopingResourceSet

Parameters:

contextObject - A context object for which a list of resources should be retrieved.

includeReferencedScopes - A boolean value that let to decide if resources must be retrieved under depending roots of the concerned model.

Returns:

getResourcesInScope

protected java.util.List<org.eclipse.emf.ecore.resource.Resource> getResourcesInScope(java.lang.Object contextObject,
                                                                          boolean includeReferencedScopes,
                                                                          boolean ignoreMetaModel)

Retrieves the resources contained by this resource set that belong to the resource scope(s) behind provided contextObject.

Parameters:

contextObject - The context object the resource scope to refer to.

includeReferencedScopes - true if the resources of resource scopes that are referenced by the resource scope behind the context object are to be retrieved as well, false if only the resources of the resource scope behind the context object are to be retrieved.

ignoreMetaModel - true if the resources should be retrieved regardless whether their metamodel descriptor matches that behind the context object, false if the metamodel descriptors of the resources and the context object are required to match.

Returns:

The resources contained by this resource set that belong to the resource scope(s) behind provided contextObject.

isResourceInScope

public boolean isResourceInScope(org.eclipse.emf.ecore.resource.Resource resource,
                        java.lang.Object contextObject)

Description copied from interface: ScopingResourceSet

Tests if given resource belongs to the resource scope(s) behind provided contextObject.

Specified by:

isResourceInScope in interface ScopingResourceSet

Parameters:

resource - The resource to be investigated.

contextObject - The context object identifying the resource scope to refer to.

Returns:

true if given resource belongs to the resource scope behind provided contextObject, or false otherwise.

isResourceInScope

public boolean isResourceInScope(org.eclipse.emf.ecore.resource.Resource resource,
                        java.lang.Object contextObject,
                        boolean includeReferencedScopes)

Description copied from interface: ScopingResourceSet

Tests if given resource belongs to the resource scope(s) behind provided contextObject.

Specified by:

isResourceInScope in interface ScopingResourceSet

Parameters:

resource - The resource to be investigated.

contextObject - The context object identifying the resource scope to refer to.

includeReferencedScopes - true if the resource scopes that are referenced by the resource scope behind the context object are to be considered as well, false if only the resource scope behind the context object is to be considered.

Returns:

true if given resource belongs to the resource scope behind provided contextObject, or false otherwise.

isResourceInScope

protected boolean isResourceInScope(org.eclipse.emf.ecore.resource.Resource resource,
                        java.lang.Object contextObject,
                        boolean includeReferencedScopes,
                        boolean ignoreMetaModel)

Tests if given resource belongs to the resource scope(s) behind provided contextObject.

Parameters:

resource - The resource to be investigated.

contextObject - The context object identifying the resource scope to refer to.

includeReferencedScopes - true if the resource scopes that are referenced by the resource scope behind the context object are to be considered as well, false if only the resource scope behind the context object is to be considered.

ignoreMetaModel - true if the given resource should be considered to belong to the resource scope behind the context object regardless whether its metamodel descriptor matches that of the context object, false if the metamodel descriptors of the given resource and the context object are required to match.

Returns:

true if given resource belongs to the resource scope behind provided contextObject, or false otherwise.

getContextResourceScopes

protected java.util.Map<IResourceScope,java.util.Set<IMetaModelDescriptor>> getContextResourceScopes(java.lang.Object contextObject)

Retrieves a map that is keyed by the resource scopes behind given context object and yields the descriptors of the metamodels using them.

Parameters:

contextObject - The context object to retrieve the resource scopes for.

Returns:

A map containing the resource scopes behind given context object along with the descriptor of the metamodels using them.

hasMatchingMetaModel

protected boolean hasMatchingMetaModel(java.util.Set<IMetaModelDescriptor> mmDescriptors,
                           org.eclipse.emf.ecore.resource.Resource resource)

getEObject

protected org.eclipse.emf.ecore.EObject getEObject(org.eclipse.emf.common.util.URI uri,
                                       IMetaModelDescriptor targetMetaModelDescriptor,
                                       java.lang.Object contextObject,
                                       boolean loadOnDemand)

Description copied from class: ExtendedResourceSetImpl

Retrieves the object from specified target metamodel that corresponds to given URI. Uses provided to limit the search scope to the subset of resources that are in the same scope as the resource.

Overrides:

getEObject in class ExtendedResourceSetImpl

Parameters:

uri - The URI to be resolved.

targetMetaModelDescriptor - The meta model descriptor of the object that is referenced by given URI.

contextObject - The context resource that is used to limit the search scope.

loadOnDemand - Whether to load the resource or model containing the object that is referenced by given URI if it is not already loaded.

Returns:

The object that corresponds to given URI or null if given URI cannot be resolved.

getResourcesToSearchIn

@Deprecated
protected java.util.List<org.eclipse.emf.ecore.resource.Resource> getResourcesToSearchIn(org.eclipse.emf.common.util.URI uri,
                                                                                        boolean loadOnDemand,
                                                                                        org.eclipse.emf.ecore.EObject contextObject)

Deprecated. Use ExtendedResourceSetImpl.getResourcesToSearchIn(List, URI, IMetaModelDescriptor) instead.

Determines the set of resources to be considered for resolving given URI. Only called when given URI is fragment-based (i.e., has no segments and doesn't reference any explicit target resource).

This implementation uses the provided context object, if not null, to retrieve the resources in scope, and returns all resources in this resource set otherwise. Clients may override this method in order to tweak the set of resources used for resolving fragment-based URIs.

Parameters:

uri - The fragment-based URI to resolve.

loadOnDemand - Whether to create and load the target resource, if it isn't already present in this resource set.

contextObject - The context object used to determine the set of resources to be considered for resolving given fragment-based URI.

Returns:

The set of resources to be considered for resolving given fragment-based URI.

See Also:

getResourcesInScope(Object), ExtendedResourceSetImpl.getResources()