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

Class AbstractIvmlTypeDescriptor

java.lang.Object

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

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

All Implemented Interfaces:

IMetaType

Direct Known Subclasses:

IvmlProjectTypeDescriptor, IvmlTypeDescriptor

abstract class AbstractIvmlTypeDescriptor
extends TypeDescriptor<DecisionVariable>

Implements a dynamic type descriptor for IVM 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 AbstractIvmlTypeDescriptor[]	refines
private TypeRegistry	typeRegistry

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

EMPTY

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
protected void	addAttributeFields(java.util.Map<java.lang.String,FieldDescriptor> fields, IModelElement elt, TypeRegistry registry)	Adds the attribute access fields.
protected void	addComparisonOperations(IDatatype type, java.util.Map<java.lang.String,OperationDescriptor> operations)	Adds the default comparison operations.
protected void	addConversionOperations(IDatatype type, java.util.List<OperationDescriptor> operations)	Adds required conversion operations to operations.
protected void	addDecisionVariableOperations(java.util.Map<java.lang.String,OperationDescriptor> operations)	Adds the operations to be taken over from DecisionVariable.
boolean	canBeInstantiated()	Returns whether TypeDescriptor.create(Object...) will return an instance.
DecisionVariable	create(java.lang.Object... params)	Creates an instance of the type according to the given parameters.
java.lang.Object	getDefaultValue()	Returns the default value for this type, usually a neutral value or a constant value to compare against.
protected abstract IDatatype	getIvmlType()	Returns the underlying IVML type.
(package private) AbstractIvmlTypeDescriptor	getRefines(int index)	Returns the type descriptor which is refined by this descriptor.
(package private) int	getRefinesCount()	Returns the number of refines.
IMetaType	getSuperType()	Returns the type this type is refined from.
java.lang.Class<DecisionVariable>	getTypeClass()	Returns the class of the described VIL type.
TypeRegistry	getTypeRegistry()	Returns the type registry this type was registered by.
private static boolean	includeMethod(java.lang.reflect.Method method)	Determines whether a method shall be included as automatically mapped operation.
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	isCollection()	Returns whether this descriptor represents a VIL collection, i.e., set, sequence or collection.
protected boolean	isEqual(AbstractIvmlTypeDescriptor d1, AbstractIvmlTypeDescriptor d2)	Returns whether two IVML type descriptors are considered to be equal.
boolean	isIterator()	Returns whether this descriptor represents an iterator.
boolean	isMap()	Returns whether this descriptor represents a VIL map.
boolean	isSequence()	Returns whether this descriptor represents a VIL sequence.
boolean	isSet()	Returns whether this descriptor represents a VIL set.
protected void	setRefines(AbstractIvmlTypeDescriptor[] refines)	Changes the type descriptor which is refined by this descriptor.

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

addOperation, addPlaceholderOperation, allInstances, 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, isAssignableFrom, isFieldsNull, isInitialized, isInstance, isInstantiator, isNameSet, isSame, isSameType, setConversions, setFields, setFields, setName, setOperations, toString

Methods inherited from class java.lang.Object

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

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

checkConversion, getBaseType, isInternal, isPlaceholder

Field Detail

typeRegistry

private TypeRegistry typeRegistry

refines

private AbstractIvmlTypeDescriptor[] refines

Constructor Detail

AbstractIvmlTypeDescriptor

AbstractIvmlTypeDescriptor()
                    throws VilException

For serialization.

Throws:

VilException - shall not occur

AbstractIvmlTypeDescriptor

AbstractIvmlTypeDescriptor(IDatatype ivmlType,
                           IvmlTypeResolver resolver)
                    throws VilException

Creates a new type descriptor. Overridden constructors shall call TypeDescriptor.setOperations(java.util.Collection) and TypeDescriptor.setConversions(java.util.Collection).

Parameters:

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

addDecisionVariableOperations

protected void addDecisionVariableOperations(java.util.Map<java.lang.String,OperationDescriptor> operations)

Adds the operations to be taken over from DecisionVariable. Calls includeMethod(Method).

Parameters:

operations - the operations (signature-descriptor) (to be modified as a side effect)

includeMethod

private static boolean includeMethod(java.lang.reflect.Method method)

Determines whether a method shall be included as automatically mapped operation.

Parameters:

method - the method to be considered

Returns:

true if method shall be included, false else

addComparisonOperations

protected void addComparisonOperations(IDatatype type,
                                       java.util.Map<java.lang.String,OperationDescriptor> operations)

Adds the default comparison operations.

Parameters:

type - the IVML type to add the operations for

operations - the operations (signature-descriptor) (to be modified as a side effect)

addConversionOperations

protected void addConversionOperations(IDatatype type,
                                       java.util.List<OperationDescriptor> operations)

Adds required conversion operations to operations.

Parameters:

type - the IVML type to add the operations for

operations - the operations to be modified as a side effect

addAttributeFields

protected void addAttributeFields(java.util.Map<java.lang.String,FieldDescriptor> fields,
                                  IModelElement elt,
                                  TypeRegistry registry)
                           throws VilException

Adds the attribute access fields.

Parameters:

fields - the fields (signature-field) (to be modified as a side effect)

elt - the model element to take the attributes from

registry - the actual type registry

Throws:

VilException - in case that creating the descriptors fails

isBasicType

public boolean isBasicType()

Description copied from interface: IMetaType

Returns whether this instance represents a basic type.

Returns:

true if this instance represents a basic type, false else

getTypeRegistry

public TypeRegistry getTypeRegistry()

Description copied from interface: IMetaType

Returns the type registry this type was registered by.

Returns:

the type registry

getTypeClass

public java.lang.Class<DecisionVariable> getTypeClass()

Description copied from class: TypeDescriptor

Returns the class of the described VIL type. Please use this method sparingly as the required functionality is provided by this class.

Specified by:

getTypeClass in class TypeDescriptor<DecisionVariable>

Returns:

the class

canBeInstantiated

public boolean canBeInstantiated()

Description copied from class: TypeDescriptor

Returns whether TypeDescriptor.create(Object...) will return an instance.

Specified by:

canBeInstantiated in class TypeDescriptor<DecisionVariable>

Returns:

true if this type can be instantiated from VIL/VTL, false else

create

public DecisionVariable create(java.lang.Object... params)
                        throws VilException

Description copied from class: TypeDescriptor

Creates an instance of the type according to the given parameters.

Specified by:

create in class TypeDescriptor<DecisionVariable>

Parameters:

params - the parameters

Returns:

the created instance

Throws:

VilException - in case that the creation does not work

isAssignableFrom

public boolean isAssignableFrom(IMetaType type)

Description copied from interface: IMetaType

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

Parameters:

type - the descriptor to be tested

Returns:

true if both types are assignment compatible, false else

isCollection

public boolean isCollection()

Description copied from class: TypeDescriptor

Returns whether this descriptor represents a VIL collection, i.e., set, sequence or collection.

Specified by:

isCollection in class TypeDescriptor<DecisionVariable>

Returns:

true if this is a VIL collection, false else

isSet

public boolean isSet()

Description copied from class: TypeDescriptor

Returns whether this descriptor represents a VIL set.

Specified by:

isSet in class TypeDescriptor<DecisionVariable>

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.

Specified by:

isSequence in class TypeDescriptor<DecisionVariable>

Returns:

true if this is a VIL sequence, false else

isIterator

public boolean isIterator()

Description copied from class: TypeDescriptor

Returns whether this descriptor represents an iterator.

Specified by:

isIterator in class TypeDescriptor<DecisionVariable>

Returns:

true if this is an iterator, false else

isMap

public boolean isMap()

Description copied from class: TypeDescriptor

Returns whether this descriptor represents a VIL map.

Specified by:

isMap in class TypeDescriptor<DecisionVariable>

Returns:

true if this is a VIL map, false else

getSuperType

public IMetaType getSuperType()

Description copied from interface: IMetaType

Returns the type this type is refined from.

Returns:

the super type or null if there is none

getRefines

AbstractIvmlTypeDescriptor getRefines(int index)

Returns the type descriptor which is refined by this descriptor.

Parameters:

index - the 0-based index of refines to return, see getRefinesCount()

Returns:

the refined type (may be null if there is none)

getRefinesCount

int getRefinesCount()

Returns the number of refines.

Returns:

the number of refines

setRefines

protected void setRefines(AbstractIvmlTypeDescriptor[] refines)

Changes the type descriptor which is refined by this descriptor.

Parameters:

refines - the refined type descriptor (may be null if there is none)

isActualTypeOf

public boolean isActualTypeOf(IMetaType type)

Description copied from interface: IMetaType

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

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

getIvmlType

protected abstract IDatatype getIvmlType()

Returns the underlying IVML type.

Returns:

the type

isEqual

protected boolean isEqual(AbstractIvmlTypeDescriptor d1,
                          AbstractIvmlTypeDescriptor d2)

Returns whether two IVML type descriptors are considered to be equal.

Parameters:

d1 - the first descriptor

d2 - the second descriptor

Returns:

true for type equality, false else

getDefaultValue

public java.lang.Object getDefaultValue()

Description copied from class: TypeDescriptor

Returns the default value for this type, usually a neutral value or a constant value to compare against.

Overrides:

getDefaultValue in class TypeDescriptor<DecisionVariable>

Returns:

the default value, null for none - may lead to an undefined operation execution