fi.techila.user

Interface ResultManager

public interface ResultManager

Methods for project result management, like downloading and unzipping.

Method Summary

Modifier and Type	Method and Description
int	downloadResult(int handle) Download result of the project associated with the handle.
int	downloadResult(int handle, boolean allowPartial) Download result of the project associated with the handle.
int	downloadResult(int handle, boolean allowPartial, boolean stream) Download result of the project associated with the handle.
int	getFilesReceived(int handle) Return the number of files received using stream.
java.lang.String[]	getNewIntermediateResultFilenames(int handle) Get the intermediate result filenames on the server.
java.lang.String[]	getNewIntermediateResultFiles(int handle) Get the intermediate result files.
java.lang.String[]	getNewStreamedResultFiles(int handle) Get the new files retrieved in streaming mode.
java.lang.String	getResultDirectory(int handle) Get the directory where results have been unzipped.
java.lang.String	getResultFile(int handle) Get the project result file.
int	getResultFileCount(int handle) Get the count of unzipped result files.
java.lang.String	getResultFileName(int handle, int index) Get the unzipped result file in specific index.
java.lang.String[]	getResultFiles(int handle) Get the unzipped result filenames.
java.lang.String	getStreamedResultFileName(int handle, int index) Get the streamed result file in specific index.
java.lang.String[]	getStreamedResultFiles(int handle) Get the files retrieved in streaming mode.
int	getStreamedResultFilesCount(int handle) Get the count of streamed result files.
int	setAllowPartial(int handle, boolean allowPartial) Set allow partial flag.
int	setDownloadDir(int handle, java.lang.String directory) Set the download directory for the associated handle.
int	setFilesReceived(int handle, int count) Do NOT use unless you know what you are doing!
int	setResultFile(int handle, java.lang.String file) Set the result file to point somewhere.
int	setStreamResults(int handle, boolean streamResults) Set or unset the stream results bit.
int	setUnzipDir(int handle, java.lang.String directory) Set the unzip directory for the associated handle.
int	setUseIntermediateResults(int handle, boolean useIntermediateResults) Set or unset the intermediate results bit.
int	unzip(int handle) Unzip the project zip file associated with the handle.

Method Detail

setStreamResults

int setStreamResults(int handle,
                     boolean streamResults)

Set or unset the stream results bit. If true results are downloaded as a stream. When a jobs completed its result file is downloaded at the next poll. Separate downloadResult call is not necessary.

Parameters:

handle -

streamResults -

See Also:

getNewStreamedResultFiles(int)

setUseIntermediateResults

int setUseIntermediateResults(int handle,
                              boolean useIntermediateResults)

Set or unset the intermediate results bit. If true the intermediate results are downloaded from the project.

Parameters:

handle -

streamResults -

See Also:

getNewIntermediateResultFiles(int)

downloadResult

int downloadResult(int handle)

Download result of the project associated with the handle. The result file is downloaded into the download directory. Use getResultFile to retrieve the filename of the downloaded result file.
Do now use downloadResult if streaming mode is set to download in the background.
Example:
ResultManager result = techila.resultManager();
int statuscode = result.downloadResult(handle);

Parameters:

handle -

Returns:

status code

See Also:

downloadResult(int, boolean), setDownloadDir(int, String), getResultFile(int), unzip(int)

downloadResult

int downloadResult(int handle,
                   boolean allowPartial)

Download result of the project associated with the handle.

Parameters:

handle -

allowPartial - allow partial result

Returns:

status code

See Also:

downloadResult(int), setDownloadDir(int, String)

downloadResult

int downloadResult(int handle,
                   boolean allowPartial,
                   boolean stream)

Download result of the project associated with the handle.

Parameters:

handle -

allowPartial - allow partial result

stream - stream the results

Returns:

status code

See Also:

downloadResult(int), setDownloadDir(int, String)

getResultFile

java.lang.String getResultFile(int handle)

Get the project result file.

Parameters:

handle -

Returns:

full path and filename to the downloaded result or null if the result has not yet been downloaded.

See Also:

downloadResult(int)

unzip

int unzip(int handle)

Unzip the project zip file associated with the handle. The files are unzipped into the unzip directory. Use getResultDirectory and/or getResultFiles to get the information.

Parameters:

handle -

Returns:

status code

See Also:

downloadResult(int), getResultFiles(int)

getResultDirectory

java.lang.String getResultDirectory(int handle)

Get the directory where results have been unzipped.

Parameters:

handle -

Returns:

the path to the unzipping directory or null if the project has not yet been unzipped.

See Also:

unzip(int)

getResultFiles

java.lang.String[] getResultFiles(int handle)

Get the unzipped result filenames.

Parameters:

handle -

Returns:

array of Strings or null if no files have been unzipped

See Also:

unzip(int)

getNewStreamedResultFiles

java.lang.String[] getNewStreamedResultFiles(int handle)

Get the new files retrieved in streaming mode. The files will be listed only once each.

Parameters:

handle -

Returns:

array of filenames (with paths) or null

getStreamedResultFiles

java.lang.String[] getStreamedResultFiles(int handle)

Get the files retrieved in streaming mode.

Parameters:

handle -

Returns:

array of filenames (with paths) or null

getNewIntermediateResultFiles

java.lang.String[] getNewIntermediateResultFiles(int handle)

Get the intermediate result files.

Parameters:

handle -

Returns:

array of filenames (with paths) or null

getNewIntermediateResultFilenames

java.lang.String[] getNewIntermediateResultFilenames(int handle)

Get the intermediate result filenames on the server.

Parameters:

handle -

Returns:

array of filenames (with paths) or null

getStreamedResultFileName

java.lang.String getStreamedResultFileName(int handle,
                                           int index)

Get the streamed result file in specific index.

Parameters:

handle -

index - the index of the file

Returns:

name of the file

getStreamedResultFilesCount

int getStreamedResultFilesCount(int handle)

Get the count of streamed result files.

Parameters:

handle -

Returns:

the count of streamed files

getResultFileName

java.lang.String getResultFileName(int handle,
                                   int index)

Get the unzipped result file in specific index.

Parameters:

handle -

index - the index of the file in zip

Returns:

name of the file

See Also:

unzip(int)

getResultFileCount

int getResultFileCount(int handle)

Get the count of unzipped result files.

Parameters:

handle -

Returns:

the count of unzipped files

See Also:

unzip(int)

setDownloadDir

int setDownloadDir(int handle,
                   java.lang.String directory)

Set the download directory for the associated handle.

Parameters:

handle -

directory -

Returns:

status code

setUnzipDir

int setUnzipDir(int handle,
                java.lang.String directory)

Set the unzip directory for the associated handle. When the unzip() is called the files will be generated in to the specified directory.

Parameters:

handle -

directory -

Returns:

status code

setResultFile

int setResultFile(int handle,
                  java.lang.String file)

Set the result file to point somewhere.

Parameters:

handle -

file -

Returns:

status code

getFilesReceived

int getFilesReceived(int handle)

Return the number of files received using stream.

Parameters:

handle -

Returns:

setFilesReceived

int setFilesReceived(int handle,
                     int count)

Do NOT use unless you know what you are doing!

setAllowPartial

int setAllowPartial(int handle,
                    boolean allowPartial)

Set allow partial flag.

Parameters:

handle -

allowPartial -