org.eclipse.sphinx.emf.metamodel

Class MetaModelDescriptorRegistry

java.lang.Object

org.eclipse.sphinx.emf.metamodel.MetaModelDescriptorRegistry

All Implemented Interfaces:

org.eclipse.core.runtime.IAdaptable

public class MetaModelDescriptorRegistry
extends java.lang.Object
implements org.eclipse.core.runtime.IAdaptable

Field Summary

Fields

Modifier and Type	Field and Description
static IMetaModelDescriptor	ANY_MM A default meta-model descriptor for any type of meta model.
static MetaModelDescriptorRegistry	INSTANCE The singleton instance of this registry.
static IMetaModelDescriptor	NO_MM A default meta-model descriptor for no meta model.

Method Summary

Methods

Modifier and Type	Method and Description
void	addDescriptor(IMetaModelDescriptor mmDescriptor) Add the specified mmDescriptor to this registry (if not already added).
protected IMetaModelDescriptor	createDescriptor(org.eclipse.emf.ecore.EPackage ePackage)
java.lang.Object	getAdapter(java.lang.Class adapterType)
IMetaModelDescriptor	getDescriptor(java.lang.Class<?> clazz) Deprecated. It is not recommended use this method because the metamodel descriptor retrieval strategy implemented here has the side effect of that it triggers a full initialization of all EPackages behind potentially all metamodel descriptors. This can have significant impact on runtime performance and may cause that the EPackages of metamodels become initialized even though not a single instance of these metamodels exists in the workspace.
IMetaModelDescriptor	getDescriptor(org.eclipse.emf.ecore.EClass eClass)
IMetaModelDescriptor	getDescriptor(org.eclipse.emf.ecore.EClassifier eClassifier)
IMetaModelDescriptor	getDescriptor(org.eclipse.emf.ecore.EObject eObject)
IMetaModelDescriptor	getDescriptor(org.eclipse.emf.ecore.EPackage ePackage)
IMetaModelDescriptor	getDescriptor(org.eclipse.emf.ecore.util.FeatureMap.Entry entry)
IMetaModelDescriptor	getDescriptor(org.eclipse.core.resources.IFile file) Returns the meta-model descriptor for given file.
IMetaModelDescriptor	getDescriptor(org.eclipse.emf.edit.provider.IWrapperItemProvider wrapperItemProvider)
IMetaModelDescriptor	getDescriptor(java.lang.Object object)
IMetaModelDescriptor	getDescriptor(org.eclipse.emf.ecore.resource.Resource resource) Returns the meta-model descriptor for the given resource.
IMetaModelDescriptor	getDescriptor(java.lang.String identifier)
<T extends IMetaModelDescriptor> T	getDescriptor(T mmDescriptor, int ordinal) Deprecated. see MetaModelVersionData.getOrdinal()
IMetaModelDescriptor	getDescriptor(TransientItemProvider transientItemProvider)
<T extends IMetaModelDescriptor> T	getDescriptor(T mmDescriptor, java.lang.String name)
IMetaModelDescriptor	getDescriptor(java.net.URI namespaceURI)
java.util.List<IMetaModelDescriptor>	getDescriptors(java.lang.String idPattern)
<T extends IMetaModelDescriptor> java.util.List<T>	getDescriptors(T mmDescriptor)
<T extends IMetaModelDescriptor> java.util.List<T>	getDescriptors(T mmDescriptor, boolean sorted) Used in UI component to return a list of sorted descriptors.
java.util.List<IMetaModelDescriptor>	getDescriptorsFromURIScheme(java.lang.String scheme) Returns the descriptors of all meta-models that use URIs with given customURIScheme in cross-document references and as proxy URIs.
IMetaModelDescriptor	getEffectiveDescriptor(org.eclipse.core.resources.IFile file) Retrieves meta-model descriptor behind the given file which will be eventually effective or relevant to clients.
IMetaModelDescriptor	getEffectiveDescriptor(org.eclipse.emf.ecore.resource.Resource resource) Retrieves meta-model descriptor behind the given resource which will be eventually effective or relevant to clients.
java.util.Collection<java.lang.String>	getFileExtensionsAssociatedWithTargetDescriptors() Deprecated. use isContentTypeOfTargetDescriptorsApplicable(IFile) instead
IMetaModelDescriptor	getOldDescriptor(org.eclipse.core.resources.IFile file) Returns the old meta-model descriptor which given file had had before is was changed or deleted.
IMetaModelDescriptor	getOldDescriptor(org.eclipse.emf.ecore.resource.Resource resource) Returns the old meta-model descriptor which given resource had had before is was changed or deleted.
java.util.List<IMetaModelDescriptor>	getResolvedDescriptors(IMetaModelDescriptor mmDescriptor)
IMetaModelDescriptor	getResourceVersionDescriptor(org.eclipse.emf.ecore.resource.Resource resource) Returns a descriptor describing the version of specified resource.
IMetaModelDescriptor	getTargetDescriptor(org.eclipse.core.resources.IFile file) Retrieves target meta-model descriptor behind the given file.
IMetaModelDescriptor	getTargetDescriptor(org.eclipse.emf.ecore.resource.Resource resource) Retrieves target meta-model descriptor behind the given resource.
boolean	isContentTypeOfTargetDescriptorsApplicable(org.eclipse.core.resources.IFile file) Returns true if the extension of the passed in file matches any extension of all file types which are associated with a target meta-model descriptor.
void	setExtensionRegistry(org.eclipse.core.runtime.IExtensionRegistry extensionRegistry)

Methods inherited from class java.lang.Object

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

Field Detail

INSTANCE

public static final MetaModelDescriptorRegistry INSTANCE

The singleton instance of this registry.

ANY_MM

public static final IMetaModelDescriptor ANY_MM

A default meta-model descriptor for any type of meta model.

NO_MM

public static final IMetaModelDescriptor NO_MM

A default meta-model descriptor for no meta model.

Method Detail

setExtensionRegistry

public void setExtensionRegistry(org.eclipse.core.runtime.IExtensionRegistry extensionRegistry)

createDescriptor

protected IMetaModelDescriptor createDescriptor(org.eclipse.emf.ecore.EPackage ePackage)

addDescriptor

public void addDescriptor(IMetaModelDescriptor mmDescriptor)

Add the specified mmDescriptor to this registry (if not already added).

Parameters:

mmDescriptor - The meta-model descriptor to add to this registry.

getAdapter

public java.lang.Object getAdapter(java.lang.Class adapterType)

Specified by:

getAdapter in interface org.eclipse.core.runtime.IAdaptable

getResolvedDescriptors

public java.util.List<IMetaModelDescriptor> getResolvedDescriptors(IMetaModelDescriptor mmDescriptor)

Parameters:

mmDescriptor -

Returns:

getDescriptor

public IMetaModelDescriptor getDescriptor(java.lang.Object object)

getDescriptors

public <T extends IMetaModelDescriptor> java.util.List<T> getDescriptors(T mmDescriptor,
                                                                boolean sorted)

Used in UI component to return a list of sorted descriptors.

Parameters:

mmDescriptor -

Returns:

Since:

0.7.0

getDescriptors

public <T extends IMetaModelDescriptor> java.util.List<T> getDescriptors(T mmDescriptor)

Parameters:

mmDescriptor -

Returns:

getDescriptor

public IMetaModelDescriptor getDescriptor(java.lang.String identifier)

Parameters:

identifier - A meta-model descriptor identifier.

Returns:

The meta-model descriptor contributed with the specified identifier.

getDescriptors

public java.util.List<IMetaModelDescriptor> getDescriptors(java.lang.String idPattern)

Parameters:

idPattern - A regular expression which the identifiers of the returned meta-model descriptors must match.

Returns:

Meta-model descriptors whose identifier matches the specified regular expression.

getDescriptorsFromURIScheme

public java.util.List<IMetaModelDescriptor> getDescriptorsFromURIScheme(java.lang.String scheme)

Returns the descriptors of all meta-models that use URIs with given customURIScheme in cross-document references and as proxy URIs.

Parameters:

scheme - The custom URI scheme for which the descriptors of the meta-model using it is to be returned.

Returns:

The descriptors of the meta-models using specified customURIScheme.

getDescriptor

@Deprecated
public <T extends IMetaModelDescriptor> T getDescriptor(T mmDescriptor,
                                                          int ordinal)

Deprecated. see MetaModelVersionData.getOrdinal()

Parameters:

mmDescriptor -

ordinal -

Returns:

getDescriptor

public <T extends IMetaModelDescriptor> T getDescriptor(T mmDescriptor,
                                               java.lang.String name)

Parameters:

mmDescriptor -

name -

Returns:

getDescriptor

public IMetaModelDescriptor getDescriptor(org.eclipse.emf.ecore.resource.Resource resource)

Returns the meta-model descriptor for the given resource.

Parameters:

resource - The resource whose meta-model descriptor is to be returned.

Returns:

The meta-model descriptor of the specified resource.

getDescriptor

public IMetaModelDescriptor getDescriptor(org.eclipse.core.resources.IFile file)

Returns the meta-model descriptor for given file.

Parameters:

file - The file whose meta-model descriptor is to be returned.

Returns:

The meta-model descriptor of given IFile, or null if no such could be determined.

getOldDescriptor

public IMetaModelDescriptor getOldDescriptor(org.eclipse.emf.ecore.resource.Resource resource)

Returns the old meta-model descriptor which given resource had had before is was changed or deleted. !Important note! The information will only be available during processing of the method org.eclipse.sphinx.emf.metamodel.MetaModelDescriptorRegistry.FileMetaModelDescriptorCache.removeDescriptor(IFile) called from org.eclipse.sphinx.emf.internal.MetaModelDescriptorCacheAndModelDescriptorRegistryUpdater. handleModelResourceUnloaded(Collection).In any other use case the method will behave as if there was no old meta-model descriptor available. The reason is that old meta-model descriptor is removed as soon as model descriptor has been removed.

Parameters:

resource - The resource whose old meta-model descriptor is to be returned.

Returns:

The old meta-model descriptor of given Resource, or null file hadn't had any meta-model descriptor before it was changed or deleted.

getOldDescriptor

public IMetaModelDescriptor getOldDescriptor(org.eclipse.core.resources.IFile file)

Returns the old meta-model descriptor which given file had had before is was changed or deleted. !Important note! The information will only be available during processing of the method org.eclipse.sphinx.emf.metamodel.MetaModelDescriptorRegistry.FileMetaModelDescriptorCache.removeDescriptor(IFile) called from org.eclipse.sphinx.emf.internal.MetaModelDescriptorCacheAndModelDescriptorRegistryUpdater. handleModelResourceUnloaded(Collection).In any other use case the method will behave as if there was no old meta-model descriptor available. The reason is that old meta-model descriptor is removed as soon as model descriptor has been removed.

Parameters:

file - The file whose old meta-model descriptor is to be returned.

Returns:

The old meta-model descriptor of given IFile, or null file hadn't had any meta-model descriptor before it was changed or deleted.

getDescriptor

public IMetaModelDescriptor getDescriptor(org.eclipse.emf.ecore.EObject eObject)

Parameters:

eObject -

Returns:

getDescriptor

public IMetaModelDescriptor getDescriptor(org.eclipse.emf.ecore.EClass eClass)

Parameters:

eClass -

Returns:

getDescriptor

public IMetaModelDescriptor getDescriptor(org.eclipse.emf.ecore.EClassifier eClassifier)

Parameters:

eClass -

Returns:

getDescriptor

public IMetaModelDescriptor getDescriptor(org.eclipse.emf.ecore.EPackage ePackage)

Parameters:

ePackage -

Returns:

getDescriptor

public IMetaModelDescriptor getDescriptor(org.eclipse.emf.edit.provider.IWrapperItemProvider wrapperItemProvider)

Parameters:

wrapperItemProvider -

Returns:

getDescriptor

public IMetaModelDescriptor getDescriptor(org.eclipse.emf.ecore.util.FeatureMap.Entry entry)

Parameters:

entry -

Returns:

getDescriptor

public IMetaModelDescriptor getDescriptor(TransientItemProvider transientItemProvider)

Parameters:

transientItemProvider -

Returns:

getDescriptor

public IMetaModelDescriptor getDescriptor(java.net.URI namespaceURI)

Parameters:

namespaceURI -

Returns:

getDescriptor

@Deprecated
public IMetaModelDescriptor getDescriptor(java.lang.Class<?> clazz)

Deprecated. It is not recommended use this method because the metamodel descriptor retrieval strategy implemented here has the side effect of that it triggers a full initialization of all EPackages behind potentially all metamodel descriptors. This can have significant impact on runtime performance and may cause that the EPackages of metamodels become initialized even though not a single instance of these metamodels exists in the workspace.

Parameters:

class -

Returns:

getTargetDescriptor

public IMetaModelDescriptor getTargetDescriptor(org.eclipse.core.resources.IFile file)

Retrieves target meta-model descriptor behind the given file.

Parameters:

file - The file to be investigated.

Returns:

The file's target meta-model descriptor or null if no such exists.

getTargetDescriptor

public IMetaModelDescriptor getTargetDescriptor(org.eclipse.emf.ecore.resource.Resource resource)

Retrieves target meta-model descriptor behind the given resource.

Parameters:

resource - The resource to be investigated.

Returns:

The resource's target meta-model descriptor or null if no such exists.

getFileExtensionsAssociatedWithTargetDescriptors

@Deprecated
public java.util.Collection<java.lang.String> getFileExtensionsAssociatedWithTargetDescriptors()

Deprecated. use isContentTypeOfTargetDescriptorsApplicable(IFile) instead

Retrieves the extensions of all file types which are associated with a target meta-model descriptor. Includes both file extensions for which a target meta-model descriptor has been specified directly and file extensions supported by content types for which a target meta-model descriptor has been defined.

Returns:

A collection with all file types associated with a target meta-model descriptor or an empty collection if no such exist.

isContentTypeOfTargetDescriptorsApplicable

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

Returns true if the extension of the passed in file matches any extension of all file types which are associated with a target meta-model descriptor. Matching is done against both file extensions for which a target meta-model descriptor has been specified directly and file extensions supported by content types for which a target meta-model descriptor has been defined.

Returns:

true if the extensions any target descriptor content type match the passed in file's extension. false if the file is null or has no extension.

getEffectiveDescriptor

public IMetaModelDescriptor getEffectiveDescriptor(org.eclipse.core.resources.IFile file)

Retrieves meta-model descriptor behind the given file which will be eventually effective or relevant to clients. This is the IFile's target meta-model descriptor if such one is available or the IFile's native meta-model descriptor otherwise.

Parameters:

file - The file to be investigated.

Returns:

The file's effective meta-model descriptor or null if no such exists.

getEffectiveDescriptor

public IMetaModelDescriptor getEffectiveDescriptor(org.eclipse.emf.ecore.resource.Resource resource)

Retrieves meta-model descriptor behind the given resource which will be eventually effective or relevant to clients. This is the IFile's target meta-model descriptor if such one is available or the IFile's native meta-model descriptor otherwise.

Parameters:

resource - The resource to be investigated.

Returns:

The resource's effective meta-model descriptor or null if no such exists.

getResourceVersionDescriptor

public IMetaModelDescriptor getResourceVersionDescriptor(org.eclipse.emf.ecore.resource.Resource resource)

Returns a descriptor describing the version of specified resource. This is done by retrieving the resource's model namespace and finding a matching metamodel descriptor or compatible resource version descriptor.

Parameters:

resource - The resource whose version descriptor is to be retrieved.

Returns:

The resource's version descriptor or null if no such could be determined.

See Also:

EcoreResourceUtil.readModelNamespace(Resource), #getCompatibleResourceVersionDescriptors()