org.eclipse.hyades.execution.runtime.datapool

Interface IDatapool

All Superinterfaces:

INamedElement

All Known Subinterfaces:

IDatapool

public interface IDatapool
extends INamedElement

This class defines the primary interface to datapools. A datapool is an ordered collection of data. The structure of data is in the form of uniformly sized records that are collected into logical groups.

datapool --> (0..n) EquivalenceClasses --> (0..n) Records

Each record contains a uniform set of variables (logically columns) with appropriate name and id properties associated with each.

See Also:

IDatapoolEquivalenceClass, IDatapoolRecord, IDatapoolVariable, DatapoolException

Method Summary

Methods

Modifier and Type	Method and Description
int	getDefaultEquivalenceClassIndex() Accessor for the default equivalence class in the datapool.
IDatapoolEquivalenceClass	getEquivalenceClass(int index) Accessor for the equivalence class at the specified zero based index in the datapool.
int	getEquivalenceClassCount() Returns the number of equivalence classes associated with a datapool.
int	getEquivalenceClassIndex(java.lang.String equivalenceClassName) Locate an equivalence class by name within an instance of a datapool.
int	getEquivalenceClassIndexById(java.lang.String equivalenceClassId) Locate an equivalence class by ID within an instance of a datapool.
IDatapoolVariable	getVariable(int variableIndex) The variable at a specified zero based column index.
int	getVariableCount() The number of variables available in each record.
int	getVariableIndex(java.lang.String variableName) Locates the appropriate index associated with a specific variable name.
int	getVariableIndexById(java.lang.String variableId) Locates the appropriate index associated with a specific variable ID.

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

getDescription, getId, getName

Method Detail

getVariableCount

int getVariableCount()

The number of variables available in each record.

Returns:

The number of data variables available in each record.

getVariable

IDatapoolVariable getVariable(int variableIndex)

The variable at a specified zero based column index. A DatapoolException is thrown if the specified index is not valid.

Parameters:

variableIndex - A zero based variable index.

Returns:

The variable for the specified zero based index.

See Also:

getVariableIndex(String)

getVariableIndex

int getVariableIndex(java.lang.String variableName)

Locates the appropriate index associated with a specific variable name. Users will depend on this method to determine the appropriate cell to access within a record given a current record and a variable name. The current record is typically made available from an iterator that is performing an ordered traversal of the records in a datapool.

Parameters:

variableName - The name of the variable associated with the desired cell.

Returns:

The variable index associated with the specified variableName.

See Also:

getVariableIndexById(String)

getVariableIndexById

int getVariableIndexById(java.lang.String variableId)

Locates the appropriate index associated with a specific variable ID. Users may use this method to determine the appropriate cell to access within a record given a current record and a variable ID.

Parameters:

variableId - The ID of the variable associated with the desired cell.

Returns:

The variable index associated with the specified variableId.

See Also:

getVariableIndex(String)

getEquivalenceClassCount

int getEquivalenceClassCount()

Returns the number of equivalence classes associated with a datapool.

Returns:

The number of equivalence classes associated with a datapool.

getEquivalenceClass

IDatapoolEquivalenceClass getEquivalenceClass(int index)

Accessor for the equivalence class at the specified zero based index in the datapool. If an invalid index is supplied a DatapoolException with an appropriate message is thrown.

Returns:

The zero-based index for the desired equivalence class.

getDefaultEquivalenceClassIndex

int getDefaultEquivalenceClassIndex()

Accessor for the default equivalence class in the datapool. If the default equivalence class has not been defined then a value of -1 is returned.

Returns:

The zero-based index for the default equivalence class.

getEquivalenceClassIndex

int getEquivalenceClassIndex(java.lang.String equivalenceClassName)

Locate an equivalence class by name within an instance of a datapool.

Returns:

The zero-based index of the equivalence class with the supplied equivalenceClassName.

See Also:

getEquivalenceClassIndexById(String)

getEquivalenceClassIndexById

int getEquivalenceClassIndexById(java.lang.String equivalenceClassId)

Locate an equivalence class by ID within an instance of a datapool.

Returns:

The zero-based index of the equivalence class with the supplied equivalenceClassId.

See Also:

getEquivalenceClassIndex(String)