Package org.eclipse.epsilon.eol.models

Class Model

java.lang.Object

org.eclipse.epsilon.eol.models.Model

All Implemented Interfaces:

AutoCloseable, IModel

Direct Known Subclasses:

CachedModel, CompositeModel, EmptyModel, HutnModel, JavaModel, JavaObjectModel, ModelGroup, MuddleModel, PatternMatchModel, SpreadsheetModel

public abstract class Model
extends Object
implements IModel

Nested Class Summary

Nested classes/interfaces inherited from interface org.eclipse.epsilon.eol.models.IModel

IModel.AmbiguityCheckResult

Field Summary

Fields

Modifier and Type	Field	Description
protected List<String>	aliases
protected static String	ENV_PREFIX	Used for acquiring properties externally (e.g.
protected String	name
static String	PROPERTY_ALIASES
static String	PROPERTY_NAME
static String	PROPERTY_READONLOAD
static String	PROPERTY_READONLY	Indicates that the model will not be modified.
static String	PROPERTY_STOREONDISPOSAL
protected IPropertyGetter	propertyGetter
protected IPropertySetter	propertySetter
protected boolean	readOnLoad
protected boolean	storeOnDisposal

Constructor Summary

Constructors

Constructor	Description
Model()

Method Summary

Modifier and Type	Method	Description
Collection<?>	allInstances()
Object	createInstance(String type, Collection<Object> parameters)
void	dispose()
List<String>	getAliases()
String	getFullyQualifiedTypeNameOf(Object instance)	Returns a string representing the fully-qualified type of the instance object.
Metamodel	getMetamodel(StringProperties properties, IRelativePathResolver resolver)
String	getName()
IPropertyGetter	getPropertyGetter()
IPropertySetter	getPropertySetter()
IModelTransactionSupport	getTransactionSupport()
Object	getTypeOf(Object instance)
boolean	isModelElement(Object instance)	Used to test whether a Java object can be contained by this model.
boolean	isOfKind(Object instance, String metaClass)
boolean	isOfType(Object instance, String metaClass)
boolean	isPropertySet(Object instance, String property)	Returns true if this instance has an explicit value for this property.
boolean	isReadOnLoad()
boolean	isStoredOnDisposal()
boolean	knowsAboutProperty(Object instance, String property)	Returns true if this instance could have this property at some point.
void	load(StringProperties properties)
void	load(StringProperties properties, String basePath)
void	load(StringProperties properties, IRelativePathResolver resolver)
void	setName(String name)
void	setReadOnLoad(boolean readOnLoad)
void	setStoredOnDisposal(boolean storedOnDisposal)

Methods inherited from class java.lang.Object

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

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

allContents, checkAmbiguity, close, createInstance, deleteElement, getAllOfKind, getAllOfType, getElementById, getElementId, getEnumerationValue, getTypeNameOf, hasType, isInstantiable, load, owns, setElementId, store, store

Field Detail

PROPERTY_NAME

public static final String PROPERTY_NAME

See Also:

Constant Field Values

PROPERTY_READONLOAD

public static final String PROPERTY_READONLOAD

See Also:

Constant Field Values

PROPERTY_STOREONDISPOSAL

public static final String PROPERTY_STOREONDISPOSAL

See Also:

Constant Field Values

PROPERTY_ALIASES

public static final String PROPERTY_ALIASES

See Also:

Constant Field Values

PROPERTY_READONLY

public static final String PROPERTY_READONLY

Indicates that the model will not be modified.

Since:

1.6

See Also:

Constant Field Values

ENV_PREFIX

protected static final String ENV_PREFIX

Used for acquiring properties externally (e.g. from environment variables)

Since:

1.6

See Also:

Constant Field Values

name

protected String name

aliases

protected List<String> aliases

storeOnDisposal

protected boolean storeOnDisposal

readOnLoad

protected boolean readOnLoad

propertyGetter

protected IPropertyGetter propertyGetter

Since:

1.6

propertySetter

protected IPropertySetter propertySetter

Since:

1.6

Constructor Detail

Model

public Model()

Method Detail

getName

public String getName()

Specified by:

getName in interface IModel

setName

public void setName(String name)

Specified by:

setName in interface IModel

getAliases

public List<String> getAliases()

Specified by:

getAliases in interface IModel

load

public void load(StringProperties properties,
                 String basePath)
          throws EolModelLoadingException

Specified by:

load in interface IModel

Throws:

EolModelLoadingException

load

public void load(StringProperties properties)
          throws EolModelLoadingException

Specified by:

load in interface IModel

Throws:

EolModelLoadingException

load

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

Specified by:

load in interface IModel

Throws:

EolModelLoadingException

createInstance

public Object createInstance(String type,
                             Collection<Object> parameters)
                      throws EolModelElementTypeNotFoundException,
                             EolNotInstantiableModelElementTypeException

Specified by:

createInstance in interface IModel

Throws:

EolModelElementTypeNotFoundException

EolNotInstantiableModelElementTypeException

allInstances

public Collection<?> allInstances()

isOfKind

public boolean isOfKind(Object instance,
                        String metaClass)
                 throws EolModelElementTypeNotFoundException

Specified by:

isOfKind in interface IModel

Throws:

EolModelElementTypeNotFoundException

isOfType

public boolean isOfType(Object instance,
                        String metaClass)
                 throws EolModelElementTypeNotFoundException

Specified by:

isOfType in interface IModel

Throws:

EolModelElementTypeNotFoundException

getFullyQualifiedTypeNameOf

public String getFullyQualifiedTypeNameOf(Object instance)

Description copied from interface: IModel

Returns a string representing the fully-qualified type of the instance object. The value returned by this function can be passed to createInstance to instantiate another object of the same type as instance.

Specified by:

getFullyQualifiedTypeNameOf in interface IModel

Parameters:

instance - The model object whose type is to be determined.

Returns:

the name of the type of the model object, instance.

isModelElement

public boolean isModelElement(Object instance)

Description copied from interface: IModel

Used to test whether a Java object can be contained by this model. For example, EMF models can contain instances of EObject, but not instances of just Object.

Specified by:

isModelElement in interface IModel

Parameters:

instance - the Java object to test.

Returns:

true if and only if instance can be contained by this model.

getTypeOf

public Object getTypeOf(Object instance)

Specified by:

getTypeOf in interface IModel

isReadOnLoad

public boolean isReadOnLoad()

Specified by:

isReadOnLoad in interface IModel

isStoredOnDisposal

public boolean isStoredOnDisposal()

Specified by:

isStoredOnDisposal in interface IModel

setReadOnLoad

public void setReadOnLoad(boolean readOnLoad)

Specified by:

setReadOnLoad in interface IModel

setStoredOnDisposal

public void setStoredOnDisposal(boolean storedOnDisposal)

Specified by:

setStoredOnDisposal in interface IModel

getPropertyGetter

public IPropertyGetter getPropertyGetter()

Specified by:

getPropertyGetter in interface IModel

getPropertySetter

public IPropertySetter getPropertySetter()

Specified by:

getPropertySetter in interface IModel

dispose

public void dispose()

Specified by:

dispose in interface IModel

knowsAboutProperty

public boolean knowsAboutProperty(Object instance,
                                  String property)

Description copied from interface: IModel

Returns true if this instance could have this property at some point.

Specified by:

knowsAboutProperty in interface IModel

getTransactionSupport

public IModelTransactionSupport getTransactionSupport()

Specified by:

getTransactionSupport in interface IModel

getMetamodel

public Metamodel getMetamodel(StringProperties properties,
                              IRelativePathResolver resolver)

Specified by:

getMetamodel in interface IModel

isPropertySet

public boolean isPropertySet(Object instance,
                             String property)
                      throws EolRuntimeException

Description copied from interface: IModel

Returns true if this instance has an explicit value for this property. This would be equivalent to eIsSet in EMF.

Specified by:

isPropertySet in interface IModel

Throws:

EolRuntimeException