Package org.eclipse.epsilon.eol.models

Class ModelReference

java.lang.Object

org.eclipse.epsilon.eol.models.ModelReference

All Implemented Interfaces:

java.lang.AutoCloseable, IOperationContributorProvider, IWrapper, IAdaptableModel, IModel

Direct Known Subclasses:

ReflectiveModelReference

public class ModelReference
extends java.lang.Object
implements IAdaptableModel, IWrapper, IOperationContributorProvider

Field Summary

Fields

Modifier and Type	Field	Description
protected java.util.List<java.lang.String>	aliases
protected java.lang.String	name
protected IModel	target

Constructor Summary

Constructors

Constructor	Description
ModelReference(IModel target)

Method Summary

Modifier and Type	Method	Description
<T> T	adaptTo(java.lang.Class<T> modelType)	Tries to adapt the model to a different type.
java.util.Collection<?>	allContents()	Returns a collection containing all of the objects contained in this model.
java.lang.Object	createInstance(java.lang.String type)
java.lang.Object	createInstance(java.lang.String type, java.util.Collection<java.lang.Object> parameters)
void	deleteElement(java.lang.Object instance)
void	dispose()
java.util.List<java.lang.String>	getAliases()
java.util.Collection<?>	getAllOfKind(java.lang.String type)
java.util.Collection<?>	getAllOfType(java.lang.String type)
java.lang.Object	getElementById(java.lang.String id)
java.lang.String	getElementId(java.lang.Object instance)
java.lang.Object	getEnumerationValue(java.lang.String enumeration, java.lang.String label)
java.lang.String	getFullyQualifiedTypeNameOf(java.lang.Object instance)	Returns a string representing the fully-qualified type of the instance object.
Metamodel	getMetamodel(StringProperties properties, IRelativePathResolver resolver)
java.lang.String	getName()
OperationContributor	getOperationContributor()
IPropertyGetter	getPropertyGetter()
IPropertySetter	getPropertySetter()
IModel	getTarget()
IModelTransactionSupport	getTransactionSupport()
java.lang.String	getTypeNameOf(java.lang.Object instance)	Returns a string representing the type of the instance object.
java.lang.Object	getTypeOf(java.lang.Object instance)
java.lang.Object	getWrapped()
boolean	hasType(java.lang.String type)
boolean	isInstantiable(java.lang.String type)
boolean	isModelElement(java.lang.Object instance)	Used to test whether a Java object can be contained by this model.
boolean	isOfKind(java.lang.Object instance, java.lang.String type)
boolean	isOfType(java.lang.Object instance, java.lang.String type)
boolean	isPropertySet(java.lang.Object instance, java.lang.String property)	Returns true if this instance has an explicit value for this property.
boolean	isReadOnLoad()
boolean	isStoredOnDisposal()
boolean	knowsAboutProperty(java.lang.Object instance, java.lang.String property)	Returns true if this instance could have this property at some point.
void	load()
void	load(StringProperties properties)
void	load(StringProperties properties, java.lang.String basePath)
void	load(StringProperties properties, IRelativePathResolver resolver)
boolean	owns(java.lang.Object instance)	Used to test whether an object is contained in this model.
void	setElementId(java.lang.Object instance, java.lang.String newId)
void	setName(java.lang.String name)
void	setReadOnLoad(boolean readOnLoad)
void	setStoredOnDisposal(boolean storedOnDisposal)
boolean	store()
boolean	store(java.lang.String fileName)

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

close

Field Detail

target

protected IModel target

name

protected java.lang.String name

aliases

protected java.util.List<java.lang.String> aliases

Constructor Detail

ModelReference

public ModelReference(IModel target)

Method Detail

getTarget

public IModel getTarget()

getName

public java.lang.String getName()

Specified by:

getName in interface IModel

setName

public void setName(java.lang.String name)

Specified by:

setName in interface IModel

getAliases

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

Specified by:

getAliases in interface IModel

allContents

public java.util.Collection<?> allContents()

Description copied from interface: IModel

Returns a collection containing all of the objects contained in this model.

Specified by:

allContents in interface IModel

Returns:

all of the objects contained in this model.

createInstance

public java.lang.Object createInstance(java.lang.String type)
                                throws EolModelElementTypeNotFoundException,
                                       EolNotInstantiableModelElementTypeException

Specified by:

createInstance in interface IModel

Throws:

EolModelElementTypeNotFoundException

EolNotInstantiableModelElementTypeException

deleteElement

public void deleteElement(java.lang.Object instance)
                   throws EolRuntimeException

Specified by:

deleteElement in interface IModel

Throws:

EolRuntimeException

dispose

public void dispose()

Specified by:

dispose in interface IModel

getAllOfKind

public java.util.Collection<?> getAllOfKind(java.lang.String type)
                                     throws EolModelElementTypeNotFoundException

Specified by:

getAllOfKind in interface IModel

Throws:

EolModelElementTypeNotFoundException

getAllOfType

public java.util.Collection<?> getAllOfType(java.lang.String type)
                                     throws EolModelElementTypeNotFoundException

Specified by:

getAllOfType in interface IModel

Throws:

EolModelElementTypeNotFoundException

getEnumerationValue

public java.lang.Object getEnumerationValue(java.lang.String enumeration,
                                            java.lang.String label)
                                     throws EolEnumerationValueNotFoundException

Specified by:

getEnumerationValue in interface IModel

Throws:

EolEnumerationValueNotFoundException

getElementById

public java.lang.Object getElementById(java.lang.String id)

Specified by:

getElementById in interface IModel

getElementId

public java.lang.String getElementId(java.lang.Object instance)

Specified by:

getElementId in interface IModel

setElementId

public void setElementId(java.lang.Object instance,
                         java.lang.String newId)

Specified by:

setElementId in interface IModel

getPropertyGetter

public IPropertyGetter getPropertyGetter()

Specified by:

getPropertyGetter in interface IModel

getPropertySetter

public IPropertySetter getPropertySetter()

Specified by:

getPropertySetter in interface IModel

getTypeOf

public java.lang.Object getTypeOf(java.lang.Object instance)

Specified by:

getTypeOf in interface IModel

getTypeNameOf

public java.lang.String getTypeNameOf(java.lang.Object instance)

Description copied from interface: IModel

Returns a string representing the 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:

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

getFullyQualifiedTypeNameOf

public java.lang.String getFullyQualifiedTypeNameOf(java.lang.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.

hasType

public boolean hasType(java.lang.String type)

Specified by:

hasType in interface IModel

isInstantiable

public boolean isInstantiable(java.lang.String type)

Specified by:

isInstantiable in interface IModel

isModelElement

public boolean isModelElement(java.lang.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.

isOfKind

public boolean isOfKind(java.lang.Object instance,
                        java.lang.String type)
                 throws EolModelElementTypeNotFoundException

Specified by:

isOfKind in interface IModel

Throws:

EolModelElementTypeNotFoundException

isOfType

public boolean isOfType(java.lang.Object instance,
                        java.lang.String type)
                 throws EolModelElementTypeNotFoundException

Specified by:

isOfType in interface IModel

Throws:

EolModelElementTypeNotFoundException

isReadOnLoad

public boolean isReadOnLoad()

Specified by:

isReadOnLoad in interface IModel

isStoredOnDisposal

public boolean isStoredOnDisposal()

Specified by:

isStoredOnDisposal in interface IModel

load

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

Specified by:

load in interface IModel

Throws:

EolModelLoadingException

load

public void load()
          throws EolModelLoadingException

Specified by:

load in interface IModel

Throws:

EolModelLoadingException

owns

public boolean owns(java.lang.Object instance)

Description copied from interface: IModel

Used to test whether an object is contained in this model.

Specified by:

owns in interface IModel

Parameters:

instance - the Java object to test.

Returns:

true if and only if instance is contained by this model.

setReadOnLoad

public void setReadOnLoad(boolean readOnLoad)

Specified by:

setReadOnLoad in interface IModel

setStoredOnDisposal

public void setStoredOnDisposal(boolean storedOnDisposal)

Specified by:

setStoredOnDisposal in interface IModel

store

public boolean store(java.lang.String fileName)

Specified by:

store in interface IModel

store

public boolean store()

Specified by:

store in interface IModel

getTransactionSupport

public IModelTransactionSupport getTransactionSupport()

Specified by:

getTransactionSupport in interface IModel

knowsAboutProperty

public boolean knowsAboutProperty(java.lang.Object instance,
                                  java.lang.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

isPropertySet

public boolean isPropertySet(java.lang.Object instance,
                             java.lang.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

createInstance

public java.lang.Object createInstance(java.lang.String type,
                                       java.util.Collection<java.lang.Object> parameters)
                                throws EolModelElementTypeNotFoundException,
                                       EolNotInstantiableModelElementTypeException

Specified by:

createInstance in interface IModel

Throws:

EolModelElementTypeNotFoundException

EolNotInstantiableModelElementTypeException

getWrapped

public java.lang.Object getWrapped()

Specified by:

getWrapped in interface IWrapper

adaptTo

public <T> T adaptTo(java.lang.Class<T> modelType)

Description copied from interface: IAdaptableModel

Tries to adapt the model to a different type. If it is not possible, this method should return null.

Specified by:

adaptTo in interface IAdaptableModel

Parameters:

modelType - Type to which this model should be adapted.

Returns:

Non-null value if the model could be adapted, null otherwise.

getOperationContributor

public OperationContributor getOperationContributor()

Specified by:

getOperationContributor in interface IOperationContributorProvider

load

public void load(StringProperties properties,
                 java.lang.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

getMetamodel

public Metamodel getMetamodel(StringProperties properties,
                              IRelativePathResolver resolver)

Specified by:

getMetamodel in interface IModel