compbio.data.msa

Interface JManagement

All Known Subinterfaces:

MsaWS<T>, SequenceAnnotation<T>

All Known Implementing Classes:

AAConWS, ClustalOWS, ClustalWS, DisemblWS, GlobPlotWS, GLprobsWS, IUPredWS, JronnWS, MafftWS, MSAprobsWS, MuscleWS, ProbconsWS, RNAalifoldWS, TcoffeeWS

public interface JManagement

Method Summary

Modifier and Type	Method and Description
boolean	cancelJob(java.lang.String jobId) Stop running the job jobId but leave its output untouched
JobStatus	getJobStatus(java.lang.String jobId) Return the status of the job.
ChunkHolder	pullExecStatistics(java.lang.String jobId, long position) Reads 1kb chunk from the statistics file which is specific to a given web service from the position.

Method Detail

cancelJob

boolean cancelJob(java.lang.String jobId)

Stop running the job jobId but leave its output untouched

Returns:

true if job was cancelled successfully, false otherwise

Throws:

java.security.InvalidParameterException - is thrown if jobId is empty or cannot be recognised e.g. in invalid format

getJobStatus

JobStatus getJobStatus(java.lang.String jobId)

Return the status of the job.

Parameters:

jobId - - unique job identifier

Returns:

JobStatus - status of the job

Throws:

java.security.InvalidParameterException - is thrown if jobId is empty or cannot be recognised e.g. in invalid format

See Also:

JobStatus

pullExecStatistics

ChunkHolder pullExecStatistics(java.lang.String jobId,
                               long position)

Reads 1kb chunk from the statistics file which is specific to a given web service from the position. If in time of a request less then 1kb data is available from the position to the end of the file, then it returns all the data available from the position to the end of the file.

Parameters:

jobId - - unique job identifier

position - - next position within the file to read

Returns:

ChunkHolder - which contains a chunk of data and a next position within the file from which no data has been read

Throws:

java.security.InvalidParameterException - thrown if jobId is empty or cannot be recognised e.g. in invalid format and also if the position value is negative

See Also:

ChunkHolder