sbrt.shell.mng.fba
Class CatalystDeletionManager

java.lang.Object
  extended by sbrt.shell.mng.AbstractProcessManager
      extended by sbrt.shell.mng.fba.FbaManager
          extended by sbrt.shell.mng.fba.CatalystDeletionManager
All Implemented Interfaces:
KernelProcessManager<java.lang.String,java.lang.String>, ProcessManager<java.lang.String,java.lang.String>

public final class CatalystDeletionManager
extends FbaManager

This class is used to manage FBA catalyst deletion processes.

Author:
This class was written and documented by Jeremiah Wright while in the Wagner lab.

Field Summary
static java.lang.String CATALYST_DELETION_FILE
          The keyword used to denote the name of a file containing sets of names of catalysts whose effect upon deletion will be computed.
static UnmodifiableSet<java.lang.String> optionalKeywords
          The set of optional keywords in the ManagerInput objects supplied to instances of this class.
static UnmodifiableSet<java.lang.String> requiredKeywords
          The set of keywords required to be present in the ManagerInput objects supplied to instances of this class.
 
Fields inherited from class sbrt.shell.mng.fba.FbaManager
CONSTRAINT_TOLERANCE, DEFAULT_CONSTRAINT_TOLERANCE, FLUX_VECTOR_FILE, FLUX_VECTOR_FILE_NAME, RXN_CATALYST_FILE, RXN_FILE, SYSTEM_SOLUTION_FILE
 
Fields inherited from class sbrt.shell.mng.AbstractProcessManager
ALGORITHM, COMPLETED, DATA_HEADERS, DEV_NULL, ELAPSED_TIME, FILE_FORMAT, INPUT_FILE, INPUT_FILE_FORMAT, INPUT_FILE_NAME_FILE, ITERATIONS, OUTPUT_FILE_FORMAT, OUTPUT_FILE_NAME, OUTPUT_FILE_NAME_FILE, PERCENT, PERCENT_COMPLETED, SEED, ZERO_CUTOFF
 
Constructor Summary
CatalystDeletionManager()
           
 
Method Summary
 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.
static InputFile<java.util.Set<java.lang.String>> getDeletionFile(ManagerInput<java.lang.String,java.lang.String> input, java.io.PrintWriter out, CatalyzedFluxome fluxome)
          Parses and returns the value for CATALYST_DELETION_FILE in the provided manager input.
static InputFile<java.util.Set<java.lang.String>> getDeletionFile(java.lang.String fileName, CatalyzedFluxome fluxome)
          Returns the catalyst input file with the provided name.
 java.util.Set<java.lang.String> getOptionalKeys()
          Returns the set of keywords the provided ManagerInput object does not necessarily have to contain.
 CatalystDeletionProcess<MixedFluxome> getProcess()
          Returns the process this process manager controls.
 java.util.Set<java.lang.String> getRequiredKeys()
          Returns the set of keywords the provided ManagerInput object must contain.
 void setInput(ManagerInput<java.lang.String,java.lang.String> input, java.io.PrintWriter out)
          Uses the provided input to prepare this process manager for execution.
 
Methods inherited from class sbrt.shell.mng.fba.FbaManager
getCatalysts, getCatalysts, getConstraintTolerance, getConstraintTolerance, getFluxomeSolution, getIrrevRxnFluxome, getIrrevRxnFluxome, getIrrevRxnFluxome, getIrrevRxnFluxome, getIrrevRxnFluxome, getMixedFluxome, getMixedFluxome, getMixedFluxome, getMixedFluxome, getMixedFluxome, getMultiFluxVectorOutputFile, getMultiFluxVectorOutputFile, getRxnNameExprFormat, getRxnNameHeaders, getRxnNameHeaders, getSingleFluxVectorOutputFile, getSingleFluxVectorOutputFile, printFluxomeInfo, writeFluxome, writeFluxome, writeFluxome, writeFluxome
 
Methods inherited from class sbrt.shell.mng.AbstractProcessManager
check, closeFile, closeRm, execute, getFileFormat, getFileFormat, getFileNameSource, getIterations, getSeed, getTextFileFormat, getTextFileFormat, getZeroCutoff, getZeroCutoff, parseInt, parseLong, printProgress, printProgress, printProgress, runProcess, setInput
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface sbrt.shell.mng.ProcessManager
check, execute, setInput
 

Field Detail

CATALYST_DELETION_FILE

public static final java.lang.String CATALYST_DELETION_FILE
The keyword used to denote the name of a file containing sets of names of catalysts whose effect upon deletion will be computed.

See Also:
Constant Field Values

requiredKeywords

public static final UnmodifiableSet<java.lang.String> requiredKeywords
The set of keywords required to be present in the ManagerInput objects supplied to instances of this class.


optionalKeywords

public static final UnmodifiableSet<java.lang.String> optionalKeywords
The set of optional keywords in the ManagerInput objects supplied to instances of this class.

Constructor Detail

CatalystDeletionManager

public CatalystDeletionManager()
Method Detail

getDeletionFile

public static InputFile<java.util.Set<java.lang.String>> getDeletionFile(ManagerInput<java.lang.String,java.lang.String> input,
                                                                         java.io.PrintWriter out,
                                                                         CatalyzedFluxome fluxome)
Parses and returns the value for CATALYST_DELETION_FILE in the provided manager input.

Parameters:
input - keyword-value pairs.
out - the print writer to which status messages will be printed.
fluxome - the fluxome in which the catalysts are contained.
Returns:
the catalyst input file with the name contained in input.

getDeletionFile

public static InputFile<java.util.Set<java.lang.String>> getDeletionFile(java.lang.String fileName,
                                                                         CatalyzedFluxome fluxome)
Returns the catalyst input file with the provided name.

Parameters:
fileName - the name of the file containing sets of catalysts.
fluxome - the fluxome in which the catalysts are contained.
Returns:
the catalyst input file with the provided name.

getRequiredKeys

public java.util.Set<java.lang.String> getRequiredKeys()
Returns the set of keywords the provided ManagerInput object must contain.

Returns:
the set of keywords the provided ManagerInput object must contain.

getOptionalKeys

public java.util.Set<java.lang.String> getOptionalKeys()
Returns the set of keywords the provided ManagerInput object does not necessarily have to contain.

Returns:
the set of keywords the provided ManagerInput object does not necessarily have to contain.

setInput

public void setInput(ManagerInput<java.lang.String,java.lang.String> input,
                     java.io.PrintWriter out)
Uses the provided input to prepare this process manager for execution. As the input is processed, informative messages are printed to the provided print writer.

Parameters:
input - all of the information required to prepare this process manager for execution.
out - the print writer to which all messages will be printed.

getProcess

public CatalystDeletionProcess<MixedFluxome> getProcess()
Returns the process this process manager controls.

Returns:
the process this process manager controls.
Throws:
java.lang.IllegalStateException - if no input was provided to this process manager via AbstractProcessManager.setInput(ManagerInput) or setInput(ManagerInput, PrintWriter)

execute

public 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.

Parameters:
out - the print writer where status messages will be printed.
Throws:
java.lang.IllegalStateException - if no input was provided to this process manager via AbstractProcessManager.setInput(ManagerInput) or setInput(ManagerInput, PrintWriter)