|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectsbrt.shell.mng.AbstractProcessManager
sbrt.shell.mng.stat.CorrelationManager
public class CorrelationManager
This class is used to manage correlation processes.
Field Summary | |
---|---|
static java.lang.String |
CORR_COEFF
The keyword used to denote the type of correlation coefficient to be computed. |
static java.lang.String |
KENDALLS_TAU
The value used to denote a Kendall's tau correlation coefficient. |
static UnmodifiableSet<java.lang.String> |
optionalKeywords
The set of keywords understood, but not required, by this process manager. |
static java.lang.String |
PEARSONS_R
The value used to denote a Pearson's r correlation coefficient. |
static UnmodifiableSet<java.lang.String> |
requiredKeywords
The set of keywords required by this process manager. |
static java.lang.String |
SPEARMANS_RHO
The value used to denote a Spearman's rho correlation coefficient. |
static java.lang.String |
X_FILE_NAME
The keyword used to denote the name of the file containing the x values. |
static java.lang.String |
Y_FILE_NAME
The keyword used to denote the name of the file containing the y values. |
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 | |
---|---|
CorrelationManager()
|
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. |
CorrelationAnalysis<java.lang.String,RCorrelator.Result> |
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 UnmodifiableMap<java.lang.String,java.lang.Double> |
getVector(java.lang.String fileName)
Parses the file with the provided name and returns the vector it contains. |
static UnmodifiableMap<java.lang.String,java.lang.Double> |
getVector(java.lang.String fileName,
java.io.PrintWriter out)
Parses the file with the provided name, prints a status message to the provided print writer, and returns the vector the file contains. |
static UnmodifiableMap<java.lang.String,java.lang.Double> |
getXValues(ManagerInput<java.lang.String,java.lang.String> input,
java.io.PrintWriter out)
Returns the parsed value for X_FILE_NAME in the provided input and prints a descriptive message to the provided print writer. |
static UnmodifiableMap<java.lang.String,java.lang.Double> |
getYValues(ManagerInput<java.lang.String,java.lang.String> input,
java.io.PrintWriter out)
Returns the parsed value for Y_FILE_NAME in the provided input and prints a descriptive message to the provided print writer. |
static ApplicationException |
interpret(JriException e)
Wraps the provided JRI exception as an application exception. |
static RCorrelator<java.lang.String> |
parseCorrelator(java.lang.String coeff)
Returns the correlation computer corresponding to the provided string value. |
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. |
static void |
startR(java.io.PrintWriter out)
Starts the R engine and writes an informative message to the provided print writer. |
static void |
writeIntersection(java.lang.String fileName,
java.util.Map<java.lang.String,java.lang.Double> xValues,
java.util.Map<java.lang.String,java.lang.Double> yValues,
java.io.PrintWriter out)
Writes the intersection of the provided vectors to a file with the specified name. |
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 |
---|
public static final java.lang.String CORR_COEFF
public static final java.lang.String KENDALLS_TAU
public static final java.lang.String PEARSONS_R
public static final java.lang.String SPEARMANS_RHO
public static final java.lang.String X_FILE_NAME
public static final java.lang.String Y_FILE_NAME
public static final UnmodifiableSet<java.lang.String> requiredKeywords
public static final UnmodifiableSet<java.lang.String> optionalKeywords
Constructor Detail |
---|
public CorrelationManager()
Method Detail |
---|
public static UnmodifiableMap<java.lang.String,java.lang.Double> getVector(java.lang.String fileName)
fileName
- the name of the file to be read.
public static UnmodifiableMap<java.lang.String,java.lang.Double> getVector(java.lang.String fileName, java.io.PrintWriter out)
fileName
- the name of the file to be read.out
- the print writer to which a status message will be written.
public static UnmodifiableMap<java.lang.String,java.lang.Double> getXValues(ManagerInput<java.lang.String,java.lang.String> input, java.io.PrintWriter out)
input
- the input whose X_FILE_NAME
value is to be parsed.out
- the print writer to which a message is printed.
getVector(String, PrintWriter)
public static UnmodifiableMap<java.lang.String,java.lang.Double> getYValues(ManagerInput<java.lang.String,java.lang.String> input, java.io.PrintWriter out)
input
- the input whose Y_FILE_NAME
value is to be parsed.out
- the print writer to which a message is printed.
getVector(String, PrintWriter)
public static void writeIntersection(java.lang.String fileName, java.util.Map<java.lang.String,java.lang.Double> xValues, java.util.Map<java.lang.String,java.lang.Double> yValues, java.io.PrintWriter out)
fileName
- the desired name of the output file.xValues
- the x values.yValues
- the y values.out
- the print writer to which descriptive messages will be written.public static RCorrelator<java.lang.String> parseCorrelator(java.lang.String coeff)
coeff
- a string equal to KENDALLS_TAU,
SPEARMANS_RHO, or PEARSONS_R.
ApplicationException
- if the provided string does not equal
KENDALLS_TAU, SPEARMANS_RHO, or
PEARSONS_R.public static void startR(java.io.PrintWriter out)
out
- the print writer to which a message will be written.public static ApplicationException interpret(JriException e)
e
- the JRI exception.
public UnmodifiableSet<java.lang.String> getRequiredKeys()
getRequiredKeys
in interface ProcessManager<java.lang.String,java.lang.String>
public UnmodifiableSet<java.lang.String> getOptionalKeys()
getOptionalKeys
in interface ProcessManager<java.lang.String,java.lang.String>
public CorrelationAnalysis<java.lang.String,RCorrelator.Result> getProcess()
getProcess
in interface KernelProcessManager<java.lang.String,java.lang.String>
public void setInput(ManagerInput<java.lang.String,java.lang.String> input, java.io.PrintWriter out)
setInput
in interface ProcessManager<java.lang.String,java.lang.String>
input
- all of the information required to prepare this process
manager for execution.out
- the print writer to which all messages will be printed.public void execute(java.io.PrintWriter out)
execute
in interface ProcessManager<java.lang.String,java.lang.String>
out
- the print writer where the results will be printed.
java.lang.IllegalStateException
- if no input was provided to this process
manager.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |