org.eclipse.sphinx.emf.scoping

Class ResourceScopeProviderRegistry

java.lang.Object

org.eclipse.sphinx.emf.scoping.ResourceScopeProviderRegistry

public class ResourceScopeProviderRegistry
extends java.lang.Object

Field Summary

Fields

Modifier and Type	Field and Description
static ResourceScopeProviderRegistry	INSTANCE The singleton instance of this registry.

Method Summary

Methods

Modifier and Type	Method and Description
IResourceScopeProvider	getDefaultResourceScopeProvider() Returns the default instance of resource scope provider.
java.util.Collection<IMetaModelDescriptor>	getMetaModelDescriptorsFor(IResourceScopeProvider resourceScopeProvider) Retrieves all the meta model descriptors registering the provided instance of resource scope provider.
IResourceScopeProvider	getResourceScopeProvider(IMetaModelDescriptor mmDescriptor) Returns the resource scope provider registered for the provided meta model descriptor.
boolean	hasApplicableFileExtension(org.eclipse.core.resources.IFile file) Tests if the given file's extension corresponds to a file type which is subject to some resource scope provider.
boolean	isNotInAnyScope(org.eclipse.core.resources.IFile file) Tests if given file does not belong to any resource scope.

Methods inherited from class java.lang.Object

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

Field Detail

INSTANCE

public static ResourceScopeProviderRegistry INSTANCE

The singleton instance of this registry.

Method Detail

getMetaModelDescriptorsFor

public java.util.Collection<IMetaModelDescriptor> getMetaModelDescriptorsFor(IResourceScopeProvider resourceScopeProvider)

Retrieves all the meta model descriptors registering the provided instance of resource scope provider.

Parameters:

resourceScopeProvider - The resource scope provider used to investigate.

Returns:

the meta model descriptors the resource scope provider is registered for.

getDefaultResourceScopeProvider

public IResourceScopeProvider getDefaultResourceScopeProvider()

Returns the default instance of resource scope provider.

Returns:

IResourceScopeProvider the default instance of resource scope provider.

isNotInAnyScope

public boolean isNotInAnyScope(org.eclipse.core.resources.IFile file)

Tests if given file does not belong to any resource scope. This can be the case if given file is an obvious non-model file (e.g., a *.txt file), a model file based on a metamodel that is not described by a metamodel descriptor, or a model file which is out of scope.

This method is guaranteed to have a very little performance overhead. It can be used by clients to optimize the retrieval of the resource scopes for large amounts of model and/or non-model files (e.g., after new files have been imported into the workspace). Clients therefore should call this method of hasApplicableFileExtension(IFile) prior to actually retrieving the resource scope for a file using getResourceScopeProvider(IMetaModelDescriptor) and IResourceScopeProvider.getScope(org.eclipse.core.resources.IResource). This makes sure that irrelevant files get filtered out in an efficient way and useless but potentially costly attempts of retrieving the resource scope for such files are avoided.

Parameters:

file - The file to be investigated.

Returns:

true if given file does not belong to any resource scope, false otherwise.

See Also:

hasApplicableFileExtension(IFile)

hasApplicableFileExtension

public boolean hasApplicableFileExtension(org.eclipse.core.resources.IFile file)

Tests if the given file's extension corresponds to a file type which is subject to some resource scope provider. This is automatically the case if given file is a model file based on a metamodel that is described by a metamodel descriptor. The applicable resource scope provider for such model files is either one that has been specifically contributed to the underlying metamodel descriptor via the org.eclipse.sphinx.emf.resourceScopeProviders extension point or a default resource scope provider.

This method is guaranteed to have a very little performance overhead. It can be used by clients to optimize the retrieval of the resource scopes for large amounts of model and/or non-model files (e.g., after new files have been imported into the workspace). Clients therefore should call this method or isNotInAnyScope(IFile) prior to actually retrieving the resource scope for a file using getResourceScopeProvider(IMetaModelDescriptor) and IResourceScopeProvider.getScope(org.eclipse.core.resources.IResource). This makes sure that irrelevant files get filtered out in an efficient way and useless but potentially costly attempts of retrieving the resource scope for such files are avoided.

Parameters:

file - The file to be investigated.

Returns:

true if some resource scope provider is applicable to files having the extension of the given file, false otherwise.

See Also:

isNotInAnyScope(IFile)

getResourceScopeProvider

public IResourceScopeProvider getResourceScopeProvider(IMetaModelDescriptor mmDescriptor)

Returns the resource scope provider registered for the provided meta model descriptor.

Parameters:

mmDescriptor - The meta model descriptor use to investigate.

Returns:

the resource scope provider registered for the provided meta model descriptor or null if none has been registered.