org.eclipse.epsilon.eol.models

Class CachedModel<ModelElementType>

java.lang.Object

org.eclipse.epsilon.eol.models.Model

org.eclipse.epsilon.eol.models.CachedModel<ModelElementType>

All Implemented Interfaces:

IModel

Direct Known Subclasses:

AbstractEmfModel, BibtexModel, CsvModel, PlainXmlModel

public abstract class CachedModel<ModelElementType>
extends Model

A model that performs memoization of allContents, getAllOfType and getAllOfKind. Subclasses should implement the template methods, which compute real values from the model or provide keys that can be used with a Map.

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	allContentsAreCached
protected Collection<ModelElementType>	allContentsCache
protected List<Object>	cachedKinds
protected List<Object>	cachedTypes
protected boolean	cachingEnabled
protected Multimap<Object,ModelElementType>	kindCache
static String	PROPERTY_CACHED
protected Multimap<Object,ModelElementType>	typeCache

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

aliases, name, PROPERTY_ALIASES, PROPERTY_NAME, PROPERTY_READONLOAD, PROPERTY_STOREONDISPOSAL, readOnLoad, storeOnDisposal

Constructor Summary

Constructors

Constructor and Description
CachedModel()

Method Summary

Methods

Modifier and Type	Method and Description
Collection<ModelElementType>	allContents() Returns a collection containing all of the objects contained in this model.
protected abstract Collection<? extends ModelElementType>	allContentsFromModel()
void	clearCache()
ModelElementType	createInstance(String type)
protected abstract ModelElementType	createInstanceInModel(String type)
void	deleteElement(Object o)
protected abstract boolean	deleteElementInModel(Object instance) Returns true iff the given instance was deleted from the model.
void	dispose()
protected abstract void	disposeModel()
Collection<ModelElementType>	getAllOfKind(String kind)
protected abstract Collection<? extends ModelElementType>	getAllOfKindFromModel(String kind)
Collection<ModelElementType>	getAllOfType(String type)
protected abstract Collection<? extends ModelElementType>	getAllOfTypeFromModel(String type)
protected abstract Collection<String>	getAllTypeNamesOf(Object instance) Returns the names of every type to which the given object conforms.
protected abstract Object	getCacheKeyForType(String type) Returns an identity for the given type, which will be used by CachedModel as a key for the memoization of model elements by type.
boolean	isCachingEnabled()
void	load()
void	load(StringProperties properties, IRelativePathResolver resolver)
protected abstract void	loadModel()
void	setCachingEnabled(boolean cachingEnabled)

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

allInstances, createInstance, getAliases, getFullyQualifiedTypeNameOf, getMetamodel, getName, getPropertyGetter, getPropertySetter, getTransactionSupport, getTypeOf, isModelElement, isOfKind, isOfType, isReadOnLoad, isStoredOnDisposal, knowsAboutProperty, load, load, setName, setReadOnLoad, setStoredOnDisposal

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

getElementById, getElementId, getEnumerationValue, getTypeNameOf, hasType, isInstantiable, owns, setElementId, store, store

Field Detail

PROPERTY_CACHED

public static String PROPERTY_CACHED

allContentsCache

protected Collection<ModelElementType> allContentsCache

allContentsAreCached

protected boolean allContentsAreCached

cachedTypes

protected List<Object> cachedTypes

typeCache

protected Multimap<Object,ModelElementType> typeCache

cachedKinds

protected List<Object> cachedKinds

kindCache

protected Multimap<Object,ModelElementType> kindCache

cachingEnabled

protected boolean cachingEnabled

Constructor Detail

CachedModel

public CachedModel()

Method Detail

allContentsFromModel

protected abstract Collection<? extends ModelElementType> allContentsFromModel()

getAllOfTypeFromModel

protected abstract Collection<? extends ModelElementType> getAllOfTypeFromModel(String type)
                                                                         throws EolModelElementTypeNotFoundException

Throws:

EolModelElementTypeNotFoundException

getAllOfKindFromModel

protected abstract Collection<? extends ModelElementType> getAllOfKindFromModel(String kind)
                                                                         throws EolModelElementTypeNotFoundException

Throws:

EolModelElementTypeNotFoundException

createInstanceInModel

protected abstract ModelElementType createInstanceInModel(String type)
                                                   throws EolModelElementTypeNotFoundException,
                                                          EolNotInstantiableModelElementTypeException

Throws:

EolModelElementTypeNotFoundException

EolNotInstantiableModelElementTypeException

loadModel

protected abstract void loadModel()
                           throws EolModelLoadingException

Throws:

EolModelLoadingException

disposeModel

protected abstract void disposeModel()

deleteElementInModel

protected abstract boolean deleteElementInModel(Object instance)
                                         throws EolRuntimeException

Returns true iff the given instance was deleted from the model.

Throws:

EolRuntimeException

getCacheKeyForType

protected abstract Object getCacheKeyForType(String type)
                                      throws EolModelElementTypeNotFoundException

Returns an identity for the given type, which will be used by CachedModel as a key for the memoization of model elements by type.

Throws:

EolModelElementTypeNotFoundException

getAllTypeNamesOf

protected abstract Collection<String> getAllTypeNamesOf(Object instance)

Returns the names of every type to which the given object conforms. The values are used by by CachedModel for the memoization of model elements by their kind (getAllOfKind(String)).

setCachingEnabled

public void setCachingEnabled(boolean cachingEnabled)

isCachingEnabled

public boolean isCachingEnabled()

allContents

public Collection<ModelElementType> allContents()

Description copied from interface: IModel

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

Returns:

all of the objects contained in this model.

getAllOfType

public Collection<ModelElementType> getAllOfType(String type)
                                          throws EolModelElementTypeNotFoundException

Throws:

EolModelElementTypeNotFoundException

getAllOfKind

public Collection<ModelElementType> getAllOfKind(String kind)
                                          throws EolModelElementTypeNotFoundException

Throws:

EolModelElementTypeNotFoundException

createInstance

public ModelElementType createInstance(String type)
                                throws EolModelElementTypeNotFoundException,
                                       EolNotInstantiableModelElementTypeException

Throws:

EolModelElementTypeNotFoundException

EolNotInstantiableModelElementTypeException

deleteElement

public void deleteElement(Object o)
                   throws EolRuntimeException

Throws:

EolRuntimeException

load

public void load()
          throws EolModelLoadingException

Throws:

EolModelLoadingException

load

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

Specified by:

load in interface IModel

Overrides:

load in class Model

Throws:

EolModelLoadingException

dispose

public void dispose()

Specified by:

dispose in interface IModel

Overrides:

dispose in class Model

clearCache

public void clearCache()