org.eclipse.sphinx.emf.model

Class ModelDescriptor

java.lang.Object

org.eclipse.core.runtime.PlatformObject

org.eclipse.sphinx.emf.model.ModelDescriptor

All Implemented Interfaces:

org.eclipse.core.runtime.IAdaptable, IModelDescriptor

public class ModelDescriptor
extends org.eclipse.core.runtime.PlatformObject
implements IModelDescriptor

A default implementation of model descriptor.

See Also:

IModelDescriptor

Field Summary

Fields

Modifier and Type	Field and Description
protected IMetaModelDescriptor	mmDescriptor The meta-model descriptor.
protected IResourceScope	resourceScope The resource scope of the model described here.
protected IMetaModelDescriptor	targetMMDescriptor The target meta-model descriptor.

Constructor Summary

Constructors

Constructor and Description
ModelDescriptor(IMetaModelDescriptor mmDescriptor, IMetaModelDescriptor targetMMDescriptor, IResourceScope resourceScope) Constructor.

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.
boolean	equals(java.lang.Object object)
org.eclipse.emf.transaction.TransactionalEditingDomain	getEditingDomain()
protected IMetaModelDescriptor	getEffectiveMetaModelDescriptor()
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()
int	hashCode()
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.
java.lang.String	toString()

Methods inherited from class org.eclipse.core.runtime.PlatformObject

getAdapter

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

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

getAdapter

Field Detail

mmDescriptor

protected IMetaModelDescriptor mmDescriptor

The meta-model descriptor.

targetMMDescriptor

protected IMetaModelDescriptor targetMMDescriptor

The target meta-model descriptor.

resourceScope

protected IResourceScope resourceScope

The resource scope of the model described here.

Constructor Detail

ModelDescriptor

public ModelDescriptor(IMetaModelDescriptor mmDescriptor,
                       IMetaModelDescriptor targetMMDescriptor,
                       IResourceScope resourceScope)

Constructor.

Parameters:

mmDescriptor - The meta-model descriptor.

rootProject - The root project of the described model.

Method Detail

getMetaModelDescriptor

public IMetaModelDescriptor getMetaModelDescriptor()

Specified by:

getMetaModelDescriptor in interface IModelDescriptor

Returns:

The meta-model descriptor.

getTargetMetaModelDescriptor

public IMetaModelDescriptor getTargetMetaModelDescriptor()

Specified by:

getTargetMetaModelDescriptor in interface IModelDescriptor

Returns:

The target meta-model descriptor.

getEffectiveMetaModelDescriptor

protected IMetaModelDescriptor getEffectiveMetaModelDescriptor()

getScope

public IResourceScope getScope()

Specified by:

getScope in interface IModelDescriptor

Returns:

The resourceScope resourceScope of the model described here.

getEditingDomain

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

Specified by:

getEditingDomain in interface IModelDescriptor

Returns:

The editing domain of the model described here.

getRoot

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

Specified by:

getRoot in interface IModelDescriptor

Returns:

The root resource of the model described here.

getReferencedRoots

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

Specified by:

getReferencedRoots in interface IModelDescriptor

Returns:

The list of rootresources constituting the model described here.

getReferencingRoots

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

Specified by:

getReferencingRoots in interface IModelDescriptor

Returns:

The list of parent rootresources referencing the model described here.

getPersistedFiles

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

Specified by:

getPersistedFiles in interface IModelDescriptor

Returns:

The file(s) that belong to this model.

getLoadedResources

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

Specified by:

getLoadedResources in interface IModelDescriptor

Returns:

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

belongsTo

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

Description copied from interface: IModelDescriptor

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).

Specified by:

belongsTo in interface IModelDescriptor

Parameters:

file - The file that may belongs to the model.

Returns:

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

belongsTo

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

Description copied from interface: IModelDescriptor

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).

Specified by:

belongsTo in interface IModelDescriptor

Parameters:

resource - The resource that may belongs to the model.

Returns:

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

belongsTo

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

Description copied from interface: IModelDescriptor

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).

Specified by:

belongsTo in interface IModelDescriptor

Parameters:

uri - The uri that may belongs to the model.

Returns:

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

didBelongTo

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

Description copied from interface: IModelDescriptor

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.

Specified by:

didBelongTo in interface IModelDescriptor

Returns:

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

didBelongTo

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

Description copied from interface: IModelDescriptor

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.

Specified by:

didBelongTo in interface IModelDescriptor

Returns:

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

didBelongTo

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

Description copied from interface: IModelDescriptor

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.

Specified by:

didBelongTo in interface IModelDescriptor

Returns:

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

isShared

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

Description copied from interface: IModelDescriptor

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

Specified by:

isShared in interface IModelDescriptor

Parameters:

file - The file to be investigated.

Returns:

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

isShared

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

Description copied from interface: IModelDescriptor

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

Specified by:

isShared in interface IModelDescriptor

Returns:

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

isShared

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

Description copied from interface: IModelDescriptor

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

Specified by:

isShared in interface IModelDescriptor

Returns:

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

equals

public boolean equals(java.lang.Object object)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object