TPTP 4.2.0 Platform Project
Public API Specification

org.eclipse.hyades.models.common.datapool.impl
Class DatapoolSuggestedTypeImpl

java.lang.Object
  extended byorg.eclipse.hyades.models.common.datapool.impl.DatapoolSuggestedTypeImpl
All Implemented Interfaces:
IDatapoolSuggestedType, IDatapoolSuggestedType

public class DatapoolSuggestedTypeImpl
extends java.lang.Object
implements IDatapoolSuggestedType


Field Summary
 
Fields inherited from interface org.eclipse.hyades.execution.runtime.datapool.IDatapoolSuggestedType
TYPE_BOOLEAN, TYPE_COMPLEX, TYPE_DISPLAY_BOOLEAN, TYPE_DISPLAY_COMPLEX, TYPE_DISPLAY_ENUMERATION, TYPE_DISPLAY_NUMBER, TYPE_DISPLAY_STRING, TYPE_ENUMERATION, TYPE_NUMBER, TYPE_STRING
 
Constructor Summary
DatapoolSuggestedTypeImpl()
           
 
Method Summary
 java.lang.String getDisplayString(int type)
          Returns the display string for the specified suggested type.
 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: IDatapoolSuggestedType.TYPE_STRING IDatapoolSuggestedType.TYPE_NUMBER IDatapoolSuggestedType.TYPE_BOOLEAN IDatapoolSuggestedType.TYPE_ENUMERATION IDatapoolSuggestedType.TYPE_COMPLEX
 void setEnumerationLiterals(java.lang.String[] enumLiterals)
          Defines the set of enumerations literals associated with a enumeration type.
 void setSuggestedClassName(java.lang.String complexClassName)
          Defines the value class name associated with a variable.
 void setSuggestedType(int type)
          Define the type associated with a variable in the associated datapool.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

DatapoolSuggestedTypeImpl

public DatapoolSuggestedTypeImpl()
Method Detail

setSuggestedType

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

Specified by:
setSuggestedType in interface IDatapoolSuggestedType
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, 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.

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

setSuggestedClassName

public void setSuggestedClassName(java.lang.String complexClassName)
Defines the value class name associated with a variable.

Specified by:
setSuggestedClassName in interface IDatapoolSuggestedType
Parameters:
complexClassName - The complex class name associated with a variable
See Also:
getSuggestedClassName()

getSuggestedType

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

Specified by:
getSuggestedType in interface IDatapoolSuggestedType
Returns:
One of the predefined type values.
See Also:
IDatapoolSuggestedType.TYPE_STRING, IDatapoolSuggestedType.TYPE_NUMBER, IDatapoolSuggestedType.TYPE_BOOLEAN, IDatapoolSuggestedType.TYPE_ENUMERATION, IDatapoolSuggestedType.TYPE_COMPLEX

getDisplayString

public java.lang.String getDisplayString(int type)
Returns the display string for the specified suggested type.

Parameters:
type - One of the predefined types:
Returns:
a display string representing the specified suggested type.
See Also:
IDatapoolSuggestedType.TYPE_STRING, IDatapoolSuggestedType.TYPE_NUMBER, IDatapoolSuggestedType.TYPE_BOOLEAN, IDatapoolSuggestedType.TYPE_ENUMERATION, IDatapoolSuggestedType.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.

Specified by:
getEnumerationLiterals in interface IDatapoolSuggestedType
Returns:
The set of enumerations literals associated with a enumeration type.
See Also:
IDatapoolSuggestedType.TYPE_ENUMERATION

getSuggestedClassName

public java.lang.String getSuggestedClassName()
The value class name associated with a variable.

Specified by:
getSuggestedClassName in interface IDatapoolSuggestedType
Returns:
The value class name associated with a variable.

TPTP 4.2.0 Platform Project
Public API Specification