|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
K
- the key type.V
- the value type.public interface ProcessManager<K,V>
This interface is used to represent process managers. A process manager is used to manage a process executed by the Systems Biology Research Tool.
A process manager is created from a ManagerInput
object. Process managers require a minimum set of key-value
pairs to perform their action.
In addition to this minimum set, a set of optional
key-value pairs may also be allowed. If the provided ManagerInput
contains any additional keys beyond the set of required and optional keys,
an ApplicationException
will be thrown.
Method Summary | |
---|---|
void |
check(ManagerInput<K,V> input)
Throws an ApplicationException if this ProcessManager
cannot understand the provided input. |
void |
execute()
Executes the process this process manager controls. |
void |
execute(java.io.PrintWriter out)
Executes the process this process manager controls, and writes the status or results of this process to the provided print writer. |
java.util.Set<K> |
getOptionalKeys()
Returns the set of keys the provided ManagerInput object does not necessarily
have to contain. |
java.util.Set<K> |
getRequiredKeys()
Returns the set of keys the provided ManagerInput object must contain. |
void |
setInput(ManagerInput<K,V> input)
Uses the provided input to prepare this process manager for execution. |
void |
setInput(ManagerInput<K,V> input,
java.io.PrintWriter out)
Uses the provided input to prepare this process manager for execution. |
Method Detail |
---|
java.util.Set<K> getRequiredKeys()
ManagerInput
object must contain.
ManagerInput
object must contain.java.util.Set<K> getOptionalKeys()
ManagerInput
object does not necessarily
have to contain.
ManagerInput
object does not necessarily
have to contain.void setInput(ManagerInput<K,V> input)
input
- all of the information required to
prepare this process manager for execution.void setInput(ManagerInput<K,V> input, java.io.PrintWriter out)
input
- all of the information required to
prepare this process manager for execution.out
- the print writer to which all messages
will be printed.void execute()
java.lang.IllegalStateException
- if no input was provided
to this process manager via setInput(ManagerInput) or
setInput(ManagerInput, PrintWriter)void execute(java.io.PrintWriter out)
out
- the print writer where some results or status messages
will be printed.
java.lang.IllegalStateException
- if no input was provided
to this process manager via setInput(ManagerInput) or
setInput(ManagerInput, PrintWriter)void check(ManagerInput<K,V> input)
ProcessManager
cannot understand the provided input.
input
- the manager input to be checked.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |