org.eclipse.hyades.edit.datapool

Interface IDatapool

All Superinterfaces:

IDatapool, INamedElement

public interface IDatapool
extends IDatapool, 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, IDatapoolListener, DatapoolException

Method Summary

Modifier and Type	Method and Description
void	addDatapoolListener(IDatapoolListener listener) Register a listener for actions against the datapool that modify the data or structure of the data model.
void	appendEquivalenceClass(IDatapoolEquivalenceClass equivalenceClass) Append the supplied equivalence class to the end of the set of available equivalence classes.
void	appendVariable(IDatapoolVariable variable) Append a variable to the end of the datapool ordered variable collection.
IDatapoolEquivalenceClass	constructEquivalenceClass() Constructs an empty equivalence class
IDatapoolVariable	constructVariable() Constructs an empty variable
void	insertEquivalenceClass(IDatapoolEquivalenceClass equivalenceClass, int beforeEquivalenceClassIndex) Insert the equivalence class at a supplied index.
void	insertVariable(IDatapoolVariable variable, int beforeVariableIndex) Insert a variable before the variable at the specified zero based variable index.
void	moveEquivalenceClass(int sourceEquivalenceClassIndex, int targetEquivalenceClassIndex) Move the equivalence class at a supplied index to a new position within the set of available equivalence classes.
void	moveVariable(int sourceVariableIndex, int targetVariableIndex) Move a variable to immediately before another variable.
void	removeDatapoolListener(IDatapoolListener listener) Removes a listener from the datapool instance.
void	removeEquivalenceClass(int equivalenceClassIndex) Remove the equivalence class at a supplied index.
void	removeVariable(int variableIndex) Remove the specified variable from the datapool.
void	setDefaultEquivalenceClassIndex(int equivalenceClassIndex) Define the default equivalence class in a datapool.
void	updateEquivalenceClass(IDatapoolEquivalenceClass equivalenceClass, int equivalenceClassIndex) Replace the equivalence class at a supplied index with a new value.
void	updateVariable(IDatapoolVariable variable, int variableIndex) Update the variable at a specified zero based variable index.

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

getDefaultEquivalenceClassIndex, getEquivalenceClass, getEquivalenceClassCount, getEquivalenceClassIndex, getEquivalenceClassIndexById, getVariable, getVariableCount, getVariableIndex, getVariableIndexById

Methods inherited from interface org.eclipse.hyades.edit.datapool.INamedElement

setDescription, setId, setName

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

getDescription, getId, getName

Method Detail

updateVariable

void updateVariable(IDatapoolVariable variable,
                    int variableIndex)

Update the variable at a specified zero based variable index.

Parameters:

variable - The variable for the cells at variableIndex.

variableIndex - A zero based variable index.

See Also:

IDatapool.getVariableIndex(String), IDatapool.getVariableIndexById(String), IDatapool.getVariable(int)

insertVariable

void insertVariable(IDatapoolVariable variable,
                    int beforeVariableIndex)

Insert a variable before the variable at the specified zero based variable index. This action will cause an empty cell to be automatically inserted in each row of the datapool.

Parameters:

variable - The new variable for the cells at beforeVariableIndex.

beforeVariableIndex - A zero based variable index.

See Also:

appendVariable(IDatapoolVariable), moveVariable(int,int), removeVariable(int)

appendVariable

void appendVariable(IDatapoolVariable variable)

Append a variable to the end of the datapool ordered variable collection. This action will cause an empty cell to be automatically appended to each record of the datapool.

Parameters:

variable - The variable instance to append.

See Also:

insertVariable(IDatapoolVariable,int), moveVariable(int,int), removeVariable(int)

moveVariable

void moveVariable(int sourceVariableIndex,
                  int targetVariableIndex)

Move a variable to immediately before another variable. The variables are denoted by a zero based variable index. This action will cause the associated cells in each row of the datapool to also be moved.

Parameters:

sourceVariableIndex - A zero based variable index for the variable to be moved.

targetVariableIndex - The variable index marking the target location for the move action.

See Also:

insertVariable(IDatapoolVariable,int), appendVariable(IDatapoolVariable), removeVariable(int)

removeVariable

void removeVariable(int variableIndex)

Remove the specified variable from the datapool. The specified variable index is zero based. Each record in the datapool is automatically updated to remove the cell that coincides with the variable.

Parameters:

variableIndex - A zero based variable index for the variable to be moved.

See Also:

insertVariable(IDatapoolVariable,int), appendVariable(IDatapoolVariable), moveVariable(int,int)

setDefaultEquivalenceClassIndex

void setDefaultEquivalenceClassIndex(int equivalenceClassIndex)

Define the default equivalence class in a datapool.

Parameters:

equivalenceClassIndex - The zero-based index for the default equivalence class.

See Also:

IDatapool.getDefaultEquivalenceClassIndex()

updateEquivalenceClass

void updateEquivalenceClass(IDatapoolEquivalenceClass equivalenceClass,
                            int equivalenceClassIndex)

Replace the equivalence class at a supplied index with a new value. This method is essentially a shortcut for a call to removeEquivalenceClass followed by a call to insertEquivalenceClass.

Parameters:

equivalenceClass - The equivalence class to insert.

equivalenceClassIndex - The equivalence class indsex to remove and insert at.

See Also:

insertEquivalenceClass(IDatapoolEquivalenceClass,int), appendEquivalenceClass(IDatapoolEquivalenceClass), moveEquivalenceClass(int,int), removeEquivalenceClass(int)

insertEquivalenceClass

void insertEquivalenceClass(IDatapoolEquivalenceClass equivalenceClass,
                            int beforeEquivalenceClassIndex)

Insert the equivalence class at a supplied index. The records in the equivalence class must match the layout of all other records in the datapool.

Parameters:

equivalenceClass - The equivalence class to insert.

beforeEquivalenceClassIndex - The equivalence class index to insert before.

See Also:

updateEquivalenceClass(IDatapoolEquivalenceClass,int), appendEquivalenceClass(IDatapoolEquivalenceClass), moveEquivalenceClass(int,int), removeEquivalenceClass(int)

appendEquivalenceClass

void appendEquivalenceClass(IDatapoolEquivalenceClass equivalenceClass)

Append the supplied equivalence class to the end of the set of available equivalence classes. The records in the equivalence class must match the layout of all other records in the datapool.

Parameters:

equivalenceClass - The equivalence class to append.

See Also:

updateEquivalenceClass(IDatapoolEquivalenceClass,int), insertEquivalenceClass(IDatapoolEquivalenceClass,int), moveEquivalenceClass(int,int), removeEquivalenceClass(int)

moveEquivalenceClass

void moveEquivalenceClass(int sourceEquivalenceClassIndex,
                          int targetEquivalenceClassIndex)

Move the equivalence class at a supplied index to a new position within the set of available equivalence classes.

Parameters:

sourceEquivalenceClassIndex - The equivalence class index to move.

targetEquivalenceClassIndex - The equivalence class destination index.

See Also:

updateEquivalenceClass(IDatapoolEquivalenceClass,int), insertEquivalenceClass(IDatapoolEquivalenceClass,int), appendEquivalenceClass(IDatapoolEquivalenceClass), removeEquivalenceClass(int)

removeEquivalenceClass

void removeEquivalenceClass(int equivalenceClassIndex)

Remove the equivalence class at a supplied index.

Parameters:

equivalenceClassIndex - The equivalence class indsex to remove.

See Also:

updateEquivalenceClass(IDatapoolEquivalenceClass,int), insertEquivalenceClass(IDatapoolEquivalenceClass,int), appendEquivalenceClass(IDatapoolEquivalenceClass), moveEquivalenceClass(int,int)

addDatapoolListener

void addDatapoolListener(IDatapoolListener listener)

Register a listener for actions against the datapool that modify the data or structure of the data model. The listener is informed when variables and records are added or deleted, and when the contents of a cell are changed.

See Also:

IDatapoolListener

removeDatapoolListener

void removeDatapoolListener(IDatapoolListener listener)

Removes a listener from the datapool instance.

See Also:

IDatapoolListener

constructEquivalenceClass

IDatapoolEquivalenceClass constructEquivalenceClass()

Constructs an empty equivalence class

constructVariable

IDatapoolVariable constructVariable()

Constructs an empty variable