Hyades Datapool Specification

org.eclipse.hyades.execution.datapool
Interface IDatapoolSuggestedType


public interface 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 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
static int TYPE_BOOLEAN
          The type of a boolean value.
static int TYPE_COMPLEX
          The type specification for a complex object, must be a serializable class.
static int TYPE_ENUMERATION
          The type of an enumeration type value.
static int TYPE_NUMBER
          The type of a scalar value.
static int TYPE_STRING
          The type of a simple String object.
 
Method Summary
 java.lang.String getComplexClassName()
          The value class name associated with a complex type.
 java.lang.String[] getEnumerationLiterals()
          The set of enumerations literals associated with a enumeration type.
 int getSuggestedType()
          One of the predefined type formats: TYPE_STRING TYPE_NUMBER TYPE_BOOLEAN TYPE_ENUMERATION TYPE_COMPLEX
 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.
 

Field Detail

TYPE_STRING

public static final int TYPE_STRING
The type of a simple String object.

See Also:
Constant Field Values

TYPE_NUMBER

public static final int TYPE_NUMBER
The type of a scalar value.

See Also:
Constant Field Values

TYPE_BOOLEAN

public static final int TYPE_BOOLEAN
The type of a boolean value.

See Also:
Constant Field Values

TYPE_ENUMERATION

public static final int TYPE_ENUMERATION
The type of an enumeration type value.

See Also:
Constant Field Values

TYPE_COMPLEX

public static final int TYPE_COMPLEX
The type specification for a complex object, must be a serializable class.

See Also:
Constant Field Values
Method Detail

getSuggestedType

public int getSuggestedType()
One of the predefined type formats:

Returns:
One of the predefined type values.
See Also:
TYPE_STRING, TYPE_NUMBER, TYPE_BOOLEAN, TYPE_ENUMERATION, TYPE_COMPLEX, setSuggestedType(int)

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:
TYPE_STRING, TYPE_NUMBER, TYPE_BOOLEAN, TYPE_ENUMERATION, TYPE_COMPLEX, getSuggestedType()

getEnumerationLiterals

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

Returns:
The set of enumerations literals associated with a enumeration type.
See Also:
TYPE_ENUMERATION, setEnumerationLiterals(String[])

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:
TYPE_ENUMERATION, getEnumerationLiterals()

getComplexClassName

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

Returns:
The value class name associated with a complex type.
See Also:
TYPE_COMPLEX, setComplexClassName(String)

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:
TYPE_COMPLEX, getComplexClassName()


Hyades DPL