sbrt.shell.mng.algebra
Class VectorIntersectionManager

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

public final class VectorIntersectionManager
extends AbstractProcessManager
implements KernelProcessManager<java.lang.String,java.lang.String>

This class is used to manage the intersection of vectors that do not contain identical sets of variables.

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

Field Summary
static java.lang.String INPUT_FILE_NAMES_FILE
          The keyword used to denote the name of a file containing the names of single-vector input files.
static UnmodifiableSet<java.lang.String> optionalKeywords
          The set of keywords understood, but not required, by this process manager.
static UnmodifiableSet<java.lang.String> requiredKeywords
          The set of keywords required by this process manager.
 
Fields inherited from class sbrt.shell.mng.AbstractProcessManager
ALGORITHM, COMPLETED, DATA_HEADERS, DEV_NULL, ELAPSED_TIME, FILE_FORMAT, INPUT_FILE, INPUT_FILE_NAME_FILE, ITERATIONS, OUTPUT_FILE_NAME, OUTPUT_FILE_NAME_FILE, PERCENT, PERCENT_COMPLETED, SEED, ZERO_CUTOFF
 
Constructor Summary
VectorIntersectionManager()
           
 
Method Summary
 void execute(java.io.PrintWriter out)
          Executes the process this process manager controls and writes the results to the provided print writer.
 UnmodifiableSet<java.lang.String> getOptionalKeys()
          Returns the set of keywords understood, but not required, by this process manager.
 VectorIntersection<java.lang.String,java.lang.String> getProcess()
          Returns the process controlled by this process manager.
 UnmodifiableSet<java.lang.String> getRequiredKeys()
          Returns the set of keywords required by this process manager.
static RomiFileSource<java.lang.String,java.lang.String> getVectorSource(java.lang.String inputFileNamesFileName)
          Returns
static RomiFileSource<java.lang.String,java.lang.String> getVectorSource(java.lang.String inputFileNamesFileName, java.io.PrintWriter out)
           
 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.AbstractProcessManager
check, closeFile, closeRm, execute, getFileFormat, getFileFormat, getFileNameSource, getIterations, getSeed, 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

INPUT_FILE_NAMES_FILE

public static final java.lang.String INPUT_FILE_NAMES_FILE
The keyword used to denote the name of a file containing the names of single-vector input files.

See Also:
Constant Field Values

requiredKeywords

public static final UnmodifiableSet<java.lang.String> requiredKeywords
The set of keywords required by this process manager.


optionalKeywords

public static final UnmodifiableSet<java.lang.String> optionalKeywords
The set of keywords understood, but not required, by this process manager.

Constructor Detail

VectorIntersectionManager

public VectorIntersectionManager()
Method Detail

getVectorSource

public static RomiFileSource<java.lang.String,java.lang.String> getVectorSource(java.lang.String inputFileNamesFileName)
Returns

Parameters:
input - the input containing a value for the the keyword
out - the print writer to which status messages will be printed.
Returns:

getVectorSource

public static RomiFileSource<java.lang.String,java.lang.String> getVectorSource(java.lang.String inputFileNamesFileName,
                                                                                java.io.PrintWriter out)

getRequiredKeys

public UnmodifiableSet<java.lang.String> getRequiredKeys()
Returns the set of keywords required by this process manager.

Specified by:
getRequiredKeys in interface ProcessManager<java.lang.String,java.lang.String>
Returns:
the set of keywords required by this process manager.

getOptionalKeys

public UnmodifiableSet<java.lang.String> getOptionalKeys()
Returns the set of keywords understood, but not required, by this process manager.

Specified by:
getOptionalKeys in interface ProcessManager<java.lang.String,java.lang.String>
Returns:
the set of keywords understood, but not required, by this process manager.

getProcess

public VectorIntersection<java.lang.String,java.lang.String> getProcess()
Returns the process controlled by this process manager.

Specified by:
getProcess in interface KernelProcessManager<java.lang.String,java.lang.String>
Returns:
the process controlled by this process manager.

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.

Specified by:
setInput in interface ProcessManager<java.lang.String,java.lang.String>
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.

execute

public void execute(java.io.PrintWriter out)
Executes the process this process manager controls and writes the results to the provided print writer.

Specified by:
execute in interface ProcessManager<java.lang.String,java.lang.String>
Parameters:
out - the print writer where the results will be printed.
Throws:
java.lang.IllegalStateException - if no input was provided to this process manager.