IMetaModelDescriptor

All Known Implementing Classes:

AbstractMetaModelDescriptor, GMFNotationDescriptor
```
public interface IMetaModelDescriptor
```
Describes a meta-model. This can either be an abstract description describing a family of meta-model implementations or a the description of a concrete meta-model version which is backed by an implementation. A description of a concrete meta-model version is expected to be backed by an EMF implementation.
Descriptors of concrete meta-model versions from the same family are expected to be derived from the same IMetaModelDescriptor implementation describing the meta-model family.
Implementations of this interface shall be immutable.

Since:

0.7.0

Field Summary

Fields
Modifier and Type Field and Description

static java.lang.String LABEL_PATTERN
The string pattern used to create the label of this meta-model descriptor.

Fields
Modifier and Type	Field and Description
`static java.lang.String`	`LABEL_PATTERN` The string pattern used to create the label of this meta-model descriptor.

Method Summary

Methods
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`.
`IMetaModelDescriptor`	`getBaseDescriptor()` Returns the `descriptor` of the base meta-model behind the described meta-model.
`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 `URI`s 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 descriptor`s 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 type`s 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.
`java.lang.String`	`getDefaultContentTypeId()` Returns the identifier of the default `content type` for the described meta-model.
`org.eclipse.emf.ecore.EFactory`	`getEFactory()` Deprecated. Use #getRootEFactory() instead. Rationale: This method has been renamed to the aforementioned name so as to indicate its purpose more clearly.
`org.eclipse.emf.ecore.EPackage`	`getEPackage()` Deprecated. Use #getRootEPackage() instead. Rationale: This method has been renamed to the aforementioned name so as to indicate its purpose more clearly.
`java.lang.String`	`getEPackageNsURIPattern()` Deprecated. use `matchesEPackageNsURIPattern(String)` instead
`java.util.Collection<org.eclipse.emf.ecore.EPackage>`	`getEPackages()` Returns the set of `EPackage`s 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.
`int`	`getOrdinal()` Deprecated. see `MetaModelVersionData.getOrdinal()`
`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`.
`boolean`	`isEPackageRegistered()` Deprecated. Use #getERootPackage() and test if result is not `null` instead. Rationale: the added value of this method is not that significant. Furthermore, the current implementation seems not to be in sync with the behavior that is put forward in the JavaDoc. Clients should no longer make use of this method and directly implement the required behavior.
`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.

- Field Detail
  - LABEL_PATTERN
```
static final java.lang.String LABEL_PATTERN
```
    The string pattern used to create the label of this meta-model descriptor.
    
    Since:
    
    0.7.0
    
    See Also:
    Constant Field Values
- Method Detail
  - getIdentifier
```
java.lang.String getIdentifier()
```
    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 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).
    
    Returns:
    The identifier of the described meta-model.
    Since:
    
    0.7.0
  - getNamespaceURI
```
java.net.URI getNamespaceURI()
```
    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.
    
    Returns:
    The namespace URI of the described meta-model.
    Since:
    
    0.7.0
  - getNamespace
```
java.lang.String getNamespace()
```
    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.
    
    Returns:
    The namespace of the described meta-model under a string format.
    Since:
    
    0.7.0
  - getName
```
java.lang.String getName()
```
    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.
    
    Returns:
    The name of the described meta-model.
    Since:
    
    0.7.0
  - getBaseDescriptor
```
IMetaModelDescriptor getBaseDescriptor()
```
    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.
    
    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
```
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.
    
    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
int getOrdinal()
```
    Deprecated. see MetaModelVersionData.getOrdinal()
    
    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.
    
    Returns:
    The ordinal of the described meta-model or null if the described meta-model is not a concrete meta-model version.
    Since:
    
    0.7.0
  - getEPackageNsURIPattern
```
@Deprecated
java.lang.String getEPackageNsURIPattern()
```
    Deprecated. use matchesEPackageNsURIPattern(String) instead
    
    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.
    
    Returns:
    The pattern describing all EPackages associated with the meta-model described.
    Since:
    
    0.7.0
  - matchesEPackageNsURIPattern
```
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. 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.
    
    Returns:
    true if the passed in URI matches the namespace pattern for the EPackages associated of with the described meta-model.
    Since:
    
    0.7.0
  - getEPackages
```
java.util.Collection<org.eclipse.emf.ecore.EPackage> getEPackages()
```
    Returns the set of EPackages which are associated with the described meta-model.
    
    Returns:
    The EPackages associated with the described meta-model.
  - getRootEPackage
```
org.eclipse.emf.ecore.EPackage getRootEPackage()
```
    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.
    
    Returns:
    The root EPackage associated with the described meta-model.
    Since:
    
    0.7.0
  - getEPackage
```
@Deprecated
org.eclipse.emf.ecore.EPackage getEPackage()
```
    Deprecated. Use #getRootEPackage() instead. Rationale: This method has been renamed to the aforementioned name so as to indicate its purpose more clearly.
  - isEPackageRegistered
```
@Deprecated
boolean isEPackageRegistered()
```
    Deprecated. Use #getERootPackage() and test if result is not null instead. Rationale: the added value of this method is not that significant. Furthermore, the current implementation seems not to be in sync with the behavior that is put forward in the JavaDoc. Clients should no longer make use of this method and directly implement the required behavior.
    
    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 getRootEPackage()).
    
    Returns:
    true if the associated top-level EPackage is registered else false;
    Since:
    0.7.0
  getRootEFactory org.eclipse.emf.ecore.EFactory getRootEFactory() 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 . Returns: The root EFactory associated with the described meta-model. Since: 0.7.0 See Also: getRootEPackage() getEFactory @Deprecated org.eclipse.emf.ecore.EFactory getEFactory() Deprecated. Use #getRootEFactory() instead. Rationale: This method has been renamed to the aforementioned name so as to indicate its purpose more clearly. getContentTypeIds java.util.List<java.lang.String> getContentTypeIds() Returns the identifiers of all content types which are associated with the described meta-model. Returns: The identifiers of the content types associated with the described meta-model. Since: 0.7.0 getDefaultContentTypeId java.lang.String getDefaultContentTypeId() 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. Returns: The identifier of the default content type for the described meta-model, or an empty string if no such is available. Since: 0.7.0 See Also: #getERootPackage() getCompatibleNamespaceURIs 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. Returns: A list of compatible namespace URIs. Since: 0.7.0 See Also: getNamespaceURI() getCompatibleContentTypeIds 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. Returns: A list of compatible content type ids. Since: 0.7.0 See Also: getContentTypeIds() addAssociatedContentTypeId void addAssociatedContentTypeId(java.lang.String contentTypeId) Adds associated content type to the meta-model described by this meta-model descriptor. Parameters: contentTypeId - getCompatibleResourceVersionDescriptors 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. Returns: A list of compatible resource version descriptors. Since: 0.7.0

Interface IMetaModelDescriptor

Field Summary

Method Summary

Field Detail

LABEL_PATTERN

Method Detail

getIdentifier

getNamespaceURI

getNamespace

getName

getBaseDescriptor

getCustomURIScheme

getOrdinal

getEPackageNsURIPattern

matchesEPackageNsURIPattern

getEPackages

getRootEPackage

getEPackage

isEPackageRegistered

getRootEFactory

getEFactory

getContentTypeIds

getDefaultContentTypeId

getCompatibleNamespaceURIs

getCompatibleContentTypeIds

addAssociatedContentTypeId

getCompatibleResourceVersionDescriptors