Package org.eclipse.epsilon.emc.emf

Class EmfModel

java.lang.Object

org.eclipse.epsilon.eol.models.Model

org.eclipse.epsilon.eol.models.CachedModel<org.eclipse.emf.ecore.EObject>

org.eclipse.epsilon.emc.emf.AbstractEmfModel

org.eclipse.epsilon.emc.emf.EmfModel

All Implemented Interfaces:

AutoCloseable, IModel, IReflectiveModel

Direct Known Subclasses:

DecoratorEmfModel, EmfM0Model, InMemoryEmfModel, UmlModel, XmlModel

public class EmfModel
extends AbstractEmfModel
implements IReflectiveModel

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected class	EmfModel.CachedContentsAdapter	This listener is the one that keeps the cached .allInstances and model .allContents() lists up to date, instead of the usual createInstance/deleteInstance methods.

Field Summary

Fields

Modifier and Type	Field	Description
protected static Map<String,List<org.eclipse.emf.ecore.EPackage>>	fileBasedMetamodels
protected static Map<String,Long>	fileBasedMetamodelTimestamps
protected boolean	isMetamodelFileBased	Deprecated.
protected List<org.eclipse.emf.common.util.URI>	metamodelFileUris
protected List<org.eclipse.emf.common.util.URI>	metamodelUris
protected org.eclipse.emf.common.util.URI	modelUri
protected List<org.eclipse.emf.ecore.EPackage>	packages
static final String	PROPERTY_FILE_BASED_METAMODEL_URI	One of the keys used to construct the first argument to Model.load(StringProperties, String).
static final String	PROPERTY_IS_METAMODEL_FILE_BASED	Deprecated. PROPERTY_METAMODEL_URI and PROPERTY_FILE_BASED_METAMODEL_URI are now interpreted as comma-separated lists of 0+ metamodel locations, and it is allowed to mix both types of metamodels now.
static final String	PROPERTY_METAMODEL_FILE	Deprecated. Replaced by PROPERTY_FILE_BASED_METAMODEL_URI.
static final String	PROPERTY_METAMODEL_URI	One of the keys used to construct the first argument to Model.load(StringProperties, String).
static final String	PROPERTY_MODEL_FILE	Deprecated. Replaced by PROPERTY_MODEL_URI.
static final String	PROPERTY_MODEL_URI	One of the keys used to construct the first argument to Model.load(StringProperties, String).
static final String	PROPERTY_REUSE_UNMODIFIED_FILE_BASED_METAMODELS	One of the keys used to construct the first argument to Model.load(StringProperties, String).
static final String	PROPERTY_VALIDATE	One of the keys used to construct the first argument to Model.load(StringProperties, String).
protected boolean	reuseUnmodifiedFileBasedMetamodels
protected boolean	useExtendedMetadata
protected boolean	validate

Fields inherited from class org.eclipse.epsilon.emc.emf.AbstractEmfModel

expand, modelImpl, PROPERTY_EXPAND, PROPERTY_PARALLELALLOF, registry, resourceLoadOptions, resourceStoreOptions, transactionSupport

Fields inherited from class org.eclipse.epsilon.eol.models.CachedModel

allContentsCache, kindCache, PROPERTY_CACHED, PROPERTY_CONCURRENT, typeCache

Fields inherited from class org.eclipse.epsilon.eol.models.Model

aliases, ENV_PREFIX, name, PROPERTY_ALIASES, PROPERTY_NAME, PROPERTY_READONLOAD, PROPERTY_READONLY, PROPERTY_STOREONDISPOSAL, propertyGetter, propertySetter, readOnLoad, storeOnDisposal

Constructor Summary

Constructors

Constructor	Description
EmfModel()

Method Summary

Modifier and Type	Method	Description
protected void	addToCache(String type, org.eclipse.emf.ecore.EObject instance)
protected org.eclipse.emf.ecore.resource.ResourceSet	createResourceSet()
protected void	determinePackagesFrom(org.eclipse.emf.ecore.resource.ResourceSet resourceSet)
protected void	forceAddToCache(org.eclipse.emf.ecore.EObject instance)	We want to use the overridden method, but not from CachedModel.createInstance(String), but rather from the adapter we set up to track additions and removals from the contents of a model.
protected void	forceRemoveFromCache(org.eclipse.emf.ecore.EObject instance)
String	getEnumerationLabelOf(Object literal)	Returns the enumeration label of the literal parameter.
String	getEnumerationTypeOf(Object literal)	Returns the name of the enumeration type of the literal parameter.
Metamodel	getMetamodel(StringProperties properties, IRelativePathResolver resolver)
List<String>	getMetamodelFiles()
List<org.eclipse.emf.common.util.URI>	getMetamodelFileUris()
List<String>	getMetamodelUris()
String	getModelFile()
org.eclipse.emf.common.util.URI	getModelFileUri()
Collection<String>	getPropertiesOf(String type)	Returns a collection containing all of the properties that instances of type know about.
IReflectivePropertySetter	getPropertySetter()
boolean	hasPackage(String packageName)	Returns true iff this model contains a package with the given name.
boolean	hasProperty(String type, String property)
boolean	isEnumerationValue(Object object)	Returns true iff object is an enumeration value.
boolean	isMetamodelFileBased()	Deprecated. This value is no longer used to load models: it is only kept for backwards compatibility, and it now simply indicates whether a file metamodel was loaded at all, or not.
boolean	isReuseUnmodifiedFileBasedMetamodels()
boolean	isValidate()
void	load(StringProperties properties, IRelativePathResolver resolver)	Load the model using the set of properties specified by the first argument.
protected void	loadModel()
void	loadModelFromUri()
boolean	preventLoadingOfExternalModelElements()	Prevents the loading of model elements that are referenced by this model but are not contained in this model.
protected void	removeFromCache(org.eclipse.emf.ecore.EObject instance)
void	setCachingEnabled(boolean cachingEnabled)
void	setMetamodelFile(String path)
void	setMetamodelFileBased(boolean isMetamodelFileBased)	Deprecated. This value is no longer honored anymore.
void	setMetamodelFiles(List<String> paths)
void	setMetamodelFileUri(org.eclipse.emf.common.util.URI uri)
void	setMetamodelFileUris(List<org.eclipse.emf.common.util.URI> fileUris)
void	setMetamodelUri(String uri)
void	setMetamodelUris(List<String> uris)
void	setModelFile(String path)
void	setModelFileUri(org.eclipse.emf.common.util.URI modelFileUri)
void	setReuseUnmodifiedFileBasedMetamodels(boolean reuseUnmodifiedFileBasedMetamodels)
void	setupContainmentChangeListeners()
void	setValidate(boolean validate)
boolean	store()
String	toString()

Methods inherited from class org.eclipse.epsilon.emc.emf.AbstractEmfModel

addMetamodelUri, allContentsFromModel, classForName, classForName, classForName, createInstanceInModel, deleteElementInModel, disposeModel, getAllOfKindFromModel, getAllOfTypeFromModel, getAllTypeNamesOf, getCacheKeyForType, getContainerOf, getElementById, getElementId, getEnumerationValue, getFullyQualifiedName, getFullyQualifiedTypeNameOf, getInputStream, getModelImpl, getPackageRegistry, getResource, getResourceLoadOptions, getResources, getResourceStoreOptions, getTransactionSupport, getTypeNameOf, getTypeOf, hasAdapter, hasType, initCaches, isExpand, isInstantiable, isLoaded, isModelElement, isOfKind, isOfType, isParallelAllOf, isPropertySet, knowsAboutProperty, knowsAboutProperty, owns, putResourceLoadOption, putResourceStoreOption, setElementId, setExpand, setModelImpl, setParallelAllOf, setResource, setResourceLoadOptions, setResourceStoreOptions, store, store, store, validate

Methods inherited from class org.eclipse.epsilon.eol.models.CachedModel

allContents, clearCache, createInstance, deleteElement, dispose, getAllOfKind, getAllOfKindOrType, getAllOfType, isCachingEnabled, isConcurrent, load, setConcurrent, wrap

Methods inherited from class org.eclipse.epsilon.eol.models.Model

allInstances, createInstance, getAliases, getName, getPropertyGetter, isReadOnLoad, isStoredOnDisposal, load, load, setName, setReadOnLoad, setStoredOnDisposal

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.eclipse.epsilon.eol.models.IModel

allContents, close, createInstance, createInstance, deleteElement, dispose, getAliases, getAllOfKind, getAllOfType, getElementById, getElementId, getEnumerationValue, getFullyQualifiedTypeNameOf, getName, getPropertyGetter, getTransactionSupport, getTypeNameOf, getTypeOf, hasType, isInstantiable, isModelElement, isOfKind, isOfType, isPropertySet, isReadOnLoad, isStoredOnDisposal, knowsAboutProperty, load, load, load, owns, setElementId, setName, setReadOnLoad, setStoredOnDisposal, store

Methods inherited from interface org.eclipse.epsilon.eol.models.IReflectiveModel

getContainerOf

Field Details

PROPERTY_IS_METAMODEL_FILE_BASED

@Deprecated
public static final String PROPERTY_IS_METAMODEL_FILE_BASED

Deprecated.

PROPERTY_METAMODEL_URI and PROPERTY_FILE_BASED_METAMODEL_URI are now interpreted as comma-separated lists of 0+ metamodel locations, and it is allowed to mix both types of metamodels now. This property is no longer used.

See Also:

• Constant Field Values

PROPERTY_METAMODEL_URI

public static final String PROPERTY_METAMODEL_URI

One of the keys used to construct the first argument to Model.load(StringProperties, String). This key is a comma-separated list of zero or more namespaces URI of some of the metamodels to which this model conforms. Users may combine this key with PROPERTY_FILE_BASED_METAMODEL_URI to load both file-based and URI-based metamodels at the same time.

See Also:

• Constant Field Values

PROPERTY_FILE_BASED_METAMODEL_URI

public static final String PROPERTY_FILE_BASED_METAMODEL_URI

One of the keys used to construct the first argument to Model.load(StringProperties, String). This key is a comma-separated list of zero or more URIs that can be used to locate some of the metamodels to which this model conforms. Users may combine this key with PROPERTY_METAMODEL_URI to load both file-based and URI-based metamodels at the same time.

See Also:

• Constant Field Values

PROPERTY_METAMODEL_FILE

@Deprecated
public static final String PROPERTY_METAMODEL_FILE

Deprecated.

Replaced by PROPERTY_FILE_BASED_METAMODEL_URI. This property will be removed in a future release of Epsilon.

See Also:

• Constant Field Values

PROPERTY_MODEL_URI

public static final String PROPERTY_MODEL_URI

One of the keys used to construct the first argument to Model.load(StringProperties, String). This key is paired with a URI that can be used to locate this model. This key must always be paired with a value.

See Also:

• Constant Field Values

PROPERTY_MODEL_FILE

@Deprecated
public static final String PROPERTY_MODEL_FILE

Deprecated.

Replaced by PROPERTY_MODEL_URI. This property will be removed in a future release of Epsilon.

See Also:

• Constant Field Values

PROPERTY_REUSE_UNMODIFIED_FILE_BASED_METAMODELS

public static final String PROPERTY_REUSE_UNMODIFIED_FILE_BASED_METAMODELS

One of the keys used to construct the first argument to Model.load(StringProperties, String). This key is a Boolean value that if set to true (the default), tries to reuse previously registered file-based EPackages that have not been modified since the last time they were registered.

See Also:

• Constant Field Values

PROPERTY_VALIDATE

public static final String PROPERTY_VALIDATE

One of the keys used to construct the first argument to Model.load(StringProperties, String). This key is a Boolean value that if set to true it triggers validation of all the resources in the model's resource set after loading (default is false)

See Also:

• Constant Field Values

metamodelUris

protected List<org.eclipse.emf.common.util.URI> metamodelUris

packages

protected List<org.eclipse.emf.ecore.EPackage> packages

isMetamodelFileBased

@Deprecated
protected boolean isMetamodelFileBased

Deprecated.

modelUri

protected org.eclipse.emf.common.util.URI modelUri

metamodelFileUris

protected List<org.eclipse.emf.common.util.URI> metamodelFileUris

useExtendedMetadata

protected boolean useExtendedMetadata

validate

protected boolean validate

reuseUnmodifiedFileBasedMetamodels

protected boolean reuseUnmodifiedFileBasedMetamodels

fileBasedMetamodels

protected static Map<String,List<org.eclipse.emf.ecore.EPackage>> fileBasedMetamodels

fileBasedMetamodelTimestamps

protected static Map<String,Long> fileBasedMetamodelTimestamps

Constructor Details

EmfModel

public EmfModel()

Method Details

getPropertySetter

public IReflectivePropertySetter getPropertySetter()

Specified by:

getPropertySetter in interface IModel

Specified by:

getPropertySetter in interface IReflectiveModel

Overrides:

getPropertySetter in class Model

getPropertiesOf

public Collection<String> getPropertiesOf(String type)
                                   throws EolModelElementTypeNotFoundException

Description copied from interface: IReflectiveModel

Returns a collection containing all of the properties that instances of type know about.

Specified by:

getPropertiesOf in interface IReflectiveModel

Parameters:

type - The type of model object whose properties are to be determined.

Returns:

all of the properties that instances of type knows about.

Throws:

EolModelElementTypeNotFoundException - when this model has no such type

preventLoadingOfExternalModelElements

public boolean preventLoadingOfExternalModelElements()

Description copied from interface: IReflectiveModel

Prevents the loading of model elements that are referenced by this model but are not contained in this model. This is useful for clients, such as Epsilon Flock, which create a clone or conservative copy of this model.

Specified by:

preventLoadingOfExternalModelElements in interface IReflectiveModel

Returns:

true iff this method had an effect (i.e. when this model supports external references, was configured to load external references and is no longer configured to load external references).

load

public void load(StringProperties properties,
 IRelativePathResolver resolver)
          throws EolModelLoadingException

Load the model using the set of properties specified by the first argument.

Specified by:

load in interface IModel

Overrides:

load in class AbstractEmfModel

Throws:

EolModelLoadingException

See Also:

• PROPERTY_MODEL_URI
• PROPERTY_IS_METAMODEL_FILE_BASED
• AbstractEmfModel.PROPERTY_EXPAND
• Rationale for deprecating the FILE properties.

loadModel

protected void loadModel()
                  throws EolModelLoadingException

Specified by:

loadModel in class CachedModel<org.eclipse.emf.ecore.EObject>

Throws:

EolModelLoadingException

addToCache

protected void addToCache(String type,
 org.eclipse.emf.ecore.EObject instance)
                   throws EolModelElementTypeNotFoundException

Overrides:

addToCache in class CachedModel<org.eclipse.emf.ecore.EObject>

Throws:

EolModelElementTypeNotFoundException

removeFromCache

protected void removeFromCache(org.eclipse.emf.ecore.EObject instance)
                        throws EolModelElementTypeNotFoundException

Overrides:

removeFromCache in class CachedModel<org.eclipse.emf.ecore.EObject>

Throws:

EolModelElementTypeNotFoundException

forceAddToCache

protected void forceAddToCache(org.eclipse.emf.ecore.EObject instance)
                        throws EolModelElementTypeNotFoundException

We want to use the overridden method, but not from CachedModel.createInstance(String), but rather from the adapter we set up to track additions and removals from the contents of a model. For this reason, we leave the overridden method empty and define this one that can be safely called from the adapter.

Throws:

EolModelElementTypeNotFoundException

forceRemoveFromCache

protected void forceRemoveFromCache(org.eclipse.emf.ecore.EObject instance)
                             throws EolModelElementTypeNotFoundException

Throws:

EolModelElementTypeNotFoundException

See Also:

• #forceAddToCache(String, EObject)

setupContainmentChangeListeners

public void setupContainmentChangeListeners()

createResourceSet

protected org.eclipse.emf.ecore.resource.ResourceSet createResourceSet()

loadModelFromUri

public void loadModelFromUri()
                      throws EolModelLoadingException

Throws:

EolModelLoadingException

setCachingEnabled

public void setCachingEnabled(boolean cachingEnabled)

Overrides:

setCachingEnabled in class CachedModel<org.eclipse.emf.ecore.EObject>

Since:

1.6

getMetamodelFiles

public List<String> getMetamodelFiles()

isMetamodelFileBased

@Deprecated
public boolean isMetamodelFileBased()

Deprecated.

This value is no longer used to load models: it is only kept for backwards compatibility, and it now simply indicates whether a file metamodel was loaded at all, or not.

setMetamodelFileBased

@Deprecated
public void setMetamodelFileBased(boolean isMetamodelFileBased)

Deprecated.

This value is no longer honored anymore. Please populate the lists in getMetamodelUris() (URI-based metamodels) and getMetamodelFileUris() (file-based metamodels) appropriately instead.

getMetamodelUris

public List<String> getMetamodelUris()

getModelFile

public String getModelFile()

getModelFileUri

public org.eclipse.emf.common.util.URI getModelFileUri()

setModelFileUri

public void setModelFileUri(org.eclipse.emf.common.util.URI modelFileUri)

getMetamodelFileUris

public List<org.eclipse.emf.common.util.URI> getMetamodelFileUris()

setMetamodelFileUris

public void setMetamodelFileUris(List<org.eclipse.emf.common.util.URI> fileUris)

setMetamodelFileUri

public void setMetamodelFileUri(org.eclipse.emf.common.util.URI uri)

setMetamodelUris

public void setMetamodelUris(List<String> uris)

setMetamodelUri

public void setMetamodelUri(String uri)

setMetamodelFiles

public void setMetamodelFiles(List<String> paths)

setMetamodelFile

public void setMetamodelFile(String path)

setModelFile

public void setModelFile(String path)

isReuseUnmodifiedFileBasedMetamodels

public boolean isReuseUnmodifiedFileBasedMetamodels()

setReuseUnmodifiedFileBasedMetamodels

public void setReuseUnmodifiedFileBasedMetamodels(boolean reuseUnmodifiedFileBasedMetamodels)

hasProperty

public boolean hasProperty(String type,
 String property)
                    throws EolModelElementTypeNotFoundException

Specified by:

hasProperty in interface IReflectiveModel

Throws:

EolModelElementTypeNotFoundException

isEnumerationValue

public boolean isEnumerationValue(Object object)

Description copied from interface: IReflectiveModel

Returns true iff object is an enumeration value.

Specified by:

isEnumerationValue in interface IReflectiveModel

getEnumerationTypeOf

public String getEnumerationTypeOf(Object literal)
                            throws EolNotAnEnumerationValueException

Description copied from interface: IReflectiveModel

Returns the name of the enumeration type of the literal parameter.

Specified by:

getEnumerationTypeOf in interface IReflectiveModel

Throws:

EolNotAnEnumerationValueException - when literal is not an enumeration value

getEnumerationLabelOf

public String getEnumerationLabelOf(Object literal)
                             throws EolNotAnEnumerationValueException

Description copied from interface: IReflectiveModel

Returns the enumeration label of the literal parameter.

Specified by:

getEnumerationLabelOf in interface IReflectiveModel

Throws:

EolNotAnEnumerationValueException - when literal is not an enumeration value

toString

public String toString()

Overrides:

toString in class Object

determinePackagesFrom

protected void determinePackagesFrom(org.eclipse.emf.ecore.resource.ResourceSet resourceSet)
                              throws EolModelLoadingException

Throws:

EolModelLoadingException

hasPackage

public boolean hasPackage(String packageName)

Description copied from interface: IReflectiveModel

Returns true iff this model contains a package with the given name. In general, a "package" is a group of types (and potentially other packages) and a namespace for the grouped elements. The precise semantics of "package" is specific to the implementation. For example, an Ecore implementation might use EPackage. An XML implementation might use XML namespaces. A CSV implementation might not support any notion of packages (and hence always return false).

Specified by:

hasPackage in interface IReflectiveModel

getMetamodel

public Metamodel getMetamodel(StringProperties properties,
 IRelativePathResolver resolver)

Specified by:

getMetamodel in interface IModel

Overrides:

getMetamodel in class Model

store

public boolean store()

Specified by:

store in interface IModel

isValidate

public boolean isValidate()

setValidate

public void setValidate(boolean validate)