Package net.ssehub.easy.instantiation.core.model.vilTypes.configuration

Class IvmlTypeDescriptor

java.lang.Object

net.ssehub.easy.instantiation.core.model.vilTypes.TypeDescriptor<DecisionVariable>

net.ssehub.easy.instantiation.core.model.vilTypes.configuration.AbstractIvmlTypeDescriptor

net.ssehub.easy.instantiation.core.model.vilTypes.configuration.IvmlTypeDescriptor

All Implemented Interfaces:

IActualTypeAssignmentProvider, IMetaType

public class IvmlTypeDescriptor
extends AbstractIvmlTypeDescriptor
implements IActualTypeAssignmentProvider

Implements a dynamic type descriptor for IVML decision variables. Instances of this class represent IVML types and act as a frontend for DecisionVariable, thus, decision variables are assignable.

Author:

Holger Eichelberger

Field Summary

Fields

Modifier and Type	Field	Description
private TypeDescriptor<?>	baseType
private IDatatype	type

Fields inherited from class net.ssehub.easy.instantiation.core.model.vilTypes.TypeDescriptor

EMPTY

Constructor Summary

Constructors

Constructor	Description
IvmlTypeDescriptor()	For serialization.
IvmlTypeDescriptor(Project project, IDatatype ivmlType, IvmlTypeResolver resolver)	Creates a new type descriptor.

Method Summary

Modifier and Type	Method	Description
private void	addCompoundOperations(IDatatype ivmlType, java.util.Map<java.lang.String,OperationDescriptor> operations, java.util.Map<java.lang.String,FieldDescriptor> fields)	Adds the operations for compound types if needed.
private void	addDerivedTypeConversions(IDatatype ivmlType, java.util.List<OperationDescriptor> conversions)	Adds the conversion operations for derived types if needed.
private void	addElements(IDecisionVariableContainer container, TypeRegistry registry, java.util.Map<java.lang.String,FieldDescriptor> fields)	Adds all the elements in this container and recursively processes attribute assignments.
private void	addEnumOperations(IDatatype ivmlType, java.util.Map<java.lang.String,OperationDescriptor> operations)	Adds the operations for enumeration types if needed.
OperationDescriptor	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.
Set<?>	allInstances()	Provides access to all instances of this type.
boolean	checkConversion(IMetaType param, IMetaOperation conversion)	Checks a conversion from this type to param via the given conversion.
IMetaType	getBaseType()	Returns the base type (in case of IVML derived types).
private IDatatype	getDatatype(java.lang.Object object)	Returns the datatype for object.
protected IDatatype	getIvmlType()	Returns the underlying IVML type.
boolean	isAssignableFrom(IMetaType type1, IMetaType type2)	Returns whether type1 is a super class of or equal to type2.
boolean	isAssignableFrom(TypeDescriptor<?> desc)	Returns whether this descriptor is the same or a super class of desc.
boolean	isInstance(java.lang.Object object)	Returns whether the given object is an instance of this descriptor.
boolean	isInstantiator()	Returns whether this type is an instantiator.
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.
boolean	isSameType(java.lang.Object object)	Returns whether the given object of of the type of this descriptor.
boolean	isSequence()	Returns whether this descriptor represents a VIL sequence.
boolean	isSet()	Returns whether this descriptor represents a VIL set.
(package private) void	resolve(Project project, IDatatype ivmlType, java.util.Set<Attribute> declaredAttributes)	Resolves the type descriptor by filling it with operations and fields.

Methods inherited from class net.ssehub.easy.instantiation.core.model.vilTypes.configuration.AbstractIvmlTypeDescriptor

addAttributeFields, addComparisonOperations, addConversionOperations, addDecisionVariableOperations, canBeInstantiated, create, getDefaultValue, getRefines, getSuperType, getTypeClass, getTypeRegistry, isActualTypeOf, isAssignableFrom, isBasicType, isCollection, isEqual, isIterator, isMap, setRefines

Methods inherited from class net.ssehub.easy.instantiation.core.model.vilTypes.TypeDescriptor

addOperation, appendParameter, createArray, enableDynamicDispatch, findCollectionIteratorOperation, findConversion, findConversion, findConversionOnBoth, flatten, flattenParam, getCandidates, getCandidates, getConversion, getConversions, getConversionsCount, getConversionToSequence, getField, getField, getFieldCount, getFields, getGenericParameter, getGenericParameterCount, getGenericParameterType, getName, getOperation, getOperations, getOperationsCount, getQualifiedName, getVilName, isFieldsNull, isInitialized, isNameSet, isSame, setConversions, setFields, setFields, setName, setOperations, toString

Methods inherited from class java.lang.Object

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

Field Detail

baseType

private TypeDescriptor<?> baseType

type

private IDatatype type

Constructor Detail

IvmlTypeDescriptor

IvmlTypeDescriptor()
            throws VilException

For serialization.

Throws:

VilException - shall not occur

IvmlTypeDescriptor

IvmlTypeDescriptor(Project project,
                   IDatatype ivmlType,
                   IvmlTypeResolver resolver)
            throws VilException

Creates a new type descriptor.

Parameters:

project - the underlying IVML project the descriptor shall be created for

ivmlType - the IVML type to create the descriptor for

resolver - for retrieving further IVML types

Throws:

VilException - if analyzing the class fails for some reason

Method Detail

resolve

void resolve(Project project,
             IDatatype ivmlType,
             java.util.Set<Attribute> declaredAttributes)
      throws VilException

Resolves the type descriptor by filling it with operations and fields. This method is separated from the constructor so that the type can be registered first and resolved then in order to enable parent resolution.

Parameters:

project - the underlying IVML project the descriptor shall be created for

ivmlType - the IVML type to resolve for

declaredAttributes - attributes declared for all variables of that type, may be null

Throws:

VilException - if analyzing the underlying type fails for some reason

addCompoundOperations

private void addCompoundOperations(IDatatype ivmlType,
                                   java.util.Map<java.lang.String,OperationDescriptor> operations,
                                   java.util.Map<java.lang.String,FieldDescriptor> fields)
                            throws VilException

Adds the operations for compound types if needed.

Parameters:

ivmlType - the type to process

operations - the operations (may be modified as a side effect)

fields - the actually known fields of ivmlType (may be modified as a side effect)

Throws:

VilException - in case that creating fields for the elements fails

addEnumOperations

private void addEnumOperations(IDatatype ivmlType,
                               java.util.Map<java.lang.String,OperationDescriptor> operations)

Adds the operations for enumeration types if needed.

Parameters:

ivmlType - the type to process

operations - the operations (may be modified as a side effect)

addDerivedTypeConversions

private void addDerivedTypeConversions(IDatatype ivmlType,
                                       java.util.List<OperationDescriptor> conversions)

Adds the conversion operations for derived types if needed.

Parameters:

ivmlType - the type to process

conversions - the conversion operations (may be modified as a side effect)

addElements

private void addElements(IDecisionVariableContainer container,
                         TypeRegistry registry,
                         java.util.Map<java.lang.String,FieldDescriptor> fields)
                  throws VilException

Adds all the elements in this container and recursively processes attribute assignments.

Parameters:

container - the container

registry - the actual type registry

fields - the name-field mapping to be modified as a side effect

Throws:

VilException - in case that creating fields for the elements fails

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

isAssignableFrom

public boolean isAssignableFrom(TypeDescriptor<?> desc)

Description copied from class: TypeDescriptor

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

Specified by:

isAssignableFrom in class TypeDescriptor<DecisionVariable>

Parameters:

desc - the descriptor to be tested

Returns:

true if both descriptors are assignment compatible, false else

isSet

public boolean isSet()

Description copied from class: TypeDescriptor

Returns whether this descriptor represents a VIL set.

Overrides:

isSet in class AbstractIvmlTypeDescriptor

Returns:

true if this is a VIL set, false else

isSequence

public boolean isSequence()

Description copied from class: TypeDescriptor

Returns whether this descriptor represents a VIL sequence.

Overrides:

isSequence in class AbstractIvmlTypeDescriptor

Returns:

true if this is a VIL sequence, false else

getIvmlType

protected IDatatype getIvmlType()

Description copied from class: AbstractIvmlTypeDescriptor

Returns the underlying IVML type.

Specified by:

getIvmlType in class AbstractIvmlTypeDescriptor

Returns:

the type

isAssignableFrom

public boolean isAssignableFrom(IMetaType type1,
                                IMetaType type2)

Description copied from interface: IActualTypeAssignmentProvider

Returns whether type1 is a super class of or equal to type2.

Specified by:

isAssignableFrom in interface IActualTypeAssignmentProvider

Parameters:

type1 - the first type to check

type2 - the second type to check

Returns:

true if assignable, false else

isInstance

public boolean isInstance(java.lang.Object object)

Description copied from class: TypeDescriptor

Returns whether the given object is an instance of this descriptor.

Specified by:

isInstance in class TypeDescriptor<DecisionVariable>

Parameters:

object - the object to be checked

Returns:

true if it is an instance, false else

getDatatype

private IDatatype getDatatype(java.lang.Object object)

Returns the datatype for object.

Parameters:

object - the object to return the datatype for

Returns:

the datatype or null if there is none

isSameType

public boolean isSameType(java.lang.Object object)

Description copied from class: TypeDescriptor

Returns whether the given object of of the type of this descriptor.

Specified by:

isSameType in class TypeDescriptor<DecisionVariable>

Parameters:

object - the object to be checked

Returns:

true if object has the same type, 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 OperationDescriptor addPlaceholderOperation(java.lang.String name,
                                                   int parameterCount,
                                                   boolean acceptsNamedParameters)

Description copied from class: TypeDescriptor

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

Specified by:

addPlaceholderOperation in class TypeDescriptor<DecisionVariable>

Parameters:

name - the name of the operation

parameterCount - the number of parameters of the operation

acceptsNamedParameters - whether the operation accepts named parameters

Returns:

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

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

isInstantiator

public boolean isInstantiator()

Description copied from class: TypeDescriptor

Returns whether this type is an instantiator.

Specified by:

isInstantiator in class TypeDescriptor<DecisionVariable>

Returns:

true if it is an instantiator, false else

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

allInstances

public Set<?> allInstances()

Description copied from class: TypeDescriptor

Provides access to all instances of this type.

Overrides:

allInstances in class TypeDescriptor<DecisionVariable>

Returns:

access to all instances (may be null if there are none)