org.eclipse.sphinx.emf.model

Interface IModelDescriptor

All Superinterfaces:

org.eclipse.core.runtime.IAdaptable

All Known Implementing Classes:

ModelDescriptor

public interface IModelDescriptor
extends org.eclipse.core.runtime.IAdaptable

Model descriptor that is used to identify and differentiate models.

One model is identified by a root project and a meta-model descriptor. This descriptor also references the editing domain owning the resource set containing the resources from the described model.

This model descriptor provides a method indicating if a specified file belongs or not to the described model.

Model descriptors are used in registry of model descriptors ( ModelDescriptorRegistry) in order to keep references of loaded models.

See Also:

org.eclipse.sphinx.emf.model.IDescriptor, ModelDescriptor, ModelDescriptorRegistry

Method Summary

Modifier and Type	Method and Description
boolean	belongsTo(org.eclipse.core.resources.IFile file, boolean includeReferencedScopes) Indicates if the given file is part of the model identified by this model descriptor.
boolean	belongsTo(org.eclipse.emf.ecore.resource.Resource resource, boolean includeReferencedScopes) Indicates if the given resource is part of the model identified by this model descriptor.
boolean	belongsTo(org.eclipse.emf.common.util.URI uri, boolean includeReferencedScopes) Indicates if the given uri is part of the model identified by this model descriptor.
boolean	didBelongTo(org.eclipse.core.resources.IFile file, boolean includeReferencedScopes) Indicates if the given file has been part of the model identified by this model descriptor before it was changed or deleted.
boolean	didBelongTo(org.eclipse.emf.ecore.resource.Resource resource, boolean includeReferencedScopes) Indicates if the given resource has been part of the model identified by this model descriptor before it was changed or deleted.
boolean	didBelongTo(org.eclipse.emf.common.util.URI uri, boolean includeReferencedScopes) if the given uri has been part of the model identified by this model descriptor before relative file it was changed or deleted.
org.eclipse.emf.transaction.TransactionalEditingDomain	getEditingDomain()
java.util.Collection<org.eclipse.emf.ecore.resource.Resource>	getLoadedResources(boolean includeReferencedScopes)
IMetaModelDescriptor	getMetaModelDescriptor()
java.util.Collection<org.eclipse.core.resources.IFile>	getPersistedFiles(boolean includeReferencedScopes)
java.util.Collection<org.eclipse.core.resources.IResource>	getReferencedRoots()
java.util.Collection<org.eclipse.core.resources.IResource>	getReferencingRoots()
org.eclipse.core.resources.IResource	getRoot()
IResourceScope	getScope()
IMetaModelDescriptor	getTargetMetaModelDescriptor()
boolean	isShared(org.eclipse.core.resources.IFile file) Determines if given file is shared among multiple models, i.e., can simultaneously belong to multiple models, or not.
boolean	isShared(org.eclipse.emf.ecore.resource.Resource resource) Determines if given resource is shared among multiple models, i.e., can simultaneously belong to multiple models, or not.
boolean	isShared(org.eclipse.emf.common.util.URI uri) Determines if given URI is shared among multiple models, i.e., can simultaneously belong to multiple models, or not.

Methods inherited from interface org.eclipse.core.runtime.IAdaptable

getAdapter

Method Detail

getMetaModelDescriptor

IMetaModelDescriptor getMetaModelDescriptor()

Returns:

The meta-model descriptor.

getTargetMetaModelDescriptor

IMetaModelDescriptor getTargetMetaModelDescriptor()

Returns:

The target meta-model descriptor.

getEditingDomain

org.eclipse.emf.transaction.TransactionalEditingDomain getEditingDomain()

Returns:

The editing domain of the model described here.

getScope

IResourceScope getScope()

Returns:

The resourceScope resourceScope of the model described here.

getRoot

org.eclipse.core.resources.IResource getRoot()

Returns:

The root resource of the model described here.

getReferencedRoots

java.util.Collection<org.eclipse.core.resources.IResource> getReferencedRoots()

Returns:

The list of rootresources constituting the model described here.

Since:

0.7.0

getReferencingRoots

java.util.Collection<org.eclipse.core.resources.IResource> getReferencingRoots()

Returns:

The list of parent rootresources referencing the model described here.

Since:

0.7.0

getLoadedResources

java.util.Collection<org.eclipse.emf.ecore.resource.Resource> getLoadedResources(boolean includeReferencedScopes)

Returns:

The resources inside the editing domain's resource set that belong to this model.

getPersistedFiles

java.util.Collection<org.eclipse.core.resources.IFile> getPersistedFiles(boolean includeReferencedScopes)

Returns:

The file(s) that belong to this model.

belongsTo

boolean belongsTo(org.eclipse.core.resources.IFile file,
                  boolean includeReferencedScopes)

Indicates if the given file is part of the model identified by this model descriptor. Criteria applied in order to know that are the following ones:

• encapsulated meta-model descriptor must be equal to file's one;
• file must be a member of the encapsulated project
  (can be member of a referenced project).

Parameters:

file - The file that may belongs to the model.

Returns:

• true if the given file belongs to the identified model;
• false otherwise.

belongsTo

boolean belongsTo(org.eclipse.emf.ecore.resource.Resource resource,
                  boolean includeReferencedScopes)

Indicates if the given resource is part of the model identified by this model descriptor. Criteria applied in order to know that are the following ones:

• encapsulated meta-model descriptor must be equal to file's one;
• file must be a member of the encapsulated project
  (can be member of a referenced project).

Parameters:

resource - The resource that may belongs to the model.

Returns:

• true if the given file belongs to the identified model;
• false otherwise.

belongsTo

boolean belongsTo(org.eclipse.emf.common.util.URI uri,
                  boolean includeReferencedScopes)

Indicates if the given uri is part of the model identified by this model descriptor. Criteria applied in order to know that are the following ones:

• encapsulated meta-model descriptor must be equal to file's one;
• file must be a member of the encapsulated project
  (can be member of a referenced project).

Parameters:

uri - The uri that may belongs to the model.

Returns:

• true if the given uri belongs to the identified model;
• false otherwise.

didBelongTo

boolean didBelongTo(org.eclipse.core.resources.IFile file,
                    boolean includeReferencedScopes)

Indicates if the given file has been part of the model identified by this model descriptor before it was changed or deleted. Criteria applied in order to know that are the following ones:

• encapsulated meta-model descriptor must be equal to file's old meta-model descriptor;
• file must be a member of the encapsulated project
  (can be member of a referenced project).

!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. The file that may belongs to the model.

Returns:

• true if the given file belongs to the identified model;
• false otherwise.

didBelongTo

boolean didBelongTo(org.eclipse.emf.ecore.resource.Resource resource,
                    boolean includeReferencedScopes)

Indicates if the given resource has been part of the model identified by this model descriptor before it was changed or deleted. Criteria applied in order to know that are the following ones:

• encapsulated meta-model descriptor must be equal to resource's old meta-model descriptor;
!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:

uri - The resource that may belongs to the model.

Returns:

• true if the given resource belongs to the identified model;
• false otherwise.

didBelongTo

boolean didBelongTo(org.eclipse.emf.common.util.URI uri,
                    boolean includeReferencedScopes)

if the given uri has been part of the model identified by this model descriptor before relative file it was changed or deleted. Criteria applied in order to know that are the following ones:

• encapsulated meta-model descriptor must be equal to uri's old meta-model descriptor;
• uri must point on a member of the encapsulated project
  (can be member of a referenced project).

!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 that may belongs to the model.

Returns:

• true if the given uri point on an element that belongs to the identified model;
• false otherwise.

isShared

boolean isShared(org.eclipse.core.resources.IFile file)

Determines if given file is shared among multiple models, i.e., can simultaneously belong to multiple models, or not.

Parameters:

file - The file to be investigated.

Returns:

true if given file is shared across multiple models, or false otherwise.

isShared

boolean isShared(org.eclipse.emf.ecore.resource.Resource resource)

Determines if given resource is shared among multiple models, i.e., can simultaneously belong to multiple models, or not.

Parameters:

file - The resource to be investigated.

Returns:

true if given resource is shared across multiple models, or false otherwise.

isShared

boolean isShared(org.eclipse.emf.common.util.URI uri)

Determines if given URI is shared among multiple models, i.e., can simultaneously belong to multiple models, or not.

Parameters:

file - The URI to be investigated.

Returns:

true if the resource behind given URI is shared across multiple models, or false otherwise.