org.eclipse.hyades.execution.runtime.datapool
Interface IDatapoolSuggestedType

All Known Subinterfaces:

IDatapoolSuggestedType

All Known Implementing Classes:

DatapoolSuggestedTypeImpl

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 java.lang.String	TYPE_DISPLAY_BOOLEAN The display string for type of a boolean value.
static java.lang.String	TYPE_DISPLAY_COMPLEX The display string for type specification for a complex object, must be a serializable class.
static java.lang.String	TYPE_DISPLAY_ENUMERATION The display string for type of an enumeration type value.
static java.lang.String	TYPE_DISPLAY_NUMBER The display string for type of a scalar value.
static java.lang.String	TYPE_DISPLAY_STRING The display string for type of a simple String object.
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[]	getEnumerationLiterals() The set of enumerations literals associated with a enumeration type.
java.lang.String	getSuggestedClassName() The value class name associated with a variable.
int	getSuggestedType() One of the predefined type formats: TYPE_STRING TYPE_NUMBER TYPE_BOOLEAN TYPE_ENUMERATION TYPE_COMPLEX

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

TYPE_DISPLAY_STRING

public static final java.lang.String TYPE_DISPLAY_STRING

The display string for type of a simple String object.

TYPE_DISPLAY_NUMBER

public static final java.lang.String TYPE_DISPLAY_NUMBER

The display string for type of a scalar value.

TYPE_DISPLAY_BOOLEAN

public static final java.lang.String TYPE_DISPLAY_BOOLEAN

The display string for type of a boolean value.

TYPE_DISPLAY_ENUMERATION

public static final java.lang.String TYPE_DISPLAY_ENUMERATION

The display string for type of an enumeration type value.

TYPE_DISPLAY_COMPLEX

public static final java.lang.String TYPE_DISPLAY_COMPLEX

The display string for type specification for a complex object, must be a serializable class.

Method Detail

getSuggestedType

public int getSuggestedType()

One of the predefined type formats:

• TYPE_STRING
• TYPE_NUMBER
• TYPE_BOOLEAN
• TYPE_ENUMERATION
• TYPE_COMPLEX

Returns:

One of the predefined type values.

See Also:

TYPE_STRING, TYPE_NUMBER, TYPE_BOOLEAN, TYPE_ENUMERATION, TYPE_COMPLEX

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

getSuggestedClassName

public java.lang.String getSuggestedClassName()

The value class name associated with a variable.

Returns:

The value class name associated with a variable.