org.eclipse.hyades.execution.runtime.datapool

Interface IDatapoolRecord

All Known Subinterfaces:

IDatapoolRecord

public interface IDatapoolRecord

A logical grouping of values in a datapool. A datapool is an ordered collection equivalence classes which contain an order collection of records. And to complete the hierarchy, a record is an ordered collection of cells.

Several restrictions exist on records within a datapool:

• A record instance can only exist in one datapool. Obviously a deep copy can be performed so the same contents can appear in multiple datapools.
• A record instance must be unique within the datapool. It can not be added to multiple equivalence classes or more then once to the same equivalence class.
• Cells within a record must each be unique to that instance of the record and can not be duplicated in multiple records at once.
• Cells within a record can only be added to the record once and can not be inserted into the same record multiple times.

Method Summary

Methods

Modifier and Type	Method and Description
IDatapoolCell	getCell(int cellIndex) The value for the cell in the current record and the specified variable is returned.
IDatapoolCell	getCell(java.lang.String variableName) The value for the cell in the current record and the specified variable is returned.
int	getCellCount() The number of cells available in a record.
IDatapoolEquivalenceClass	getEquivalenceClass() Access to the equivalenceClass that is the parent of this record.

Method Detail

getCellCount

int getCellCount()

The number of cells available in a record.

Returns:

The number of cells available.

getCell

IDatapoolCell getCell(int cellIndex)

The value for the cell in the current record and the specified variable is returned. The variable is located by the specified zero based index. ADatapoolException is thrown if the name does not match a variable name in the record.

Parameters:

cellIndex - The zero based cell index.

Returns:

The value for the cell in the current record and the specified variable.

getCell

IDatapoolCell getCell(java.lang.String variableName)

The value for the cell in the current record and the specified variable is returned. The variable is located by the specified name, which must match a variable name in the record. A DatapoolException is thrown if the name does not match a variable name in the record.

Parameters:

variableName - The variable name to identify the cell by.

Returns:

The value for the cell in the current record and the specified variable name.

getEquivalenceClass

IDatapoolEquivalenceClass getEquivalenceClass()

Access to the equivalenceClass that is the parent of this record.

Returns:

The equivalenceClass that is the parent of this record.