|
Hyades Datapool Specification | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
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.
IDatapoolEquivalenceClass
,
IDatapoolRecord
,
IDatapoolVariable
,
IDatapoolListener
,
DatapoolException
Method Summary | |
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. |
int |
getDefaultEquivalenceClassIndex()
Accessor for the default equivalence class
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. |
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 equivalenceClassIndex,
int beforeEquivalenceClass)
Move the equivalence class at a
supplied index to a new position within the set of available equivalence classes. |
void |
moveVariable(int variableIndex,
int beforeVariable)
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.datapool.INamedElement |
getDescription, getId, getName, setDescription, setId, setName |
Method Detail |
public int getVariableCount()
public IDatapoolVariable getVariable(int variableIndex)
DatapoolException
is thrown if the
specified index is not valid.
variableIndex
- A zero based variable index.
getVariableIndex(String)
public int getVariableIndex(java.lang.String variableName)
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.
variableName
- The name of the variable associated
with the desired cell.
getVariableIndexById(String)
public int getVariableIndexById(java.lang.String variableId)
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.
variableId
- The ID of the variable associated
with the desired cell.
getVariableIndex(String)
public void updateVariable(IDatapoolVariable variable, int variableIndex)
variable
- The variable for the cells at variableIndex.variableIndex
- A zero based variable index.getVariableIndex(String)
,
getVariableIndexById(String)
,
getVariable(int)
public void insertVariable(IDatapoolVariable variable, int beforeVariableIndex)
variable
- The new variable for the cells at beforeVariableIndex.beforeVariableIndex
- A zero based variable index.appendVariable(IDatapoolVariable)
,
moveVariable(int,int)
,
removeVariable(int)
public void appendVariable(IDatapoolVariable variable)
variable
- The variable instance to append.insertVariable(IDatapoolVariable,int)
,
moveVariable(int,int)
,
removeVariable(int)
public void moveVariable(int variableIndex, int beforeVariable)
variableIndex
- A zero based variable index for the variable to
be moved.beforeVariable
- The variable index marking the target location for
the move action.insertVariable(IDatapoolVariable,int)
,
appendVariable(IDatapoolVariable)
,
removeVariable(int)
public void removeVariable(int variableIndex)
variableIndex
- A zero based variable index for the variable to
be removed.insertVariable(IDatapoolVariable,int)
,
appendVariable(IDatapoolVariable)
,
moveVariable(int,int)
public int getEquivalenceClassCount()
equivalence classes
associated with a datapool.
public int getDefaultEquivalenceClassIndex()
equivalence class
in the datapool. If the default equivalence class has not been defined then
a value of -1 is returned.
setDefaultEquivalenceClassIndex(int)
public void setDefaultEquivalenceClassIndex(int equivalenceClassIndex)
equivalence class
in a datapool.
equivalenceClassIndex
- The zero-based index for the default equivalence class.getDefaultEquivalenceClassIndex()
public int getEquivalenceClassIndex(java.lang.String equivalenceClassName)
equivalence class
by name
within an instance of a datapool.
getEquivalenceClassIndexById(String)
public int getEquivalenceClassIndexById(java.lang.String equivalenceClassId)
equivalence class
by ID
within an instance of a datapool.
getEquivalenceClassIndex(String)
public void updateEquivalenceClass(IDatapoolEquivalenceClass equivalenceClass, int equivalenceClassIndex)
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
.
equivalenceClass
- The equivalence class to insert.equivalenceClassIndex
- The equivalence class indsex to remove and insert at.insertEquivalenceClass(IDatapoolEquivalenceClass,int)
,
appendEquivalenceClass(IDatapoolEquivalenceClass)
,
moveEquivalenceClass(int,int)
,
removeEquivalenceClass(int)
public void insertEquivalenceClass(IDatapoolEquivalenceClass equivalenceClass, int beforeEquivalenceClassIndex)
equivalence class
at a
supplied index. The records
in the equivalence
class must match the layout of all other records in the datapool.
equivalenceClass
- The equivalence class to insert.beforeEquivalenceClassIndex
- The equivalence class index to insert before.updateEquivalenceClass(IDatapoolEquivalenceClass,int)
,
appendEquivalenceClass(IDatapoolEquivalenceClass)
,
moveEquivalenceClass(int,int)
,
removeEquivalenceClass(int)
public void appendEquivalenceClass(IDatapoolEquivalenceClass equivalenceClass)
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.
equivalenceClass
- The equivalence class to append.updateEquivalenceClass(IDatapoolEquivalenceClass,int)
,
insertEquivalenceClass(IDatapoolEquivalenceClass,int)
,
moveEquivalenceClass(int,int)
,
removeEquivalenceClass(int)
public void moveEquivalenceClass(int equivalenceClassIndex, int beforeEquivalenceClass)
equivalence class
at a
supplied index to a new position within the set of available equivalence classes.
equivalenceClassIndex
- The equivalence class index to move.beforeEquivalenceClass
- The equivalence class destination index.updateEquivalenceClass(IDatapoolEquivalenceClass,int)
,
insertEquivalenceClass(IDatapoolEquivalenceClass,int)
,
appendEquivalenceClass(IDatapoolEquivalenceClass)
,
removeEquivalenceClass(int)
public void removeEquivalenceClass(int equivalenceClassIndex)
equivalence class
at a
supplied index.
equivalenceClassIndex
- The equivalence class indsex to remove.updateEquivalenceClass(IDatapoolEquivalenceClass,int)
,
insertEquivalenceClass(IDatapoolEquivalenceClass,int)
,
appendEquivalenceClass(IDatapoolEquivalenceClass)
,
moveEquivalenceClass(int,int)
public void addDatapoolListener(IDatapoolListener listener)
IDatapoolListener
public void removeDatapoolListener(IDatapoolListener listener)
IDatapoolListener
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |