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

All Superinterfaces:

INamedElement

All Known Subinterfaces:

IDatapoolVariable

public interface IDatapoolVariable
extends INamedElement

Each cell in a record has a unique variable association. Logically a variable is the equivalent of a column in a datapool display. Associated with each variable is a suggested type that may be used by a datapool editor to improve display and editing of individual cells. The role may also be used by an editor to control the type of data allowed in a particular column in the display.

See Also:

IDatapool

Field Summary

static int	ROLE_INPUT_DATA
static int	ROLE_INPUT_OUTPUT_DATA
static int	ROLE_OUTPUT_DATA
static int	ROLE_UNSPECIFIED
static int	ROLE_VERIFICATION_DATA

Method Summary

int	getRoleAsInt() Accesor for the role associated with a variable.
IDatapoolSuggestedType	getSuggestedType() The suggested type of the data associated with this variable.

Methods inherited from interface org.eclipse.hyades.execution.runtime.datapool.INamedElement

getDescription, getId, getName

Field Detail

ROLE_UNSPECIFIED

static final int ROLE_UNSPECIFIED

See Also:

Constant Field Values

ROLE_INPUT_DATA

static final int ROLE_INPUT_DATA

See Also:

Constant Field Values

ROLE_OUTPUT_DATA

static final int ROLE_OUTPUT_DATA

See Also:

Constant Field Values

ROLE_INPUT_OUTPUT_DATA

static final int ROLE_INPUT_OUTPUT_DATA

See Also:

Constant Field Values

ROLE_VERIFICATION_DATA

static final int ROLE_VERIFICATION_DATA

See Also:

Constant Field Values

Method Detail

getSuggestedType

IDatapoolSuggestedType getSuggestedType()

The suggested type of the data associated with this variable. As implied by the name there is no enforcement of the type of data in any cell of the datapool. However, an editor could take advantage of the type information to improve display and editing of cells within the display.

Returns:

The suggested type associated with this variable.

getRoleAsInt

int getRoleAsInt()

Accesor for the role associated with a variable. The role may be used by an editor to control the type of data that may be applied to an individual cell with a datapool.

Returns:

The role associated with a variable.

See Also:

ROLE_UNSPECIFIED, ROLE_INPUT_DATA, ROLE_OUTPUT_DATA, ROLE_INPUT_OUTPUT_DATA, ROLE_VERIFICATION_DATA