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

Class Template

java.lang.Object

net.ssehub.easy.instantiation.core.model.common.AbstractResolvableModel<VariableDeclaration,Template>

net.ssehub.easy.instantiation.core.model.templateModel.Template

All Implemented Interfaces:

IModel, IModelData, IModelListener<Project>, ICompoundReceiver, ILanguageElement, IParameterizable<VariableDeclaration>, IResolvableModel<VariableDeclaration,Template>, ITypedefReceiver, IVariableDeclarationReceiver<VariableDeclaration>, ITemplateLangElement, IMetaType, ITypedModel

public class Template
extends AbstractResolvableModel<VariableDeclaration,Template>
implements ITemplateLangElement, IResolvableModel<VariableDeclaration,Template>, IVariableDeclarationReceiver<VariableDeclaration>

Represents a VIL template.

Author:

Holger Eichelberger

Field Summary

Fields

Modifier and Type	Field	Description
private java.util.List<VariableDeclaration>	declarations
private java.util.List<Def>	defs
private ModelImport<Template>	extension
private FormattingConfiguration	formattingConfiguration
private IndentationConfiguration	indentationConfiguration
private JavaExtension[]	javaExtensions
private java.lang.String	name
private java.util.Map<java.lang.String,VariableDeclaration>	namedParams
private VariableDeclaration[]	param
private Version	version

Constructor Summary

Constructors

Constructor	Description
Template()	Constructor for serialization.
Template(java.lang.String name, ModelImport<Template> extension, TemplateDescriptor descriptor, TypeRegistry registry)	Creates a VIL template instance.

Method Summary

Modifier and Type	Method	Description
java.lang.Object	accept(IVisitor visitor)	Accepts the visitor for visiting.
void	addDef(Def def)	Adds a sub-template.
IMetaOperation	addPlaceholderOperation(java.lang.String name, int parameterCount, boolean acceptsNamedParameters)	Adds a placeholder operation, i.e., in case that the original operation cannot be resolved but the script shall remain executable.
void	addVariableDeclaration(VariableDeclaration var)	Adds a variable declaration.
protected void	adjustParents()	Adjusts the parents.
boolean	checkConversion(IMetaType param, IMetaOperation conversion)	Checks a conversion from this type to param via the given conversion.
boolean	enableDynamicDispatch()	Returns whether this type enables dynamic dispatch of operations.
IMetaOperation	findConversion(IMetaType sourceType, IMetaType targetType)	Returns the conversion operation from this type to target type (if there is any).
IMetaType	getBaseType()	Returns the base type (in case of IVML derived types).
java.util.List<IMetaOperation>	getCandidates(java.lang.String name, int unnamedArgsCount)	Returns operation candidates matching the given name and number of unnamed (required) arguments.
Def	getDef(int index)	Get the sub-templates of this template at the specified index.
int	getDefCount()	Get the number of sub-templates of this template.
IMetaType	getExtensionType(int index)	Returns the specified extension type.
int	getExtensionTypesCount()	Returns the number of extension types declared in/by this model.
IMetaField	getField(int index)	Returns the specified field.
int	getFieldCount()	Returns the number of fields provided by this type.
FormattingConfiguration	getFormattingConfiguration()	Returns the formatting configuration of this script.
int	getGenericParameterCount()	Returns the number of generic type parameters.
TypeDescriptor<?>	getGenericParameterType(int index)	Returns the specified generic parameter type.
IndentationConfiguration	getIndentationConfiguration()	Returns the indentation configuration for this model.
JavaExtension	getJavaExtension(int index)	Get the extension of this template at the specified index.
int	getJavaExtensionCount()	Get the number of extensions of this template.
java.lang.String	getName()	Returns the name of the model element.
IMetaOperation	getOperation(int index)	Returns the specified operation.
int	getOperationsCount()	Returns the number of operations provided by this type.
VariableDeclaration	getParameter(int index)	Get the parameter of this rule at the specified index.
VariableDeclaration	getParameter(java.lang.String name)	Returns a named parameter declaration.
int	getParameterCount()	Get the number of parameters of this rule.
Template	getParent()	Returns the parent element.
java.lang.String	getQualifiedName()	Returns the qualified name of this type.
int	getRequiredParameterCount()	Returns the number of required parameters, i.e., non-default and non-named parameters.
IRestrictionEvaluationContext	getRestrictionEvaluationContext()	Returns the context for evaluating import / conflict restrictions.
ModelImport<Template>	getSuper()	Returns the reference to the super model (if it exists).
IMetaType	getSuperType()	Returns the type this type is refined from.
VariableDeclaration	getVariableDeclaration(int index)	Get the variable declaration of this template at the specified index.
int	getVariableDeclarationCount()	Get the number of variable declaration of this template.
Version	getVersion()	Returns the version of this model.
boolean	isActualTypeOf(IMetaType type)	Returns whether this type can act as an actual type of type.
boolean	isAssignableFrom(IMetaType type)	Returns whether this type is the same or a super class of type.
boolean	isBasicType()	Returns whether this instance represents a basic type.
boolean	isImplicit(VariableDeclaration decl)	Returns whether a variable declaration is implicit (predefined).
boolean	isInternal()	Returns whether this type is internal and shall not be visible to the user.
boolean	isPlaceholder()	Returns whether this type is valid or whether it is a placeholder type in case that the original type cannot be resolved but the script shall remain executable.
protected void	reload()	Causes a reload of this model.
void	removeDef(Def def)	Adds a sub-template.
void	setVersion(Version version)	Changes the version of this model.

Methods inherited from class net.ssehub.easy.instantiation.core.model.common.AbstractResolvableModel

addCompound, addImport, addRuntimeImport, addTypedef, createImports, dispose, getAdvice, getAdviceCount, getCompound, getCompound, getCompoundCount, getImport, getImports, getImportsCount, getIvmlElement, getTypedef, getTypedef, getTypedefCount, getTypeRegistry, isDirty, notifyReplaced

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.basics.modelManagement.IModel

dispose, getImport, getImportsCount

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

addRuntimeImport, getCompound, getCompound, getCompoundCount, getIvmlElement, getTypedef, getTypedef, getTypedefCount, getTypeRegistry

Field Detail

version

private Version version

name

private java.lang.String name

extension

private ModelImport<Template> extension

javaExtensions

private JavaExtension[] javaExtensions

declarations

private java.util.List<VariableDeclaration> declarations

param

private VariableDeclaration[] param

namedParams

private java.util.Map<java.lang.String,VariableDeclaration> namedParams

defs

private java.util.List<Def> defs

indentationConfiguration

private IndentationConfiguration indentationConfiguration

formattingConfiguration

private FormattingConfiguration formattingConfiguration

Constructor Detail

Template

Template()

Constructor for serialization.

Template

public Template(java.lang.String name,
                ModelImport<Template> extension,
                TemplateDescriptor descriptor,
                TypeRegistry registry)
         throws VilException

Creates a VIL template instance.

Parameters:

name - the name

extension - the extended template (may be null)

descriptor - information to create the template from

registry - the registry responsible for this template

Throws:

VilException - in case of erroneous input

Method Detail

adjustParents

protected void adjustParents()

Adjusts the parents.

getJavaExtensionCount

public int getJavaExtensionCount()

Get the number of extensions of this template.

Returns:

The number of extensions of this template.

getJavaExtension

public JavaExtension getJavaExtension(int index)

Get the extension of this template at the specified index.

Parameters:

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

Returns:

The extension at the given index.

Throws:

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

isImplicit

public boolean isImplicit(VariableDeclaration decl)

Description copied from interface: IResolvableModel

Returns whether a variable declaration is implicit (predefined).

Specified by:

isImplicit in interface IResolvableModel<VariableDeclaration,Template>

Parameters:

decl - the declaration to be tested

Returns:

true if it is implicit, false else

getName

public java.lang.String getName()

Description copied from interface: IModel

Returns the name of the model element.

Specified by:

getName in interface IMetaType

Specified by:

getName in interface IModel

Specified by:

getName in interface IModelData

Returns:

the name of this model element.

getQualifiedName

public java.lang.String getQualifiedName()

Description copied from interface: IMetaType

Returns the qualified name of this type.

Specified by:

getQualifiedName in interface IMetaType

Returns:

the qualified name

addVariableDeclaration

public void addVariableDeclaration(VariableDeclaration var)

Description copied from interface: IVariableDeclarationReceiver

Adds a variable declaration.

Specified by:

addVariableDeclaration in interface IVariableDeclarationReceiver<VariableDeclaration>

Parameters:

var - the variable declaration

getVariableDeclarationCount

public int getVariableDeclarationCount()

Get the number of variable declaration of this template.

Specified by:

getVariableDeclarationCount in interface IResolvableModel<VariableDeclaration,Template>

Returns:

The number of variable declaration of this template.

getVariableDeclaration

public VariableDeclaration getVariableDeclaration(int index)

Get the variable declaration of this template at the specified index.

Specified by:

getVariableDeclaration in interface IResolvableModel<VariableDeclaration,Template>

Parameters:

index - The 0-based index of the variable declaration to be returned.

Returns:

The variable declaration at the given index.

Throws:

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

getDefCount

public int getDefCount()

Get the number of sub-templates of this template.

Returns:

The number of sub-templates of this template.

addDef

public void addDef(Def def)

Adds a sub-template.

Parameters:

def - the sub-template to be added

removeDef

public void removeDef(Def def)

Adds a sub-template. (not nice)

Parameters:

def - the sub-template to be removed

getDef

public Def getDef(int index)

Get the sub-templates of this template at the specified index.

Parameters:

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

Returns:

The defs at the given index.

Throws:

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

getParameterCount

public int getParameterCount()

Description copied from interface: IParameterizable

Get the number of parameters of this rule.

Specified by:

getParameterCount in interface IParameterizable<VariableDeclaration>

Returns:

The number of parameters of this rule.

getParameter

public VariableDeclaration getParameter(int index)

Description copied from interface: IParameterizable

Get the parameter of this rule at the specified index.

Specified by:

getParameter in interface IParameterizable<VariableDeclaration>

Parameters:

index - The 0-based index of the rule parameter to be returned.

Returns:

The rule parameter at the given index.

getRequiredParameterCount

public int getRequiredParameterCount()

Description copied from interface: IParameterizable

Returns the number of required parameters, i.e., non-default and non-named parameters.

Specified by:

getRequiredParameterCount in interface IParameterizable<VariableDeclaration>

Returns:

the number of required parameters

getParameter

public VariableDeclaration getParameter(java.lang.String name)

Description copied from interface: IParameterizable

Returns a named parameter declaration.

Specified by:

getParameter in interface IParameterizable<VariableDeclaration>

Parameters:

name - the name of the parameter

Returns:

the declaration or null if there is none

accept

public java.lang.Object accept(IVisitor visitor)
                        throws VilException

Description copied from interface: ITemplateLangElement

Accepts the visitor for visiting.

Specified by:

accept in interface ITemplateLangElement

Parameters:

visitor - the visitor to be used

Returns:

the result of visiting this instance (may be null)

Throws:

VilException - in case that visiting fails (e.g., execution)

setVersion

public void setVersion(Version version)

Description copied from interface: IModel

Changes the version of this model.

Specified by:

setVersion in interface IModel

Parameters:

version - Version to set

getVersion

public Version getVersion()

Description copied from interface: IModel

Returns the version of this model.

Specified by:

getVersion in interface IModel

Specified by:

getVersion in interface IModelData

Returns:

the version or null if no version is specified for this model.

getSuper

public ModelImport<Template> getSuper()

Description copied from interface: IModel

Returns the reference to the super model (if it exists).

Specified by:

getSuper in interface IModel

Returns:

the super model (in terms of a model import/reference, may be null)

getOperationsCount

public int getOperationsCount()

Description copied from interface: IMetaType

Returns the number of operations provided by this type.

Specified by:

getOperationsCount in interface IMetaType

Returns:

the number of operations

getOperation

public IMetaOperation getOperation(int index)

Description copied from interface: IMetaType

Returns the specified operation.

Specified by:

getOperation in interface IMetaType

Parameters:

index - the 0-based index of the operation to be returned

Returns:

the specified operation

isAssignableFrom

public boolean isAssignableFrom(IMetaType type)

Description copied from interface: IMetaType

Returns whether this type is the same or a super class of type.

Specified by:

isAssignableFrom in interface IMetaType

Parameters:

type - the descriptor to be tested

Returns:

true if both types are assignment compatible, false else

findConversion

public IMetaOperation findConversion(IMetaType sourceType,
                                     IMetaType targetType)

Description copied from interface: IMetaType

Returns the conversion operation from this type to target type (if there is any).

Specified by:

findConversion in interface IMetaType

Parameters:

sourceType - the source type to convert from

targetType - the target type to convert to

Returns:

the conversion operation as defined in the underlying implementation class, null if no matching can be found

getParent

public Template getParent()

Description copied from interface: ILanguageElement

Returns the parent element.

Specified by:

getParent in interface ILanguageElement

Specified by:

getParent in interface IResolvableModel<VariableDeclaration,Template>

Returns:

the parent element (may be null if unknown)

getExtensionTypesCount

public int getExtensionTypesCount()

Description copied from interface: IResolvableModel

Returns the number of extension types declared in/by this model.

Specified by:

getExtensionTypesCount in interface IResolvableModel<VariableDeclaration,Template>

Returns:

the number of extension types

getExtensionType

public IMetaType getExtensionType(int index)

Description copied from interface: IResolvableModel

Returns the specified extension type.

Specified by:

getExtensionType in interface IResolvableModel<VariableDeclaration,Template>

Parameters:

index - the 0-based index of the extension type to be returned

Returns:

the specified extension type

getIndentationConfiguration

public IndentationConfiguration getIndentationConfiguration()

Description copied from interface: IModel

Returns the indentation configuration for this model. The indentation configuration is considered to be immutable.

Specified by:

getIndentationConfiguration in interface IModel

Returns:

the indentation configuration (disabled if null)

getFormattingConfiguration

public FormattingConfiguration getFormattingConfiguration()

Returns the formatting configuration of this script.

Returns:

the formatting configuration (may be null of there is none)

isBasicType

public boolean isBasicType()

Description copied from interface: IMetaType

Returns whether this instance represents a basic type.

Specified by:

isBasicType in interface IMetaType

Returns:

true if this instance represents a basic type, false else

enableDynamicDispatch

public boolean enableDynamicDispatch()

Description copied from interface: IMetaType

Returns whether this type enables dynamic dispatch of operations.

Specified by:

enableDynamicDispatch in interface IMetaType

Returns:

true if it enables dynamic dispatch, false else

isPlaceholder

public boolean isPlaceholder()

Description copied from interface: IMetaType

Returns whether this type is valid or whether it is a placeholder type in case that the original type cannot be resolved but the script shall remain executable.

Specified by:

isPlaceholder in interface IMetaType

Returns:

true if this type is a placeholder, false else

addPlaceholderOperation

public IMetaOperation addPlaceholderOperation(java.lang.String name,
                                              int parameterCount,
                                              boolean acceptsNamedParameters)

Description copied from interface: IMetaType

Adds a placeholder operation, i.e., in case that the original operation cannot be resolved but the script shall remain executable.

Specified by:

addPlaceholderOperation in interface IMetaType

Parameters:

name - the name of the operation

parameterCount - the number of parameters of the operation

acceptsNamedParameters - whether the operation shall accept named parameters

Returns:

the added operation, null if this type is not a placeholder

isActualTypeOf

public boolean isActualTypeOf(IMetaType type)

Description copied from interface: IMetaType

Returns whether this type can act as an actual type of type.

Specified by:

isActualTypeOf in interface IMetaType

Parameters:

type - the type to be checked

Returns:

true if this type can act as an actual type of type, false else

See Also:

IActualTypeProvider

reload

protected void reload()

Description copied from class: AbstractResolvableModel

Causes a reload of this model.

Specified by:

reload in class AbstractResolvableModel<VariableDeclaration,Template>

getRestrictionEvaluationContext

public IRestrictionEvaluationContext getRestrictionEvaluationContext()

Description copied from interface: IModel

Returns the context for evaluating import / conflict restrictions. This context shall only contain the information that is necessary to evaluate restriction information.

Specified by:

getRestrictionEvaluationContext in interface IModel

Returns:

the evaluation context

getBaseType

public IMetaType getBaseType()

Description copied from interface: IMetaType

Returns the base type (in case of IVML derived types).

Specified by:

getBaseType in interface IMetaType

Returns:

the base type or null

getFieldCount

public int getFieldCount()

Description copied from interface: IMetaType

Returns the number of fields provided by this type.

Specified by:

getFieldCount in interface IMetaType

Returns:

the number of fields

getField

public IMetaField getField(int index)

Description copied from interface: IMetaType

Returns the specified field.

Specified by:

getField in interface IMetaType

Parameters:

index - the 0-based index of the field to be returned

Returns:

the specified field

isInternal

public boolean isInternal()

Description copied from interface: IMetaType

Returns whether this type is internal and shall not be visible to the user.

Specified by:

isInternal in interface IMetaType

Returns:

true if this type is internal, false else

getSuperType

public IMetaType getSuperType()

Description copied from interface: IMetaType

Returns the type this type is refined from.

Specified by:

getSuperType in interface IMetaType

Returns:

the super type or null if there is none

getGenericParameterCount

public int getGenericParameterCount()

Description copied from interface: IMetaType

Returns the number of generic type parameters.

Specified by:

getGenericParameterCount in interface IMetaType

Returns:

the number of generic type parameters

getGenericParameterType

public TypeDescriptor<?> getGenericParameterType(int index)

Description copied from interface: IMetaType

Returns the specified generic parameter type.

Specified by:

getGenericParameterType in interface IMetaType

Parameters:

index - the index of the parameter type to return

Returns:

the specified parameter type

checkConversion

public boolean checkConversion(IMetaType param,
                               IMetaOperation conversion)

Description copied from interface: IMetaType

Checks a conversion from this type to param via the given conversion.

Specified by:

checkConversion in interface IMetaType

Parameters:

param - the original parameter value

conversion - the conversion function

Returns:

true if ok, false else

getCandidates

public java.util.List<IMetaOperation> getCandidates(java.lang.String name,
                                                    int unnamedArgsCount)

Description copied from interface: IMetaType

Returns operation candidates matching the given name and number of unnamed (required) arguments.

Specified by:

getCandidates in interface IMetaType

Parameters:

name - the name of the operation

unnamedArgsCount - the number of unnamed arguments

Returns:

the operation candidates