Hyades Datapool Specification

org.eclipse.hyades.edit.datapool
Interface IDatapoolSuggestedType

All Superinterfaces:
IDatapoolSuggestedType

public interface IDatapoolSuggestedType
extends IDatapoolSuggestedType

Each variable in a datapool contains a specific type data and this class represents the types that can be readily handled. The type information is primarily advisory, variables by definition are not strongly typed. The type information allows the datapool editor the ability to flag data that may have been incorrectly specified and improves the ease of editing values in the datapool. For instance specifying a IDatapoolSuggestedType.TYPE_ENUMERATION allows the editor to use an editable combobox for manually changing a value rather then requiring the user to get the spelling correct for each value in the available value set.


Field Summary
 
Fields inherited from interface org.eclipse.hyades.execution.runtime.datapool.IDatapoolSuggestedType
TYPE_BOOLEAN, TYPE_COMPLEX, TYPE_ENUMERATION, TYPE_NUMBER, TYPE_STRING
 
Method Summary
 void setComplexClassName(java.lang.String complexClassName)
          Defines the value class name associated with a complex type.
 void setEnumerationLiterals(java.lang.String[] enumLiterals)
          Defines the set of enumerations literals associated with a enumeration type.
 void setSuggestedType(int type)
          Define the type associated with a variable in the associated datapool.
 
Methods inherited from interface org.eclipse.hyades.execution.runtime.datapool.IDatapoolSuggestedType
getComplexClassName, getEnumerationLiterals, getSuggestedType
 

Method Detail

setSuggestedType

public void setSuggestedType(int type)
Define the type associated with a variable in the associated datapool.

Parameters:
type - One of the predefined type formats.
See Also:
IDatapoolSuggestedType.TYPE_STRING, IDatapoolSuggestedType.TYPE_NUMBER, IDatapoolSuggestedType.TYPE_BOOLEAN, IDatapoolSuggestedType.TYPE_ENUMERATION, IDatapoolSuggestedType.TYPE_COMPLEX, IDatapoolSuggestedType.getSuggestedType()

setEnumerationLiterals

public void setEnumerationLiterals(java.lang.String[] enumLiterals)
Defines the set of enumerations literals associated with a enumeration type. If the type is not set to a enumeration type then an appropriate DatapoolException is thrown.

Parameters:
enumLiterals - The set of enumerations literals associated with a enumeration type.
See Also:
IDatapoolSuggestedType.TYPE_ENUMERATION, IDatapoolSuggestedType.getEnumerationLiterals()

setComplexClassName

public void setComplexClassName(java.lang.String complexClassName)
Defines the value class name associated with a complex type. If the type is not set to a value class type then an appropriate DatapoolException is thrown.

Parameters:
complexClassName - The complex class name associated with a complex class type.
See Also:
IDatapoolSuggestedType.TYPE_COMPLEX, IDatapoolSuggestedType.getComplexClassName()


Hyades DPL