org.eclipse.sphinx.emf.metamodel

Class AbstractMetaModelDescriptor

java.lang.Object

org.eclipse.core.runtime.PlatformObject

org.eclipse.sphinx.emf.metamodel.AbstractMetaModelDescriptor

All Implemented Interfaces:

org.eclipse.core.runtime.IAdaptable, IMetaModelDescriptor

Direct Known Subclasses:

GMFNotationDescriptor

public abstract class AbstractMetaModelDescriptor
extends org.eclipse.core.runtime.PlatformObject
implements IMetaModelDescriptor

A base implementation for meta-model descriptors. Provides default implementations for all methods specified by the IMetaModelDescriptor interface.

Extends PlatformObject in order to be adaptable by Eclipse adapters mechanism.

Since:

0.7.0

See Also:

IMetaModelDescriptor

Field Summary

Fields

Modifier and Type	Field and Description
protected java.net.URI	fBaseNamespaceURI
protected static java.lang.String	URI_SEGMENT_SEPARATOR

Fields inherited from interface org.eclipse.sphinx.emf.metamodel.IMetaModelDescriptor

LABEL_PATTERN

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractMetaModelDescriptor(java.lang.String identifier, java.lang.String baseNamespace, MetaModelVersionData versionData) Creates a descriptor for a concrete version of a meta-model.
protected	AbstractMetaModelDescriptor(java.lang.String identifier, java.lang.String namespace, java.lang.String name) Creates a descriptor for a meta-model.
protected	AbstractMetaModelDescriptor(java.lang.String identifier, java.lang.String baseNamespace, java.lang.String ePackageNsURIPostfixPattern, java.lang.String name) Creates a descriptor for a meta-model.

Method Summary

Modifier and Type	Method and Description
void	addAssociatedContentTypeId(java.lang.String contentTypeId) Adds associated content type to the meta-model described by this meta-model descriptor.
boolean	equals(java.lang.Object obj)
IMetaModelDescriptor	getBaseDescriptor() Returns the descriptor of the base meta-model behind the described meta-model.
protected java.net.URI	getBaseNamespaceURI()
java.util.List<java.lang.String>	getCompatibleContentTypeIds() Returns a collection of content type ids which are supported by older but all the same compatible versions of the meta-model described by this meta-model descriptor.
java.util.List<java.net.URI>	getCompatibleNamespaceURIs() Returns a collection of namespace URIs which refer to older but all the same compatible versions of the meta-model described by this meta-model descriptor.
java.util.Collection<IMetaModelDescriptor>	getCompatibleResourceVersionDescriptors() Returns a collection of meta-model descriptors identifying resource versions which are older but all the same compatible with the meta-model described by this meta-model descriptor.
java.util.List<java.lang.String>	getContentTypeIds() Returns the identifiers of all content types which are associated with the described meta-model.
java.lang.String	getCustomURIScheme() Returns the scheme of the custom URIs that the described meta-model uses in cross-document references and as proxy URIs.
abstract java.lang.String	getDefaultContentTypeId() Returns the identifier of the default content type for the described meta-model.
org.eclipse.emf.ecore.EFactory	getEFactory() Deprecated.
org.eclipse.emf.ecore.EPackage	getEPackage() Deprecated.
java.lang.String	getEPackageNsURIPattern() Deprecated.
org.eclipse.emf.ecore.EPackage.Registry	getEPackageRegistry()
java.util.Collection<org.eclipse.emf.ecore.EPackage>	getEPackages() Returns the set of EPackages which are associated with the described meta-model.
java.lang.String	getIdentifier() Returns the identifier of the described meta-model.
java.lang.String	getName() Returns the name of the described meta-model.
java.lang.String	getNamespace() Returns the namespace (as a string) of the described meta-model.
java.net.URI	getNamespaceURI() Returns the namespace URI of the described meta-model.
protected java.lang.String	getNsPostfix()
int	getOrdinal() Deprecated.
org.eclipse.emf.ecore.EFactory	getRootEFactory() Returns the root EFactory which is associated with the described meta-model.
org.eclipse.emf.ecore.EPackage	getRootEPackage() Returns the root EPackage which is associated with the described meta-model.
protected java.lang.String	getRootEPackageContentTypeId() Deprecated. This method could be used to implement getDefaultContentTypeId(). It is however not recommended to do so because the content type id retrieval strategy implemented here has the side effect of that it triggers a full initialization of the metamodel's root EPackage and all dependent EPackages. This can have significant impact on runtime performance, e.g., in the UI when metamodel descriptors are used to determine if some common navigator content needs to be activated or not, and may cause that the EPackages of a metamodel become initialized even though not a single instance of that metamodel exists in the workspace.
int	hashCode()
protected void	initContentTypeIds()
protected void	initEPackageNsURIPattern() Initializes the URI pattern used for determining if an EPackage belongs to the meta-model or not.
protected void	initEPackages()
protected void	initName()
protected void	initNamespace() Initializes the meta-model's namespace.
protected void	initRootEPackage()
boolean	isEPackageRegistered() Deprecated.
boolean	matchesEPackageNsURIPattern(java.lang.String uri) Returns true if the passed in URI matches the namespace pattern for the EPackages associated of with the described meta-model.
protected void	setEPackageRegistry(org.eclipse.emf.ecore.EPackage.Registry ePkgRegistry)
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

Field Detail

URI_SEGMENT_SEPARATOR

protected static final java.lang.String URI_SEGMENT_SEPARATOR

See Also:

Constant Field Values

fBaseNamespaceURI

protected java.net.URI fBaseNamespaceURI

Constructor Detail

AbstractMetaModelDescriptor

protected AbstractMetaModelDescriptor(java.lang.String identifier,
                                      java.lang.String namespace,
                                      java.lang.String name)

Creates a descriptor for a meta-model. This constructor is to be used if the descriptor shall describe an abstract meta-model family (without an implementation backing it) or a meta-model (backed by an implementation) which exists only in one version and consists of only one EPackage, i.e., a root EPackage without sub-packages.

Parameters:

identifier - The identifier of the described meta-model. A unique identifier used for referencing the meta-model from within an extension point.

namespace - The namespace of the described meta-model.

name - The name of the described meta-model.

See Also:

getRootEPackage()

AbstractMetaModelDescriptor

protected AbstractMetaModelDescriptor(java.lang.String identifier,
                                      java.lang.String baseNamespace,
                                      java.lang.String ePackageNsURIPostfixPattern,
                                      java.lang.String name)

Creates a descriptor for a meta-model. This constructor is to be used if the descriptor shall describe a meta-model (backed by an implementation) which exists in only one version and consists of multiple EPackages.

Parameters:

identifier - The identifier of the described meta-model. A unique identifier used for referencing the meta-model from within an extension point.

baseNamespace - Typically the namespace of the root EPackage.

ePackageNsURIPostfixPattern - A regular expression when appended to the baseNamespace will match the namespace of the meta-model sub-packages.

name - The name of the described meta-model.

See Also:

getRootEPackage()

AbstractMetaModelDescriptor

protected AbstractMetaModelDescriptor(java.lang.String identifier,
                                      java.lang.String baseNamespace,
                                      MetaModelVersionData versionData)

Creates a descriptor for a concrete version of a meta-model. The constructor is to be used if the descriptor shall describe a concrete version of a meta-model (backed by an implementation).

Parameters:

identifier - The identifier of the described meta-model. A unique identifier used for referencing the meta-model from within an extension point.

baseNamespace - The base namespace of the described meta-model. Is equal to the full namespace if no version data is provided.

versionData - Data describing the meta-model version details.

Method Detail

getEPackageRegistry

public org.eclipse.emf.ecore.EPackage.Registry getEPackageRegistry()

setEPackageRegistry

protected void setEPackageRegistry(org.eclipse.emf.ecore.EPackage.Registry ePkgRegistry)

getIdentifier

public java.lang.String getIdentifier()

Description copied from interface: IMetaModelDescriptor

Returns the identifier of the described meta-model. The identifier is used to reference the meta-model. The identifier must be unique among descriptors available on the platform. It is not intended to be used for user interaction (see IMetaModelDescriptor.getName()). The identifier can also be used to reference the described meta-model from within an extension point.

Uses a specific identifier instead of namespace URI in order to distinguish available meta-model descriptors.

Namespace URI is revision dependent since when the minor version of a release changes, the namespace URI changes. As a consequence, it is more safe to refer a meta-model descriptor with its identifier (e.g. in a project's preferences).

Specified by:

getIdentifier in interface IMetaModelDescriptor

Returns:

The identifier of the described meta-model.

getNamespaceURI

public java.net.URI getNamespaceURI()

Description copied from interface: IMetaModelDescriptor

Returns the namespace URI of the described meta-model. The namespace URI is a unique identifier used to link the meta-model description to registered EMF artifacts like the root EPackage and the EFactory.

Specified by:

getNamespaceURI in interface IMetaModelDescriptor

Returns:

The namespace URI of the described meta-model.

initNamespace

protected void initNamespace()

Initializes the meta-model's namespace.

getBaseNamespaceURI

protected java.net.URI getBaseNamespaceURI()

getNsPostfix

protected java.lang.String getNsPostfix()

getNamespace

public java.lang.String getNamespace()

Description copied from interface: IMetaModelDescriptor

Returns the namespace (as a string) of the described meta-model. The namespace is a unique identifier used to link the meta-model description to registered EMF artifacts like the root EPackage and the EFactory.

Specified by:

getNamespace in interface IMetaModelDescriptor

Returns:

The namespace of the described meta-model under a string format.

getName

public java.lang.String getName()

Description copied from interface: IMetaModelDescriptor

Returns the name of the described meta-model. The name of the meta-model is a human readable identifier which can be used for user interaction.

Specified by:

getName in interface IMetaModelDescriptor

Returns:

The name of the described meta-model.

initName

protected void initName()

getBaseDescriptor

public IMetaModelDescriptor getBaseDescriptor()

Description copied from interface: IMetaModelDescriptor

Returns the descriptor of the base meta-model behind the described meta-model. When multiple implementations of different versions of the same meta-model exist each of them is described by a version-specific meta-model descriptor. In this case, the base meta-model encompasses the common aspects of all meta-model versions and the descriptor of it, if there is any, is what is returned by this method.

Specified by:

getBaseDescriptor in interface IMetaModelDescriptor

Returns:

The descriptor of base meta-model behind the described meta-model or null if the described meta-model has no base meta-model.

getCustomURIScheme

public java.lang.String getCustomURIScheme()

Description copied from interface: IMetaModelDescriptor

Returns the scheme of the custom URIs that the described meta-model uses in cross-document references and as proxy URIs.

Specified by:

getCustomURIScheme in interface IMetaModelDescriptor

Returns:

The scheme of the custom URIs used by the described meta-model or null if it uses standard URIs (e.g., platform:/resource, file:, etc.) instead.

getOrdinal

@Deprecated
public int getOrdinal()

Deprecated.

Description copied from interface: IMetaModelDescriptor

Returns the ordinal of the described meta-model. The ordinal is used for sorting IMetaModelDescriptors describing meta-model versions. If the IMetaModelDescriptor does not describe a concrete version of a meta-model or no MetaModelVersionData has been provided as there is only one version of the meta-model null is returned.

Specified by:

getOrdinal in interface IMetaModelDescriptor

Returns:

The ordinal of the described meta-model or null if the described meta-model is not a concrete meta-model version.

getEPackageNsURIPattern

@Deprecated
public java.lang.String getEPackageNsURIPattern()

Deprecated.

Description copied from interface: IMetaModelDescriptor

Returns the namespace pattern for the EPackages associated of with the described meta-model. The pattern is used to resolve the EPackages which are associated with the meta-model described. Any registered EPackage with a namespace matching the pattern is considered to be associated with the described meta-model.

Specified by:

getEPackageNsURIPattern in interface IMetaModelDescriptor

Returns:

The pattern describing all EPackages associated with the meta-model described.

matchesEPackageNsURIPattern

public boolean matchesEPackageNsURIPattern(java.lang.String uri)

Description copied from interface: IMetaModelDescriptor

Returns true if the passed in URI matches the namespace pattern for the EPackages associated of with the described meta-model. The pattern is used to resolve the EPackages which are associated with the meta-model described. Any registered EPackage with a namespace matching the pattern is considered to be associated with the described meta-model.

Specified by:

matchesEPackageNsURIPattern in interface IMetaModelDescriptor

Returns:

true if the passed in URI matches the namespace pattern for the EPackages associated of with the described meta-model.

initEPackageNsURIPattern

protected void initEPackageNsURIPattern()

Initializes the URI pattern used for determining if an EPackage belongs to the meta-model or not.

getEPackages

public java.util.Collection<org.eclipse.emf.ecore.EPackage> getEPackages()

Description copied from interface: IMetaModelDescriptor

Returns the set of EPackages which are associated with the described meta-model.

Specified by:

getEPackages in interface IMetaModelDescriptor

Returns:

The EPackages associated with the described meta-model.

initEPackages

protected void initEPackages()

getRootEPackage

public org.eclipse.emf.ecore.EPackage getRootEPackage()

Description copied from interface: IMetaModelDescriptor

Returns the root EPackage which is associated with the described meta-model. An EPackage is considered to be a meta-model's root EPackage if it has the same namespace as the latter.

Specified by:

getRootEPackage in interface IMetaModelDescriptor

Returns:

The root EPackage associated with the described meta-model.

initRootEPackage

protected void initRootEPackage()

getEPackage

@Deprecated
public org.eclipse.emf.ecore.EPackage getEPackage()

Deprecated.

Specified by:

getEPackage in interface IMetaModelDescriptor

isEPackageRegistered

@Deprecated
public boolean isEPackageRegistered()

Deprecated.

Description copied from interface: IMetaModelDescriptor

Determines if the top-level EPackage associated with the described meta-model is registered. The EPackage.Registry is to be consolidated if the top-level package is actually registered (see also IMetaModelDescriptor.getRootEPackage()).

Specified by:

isEPackageRegistered in interface IMetaModelDescriptor

Returns:

true if the associated top-level EPackage is registered else false;

getRootEFactory

public org.eclipse.emf.ecore.EFactory getRootEFactory()

Description copied from interface: IMetaModelDescriptor

Returns the root EFactory which is associated with the described meta-model. An EFactory is considered to be a meta-model's root EFactory if the EPackage it belongs to is the meta-model's root EPackage .

Specified by:

getRootEFactory in interface IMetaModelDescriptor

Returns:

The root EFactory associated with the described meta-model.

See Also:

IMetaModelDescriptor.getRootEPackage()

getEFactory

@Deprecated
public org.eclipse.emf.ecore.EFactory getEFactory()

Deprecated.

Specified by:

getEFactory in interface IMetaModelDescriptor

getContentTypeIds

public java.util.List<java.lang.String> getContentTypeIds()

Description copied from interface: IMetaModelDescriptor

Returns the identifiers of all content types which are associated with the described meta-model.

Specified by:

getContentTypeIds in interface IMetaModelDescriptor

Returns:

The identifiers of the content types associated with the described meta-model.

initContentTypeIds

protected void initContentTypeIds()

getDefaultContentTypeId

public abstract java.lang.String getDefaultContentTypeId()

Description copied from interface: IMetaModelDescriptor

Returns the identifier of the default content type for the described meta-model.

The default content type identifier typically is the content type identifier which has been specified in the generator model options for the root package of the described meta-model and is available on the root package's static #eCONTENT_TYPE field.

Specified by:

getDefaultContentTypeId in interface IMetaModelDescriptor

Returns:

The identifier of the default content type for the described meta-model, or an empty string if no such is available.

See Also:

#getERootPackage()

addAssociatedContentTypeId

public void addAssociatedContentTypeId(java.lang.String contentTypeId)

Description copied from interface: IMetaModelDescriptor

Adds associated content type to the meta-model described by this meta-model descriptor.

Specified by:

addAssociatedContentTypeId in interface IMetaModelDescriptor

getRootEPackageContentTypeId

@Deprecated
protected java.lang.String getRootEPackageContentTypeId()

Deprecated. This method could be used to implement getDefaultContentTypeId(). It is however not recommended to do so because the content type id retrieval strategy implemented here has the side effect of that it triggers a full initialization of the metamodel's root EPackage and all dependent EPackages. This can have significant impact on runtime performance, e.g., in the UI when metamodel descriptors are used to determine if some common navigator content needs to be activated or not, and may cause that the EPackages of a metamodel become initialized even though not a single instance of that metamodel exists in the workspace.

Returns the content type identifier exposed on the metamodel's root EPackage, if any.

Returns:

The content type identifier of the metamodel's root EPackage, or and empty string if no such is available.

getCompatibleContentTypeIds

public java.util.List<java.lang.String> getCompatibleContentTypeIds()

Description copied from interface: IMetaModelDescriptor

Returns a collection of content type ids which are supported by older but all the same compatible versions of the meta-model described by this meta-model descriptor.

Specified by:

getCompatibleContentTypeIds in interface IMetaModelDescriptor

Returns:

A list of compatible content type ids.

See Also:

IMetaModelDescriptor.getContentTypeIds()

getCompatibleNamespaceURIs

public java.util.List<java.net.URI> getCompatibleNamespaceURIs()

Description copied from interface: IMetaModelDescriptor

Returns a collection of namespace URIs which refer to older but all the same compatible versions of the meta-model described by this meta-model descriptor.

Specified by:

getCompatibleNamespaceURIs in interface IMetaModelDescriptor

Returns:

A list of compatible namespace URIs.

See Also:

IMetaModelDescriptor.getNamespaceURI()

getCompatibleResourceVersionDescriptors

public java.util.Collection<IMetaModelDescriptor> getCompatibleResourceVersionDescriptors()

Description copied from interface: IMetaModelDescriptor

Returns a collection of meta-model descriptors identifying resource versions which are older but all the same compatible with the meta-model described by this meta-model descriptor.

Specified by:

getCompatibleResourceVersionDescriptors in interface IMetaModelDescriptor

Returns:

A list of compatible resource version descriptors.

equals

public boolean equals(java.lang.Object obj)

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