at.srfg.miner.clientlib

Class Results

Object

at.srfg.miner.clientlib.Results

public class Results
extends Object

This class provides static utility methods for printing and saving results. By default, it uses a ResultFormatterSimple for saving results and a ResultFormatterDate for printing results. These default formatters can be changed via setPrintFormatter(ResultFormatter) and setSaveFormatter(ResultFormatter), respectively. Example

 ResultFormatterDate rfd = new ResultFormatterDate();
 rfd.setTimebase(exec.getStart());
 Results.setPrintFormatter(rfd);
 

Additionally, a specific formatter can be used per-call, see the print/save/append methods.

Moreover, the class provides 2 utility methods that are useful if results shall be queried at a time, where the Execution and ResultHandle instances are not available any more.

The method marshallQuery(Execution, ResultHandle) creates a String that contains all the information which is needed to retrieve results for (exec,handle) at a later time. From this String, a Query instance can be regenerated using unmarshallQuery(String).

Field Summary

Fields

Modifier and Type	Field and Description
static String	SUFFIX_BIN
static String	SUFFIX_TXT

Method Summary

Methods

Modifier and Type	Method and Description
static void	append(List<Result> results, java.io.File file) Append all results to file.
static void	append(List<Result> results, java.io.File file, ResultFormatter formatter) Appends all results to file.
static void	append(List<Result> results, String filename) Append all results to filename.
static void	append(List<Result> results, String filename, ResultFormatter formatter) Append all results to filename.
static void	disableAutoSuffix()
static void	enableAutoSuffix()
static void	getAndPrint(Execution exec, Collection<ResultHandle> handles) For each result handle the results are incrementally loaded from the MINER Core and printed to System.out.
static void	getAndPrint(Execution exec, ResultFormatter formatter, Collection<ResultHandle> handles) For each result handle the results are incrementally loaded from the MINER Core and printed to System.out.
static void	getAndPrint(Execution exec, ResultFormatter formatter, ResultHandle... handles) For each result handle the results are incrementally loaded from the MINER Core and printed to System.out.
static void	getAndPrint(Execution exec, ResultHandle... handles) For each result handle the results are incrementally loaded from the MINER Core and printed to System.out.
static void	getAndPrintAllResults(Execution exec) Gets the results and prints them to System.out for each ResultHandle defined in the scenario of this execution.
static void	getAndPrintAllResults(Execution exec, ResultFormatter formatter) Gets the results and prints them to System.out for each ResultHandle defined in the scenario of this execution.
static List<Result>	getAndPrintAndReturn(Execution exec, ResultFormatter formatter, ResultHandle handle) Gets all results from the MINER Core, prints them and returns the results.
static List<Result>	getAndPrintAndReturn(Execution exec, ResultHandle handle) Gets all results from the MINER Core, prints them and returns the results.
static void	getAndSave(Execution exec, Collection<ResultHandle> handles) For each result handle the results are incrementally loaded from the MINER Core and saved to a file.
static void	getAndSave(Execution exec, ResultFormatter formatter, Collection<ResultHandle> handles) For each result handle the results are incrementally loaded from the MINER Core and saved to a file.
static void	getAndSave(Execution exec, ResultFormatter formatter, ResultHandle... handles) For each result handle the results are incrementally loaded from the MINER Core and saved to a file.
static void	getAndSave(Execution exec, ResultHandle... handles) For each result handle the results are incrementally loaded from the MINER Core and saved to a file.
static void	getAndSaveAllResults(Execution exec) Incrementally gets the results and saves them for each ResultHandle defined in the scenario of this execution.
static void	getAndSaveAllResults(Execution exec, ResultFormatter formatter) Incrementally gets the results and saved them for each ResultHandle defined in the scenario of this execution.
static List<Result>	getAndSaveAndReturn(Execution exec, ResultFormatter formatter, ResultHandle handle) Gets all results from the MINER Core, saves them and returns the results.
static List<Result>	getAndSaveAndReturn(Execution exec, ResultHandle handle) Gets all results from the MINER Core, saves them and returns the results.
static ResultFormatter	getPrintFormatter() Gets the print formatter.
static java.io.File	getResultFileAndCreateParentDirs(String filename) Creates a File instance in one of the following directories (whatever matches first): the absolute or relative path defined in filename if set the getSaveDir() if set the working directory If necessary non-existent parent directories are created.
static java.io.File	getSaveDir() Gets the base directory for saving results.
static ResultFormatter	getSaveFormatter() Gets the default ResultFormatter used for saving results.
static void	marshallQueriesToFile(java.io.File file, Execution exec, Collection<ResultHandle> handles) For each handle, a queryString is created via marshallQuery(Execution, ResultHandle) and saved to file.
static void	marshallQueriesToFile(java.io.File file, Execution exec, ResultHandle... handles) For each handle, a queryString is created via marshallQuery(Execution, ResultHandle) and saved to file.
static String	marshallQuery(Execution exec, ResultHandle handle) Creates a String that contains all the information which is needed to retrieve results for (exec,handle) at a later time.
static void	print(List<Result> results) Prints all results to System.out using the default result formatter.
static void	print(List<Result> results, ResultFormatter formatter) Prints all results to System.out using the given formatter.
static void	save(List<Result> results, java.io.File file) Saves all results to file.
static void	save(List<Result> results, java.io.File file, ResultFormatter formatter) Saves all results to file.
static void	save(List<Result> results, String filename) Saves all results to filename.
static void	save(List<Result> results, String filename, ResultFormatter formatter) Saves all results to filename.
static void	setPrintFormatter(ResultFormatter formatter) Sets the default ResultFormatter used for printing results.
static void	setSaveDir(java.io.File dir) Sets the base directory for saving results.
static void	setSaveFormatter(ResultFormatter formatter) Sets the default ResultFormatter used for saving results.
static Map<Proxy,List<Result>>	splitByProxy(List<Result> results)
static Query	unmarshallQuery(String savedQuery) Creates a Query instance from a String which was previously generated using marshallQuery(Execution, ResultHandle, String).

Methods inherited from class Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

SUFFIX_TXT

public static final String SUFFIX_TXT

See Also:

Constant Field Values

SUFFIX_BIN

public static final String SUFFIX_BIN

See Also:

Constant Field Values

Method Detail

print

public static void print(List<Result> results)

Prints all results to System.out using the default result formatter.

Parameters:

results - the list of results to be printed

print

public static void print(List<Result> results,
         ResultFormatter formatter)

Prints all results to System.out using the given formatter.

Parameters:

results - the result list to be printed

formatter - the formatter which transforms results to String

save

public static void save(List<Result> results,
        String filename)
                 throws java.io.IOException

Saves all results to filename. The target directory is either getSaveDir() if it is set; otherwise it is the working directory. The results are converted to String using the default result formatter for saving files, see setSaveFormatter(ResultFormatter).

Parameters:

results - the list of result instances

filename - the target file name

Throws:

java.io.IOException

save

public static void save(List<Result> results,
        String filename,
        ResultFormatter formatter)
                 throws java.io.IOException

Saves all results to filename. The target directory is either getSaveDir() if it is set; otherwise it is the working directory. The results are converted to String using formatter.

Parameters:

results - the list of result instances

filename - the target file name

formatter - the formatter which transforms results to String

Throws:

java.io.IOException

save

public static void save(List<Result> results,
        java.io.File file)
                 throws java.io.IOException

Saves all results to file. The file is overwritten if it exists already. The results are converted to String using the default result formatter for saving files, see setSaveFormatter(ResultFormatter). Note that unlike save(List, String) this method ignores the getSaveDir().

Parameters:

results - the list of result instances

file - the destination file

Throws:

java.io.IOException

save

public static void save(List<Result> results,
        java.io.File file,
        ResultFormatter formatter)
                 throws java.io.IOException

Saves all results to file. The file is overwritten if it exists already. The results are converted to String with the given formatter. Note that unlike save(List, String, ResultFormatter) this method ignores the getSaveDir().

Parameters:

results - the list of result instances

file - the destination file

formatter - the formatter which transforms results to String

Throws:

java.io.IOException

append

public static void append(List<Result> results,
          String filename)
                   throws java.io.IOException

Append all results to filename. The target directory is either getSaveDir() if it is set; otherwise it is the working directory. The file is created if it doesn't exist. The results are converted to String using the default result formatter for saving files, see setSaveFormatter(ResultFormatter).

Parameters:

results - the list of result instances

filename - the destination filename

Throws:

java.io.IOException

append

public static void append(List<Result> results,
          String filename,
          ResultFormatter formatter)
                   throws java.io.IOException

Append all results to filename. The target directory is either getSaveDir() if it is set; otherwise it is the working directory. The file is created if it doesn't exist. The results are converted using formatter.

Parameters:

results - the list of result instances

filename - the destination filename

formatter - the result formatter

Throws:

java.io.IOException

append

public static void append(List<Result> results,
          java.io.File file)
                   throws java.io.IOException

Append all results to file. The file is created if it doesn't exist. The results are converted to String using the default result formatter for saving files, see setSaveFormatter(ResultFormatter). Note that unlike append(List, String) this method ignores the getSaveDir().

Parameters:

results - the list of result instances

file - the destination file

Throws:

java.io.IOException

append

public static void append(List<Result> results,
          java.io.File file,
          ResultFormatter formatter)
                   throws java.io.IOException

Appends all results to file. The file is created if it doesn't exist. The results are converted to String using the given formatter. Note that unlike append(List, String, ResultFormatter) this method ignores the getSaveDir().

Parameters:

results - the list of result instances

file - the destination file

formatter - the result formatter

Throws:

java.io.IOException

getAndPrintAllResults

public static void getAndPrintAllResults(Execution exec)
                                  throws at.srfg.miner.exception.MinerException

Gets the results and prints them to System.out for each ResultHandle defined in the scenario of this execution. The first line of the output is

 # resultName[-resultSelector]
 

then follow the results and finally a newline is printed. The results are converted to String using the default result formatter for printing results, see setPrintFormatter(ResultFormatter).

Parameters:

exec - the execution

Throws:

at.srfg.miner.exception.MinerException

getAndPrintAllResults

public static void getAndPrintAllResults(Execution exec,
                         ResultFormatter formatter)
                                  throws at.srfg.miner.exception.MinerException

Gets the results and prints them to System.out for each ResultHandle defined in the scenario of this execution. The first line of the output is

 # resultName[-resultSelector]
 

then follow the results and finally a newline is printed. The results are converted to String using the given formatter.

Parameters:

exec - the execution

formatter - the result formatter

Throws:

at.srfg.miner.exception.MinerException

getAndPrint

public static void getAndPrint(Execution exec,
               ResultHandle... handles)
                        throws at.srfg.miner.exception.MinerException

For each result handle the results are incrementally loaded from the MINER Core and printed to System.out. The first line of the output is

 # resultName[-resultSelector]
 

then follow the results and finally a newline is printed. The results are converted to String using the default result formatter for printing results, see setPrintFormatter(ResultFormatter).

Parameters:

exec - the execution

handles - the result handles

Throws:

at.srfg.miner.exception.MinerException

getAndPrint

public static void getAndPrint(Execution exec,
               Collection<ResultHandle> handles)
                        throws at.srfg.miner.exception.MinerException

For each result handle the results are incrementally loaded from the MINER Core and printed to System.out. The first line of the output is

 # resultName[-resultSelector]
 

then follow the results and finally a newline is printed. The results are converted to String using the default result formatter for printing results, see setPrintFormatter(ResultFormatter).

Parameters:

exec - the execution

handles - the result handles

Throws:

at.srfg.miner.exception.MinerException

getAndPrint

public static void getAndPrint(Execution exec,
               ResultFormatter formatter,
               ResultHandle... handles)
                        throws at.srfg.miner.exception.MinerException

For each result handle the results are incrementally loaded from the MINER Core and printed to System.out. The first line of the output is

 # resultName[-resultSelector]
 

then follow the results and finally a newline is printed. The results are converted to String using the given formatter.

Parameters:

exec - the execution

formatter - the result formatter

handles - the result handles

Throws:

at.srfg.miner.exception.MinerException

getAndPrint

public static void getAndPrint(Execution exec,
               ResultFormatter formatter,
               Collection<ResultHandle> handles)
                        throws at.srfg.miner.exception.MinerException

For each result handle the results are incrementally loaded from the MINER Core and printed to System.out. The first line of the output is

 # resultName[-resultSelector]
 

then follow the results and finally a newline is printed. The results are converted to String using the given formatter.

Parameters:

exec - the execution

formatter - the result formatter

handles - the result handles

Throws:

at.srfg.miner.exception.MinerException

getAndPrintAndReturn

public static List<Result> getAndPrintAndReturn(Execution exec,
                                ResultHandle handle)
                                         throws at.srfg.miner.exception.MinerException

Gets all results from the MINER Core, prints them and returns the results. The results are converted to String using the default result formatter for printing results, see setPrintFormatter(ResultFormatter).

Parameters:

exec - the execution

handle - the result handle

Returns:

An unsorted list of all results. If there aren't any, an empty list is returned (but never null).

Throws:

at.srfg.miner.exception.MinerException

getAndPrintAndReturn

public static List<Result> getAndPrintAndReturn(Execution exec,
                                ResultFormatter formatter,
                                ResultHandle handle)
                                         throws at.srfg.miner.exception.MinerException

Gets all results from the MINER Core, prints them and returns the results. The results are converted to String using the given formatter.

Parameters:

exec - the execution

formatter - the result formatter

handle - the result handle

Returns:

An unsorted list of all results. If there aren't any, an empty list is returned (but never null).

Throws:

at.srfg.miner.exception.MinerException

getAndSaveAllResults

public static void getAndSaveAllResults(Execution exec)
                                 throws java.io.IOException,
                                        at.srfg.miner.exception.MinerException

Incrementally gets the results and saves them for each ResultHandle defined in the scenario of this execution. This method makes use of ResultHandle.getSavePattern() if set. Otherwise, the filename is created from properties of the result handle. If the target file already exists it is deleted (and if it can't be deleted an IOException is thrown). The results are converted to String using the default result formatter for saving files, see setSaveFormatter(ResultFormatter).

Parameters:

exec - the execution

Throws:

java.io.IOException

at.srfg.miner.exception.MinerException

getAndSaveAllResults

public static void getAndSaveAllResults(Execution exec,
                        ResultFormatter formatter)
                                 throws java.io.IOException,
                                        at.srfg.miner.exception.MinerException

Incrementally gets the results and saved them for each ResultHandle defined in the scenario of this execution. This method makes use of ResultHandle.getSavePattern() if set. Otherwise, the filename is created from properties of the result handle. If the target file already exists it is deleted (and if it can't be deleted an IOException is thrown). The results are converted to String using the given formatter.

Parameters:

exec - the execution

formatter - the result formatter

Throws:

java.io.IOException

at.srfg.miner.exception.MinerException

getAndSave

public static void getAndSave(Execution exec,
              ResultHandle... handles)
                       throws java.io.IOException,
                              at.srfg.miner.exception.MinerException

For each result handle the results are incrementally loaded from the MINER Core and saved to a file. This method makes use of ResultHandle.getSavePattern() if set. Otherwise, the filename is created from properties of the result handle. If the target file already exists it is deleted (and if it can't be deleted an IOException is thrown). The results are converted to String using the default result formatter for saving files, see setSaveFormatter(ResultFormatter).

Parameters:

exec - the execution

handles - the result handles

Throws:

java.io.IOException

at.srfg.miner.exception.MinerException

getAndSave

public static void getAndSave(Execution exec,
              ResultFormatter formatter,
              ResultHandle... handles)
                       throws java.io.IOException,
                              at.srfg.miner.exception.MinerException

For each result handle the results are incrementally loaded from the MINER Core and saved to a file. This method makes use of ResultHandle.getSavePattern() if set. Otherwise, the filename is created from properties of the result handle. If the target file already exists it is deleted (and if it can't be deleted an IOException is thrown). The results are converted to String using the given formatter.

Parameters:

exec - the execution

formatter - the result formatter

handles - the result handles

Throws:

java.io.IOException

at.srfg.miner.exception.MinerException

getAndSave

public static void getAndSave(Execution exec,
              Collection<ResultHandle> handles)
                       throws java.io.IOException,
                              at.srfg.miner.exception.MinerException

For each result handle the results are incrementally loaded from the MINER Core and saved to a file. This method makes use of ResultHandle.getSavePattern() if set. Otherwise, the filename is created from properties of the result handle. If the target file already exists it is deleted (and if it can't be deleted an IOException is thrown). The results are converted to String using the default result formatter for saving files, see setSaveFormatter(ResultFormatter)

Parameters:

exec - the execution

handles - the result handles

Throws:

java.io.IOException

at.srfg.miner.exception.MinerException

getAndSave

public static void getAndSave(Execution exec,
              ResultFormatter formatter,
              Collection<ResultHandle> handles)
                       throws java.io.IOException,
                              at.srfg.miner.exception.MinerException

For each result handle the results are incrementally loaded from the MINER Core and saved to a file. This method makes use of ResultHandle.getSavePattern() if set. Otherwise, the filename is created from properties of the result handle. If the target file already exists it is deleted (and if it can't be deleted an IOException is thrown). The results are converted to String using the given formatter.

Parameters:

exec - the execution

formatter - the result formatter

handles - the result handles

Throws:

java.io.IOException

at.srfg.miner.exception.MinerException

getAndSaveAndReturn

public static List<Result> getAndSaveAndReturn(Execution exec,
                               ResultHandle handle)
                                        throws java.io.IOException,
                                               at.srfg.miner.exception.MinerException

Gets all results from the MINER Core, saves them and returns the results. This method makes use of ResultHandle.getSavePattern() if set. Otherwise, the filename is created from properties of the result handle. If the target file already exists it is deleted (and if it can't be deleted an IOException is thrown). The results are converted to String using the default result formatter for saving files, see setSaveFormatter(ResultFormatter).

Parameters:

exec - the execution

handle - the result handle

Returns:

An unsorted list of all results. If there aren't any, an empty list is returned (but never null).

Throws:

java.io.IOException

at.srfg.miner.exception.MinerException

getAndSaveAndReturn

public static List<Result> getAndSaveAndReturn(Execution exec,
                               ResultFormatter formatter,
                               ResultHandle handle)
                                        throws java.io.IOException,
                                               at.srfg.miner.exception.MinerException

Gets all results from the MINER Core, saves them and returns the results. This method makes use of ResultHandle.getSavePattern() if set. Otherwise, the filename is created from properties of the result handle. If the target file already exists it is deleted (and if it can't be deleted an IOException is thrown). The results are converted to String using the given formatter.

Parameters:

exec - the execution

formatter - the result formatter

handle - the result handle

Returns:

An unsorted list of all results. If there aren't any, an empty list is returned (but never null).

Throws:

java.io.IOException

at.srfg.miner.exception.MinerException

splitByProxy

public static Map<Proxy,List<Result>> splitByProxy(List<Result> results)

enableAutoSuffix

public static void enableAutoSuffix()

disableAutoSuffix

public static void disableAutoSuffix()

getPrintFormatter

public static ResultFormatter getPrintFormatter()

Gets the print formatter.

Returns:

the print formatter

setPrintFormatter

public static void setPrintFormatter(ResultFormatter formatter)

Sets the default ResultFormatter used for printing results.

Parameters:

formatter - the formatter

getSaveFormatter

public static ResultFormatter getSaveFormatter()

Gets the default ResultFormatter used for saving results.

Returns:

the formatter

setSaveFormatter

public static void setSaveFormatter(ResultFormatter formatter)

Sets the default ResultFormatter used for saving results.

Parameters:

formatter - the formatter

marshallQuery

public static String marshallQuery(Execution exec,
                   ResultHandle handle)

Creates a String that contains all the information which is needed to retrieve results for (exec,handle) at a later time. From this String, a Query instance can be generated at a later time using unmarshallQuery(String).

Parameters:

exec - the execution

handle - the result handle

Returns:

a String representation containing Query information

marshallQueriesToFile

public static void marshallQueriesToFile(java.io.File file,
                         Execution exec,
                         ResultHandle... handles)
                                  throws java.io.IOException

For each handle, a queryString is created via marshallQuery(Execution, ResultHandle) and saved to file.

Parameters:

file - the output file

exec - the execution

handles - the result handles

Throws:

java.io.IOException

marshallQueriesToFile

public static void marshallQueriesToFile(java.io.File file,
                         Execution exec,
                         Collection<ResultHandle> handles)
                                  throws java.io.IOException

For each handle, a queryString is created via marshallQuery(Execution, ResultHandle) and saved to file.

Parameters:

file - the output file

exec - the execution

handles - the result handles

Throws:

java.io.IOException

unmarshallQuery

public static Query unmarshallQuery(String savedQuery)

Creates a Query instance from a String which was previously generated using marshallQuery(Execution, ResultHandle, String).

Parameters:

savedQuery - the query string

Returns:

a Query

getResultFileAndCreateParentDirs

public static java.io.File getResultFileAndCreateParentDirs(String filename)

Creates a File instance in one of the following directories (whatever matches first):

1. the absolute or relative path defined in filename if set
2. the getSaveDir() if set
3. the working directory

If necessary non-existent parent directories are created. If the creation fails, no error is signaled.

Parameters:

filename - the filename which may contain an absolute or relative path specification

Returns:

a File where the result can be saved

setSaveDir

public static void setSaveDir(java.io.File dir)
                       throws java.io.IOException,
                              IllegalArgumentException

Sets the base directory for saving results. If file contains a relative path then it is relative to the current working directory.

Parameters:

dir - the saveDir to set

Throws:

IllegalArgumentException - if saveDir is not an existing directory with write permissions.

java.io.IOException

getSaveDir

public static java.io.File getSaveDir()

Gets the base directory for saving results.

Returns:

the saveDir