Package net.ssehub.easy.instantiation.core.model.common

Class AbstractResolvableModel<V extends IMetaParameterDeclaration,M extends IModel>

java.lang.Object

net.ssehub.easy.instantiation.core.model.common.AbstractResolvableModel<V,M>

Type Parameters:

V - the actual type of variable declaration

M - the actual type of model

All Implemented Interfaces:

IModel, IModelData, IModelListener<Project>, ICompoundReceiver, IParameterizable<V>, IResolvableModel<V,M>, ITypedefReceiver, IMetaType, ITypedModel

Direct Known Subclasses:

Script, Template

public abstract class AbstractResolvableModel<V extends IMetaParameterDeclaration,M extends IModel>
extends java.lang.Object
implements IResolvableModel<V,M>, IModelListener<Project>, ITypedefReceiver, ICompoundReceiver

A basic implementation of IResolvableModel. It registers itself as model listener in order to be informed when advices are updated causing the model to be flagged as dirty (direct reload may cause uncoordinated model reloads).

Author:

Holger Eichelberger

Field Summary

Fields

Modifier and Type	Field	Description
private Advice[]	advices
private java.util.List<Compound>	compounds
private boolean	dirty
private Imports<M>	imports
private TypeRegistry	registry
private java.util.List<Typedef>	typedefs

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AbstractResolvableModel(Imports<M> imports, TypeRegistry registry, Advice[] advices)	Creates an abstract resolvable model.

Method Summary

Modifier and Type	Method	Description
void	addCompound(Compound compound)	Adds a compound.
void	addImport(ModelImport<M> imp)	Add a project import to this model.
void	addRuntimeImport(ModelImport<M> imp)	Adds a runtime model import.
void	addTypedef(Typedef typedef)	Adds a typedef.
protected Imports<M>	createImports()	Creates an empty imports instance (in case that a specialized instance shall be used).
void	dispose()	Shall be called at the end of the lifetime of the model in order to clean up references such as listeners.
Advice	getAdvice(int index)	Get the advice at the specified index.
int	getAdviceCount()	Get the number of advices of this model.
Compound	getCompound(int index)	Get the compound at the specified index.
Compound	getCompound(java.lang.String name)	Returns the compound declaration with given name.
int	getCompoundCount()	Get the number of compounds defined in this model.
ModelImport<M>	getImport(int index)	Returns the model import specified by index.
protected Imports<M>	getImports()	Returns the imports instance.
int	getImportsCount()	Returns the number of imports.
java.lang.Object	getIvmlElement(java.lang.String name)	Returns whether the given name resolves to an IVML element.
Typedef	getTypedef(int index)	Get the typedef at the specified index.
Typedef	getTypedef(java.lang.String name)	Returns the typedef with given name.
int	getTypedefCount()	Get the number of typedefs of this model.
TypeRegistry	getTypeRegistry()	Returns the responsible type registry.
boolean	isDirty()	Returns whether this model has become dirty, e.g., due to updates of the underlying adviced models.
void	notifyReplaced(Project oldModel, Project newModel)	Is called to notify that oldModel is replaced by newModel.
private void	processModelListeners(boolean add)	Processes the model listeners for the advices.
protected abstract void	reload()	Causes a reload of this model.

Methods inherited from class java.lang.Object

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

Methods inherited from interface net.ssehub.easy.instantiation.core.model.vilTypes.IMetaType

addPlaceholderOperation, checkConversion, enableDynamicDispatch, findConversion, getBaseType, getCandidates, getField, getFieldCount, getGenericParameterCount, getGenericParameterType, getName, getOperation, getOperationsCount, getQualifiedName, getSuperType, isActualTypeOf, isAssignableFrom, isBasicType, isInternal, isPlaceholder

Methods inherited from interface net.ssehub.easy.basics.modelManagement.IModel

getIndentationConfiguration, getName, getRestrictionEvaluationContext, getSuper, getVersion, setVersion

Methods inherited from interface net.ssehub.easy.instantiation.core.model.common.IParameterizable

getParameter, getParameter, getParameterCount, getRequiredParameterCount

Methods inherited from interface net.ssehub.easy.instantiation.core.model.common.IResolvableModel

getExtensionType, getExtensionTypesCount, getParent, getVariableDeclaration, getVariableDeclarationCount, isImplicit

Field Detail

dirty

private transient boolean dirty

imports

private Imports<M extends IModel> imports

registry

private TypeRegistry registry

advices

private Advice[] advices

typedefs

private java.util.List<Typedef> typedefs

compounds

private java.util.List<Compound> compounds

Constructor Detail

AbstractResolvableModel

protected AbstractResolvableModel(Imports<M> imports,
                                  TypeRegistry registry,
                                  Advice[] advices)

Creates an abstract resolvable model.

Parameters:

imports - the imports

registry - the registry which is responsible for this type

advices - the advices (may be null)

Method Detail

processModelListeners

private void processModelListeners(boolean add)

Processes the model listeners for the advices.

Parameters:

add - add or remove the model listeners

getImportsCount

public int getImportsCount()

Description copied from interface: IModel

Returns the number of imports.

Specified by:

getImportsCount in interface IModel

Returns:

the number of imports

getImport

public ModelImport<M> getImport(int index)

Description copied from interface: IModel

Returns the model import specified by index.

Specified by:

getImport in interface IModel

Parameters:

index - a 0-based index specifying the import to be returned

Returns:

the model import

createImports

protected Imports<M> createImports()

Creates an empty imports instance (in case that a specialized instance shall be used).

Returns:

the created instance

addImport

public void addImport(ModelImport<M> imp)

Add a project import to this model.

Parameters:

imp - The additional project import.

addRuntimeImport

public void addRuntimeImport(ModelImport<M> imp)

Description copied from interface: IResolvableModel

Adds a runtime model import.

Specified by:

addRuntimeImport in interface IResolvableModel<V extends IMetaParameterDeclaration,M extends IModel>

Parameters:

imp - the import

getImports

protected Imports<M> getImports()

Returns the imports instance.

Returns:

the imports instance

getTypeRegistry

public TypeRegistry getTypeRegistry()

Description copied from interface: IResolvableModel

Returns the responsible type registry.

Specified by:

getTypeRegistry in interface IMetaType

Specified by:

getTypeRegistry in interface IResolvableModel<V extends IMetaParameterDeclaration,M extends IModel>

Returns:

the type registry

getAdviceCount

public int getAdviceCount()

Get the number of advices of this model.

Returns:

The number of advices of this model.

getAdvice

public Advice getAdvice(int index)

Get the advice at the specified index.

Parameters:

index - The 0-based index of the advice to be returned.

Returns:

The advice parameter at the given index.

Throws:

java.lang.IndexOutOfBoundsException - if index < 0 || index >=getAdviceCount()

getTypedefCount

public int getTypedefCount()

Description copied from interface: IResolvableModel

Get the number of typedefs of this model.

Specified by:

getTypedefCount in interface IResolvableModel<V extends IMetaParameterDeclaration,M extends IModel>

Returns:

The number of typedefs of this model.

getTypedef

public Typedef getTypedef(int index)

Description copied from interface: IResolvableModel

Get the typedef at the specified index.

Specified by:

getTypedef in interface IResolvableModel<V extends IMetaParameterDeclaration,M extends IModel>

Parameters:

index - The 0-based index of the typedef to be returned.

Returns:

The typedef parameter at the given index.

addTypedef

public void addTypedef(Typedef typedef)

Description copied from interface: ITypedefReceiver

Adds a typedef.

Specified by:

addTypedef in interface ITypedefReceiver

Parameters:

typedef - the typedef to be added

getTypedef

public Typedef getTypedef(java.lang.String name)

Description copied from interface: IResolvableModel

Returns the typedef with given name.

Specified by:

getTypedef in interface IResolvableModel<V extends IMetaParameterDeclaration,M extends IModel>

Parameters:

name - the name

Returns:

the typedef (may be null for none)

addCompound

public void addCompound(Compound compound)

Description copied from interface: ICompoundReceiver

Adds a compound.

Specified by:

addCompound in interface ICompoundReceiver

Parameters:

compound - the compound to be added

getCompound

public Compound getCompound(java.lang.String name)

Description copied from interface: IResolvableModel

Returns the compound declaration with given name.

Specified by:

getCompound in interface IResolvableModel<V extends IMetaParameterDeclaration,M extends IModel>

Parameters:

name - the name

Returns:

the compound (may be null for none)

getCompoundCount

public int getCompoundCount()

Description copied from interface: IResolvableModel

Get the number of compounds defined in this model.

Specified by:

getCompoundCount in interface IResolvableModel<V extends IMetaParameterDeclaration,M extends IModel>

Returns:

The number of compounds of this model.

getCompound

public Compound getCompound(int index)

Description copied from interface: IResolvableModel

Get the compound at the specified index.

Specified by:

getCompound in interface IResolvableModel<V extends IMetaParameterDeclaration,M extends IModel>

Parameters:

index - The 0-based index of the compound to be returned.

Returns:

The compound at the given index.

dispose

public void dispose()

Description copied from interface: IModel

Shall be called at the end of the lifetime of the model in order to clean up references such as listeners.

Specified by:

dispose in interface IModel

isDirty

public boolean isDirty()

Returns whether this model has become dirty, e.g., due to updates of the underlying adviced models.

Returns:

true if this model has become dirty and shall be at least reloaded before execution, false else

notifyReplaced

public void notifyReplaced(Project oldModel,
                           Project newModel)

Description copied from interface: IModelListener

Is called to notify that oldModel is replaced by newModel. The listener registrations for oldModel will be adjusted accordingly.
Do not modify the the listeners of oldModel or newModel during this method.

Specified by:

notifyReplaced in interface IModelListener<V extends IMetaParameterDeclaration>

Parameters:

oldModel - the old model being replaced

newModel - the new model (the replacement)

getIvmlElement

public java.lang.Object getIvmlElement(java.lang.String name)

Description copied from interface: IResolvableModel

Returns whether the given name resolves to an IVML element.

Specified by:

getIvmlElement in interface IResolvableModel<V extends IMetaParameterDeclaration,M extends IModel>

Parameters:

name - the name to be resolved

Returns:

the IVML element (value, containable model element), null else

reload

protected abstract void reload()

Causes a reload of this model.