website/dm_javadoc/compbio/data/msa/JManagement.html

   1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">\r
   2 <!--NewPage-->\r
   3 <HTML>\r
   4 <HEAD>\r
   5 <!-- Generated by javadoc (build 1.6.0_24) on Fri Aug 12 14:32:03 BST 2011 -->\r
   6 <TITLE>\r
   7 JManagement\r
   8 </TITLE>\r
   9 \r
  10 <META NAME="date" CONTENT="2011-08-12">\r
  11 \r
  12 <LINK REL ="stylesheet" TYPE="text/css" HREF="../../../stylesheet.css" TITLE="Style">\r
  13 \r
  14 <SCRIPT type="text/javascript">\r
  15 function windowTitle()\r
  16 {\r
  17     if (location.href.indexOf('is-external=true') == -1) {\r
  18         parent.document.title="JManagement";\r
  19     }\r
  20 }\r
  21 </SCRIPT>\r
  22 <NOSCRIPT>\r
  23 </NOSCRIPT>\r
  24 \r
  25 </HEAD>\r
  26 \r
  27 <BODY BGCOLOR="white" onload="windowTitle();">\r
  28 <HR>\r
  29 \r
  30 \r
  31 <!-- ========= START OF TOP NAVBAR ======= -->\r
  32 <A NAME="navbar_top"><!-- --></A>\r
  33 <A HREF="#skip-navbar_top" title="Skip navigation links"></A>\r
  34 <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">\r
  35 <TR>\r
  36 <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">\r
  37 <A NAME="navbar_top_firstrow"><!-- --></A>\r
  38 <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">\r
  39   <TR ALIGN="center" VALIGN="top">\r
  40   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>\r
  41   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>\r
  42   <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>\r
  43   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="class-use/JManagement.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>\r
  44   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>\r
  45   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>\r
  46   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../index-files/index-1.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>\r
  47   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>\r
  48   </TR>\r
  49 </TABLE>\r
  50 </TD>\r
  51 <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>\r
  52 </EM>\r
  53 </TD>\r
  54 </TR>\r
  55 \r
  56 <TR>\r
  57 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">\r
  58 &nbsp;<A HREF="../../../compbio/data/msa/JABAService.html" title="interface in compbio.data.msa"><B>PREV CLASS</B></A>&nbsp;\r
  59 &nbsp;<A HREF="../../../compbio/data/msa/Metadata.html" title="interface in compbio.data.msa"><B>NEXT CLASS</B></A></FONT></TD>\r
  60 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">\r
  61   <A HREF="../../../index.html?compbio/data/msa/JManagement.html" target="_top"><B>FRAMES</B></A>  &nbsp;\r
  62 &nbsp;<A HREF="JManagement.html" target="_top"><B>NO FRAMES</B></A>  &nbsp;\r
  63 &nbsp;<SCRIPT type="text/javascript">\r
  64   <!--\r
  65   if(window==top) {\r
  66     document.writeln('<A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A>');\r
  67   }\r
  68   //-->\r
  69 </SCRIPT>\r
  70 <NOSCRIPT>\r
  71   <A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A>\r
  72 </NOSCRIPT>\r
  73 \r
  74 \r
  75 </FONT></TD>\r
  76 </TR>\r
  77 <TR>\r
  78 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">\r
  79   SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>\r
  80 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">\r
  81 DETAIL:&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>\r
  82 </TR>\r
  83 </TABLE>\r
  84 <A NAME="skip-navbar_top"></A>\r
  85 <!-- ========= END OF TOP NAVBAR ========= -->\r
  86 \r
  87 <HR>\r
  88 <!-- ======== START OF CLASS DATA ======== -->\r
  89 <H2>\r
  90 <FONT SIZE="-1">\r
  91 compbio.data.msa</FONT>\r
  92 <BR>\r
  93 Interface JManagement</H2>\r
  94 <DL>\r
  95 <DT><B>All Known Subinterfaces:</B> <DD><A HREF="../../../compbio/data/msa/MsaWS.html" title="interface in compbio.data.msa">MsaWS</A>&lt;T&gt;, <A HREF="../../../compbio/data/msa/SequenceAnnotation.html" title="interface in compbio.data.msa">SequenceAnnotation</A>&lt;T&gt;</DD>\r
  96 </DL>\r
  97 <HR>\r
  98 <DL>\r
  99 <DT><PRE>public interface <B>JManagement</B></DL>\r
 100 </PRE>\r
 101 \r
 102 <P>\r
 103 <HR>\r
 104 \r
 105 <P>\r
 106 \r
 107 <!-- ========== METHOD SUMMARY =========== -->\r
 108 \r
 109 <A NAME="method_summary"><!-- --></A>\r
 110 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">\r
 111 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">\r
 112 <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">\r
 113 <B>Method Summary</B></FONT></TH>\r
 114 </TR>\r
 115 <TR BGCOLOR="white" CLASS="TableRowColor">\r
 116 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
 117 <CODE>&nbsp;boolean</CODE></FONT></TD>\r
 118 <TD><CODE><B><A HREF="../../../compbio/data/msa/JManagement.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>&nbsp;jobId)</CODE>\r
 119 \r
 120 <BR>\r
 121 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Stop running the job <code>jobId</code> but leave its output untouched</TD>\r
 122 </TR>\r
 123 <TR BGCOLOR="white" CLASS="TableRowColor">\r
 124 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
 125 <CODE>&nbsp;<A HREF="../../../compbio/metadata/JobStatus.html" title="enum in compbio.metadata">JobStatus</A></CODE></FONT></TD>\r
 126 <TD><CODE><B><A HREF="../../../compbio/data/msa/JManagement.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>&nbsp;jobId)</CODE>\r
 127 \r
 128 <BR>\r
 129 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Return the status of the job.</TD>\r
 130 </TR>\r
 131 <TR BGCOLOR="white" CLASS="TableRowColor">\r
 132 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
 133 <CODE>&nbsp;<A HREF="../../../compbio/metadata/ChunkHolder.html" title="class in compbio.metadata">ChunkHolder</A></CODE></FONT></TD>\r
 134 <TD><CODE><B><A HREF="../../../compbio/data/msa/JManagement.html#pullExecStatistics(java.lang.String, long)">pullExecStatistics</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>&nbsp;jobId,\r
 135                    long&nbsp;position)</CODE>\r
 136 \r
 137 <BR>\r
 138 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Reads 1kb chunk from the statistics file which is specific to a given web
 139  service from the <code>position</code>.</TD>\r
 140 </TR>\r
 141 </TABLE>\r
 142 &nbsp;\r
 143 <P>\r
 144 \r
 145 <!-- ============ METHOD DETAIL ========== -->\r
 146 \r
 147 <A NAME="method_detail"><!-- --></A>\r
 148 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">\r
 149 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">\r
 150 <TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">\r
 151 <B>Method Detail</B></FONT></TH>\r
 152 </TR>\r
 153 </TABLE>\r
 154 \r
 155 <A NAME="cancelJob(java.lang.String)"><!-- --></A><H3>\r
 156 cancelJob</H3>\r
 157 <PRE>\r
 158 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>&nbsp;jobId)</PRE>\r
 159 <DL>\r
 160 <DD>Stop running the job <code>jobId</code> but leave its output untouched\r
 161 <P>\r
 162 <DD><DL>\r
 163 \r
 164 <DT><B>Returns:</B><DD>true if job was cancelled successfully, false otherwise\r
 165 <DT><B>Throws:</B>\r
 166 <DD><CODE><A HREF="http://java.sun.com/javase/6/docs/api/java/security/InvalidParameterException.html?is-external=true" title="class or interface in java.security">InvalidParameterException</A></CODE> - is thrown if jobId is empty or cannot be recognised e.g. in
 167              invalid format</DL>\r
 168 </DD>\r
 169 </DL>\r
 170 <HR>\r
 171 \r
 172 <A NAME="getJobStatus(java.lang.String)"><!-- --></A><H3>\r
 173 getJobStatus</H3>\r
 174 <PRE>\r
 175 <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>&nbsp;jobId)</PRE>\r
 176 <DL>\r
 177 <DD>Return the status of the job.\r
 178 <P>\r
 179 <DD><DL>\r
 180 <DT><B>Parameters:</B><DD><CODE>jobId</CODE> - - unique job identifier\r
 181 <DT><B>Returns:</B><DD>JobStatus - status of the job\r
 182 <DT><B>Throws:</B>\r
 183 <DD><CODE><A HREF="http://java.sun.com/javase/6/docs/api/java/security/InvalidParameterException.html?is-external=true" title="class or interface in java.security">InvalidParameterException</A></CODE> - is thrown if jobId is empty or cannot be recognised e.g. in
 184              invalid format<DT><B>See Also:</B><DD><A HREF="../../../compbio/metadata/JobStatus.html" title="enum in compbio.metadata"><CODE>JobStatus</CODE></A></DL>\r
 185 </DD>\r
 186 </DL>\r
 187 <HR>\r
 188 \r
 189 <A NAME="pullExecStatistics(java.lang.String, long)"><!-- --></A><H3>\r
 190 pullExecStatistics</H3>\r
 191 <PRE>\r
 192 <A HREF="../../../compbio/metadata/ChunkHolder.html" title="class in compbio.metadata">ChunkHolder</A> <B>pullExecStatistics</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>&nbsp;jobId,\r
 193                                long&nbsp;position)</PRE>\r
 194 <DL>\r
 195 <DD>Reads 1kb chunk from the statistics file which is specific to a given web
 196  service from the <code>position</code>. If in time of a request less then
 197  1kb data is available from the position to the end of the file, then it
 198  returns all the data available from the position to the end of the file.\r
 199 <P>\r
 200 <DD><DL>\r
 201 <DT><B>Parameters:</B><DD><CODE>jobId</CODE> - - unique job identifier<DD><CODE>position</CODE> - - next position within the file to read\r
 202 <DT><B>Returns:</B><DD>ChunkHolder - which contains a chunk of data and a next position
 203          within the file from which no data has been read\r
 204 <DT><B>Throws:</B>\r
 205 <DD><CODE><A HREF="http://java.sun.com/javase/6/docs/api/java/security/InvalidParameterException.html?is-external=true" title="class or interface in java.security">InvalidParameterException</A></CODE> - thrown if jobId is empty or cannot be recognised e.g. in
 206              invalid format and also if the position value is negative<DT><B>See Also:</B><DD><A HREF="../../../compbio/metadata/ChunkHolder.html" title="class in compbio.metadata"><CODE>ChunkHolder</CODE></A></DL>\r
 207 </DD>\r
 208 </DL>\r
 209 <!-- ========= END OF CLASS DATA ========= -->\r
 210 <HR>\r
 211 \r
 212 \r
 213 <!-- ======= START OF BOTTOM NAVBAR ====== -->\r
 214 <A NAME="navbar_bottom"><!-- --></A>\r
 215 <A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>\r
 216 <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">\r
 217 <TR>\r
 218 <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">\r
 219 <A NAME="navbar_bottom_firstrow"><!-- --></A>\r
 220 <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">\r
 221   <TR ALIGN="center" VALIGN="top">\r
 222   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>\r
 223   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>\r
 224   <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>\r
 225   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="class-use/JManagement.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>\r
 226   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>\r
 227   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>\r
 228   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../index-files/index-1.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>\r
 229   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>\r
 230   </TR>\r
 231 </TABLE>\r
 232 </TD>\r
 233 <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>\r
 234 </EM>\r
 235 </TD>\r
 236 </TR>\r
 237 \r
 238 <TR>\r
 239 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">\r
 240 &nbsp;<A HREF="../../../compbio/data/msa/JABAService.html" title="interface in compbio.data.msa"><B>PREV CLASS</B></A>&nbsp;\r
 241 &nbsp;<A HREF="../../../compbio/data/msa/Metadata.html" title="interface in compbio.data.msa"><B>NEXT CLASS</B></A></FONT></TD>\r
 242 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">\r
 243   <A HREF="../../../index.html?compbio/data/msa/JManagement.html" target="_top"><B>FRAMES</B></A>  &nbsp;\r
 244 &nbsp;<A HREF="JManagement.html" target="_top"><B>NO FRAMES</B></A>  &nbsp;\r
 245 &nbsp;<SCRIPT type="text/javascript">\r
 246   <!--\r
 247   if(window==top) {\r
 248     document.writeln('<A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A>');\r
 249   }\r
 250   //-->\r
 251 </SCRIPT>\r
 252 <NOSCRIPT>\r
 253   <A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A>\r
 254 </NOSCRIPT>\r
 255 \r
 256 \r
 257 </FONT></TD>\r
 258 </TR>\r
 259 <TR>\r
 260 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">\r
 261   SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>\r
 262 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">\r
 263 DETAIL:&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>\r
 264 </TR>\r
 265 </TABLE>\r
 266 <A NAME="skip-navbar_bottom"></A>\r
 267 <!-- ======== END OF BOTTOM NAVBAR ======= -->\r
 268 \r
 269 <HR>\r
 270 \r
 271 </BODY>\r
 272 </HTML>\r