org.eclipse.sphinx.emf.model

Class ModelDescriptorRegistry

java.lang.Object

org.eclipse.sphinx.emf.model.ModelDescriptorRegistry

public class ModelDescriptorRegistry
extends java.lang.Object

The model descriptor registry owning descriptors of loaded models.

This registry provides methods allowing to add, remove or retrieve one (or several) model descriptor(s). Registry is kept up-to-date thanks to a resource set listener that is notified when any resource is loaded or unloaded.

See Also:

IModelDescriptor

Field Summary

Fields

Modifier and Type	Field and Description
static ModelDescriptorRegistry	INSTANCE The singleton instance of this registry.
protected java.util.Map<IMetaModelDescriptor,java.util.Set<IModelDescriptor>>	modelDescriptors The described models.

Method Summary

Methods

Modifier and Type	Method and Description
void	addModel(org.eclipse.core.resources.IFile file) Adds the model descriptor for the specified file to this registry.
void	addModel(IMetaModelDescriptor mmDescriptor, IMetaModelDescriptor targetMMDescriptor, org.eclipse.core.resources.IResource resourceScopeRoot) Adds the model descriptor corresponding to the specified meta-model descriptor, target meta-model descriptor and resource scope root to this registry.
void	addModel(org.eclipse.emf.ecore.resource.Resource resource) Adds the model descriptor for the specified resource to this registry.
void	addModelDescriptorChangeListener(IModelDescriptorChangeListener listener) Adds the given listener for model descriptor change events to this modelDescriptorRegistry.
void	addModels(org.eclipse.core.resources.IProject project)
java.util.Collection<IModelDescriptor>	getAllModels() Returns all registered model descriptors.
java.util.Collection<IModelDescriptor>	getAllModels(IMetaModelDescriptor mmDescriptor) Returns all registered model descriptors for the specified meta-model descriptor.
IModelDescriptor	getModel(org.eclipse.core.resources.IFile file) Returns the descriptor of the model the specified file belongs to.
IModelDescriptor	getModel(org.eclipse.emf.ecore.resource.Resource resource) Returns the descriptor of the model the specified resource belongs to.
java.util.Collection<IModelDescriptor>	getModels(org.eclipse.core.resources.IContainer container)
java.util.Collection<IModelDescriptor>	getModels(org.eclipse.core.resources.IContainer container, IMetaModelDescriptor mmFilter)
IModelDescriptor	getOldModel(org.eclipse.core.resources.IFile file) Returns the old descriptor of the model the specified file did belong to before it was changed or deleted.
IModelDescriptor	getOldModel(org.eclipse.emf.ecore.resource.Resource resource) Returns the old descriptor of the model the specified resource did belong to before it was changed or unloaded.
boolean	isModelFile(org.eclipse.core.resources.IFile file) Check if specified file is a Sphinx model file
void	moveModels(org.eclipse.core.resources.IProject oldProject, org.eclipse.core.resources.IProject newProject) Moves all model descriptors from specified old project, if any, to specified new project.Usually called when specified old project has been renamed.
void	printAllModels()
void	removeModel(org.eclipse.core.resources.IFile file) Removes the model descriptor for the specified file from this registry.
void	removeModel(IModelDescriptor modelDescriptor) Removes the specified model descriptor this registry.
void	removeModel(org.eclipse.emf.ecore.resource.Resource resource) Removes the model descriptor for the specified resource from this registry.
void	removeModelDescriptorChangeListener(IModelDescriptorChangeListener listener) remove the given listener for model descriptor change events from this modelDescriptorRegistry.
void	removeModels(org.eclipse.core.resources.IContainer container)

Methods inherited from class java.lang.Object

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

Field Detail

INSTANCE

public static ModelDescriptorRegistry INSTANCE

The singleton instance of this registry.

modelDescriptors

protected java.util.Map<IMetaModelDescriptor,java.util.Set<IModelDescriptor>> modelDescriptors

The described models.

This map - which represents an association between a root model project and the models it owns - contains an entry for each loaded model.

Method Detail

addModel

public void addModel(org.eclipse.core.resources.IFile file)

Adds the model descriptor for the specified file to this registry. Usually called when the resource corresponding to the specified file has just been loaded.

Parameters:

file - The file for which corresponding model descriptor must be added/upgraded.

Since:

0.7.0

addModel

public void addModel(org.eclipse.emf.ecore.resource.Resource resource)

Adds the model descriptor for the specified resource to this registry. Usually called when the resource has just been loaded.

Parameters:

resource - The resource for which corresponding model descriptor must be added/upgraded.

Since:

0.7.0

addModel

public void addModel(IMetaModelDescriptor mmDescriptor,
            IMetaModelDescriptor targetMMDescriptor,
            org.eclipse.core.resources.IResource resourceScopeRoot)

Adds the model descriptor corresponding to the specified meta-model descriptor, target meta-model descriptor and resource scope root to this registry. The model descriptor is also added for the resource scopes referenced by the resource scope behind specified resourceScopeRoot.

Parameters:

mmDescriptor - The meta-model descriptor of the model to add.

targetMMDescriptor - The target meta-model descriptor of the model to add.

resourceScopeRoot - The root of the resource scope of the model to add.

Since:

0.8.0

addModels

public void addModels(org.eclipse.core.resources.IProject project)

getModel

public IModelDescriptor getModel(org.eclipse.core.resources.IFile file)

Returns the descriptor of the model the specified file belongs to.

Parameters:

file - The file whose model descriptor is to be retrieved.

Returns:

The descriptor of the model the specified file belongs to, or null if file is not part of any model.

isModelFile

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

Check if specified file is a Sphinx model file

Parameters:

file - the file be checked.

Returns:

true if specified file is a Sphinx model file. Otherwise false.

getModel

public IModelDescriptor getModel(org.eclipse.emf.ecore.resource.Resource resource)

Returns the descriptor of the model the specified resource belongs to.

Parameters:

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

Returns:

The descriptor of the model the specified resource belongs to, or null if file is not part of any model.

Since:

0.7.0

getOldModel

public IModelDescriptor getOldModel(org.eclipse.core.resources.IFile file)

Returns the old descriptor of the model the specified file did belong to before it was changed or deleted.

Parameters:

file - The file whose old model descriptor is to be retrieved.

Returns:

The descriptor of the model the specified file did belong to, or null if file hadn't been part of any model before it was changed or deleted.

getOldModel

public IModelDescriptor getOldModel(org.eclipse.emf.ecore.resource.Resource resource)

Returns the old descriptor of the model the specified resource did belong to before it was changed or unloaded.

Parameters:

file - The file whose old model descriptor is to be retrieved.

Returns:

The descriptor of the model the specified resource did belong to, or null if resource hadn't been part of any model before it was changed or unloaded.

getModels

public java.util.Collection<IModelDescriptor> getModels(org.eclipse.core.resources.IContainer container)

Parameters:

container - The container for which model descriptors must be returned; can be an instance of IWorkspaceRoot, IProject or IFolder.

Returns:

The descriptors of the models contained in the specified container.

getModels

public java.util.Collection<IModelDescriptor> getModels(org.eclipse.core.resources.IContainer container,
                                               IMetaModelDescriptor mmFilter)

Parameters:

container - The container for which model descriptors must be returned; can be an instance of IWorkspaceRoot, IProject or IFolder.

mmFilter - meta-model desciptor used to filter model descriptors returned

Returns:

getAllModels

public java.util.Collection<IModelDescriptor> getAllModels()

Returns all registered model descriptors.

Returns:

As specified above.

getAllModels

public java.util.Collection<IModelDescriptor> getAllModels(IMetaModelDescriptor mmDescriptor)

Returns all registered model descriptors for the specified meta-model descriptor.

Parameters:

mmDescriptor - The meta-model descriptor to use in order to filter the model descriptors in the registry.

Returns:

As specified above.

moveModels

public void moveModels(org.eclipse.core.resources.IProject oldProject,
              org.eclipse.core.resources.IProject newProject)

Moves all model descriptors from specified old project, if any, to specified new project.Usually called when specified old project has been renamed.

Parameters:

oldProject - The old project whose meta-model descriptors are to be moved.

newProject - The new project to which the old project's meta-model descriptors are to be moved.

removeModel

public void removeModel(org.eclipse.core.resources.IFile file)

Removes the model descriptor for the specified file from this registry. Usually called when the resource corresponding to the specified file has just been unloaded.

Parameters:

file - The file for which corresponding model descriptor must be upgraded/removed.

Since:

0.7.0

removeModel

public void removeModel(org.eclipse.emf.ecore.resource.Resource resource)

Removes the model descriptor for the specified resource from this registry. Usually called when the resource has just been unloaded.

Parameters:

resource - The resource for which corresponding model descriptor must be upgraded/removed.

Since:

0.7.0

removeModel

public void removeModel(IModelDescriptor modelDescriptor)

Removes the specified model descriptor this registry. Also removes as well all corresponding model descriptors from projects referencing the projects covered by the given modelDescriptor.

Parameters:

modelDescriptor - The model descriptor to remove from this registry.

Since:

0.7.0

removeModels

public void removeModels(org.eclipse.core.resources.IContainer container)

addModelDescriptorChangeListener

public void addModelDescriptorChangeListener(IModelDescriptorChangeListener listener)

Adds the given listener for model descriptor change events to this modelDescriptorRegistry. Has no effect if an identical listener is already registered.

Parameters:

listener - the listener

See Also:

IModelDescriptorChangeListener

removeModelDescriptorChangeListener

public void removeModelDescriptorChangeListener(IModelDescriptorChangeListener listener)

remove the given listener for model descriptor change events from this modelDescriptorRegistry. Has no effect if such a listener is not registered.

Parameters:

listener - the listener

See Also:

IModelDescriptorChangeListener

printAllModels

public void printAllModels()