+++ /dev/null
-<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">\r
-<!--NewPage-->\r
-<HTML>\r
-<HEAD>\r
-<!-- Generated by javadoc (build 1.6.0_24) on Fri Aug 12 14:32:35 BST 2011 -->\r
-<TITLE>\r
-AsyncExecutor\r
-</TITLE>\r
-\r
-<META NAME="date" CONTENT="2011-08-12">\r
-\r
-<LINK REL ="stylesheet" TYPE="text/css" HREF="../../stylesheet.css" TITLE="Style">\r
-\r
-<SCRIPT type="text/javascript">\r
-function windowTitle()\r
-{\r
- if (location.href.indexOf('is-external=true') == -1) {\r
- parent.document.title="AsyncExecutor";\r
- }\r
-}\r
-</SCRIPT>\r
-<NOSCRIPT>\r
-</NOSCRIPT>\r
-\r
-</HEAD>\r
-\r
-<BODY BGCOLOR="white" onload="windowTitle();">\r
-<HR>\r
-\r
-\r
-<!-- ========= START OF TOP NAVBAR ======= -->\r
-<A NAME="navbar_top"><!-- --></A>\r
-<A HREF="#skip-navbar_top" title="Skip navigation links"></A>\r
-<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">\r
-<TR>\r
-<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">\r
-<A NAME="navbar_top_firstrow"><!-- --></A>\r
-<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">\r
- <TR ALIGN="center" VALIGN="top">\r
- <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD>\r
- <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD>\r
- <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD>\r
- <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/AsyncExecutor.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD>\r
- <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>\r
- <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>\r
- <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../index-files/index-1.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>\r
- <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>\r
- </TR>\r
-</TABLE>\r
-</TD>\r
-<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>\r
-</EM>\r
-</TD>\r
-</TR>\r
-\r
-<TR>\r
-<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">\r
- PREV CLASS \r
- <A HREF="../../compbio/engine/Cleaner.html" title="class in compbio.engine"><B>NEXT CLASS</B></A></FONT></TD>\r
-<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">\r
- <A HREF="../../index.html?compbio/engine/AsyncExecutor.html" target="_top"><B>FRAMES</B></A> \r
- <A HREF="AsyncExecutor.html" target="_top"><B>NO FRAMES</B></A> \r
- <SCRIPT type="text/javascript">\r
- <!--\r
- if(window==top) {\r
- document.writeln('<A HREF="../../allclasses-noframe.html"><B>All Classes</B></A>');\r
- }\r
- //-->\r
-</SCRIPT>\r
-<NOSCRIPT>\r
- <A HREF="../../allclasses-noframe.html"><B>All Classes</B></A>\r
-</NOSCRIPT>\r
-\r
-\r
-</FONT></TD>\r
-</TR>\r
-<TR>\r
-<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">\r
- SUMMARY: NESTED | FIELD | CONSTR | <A HREF="#method_summary">METHOD</A></FONT></TD>\r
-<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">\r
-DETAIL: FIELD | CONSTR | <A HREF="#method_detail">METHOD</A></FONT></TD>\r
-</TR>\r
-</TABLE>\r
-<A NAME="skip-navbar_top"></A>\r
-<!-- ========= END OF TOP NAVBAR ========= -->\r
-\r
-<HR>\r
-<!-- ======== START OF CLASS DATA ======== -->\r
-<H2>\r
-<FONT SIZE="-1">\r
-compbio.engine</FONT>\r
-<BR>\r
-Interface AsyncExecutor</H2>\r
-<DL>\r
-<DT><B>All Known Implementing Classes:</B> <DD><A HREF="../../compbio/engine/cluster/drmaa/AsyncJobRunner.html" title="class in compbio.engine.cluster.drmaa">AsyncJobRunner</A>, <A HREF="../../compbio/engine/local/AsyncLocalRunner.html" title="class in compbio.engine.local">AsyncLocalRunner</A></DD>\r
-</DL>\r
-<HR>\r
-<DL>\r
-<DT><PRE>public interface <B>AsyncExecutor</B></DL>\r
-</PRE>\r
-\r
-<P>\r
-An asynchronous executor engine, capable of running, cancelling,
- obtaining results calculated by a native executable wrapper in Executable interface.
- Implementation agnostic. Executables can be run either locally to the JVM or on the cluster.\r
-<P>\r
-\r
-<P>\r
-<DL>\r
-<DT><B>Author:</B></DT>\r
- <DD>pvtroshin
- Date October 2009</DD>\r
-</DL>\r
-<HR>\r
-\r
-<P>\r
-\r
-<!-- ========== METHOD SUMMARY =========== -->\r
-\r
-<A NAME="method_summary"><!-- --></A>\r
-<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">\r
-<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">\r
-<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">\r
-<B>Method Summary</B></FONT></TH>\r
-</TR>\r
-<TR BGCOLOR="white" CLASS="TableRowColor">\r
-<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
-<CODE> boolean</CODE></FONT></TD>\r
-<TD><CODE><B><A HREF="../../compbio/engine/AsyncExecutor.html#cancelJob(java.lang.String)">cancelJob</A></B>(<A HREF="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> jobId)</CODE>\r
-\r
-<BR>\r
- Stop running job.</TD>\r
-</TR>\r
-<TR BGCOLOR="white" CLASS="TableRowColor">\r
-<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
-<CODE> boolean</CODE></FONT></TD>\r
-<TD><CODE><B><A HREF="../../compbio/engine/AsyncExecutor.html#cleanup(java.lang.String)">cleanup</A></B>(<A HREF="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> jobId)</CODE>\r
-\r
-<BR>\r
- Remove all files and a job directory for a jobid.</TD>\r
-</TR>\r
-<TR BGCOLOR="white" CLASS="TableRowColor">\r
-<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
-<CODE> <A HREF="../../compbio/metadata/JobStatus.html" title="enum in compbio.metadata">JobStatus</A></CODE></FONT></TD>\r
-<TD><CODE><B><A HREF="../../compbio/engine/AsyncExecutor.html#getJobStatus(java.lang.String)">getJobStatus</A></B>(<A HREF="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> jobId)</CODE>\r
-\r
-<BR>\r
- Query the status of the job</TD>\r
-</TR>\r
-<TR BGCOLOR="white" CLASS="TableRowColor">\r
-<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
-<CODE> <A HREF="../../compbio/engine/client/ConfiguredExecutable.html" title="interface in compbio.engine.client">ConfiguredExecutable</A><?></CODE></FONT></TD>\r
-<TD><CODE><B><A HREF="../../compbio/engine/AsyncExecutor.html#getResults(java.lang.String)">getResults</A></B>(<A HREF="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> jobId)</CODE>\r
-\r
-<BR>\r
- Retrieve the results of the job.</TD>\r
-</TR>\r
-<TR BGCOLOR="white" CLASS="TableRowColor">\r
-<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
-<CODE> <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A></CODE></FONT></TD>\r
-<TD><CODE><B><A HREF="../../compbio/engine/AsyncExecutor.html#getWorkDirectory(java.lang.String)">getWorkDirectory</A></B>(<A HREF="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> jobId)</CODE>\r
-\r
-<BR>\r
- </TD>\r
-</TR>\r
-<TR BGCOLOR="white" CLASS="TableRowColor">\r
-<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
-<CODE> <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A></CODE></FONT></TD>\r
-<TD><CODE><B><A HREF="../../compbio/engine/AsyncExecutor.html#submitJob(compbio.engine.client.ConfiguredExecutable)">submitJob</A></B>(<A HREF="../../compbio/engine/client/ConfiguredExecutable.html" title="interface in compbio.engine.client">ConfiguredExecutable</A><?> executable)</CODE>\r
-\r
-<BR>\r
- Submits job for the execution
- Immediate execution is not guaranteed, this method puts the job in the queue.</TD>\r
-</TR>\r
-</TABLE>\r
- \r
-<P>\r
-\r
-<!-- ============ METHOD DETAIL ========== -->\r
-\r
-<A NAME="method_detail"><!-- --></A>\r
-<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">\r
-<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">\r
-<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">\r
-<B>Method Detail</B></FONT></TH>\r
-</TR>\r
-</TABLE>\r
-\r
-<A NAME="submitJob(compbio.engine.client.ConfiguredExecutable)"><!-- --></A><H3>\r
-submitJob</H3>\r
-<PRE>\r
-<A HREF="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> <B>submitJob</B>(<A HREF="../../compbio/engine/client/ConfiguredExecutable.html" title="interface in compbio.engine.client">ConfiguredExecutable</A><?> executable)\r
- throws <A HREF="../../compbio/metadata/JobSubmissionException.html" title="class in compbio.metadata">JobSubmissionException</A></PRE>\r
-<DL>\r
-<DD>Submits job for the execution
- Immediate execution is not guaranteed, this method puts the job in the queue.
- All it guarantees that the job will be eventually executed.
- The start of execution will depend on the number of jobs in the queue.\r
-<P>\r
-<DD><DL>\r
-\r
-<DT><B>Returns:</B><DD>unique job identifier\r
-<DT><B>Throws:</B>\r
-<DD><CODE><A HREF="../../compbio/metadata/JobSubmissionException.html" title="class in compbio.metadata">JobSubmissionException</A></CODE> - if submission fails. This usually happens due to the problem on a server side.</DL>\r
-</DD>\r
-</DL>\r
-<HR>\r
-\r
-<A NAME="getResults(java.lang.String)"><!-- --></A><H3>\r
-getResults</H3>\r
-<PRE>\r
-<A HREF="../../compbio/engine/client/ConfiguredExecutable.html" title="interface in compbio.engine.client">ConfiguredExecutable</A><?> <B>getResults</B>(<A HREF="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> jobId)\r
- throws <A HREF="../../compbio/metadata/ResultNotAvailableException.html" title="class in compbio.metadata">ResultNotAvailableException</A></PRE>\r
-<DL>\r
-<DD>Retrieve the results of the job. Please not that current implementations of this method
- blocks if the task is running until the end of the calculation.\r
-<P>\r
-<DD><DL>\r
-<DT><B>Parameters:</B><DD><CODE>jobId</CODE> - job identifier obtained at the job submission\r
-<DT><B>Returns:</B><DD>ConfiguredExecutable object from which result can be obtained\r
-<DT><B>Throws:</B>\r
-<DD><CODE><A HREF="../../compbio/metadata/ResultNotAvailableException.html" title="class in compbio.metadata">ResultNotAvailableException</A></CODE> - if the result is not available for whatever reason.
- Could be due to execution failure, or due to the results being removed from the server at
- the time of request.</DL>\r
-</DD>\r
-</DL>\r
-<HR>\r
-\r
-<A NAME="getWorkDirectory(java.lang.String)"><!-- --></A><H3>\r
-getWorkDirectory</H3>\r
-<PRE>\r
-<A HREF="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> <B>getWorkDirectory</B>(<A HREF="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> jobId)</PRE>\r
-<DL>\r
-<DD><DL>\r
-<DT><B>Parameters:</B><DD><CODE>jobId</CODE> - unique job identifier\r
-<DT><B>Returns:</B><DD>task working directory</DL>\r
-</DD>\r
-</DL>\r
-<HR>\r
-\r
-<A NAME="cleanup(java.lang.String)"><!-- --></A><H3>\r
-cleanup</H3>\r
-<PRE>\r
-boolean <B>cleanup</B>(<A HREF="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> jobId)</PRE>\r
-<DL>\r
-<DD>Remove all files and a job directory for a jobid.\r
-<P>\r
-<DD><DL>\r
-<DT><B>Parameters:</B><DD><CODE>jobId</CODE> - \r
-<DT><B>Returns:</B><DD>true if job directory was successfully removed, false otherwise.</DL>\r
-</DD>\r
-</DL>\r
-<HR>\r
-\r
-<A NAME="cancelJob(java.lang.String)"><!-- --></A><H3>\r
-cancelJob</H3>\r
-<PRE>\r
-boolean <B>cancelJob</B>(<A HREF="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> jobId)</PRE>\r
-<DL>\r
-<DD>Stop running job. Please not that this method does not guarantee to remove the job directory and files in it.\r
-<P>\r
-<DD><DL>\r
-\r
-<DT><B>Returns:</B><DD>true if job was cancelled successfully, false otherwise</DL>\r
-</DD>\r
-</DL>\r
-<HR>\r
-\r
-<A NAME="getJobStatus(java.lang.String)"><!-- --></A><H3>\r
-getJobStatus</H3>\r
-<PRE>\r
-<A HREF="../../compbio/metadata/JobStatus.html" title="enum in compbio.metadata">JobStatus</A> <B>getJobStatus</B>(<A HREF="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> jobId)</PRE>\r
-<DL>\r
-<DD>Query the status of the job\r
-<P>\r
-<DD><DL>\r
-<DT><B>Parameters:</B><DD><CODE>String</CODE> - jobId - unique job identifier\r
-<DT><B>Returns:</B><DD>The JobStatus object representing the status of the job<DT><B>See Also:</B><DD><A HREF="../../compbio/metadata/JobStatus.html" title="enum in compbio.metadata"><CODE>JobStatus</CODE></A></DL>\r
-</DD>\r
-</DL>\r
-<!-- ========= END OF CLASS DATA ========= -->\r
-<HR>\r
-\r
-\r
-<!-- ======= START OF BOTTOM NAVBAR ====== -->\r
-<A NAME="navbar_bottom"><!-- --></A>\r
-<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>\r
-<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">\r
-<TR>\r
-<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">\r
-<A NAME="navbar_bottom_firstrow"><!-- --></A>\r
-<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">\r
- <TR ALIGN="center" VALIGN="top">\r
- <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD>\r
- <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD>\r
- <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD>\r
- <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/AsyncExecutor.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD>\r
- <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>\r
- <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>\r
- <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../index-files/index-1.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>\r
- <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>\r
- </TR>\r
-</TABLE>\r
-</TD>\r
-<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>\r
-</EM>\r
-</TD>\r
-</TR>\r
-\r
-<TR>\r
-<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">\r
- PREV CLASS \r
- <A HREF="../../compbio/engine/Cleaner.html" title="class in compbio.engine"><B>NEXT CLASS</B></A></FONT></TD>\r
-<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">\r
- <A HREF="../../index.html?compbio/engine/AsyncExecutor.html" target="_top"><B>FRAMES</B></A> \r
- <A HREF="AsyncExecutor.html" target="_top"><B>NO FRAMES</B></A> \r
- <SCRIPT type="text/javascript">\r
- <!--\r
- if(window==top) {\r
- document.writeln('<A HREF="../../allclasses-noframe.html"><B>All Classes</B></A>');\r
- }\r
- //-->\r
-</SCRIPT>\r
-<NOSCRIPT>\r
- <A HREF="../../allclasses-noframe.html"><B>All Classes</B></A>\r
-</NOSCRIPT>\r
-\r
-\r
-</FONT></TD>\r
-</TR>\r
-<TR>\r
-<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">\r
- SUMMARY: NESTED | FIELD | CONSTR | <A HREF="#method_summary">METHOD</A></FONT></TD>\r
-<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">\r
-DETAIL: FIELD | CONSTR | <A HREF="#method_detail">METHOD</A></FONT></TD>\r
-</TR>\r
-</TABLE>\r
-<A NAME="skip-navbar_bottom"></A>\r
-<!-- ======== END OF BOTTOM NAVBAR ======= -->\r
-\r
-<HR>\r
-\r
-</BODY>\r
-</HTML>\r
git://source.jalview.org / jabaws.git / blobdiff