website/dm_javadoc/compbio/data/msa/MsaWS.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_14) on Wed Feb 03 14:32:20 GMT 2010 -->\r
   6 <TITLE>\r
   7 MsaWS\r
   8 </TITLE>\r
   9 \r
  10 <META NAME="date" CONTENT="2010-02-03">\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="MsaWS";\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/MsaWS.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;PREV CLASS&nbsp;\r
  59 &nbsp;NEXT CLASS</FONT></TD>\r
  60 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">\r
  61   <A HREF="../../../index.html?compbio/data/msa/MsaWS.html" target="_top"><B>FRAMES</B></A>  &nbsp;\r
  62 &nbsp;<A HREF="MsaWS.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 MsaWS&lt;T&gt;</H2>\r
  94 <DL>\r
  95 <DT><DT><B>Type Parameters:</B><DD><CODE>T</CODE> - executable type</DL>\r
  96 <DL>\r
  97 <DT><B>All Known Implementing Classes:</B> <DD><A HREF="../../../compbio/ws/server/ClustalWS.html" title="class in compbio.ws.server">ClustalWS</A>, <A HREF="../../../compbio/ws/server/MafftWS.html" title="class in compbio.ws.server">MafftWS</A>, <A HREF="../../../compbio/ws/server/MuscleWS.html" title="class in compbio.ws.server">MuscleWS</A>, <A HREF="../../../compbio/ws/server/ProbconsWS.html" title="class in compbio.ws.server">ProbconsWS</A>, <A HREF="../../../compbio/ws/server/TcoffeeWS.html" title="class in compbio.ws.server">TcoffeeWS</A></DD>\r
  98 </DL>\r
  99 <HR>\r
 100 <DL>\r
 101 <DT><PRE>public interface <B>MsaWS&lt;T&gt;</B></DL>\r
 102 </PRE>\r
 103 \r
 104 <P>\r
 105 Multiple Sequence Alignment (MSA) Web Services Interface\r
 106 <P>\r
 107 \r
 108 <P>\r
 109 <DL>\r
 110 <DT><B>Author:</B></DT>\r
 111   <DD>pvtroshin
 112
 113          Date September 2009</DD>\r
 114 </DL>\r
 115 <HR>\r
 116 \r
 117 <P>\r
 118 \r
 119 <!-- ========== METHOD SUMMARY =========== -->\r
 120 \r
 121 <A NAME="method_summary"><!-- --></A>\r
 122 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">\r
 123 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">\r
 124 <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">\r
 125 <B>Method Summary</B></FONT></TH>\r
 126 </TR>\r
 127 <TR BGCOLOR="white" CLASS="TableRowColor">\r
 128 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
 129 <CODE>&nbsp;java.lang.String</CODE></FONT></TD>\r
 130 <TD><CODE><B><A HREF="../../../compbio/data/msa/MsaWS.html#align(java.util.List)">align</A></B>(java.util.List&lt;<A HREF="../../../compbio/data/sequence/FastaSequence.html" title="class in compbio.data.sequence">FastaSequence</A>&gt;&nbsp;sequences)</CODE>\r
 131 \r
 132 <BR>\r
 133 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Align a list of sequences with default settings.</TD>\r
 134 </TR>\r
 135 <TR BGCOLOR="white" CLASS="TableRowColor">\r
 136 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
 137 <CODE>&nbsp;boolean</CODE></FONT></TD>\r
 138 <TD><CODE><B><A HREF="../../../compbio/data/msa/MsaWS.html#cancelJob(java.lang.String)">cancelJob</A></B>(java.lang.String&nbsp;jobId)</CODE>\r
 139 \r
 140 <BR>\r
 141 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Stop running job but leave its output untouched</TD>\r
 142 </TR>\r
 143 <TR BGCOLOR="white" CLASS="TableRowColor">\r
 144 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
 145 <CODE>&nbsp;java.lang.String</CODE></FONT></TD>\r
 146 <TD><CODE><B><A HREF="../../../compbio/data/msa/MsaWS.html#customAlign(java.util.List, java.util.List)">customAlign</A></B>(java.util.List&lt;<A HREF="../../../compbio/data/sequence/FastaSequence.html" title="class in compbio.data.sequence">FastaSequence</A>&gt;&nbsp;sequences,\r
 147             java.util.List&lt;<A HREF="../../../compbio/metadata/Option.html" title="class in compbio.metadata">Option</A>&lt;<A HREF="../../../compbio/data/msa/MsaWS.html" title="type parameter in MsaWS">T</A>&gt;&gt;&nbsp;options)</CODE>\r
 148 \r
 149 <BR>\r
 150 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Align a list of sequences with options.</TD>\r
 151 </TR>\r
 152 <TR BGCOLOR="white" CLASS="TableRowColor">\r
 153 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
 154 <CODE>&nbsp;<A HREF="../../../compbio/metadata/JobStatus.html" title="enum in compbio.metadata">JobStatus</A></CODE></FONT></TD>\r
 155 <TD><CODE><B><A HREF="../../../compbio/data/msa/MsaWS.html#getJobStatus(java.lang.String)">getJobStatus</A></B>(java.lang.String&nbsp;jobId)</CODE>\r
 156 \r
 157 <BR>\r
 158 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Return the status of the job.</TD>\r
 159 </TR>\r
 160 <TR BGCOLOR="white" CLASS="TableRowColor">\r
 161 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
 162 <CODE>&nbsp;<A HREF="../../../compbio/metadata/Limit.html" title="class in compbio.metadata">Limit</A>&lt;<A HREF="../../../compbio/data/msa/MsaWS.html" title="type parameter in MsaWS">T</A>&gt;</CODE></FONT></TD>\r
 163 <TD><CODE><B><A HREF="../../../compbio/data/msa/MsaWS.html#getLimits(java.lang.String)">getLimits</A></B>(java.lang.String&nbsp;presetName)</CODE>\r
 164 \r
 165 <BR>\r
 166 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Get a Limit for a preset.</TD>\r
 167 </TR>\r
 168 <TR BGCOLOR="white" CLASS="TableRowColor">\r
 169 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
 170 <CODE>&nbsp;<A HREF="../../../compbio/metadata/PresetManager.html" title="class in compbio.metadata">PresetManager</A>&lt;<A HREF="../../../compbio/data/msa/MsaWS.html" title="type parameter in MsaWS">T</A>&gt;</CODE></FONT></TD>\r
 171 <TD><CODE><B><A HREF="../../../compbio/data/msa/MsaWS.html#getPresets()">getPresets</A></B>()</CODE>\r
 172 \r
 173 <BR>\r
 174 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Get presets supported by a web service</TD>\r
 175 </TR>\r
 176 <TR BGCOLOR="white" CLASS="TableRowColor">\r
 177 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
 178 <CODE>&nbsp;<A HREF="../../../compbio/data/sequence/Alignment.html" title="class in compbio.data.sequence">Alignment</A></CODE></FONT></TD>\r
 179 <TD><CODE><B><A HREF="../../../compbio/data/msa/MsaWS.html#getResult(java.lang.String)">getResult</A></B>(java.lang.String&nbsp;jobId)</CODE>\r
 180 \r
 181 <BR>\r
 182 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Return the result of the job.</TD>\r
 183 </TR>\r
 184 <TR BGCOLOR="white" CLASS="TableRowColor">\r
 185 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
 186 <CODE>&nbsp;<A HREF="../../../compbio/metadata/RunnerConfig.html" title="class in compbio.metadata">RunnerConfig</A>&lt;<A HREF="../../../compbio/data/msa/MsaWS.html" title="type parameter in MsaWS">T</A>&gt;</CODE></FONT></TD>\r
 187 <TD><CODE><B><A HREF="../../../compbio/data/msa/MsaWS.html#getRunnerOptions()">getRunnerOptions</A></B>()</CODE>\r
 188 \r
 189 <BR>\r
 190 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Get options supported by a web service</TD>\r
 191 </TR>\r
 192 <TR BGCOLOR="white" CLASS="TableRowColor">\r
 193 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
 194 <CODE>&nbsp;java.lang.String</CODE></FONT></TD>\r
 195 <TD><CODE><B><A HREF="../../../compbio/data/msa/MsaWS.html#presetAlign(java.util.List, compbio.metadata.Preset)">presetAlign</A></B>(java.util.List&lt;<A HREF="../../../compbio/data/sequence/FastaSequence.html" title="class in compbio.data.sequence">FastaSequence</A>&gt;&nbsp;sequences,\r
 196             <A HREF="../../../compbio/metadata/Preset.html" title="class in compbio.metadata">Preset</A>&lt;<A HREF="../../../compbio/data/msa/MsaWS.html" title="type parameter in MsaWS">T</A>&gt;&nbsp;preset)</CODE>\r
 197 \r
 198 <BR>\r
 199 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Align a list of sequences with preset.</TD>\r
 200 </TR>\r
 201 <TR BGCOLOR="white" CLASS="TableRowColor">\r
 202 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
 203 <CODE>&nbsp;<A HREF="../../../compbio/metadata/ChunkHolder.html" title="class in compbio.metadata">ChunkHolder</A></CODE></FONT></TD>\r
 204 <TD><CODE><B><A HREF="../../../compbio/data/msa/MsaWS.html#pullExecStatistics(java.lang.String, long)">pullExecStatistics</A></B>(java.lang.String&nbsp;jobId,\r
 205                    long&nbsp;position)</CODE>\r
 206 \r
 207 <BR>\r
 208 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Reads 1kb chunk from the statistics file which is specific to a given web
 209  service from the position.</TD>\r
 210 </TR>\r
 211 </TABLE>\r
 212 &nbsp;\r
 213 <P>\r
 214 \r
 215 <!-- ============ METHOD DETAIL ========== -->\r
 216 \r
 217 <A NAME="method_detail"><!-- --></A>\r
 218 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">\r
 219 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">\r
 220 <TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">\r
 221 <B>Method Detail</B></FONT></TH>\r
 222 </TR>\r
 223 </TABLE>\r
 224 \r
 225 <A NAME="align(java.util.List)"><!-- --></A><H3>\r
 226 align</H3>\r
 227 <PRE>\r
 228 java.lang.String <B>align</B>(java.util.List&lt;<A HREF="../../../compbio/data/sequence/FastaSequence.html" title="class in compbio.data.sequence">FastaSequence</A>&gt;&nbsp;sequences)\r
 229                        throws <A HREF="../../../compbio/metadata/JobSubmissionException.html" title="class in compbio.metadata">JobSubmissionException</A></PRE>\r
 230 <DL>\r
 231 <DD>Align a list of sequences with default settings.
 232
 233  Any dataset containing a greater number of sequences or the average
 234  length of the sequences are greater then defined in the default Limit
 235  will not be accepted for an alignment operation and
 236  JobSubmissionException will be thrown.\r
 237 <P>\r
 238 <DD><DL>\r
 239 <DT><B>Parameters:</B><DD><CODE>sequences</CODE> - List of FastaSequence objects. The programme does not perform
 240             any sequence validity checks. Nor does it checks whether the
 241             sequences names are unique. It is responsibility of the caller
 242             to validate this information\r
 243 <DT><B>Returns:</B><DD>jobId - unique identifier for the job\r
 244 <DT><B>Throws:</B>\r
 245 <DD><CODE>JobSubmissionException.</CODE> - This
 246              exception is thrown when the job could not be submitted due
 247              to the following reasons: 1) The number of sequences in the
 248              submission or their average length is greater then defined by
 249              the default Limit. 2) Any problems on the server side e.g. it
 250              is misconfigured or malfunction, is reported via this
 251              exception. In the first case the information on the limit
 252              could be obtained from an exception.\r
 253 <DD><CODE>java.security.InvalidParameterException</CODE> - thrown if input list of fasta sequence is null or empty\r
 254 <DD><CODE><A HREF="../../../compbio/metadata/JobSubmissionException.html" title="class in compbio.metadata">JobSubmissionException</A></CODE></DL>\r
 255 </DD>\r
 256 </DL>\r
 257 <HR>\r
 258 \r
 259 <A NAME="customAlign(java.util.List, java.util.List)"><!-- --></A><H3>\r
 260 customAlign</H3>\r
 261 <PRE>\r
 262 java.lang.String <B>customAlign</B>(java.util.List&lt;<A HREF="../../../compbio/data/sequence/FastaSequence.html" title="class in compbio.data.sequence">FastaSequence</A>&gt;&nbsp;sequences,\r
 263                              java.util.List&lt;<A HREF="../../../compbio/metadata/Option.html" title="class in compbio.metadata">Option</A>&lt;<A HREF="../../../compbio/data/msa/MsaWS.html" title="type parameter in MsaWS">T</A>&gt;&gt;&nbsp;options)\r
 264                              throws <A HREF="../../../compbio/metadata/JobSubmissionException.html" title="class in compbio.metadata">JobSubmissionException</A>,\r
 265                                     <A HREF="../../../compbio/metadata/WrongParameterException.html" title="class in compbio.metadata">WrongParameterException</A></PRE>\r
 266 <DL>\r
 267 <DD>Align a list of sequences with options.\r
 268 <P>\r
 269 <DD><DL>\r
 270 <DT><B>Parameters:</B><DD><CODE>sequences</CODE> - List of FastaSequence objects. The programme does not perform
 271             any sequence validity checks. Nor does it checks whether the
 272             sequences names are unique. It is responsibility of the caller
 273             to validate this information<DD><CODE>options</CODE> - A list of Options\r
 274 <DT><B>Returns:</B><DD>jobId - unique identifier for the job\r
 275 <DT><B>Throws:</B>\r
 276 <DD><CODE>JobSubmissionException.</CODE> - This
 277              exception is thrown when the job could not be submitted due
 278              to the following reasons: 1) The number of sequences in the
 279              submission or their average length is greater then defined by
 280              the default Limit. 2) Any problems on the server side e.g. it
 281              is misconfigured or malfunction, is reported via this
 282              exception. In the first case the information on the limit
 283              could be obtained from an exception.\r
 284 <DD><CODE><A HREF="../../../compbio/metadata/WrongParameterException.html" title="class in compbio.metadata">WrongParameterException</A></CODE> - is throws when 1) One of the Options provided is not
 285              supported, 2) The value of the option is defined outside the
 286              boundaries. In both cases exception object contain the
 287              information on the violating Option.\r
 288 <DD><CODE>java.security.InvalidParameterException</CODE> - thrown if input list of fasta sequence is null or empty\r
 289 <DD><CODE><A HREF="../../../compbio/metadata/JobSubmissionException.html" title="class in compbio.metadata">JobSubmissionException</A></CODE><DT><B>See Also:</B><DD><A HREF="../../../compbio/metadata/Option.html" title="class in compbio.metadata"><CODE>Default Limit is used to decide whether the calculation will be
 290       permitted or denied</CODE></A></DL>\r
 291 </DD>\r
 292 </DL>\r
 293 <HR>\r
 294 \r
 295 <A NAME="presetAlign(java.util.List, compbio.metadata.Preset)"><!-- --></A><H3>\r
 296 presetAlign</H3>\r
 297 <PRE>\r
 298 java.lang.String <B>presetAlign</B>(java.util.List&lt;<A HREF="../../../compbio/data/sequence/FastaSequence.html" title="class in compbio.data.sequence">FastaSequence</A>&gt;&nbsp;sequences,\r
 299                              <A HREF="../../../compbio/metadata/Preset.html" title="class in compbio.metadata">Preset</A>&lt;<A HREF="../../../compbio/data/msa/MsaWS.html" title="type parameter in MsaWS">T</A>&gt;&nbsp;preset)\r
 300                              throws <A HREF="../../../compbio/metadata/JobSubmissionException.html" title="class in compbio.metadata">JobSubmissionException</A>,\r
 301                                     <A HREF="../../../compbio/metadata/WrongParameterException.html" title="class in compbio.metadata">WrongParameterException</A></PRE>\r
 302 <DL>\r
 303 <DD>Align a list of sequences with preset. @see Preset
 304
 305  Limit for a presetName is used whether the calculation will be permitted
 306  or denied. If no Limit was defined for a presetName, than default limit
 307  is used.\r
 308 <P>\r
 309 <DD><DL>\r
 310 <DT><B>Parameters:</B><DD><CODE>sequences</CODE> - List of FastaSequence objects. The programme does not perform
 311             any sequence validity checks. Nor does it checks whether the
 312             sequences names are unique. It is responsibility of the caller
 313             to validate this information<DD><CODE>options</CODE> - A list of Options\r
 314 <DT><B>Returns:</B><DD>String - jobId - unique identifier for the job\r
 315 <DT><B>Throws:</B>\r
 316 <DD><CODE>JobSubmissionException.</CODE> - This
 317              exception is thrown when the job could not be submitted due
 318              to the following reasons: 1) The number of sequences in the
 319              submission or their average length is greater then defined by
 320              the default Limit. 2) Any problems on the server side e.g. it
 321              is misconfigured or malfunction, is reported via this
 322              exception. In the first case the information on the limit
 323              could be obtained from an exception.\r
 324 <DD><CODE><A HREF="../../../compbio/metadata/WrongParameterException.html" title="class in compbio.metadata">WrongParameterException</A></CODE> - is throws when 1) One of the Options provided is not
 325              supported, 2) The value of the option is defined outside the
 326              boundaries. In both cases exception object contain the
 327              information on the violating Option.\r
 328 <DD><CODE>java.security.InvalidParameterException</CODE> - thrown if input list of fasta sequence is null or empty\r
 329 <DD><CODE><A HREF="../../../compbio/metadata/JobSubmissionException.html" title="class in compbio.metadata">JobSubmissionException</A></CODE></DL>\r
 330 </DD>\r
 331 </DL>\r
 332 <HR>\r
 333 \r
 334 <A NAME="getResult(java.lang.String)"><!-- --></A><H3>\r
 335 getResult</H3>\r
 336 <PRE>\r
 337 <A HREF="../../../compbio/data/sequence/Alignment.html" title="class in compbio.data.sequence">Alignment</A> <B>getResult</B>(java.lang.String&nbsp;jobId)\r
 338                     throws <A HREF="../../../compbio/metadata/ResultNotAvailableException.html" title="class in compbio.metadata">ResultNotAvailableException</A></PRE>\r
 339 <DL>\r
 340 <DD>Return the result of the job.\r
 341 <P>\r
 342 <DD><DL>\r
 343 <DT><B>Parameters:</B><DD><CODE>jobId</CODE> - a unique job identifier\r
 344 <DT><B>Returns:</B><DD>Alignment\r
 345 <DT><B>Throws:</B>\r
 346 <DD><CODE><A HREF="../../../compbio/metadata/ResultNotAvailableException.html" title="class in compbio.metadata">ResultNotAvailableException</A></CODE> - this exception is throw if the job execution was not
 347              successful or the result of the execution could not be found.
 348              (e.g. removed). Exception could also be thrown is dues to the
 349              lower level problems on the server i.e. IOException,
 350              FileNotFoundException problems as well as
 351              UnknownFileFormatException.\r
 352 <DD><CODE>java.security.InvalidParameterException</CODE> - thrown if jobId is empty or cannot be recognised e.g. in
 353              invalid format</DL>\r
 354 </DD>\r
 355 </DL>\r
 356 <HR>\r
 357 \r
 358 <A NAME="cancelJob(java.lang.String)"><!-- --></A><H3>\r
 359 cancelJob</H3>\r
 360 <PRE>\r
 361 boolean <B>cancelJob</B>(java.lang.String&nbsp;jobId)</PRE>\r
 362 <DL>\r
 363 <DD>Stop running job but leave its output untouched\r
 364 <P>\r
 365 <DD><DL>\r
 366 \r
 367 <DT><B>Returns:</B><DD>true if job was cancelled successfully, false otherwise\r
 368 <DT><B>Throws:</B>\r
 369 <DD><CODE>java.security.InvalidParameterException</CODE> - thrown if jobId is empty or cannot be recognised e.g. in
 370              invalid format</DL>\r
 371 </DD>\r
 372 </DL>\r
 373 <HR>\r
 374 \r
 375 <A NAME="getJobStatus(java.lang.String)"><!-- --></A><H3>\r
 376 getJobStatus</H3>\r
 377 <PRE>\r
 378 <A HREF="../../../compbio/metadata/JobStatus.html" title="enum in compbio.metadata">JobStatus</A> <B>getJobStatus</B>(java.lang.String&nbsp;jobId)</PRE>\r
 379 <DL>\r
 380 <DD>Return the status of the job. @see JobStatus\r
 381 <P>\r
 382 <DD><DL>\r
 383 <DT><B>Parameters:</B><DD><CODE>jobId</CODE> - - unique job identifier\r
 384 <DT><B>Returns:</B><DD>JobStatus - status of the job\r
 385 <DT><B>Throws:</B>\r
 386 <DD><CODE>java.security.InvalidParameterException</CODE> - thrown if jobId is empty or cannot be recognised e.g. in
 387              invalid format</DL>\r
 388 </DD>\r
 389 </DL>\r
 390 <HR>\r
 391 \r
 392 <A NAME="pullExecStatistics(java.lang.String, long)"><!-- --></A><H3>\r
 393 pullExecStatistics</H3>\r
 394 <PRE>\r
 395 <A HREF="../../../compbio/metadata/ChunkHolder.html" title="class in compbio.metadata">ChunkHolder</A> <B>pullExecStatistics</B>(java.lang.String&nbsp;jobId,\r
 396                                long&nbsp;position)</PRE>\r
 397 <DL>\r
 398 <DD>Reads 1kb chunk from the statistics file which is specific to a given web
 399  service from the position. If in time of a request less then 1kb data is
 400  available from the position to the end of the file, then it returns all
 401  the data available from the position to the end of the file.\r
 402 <P>\r
 403 <DD><DL>\r
 404 <DT><B>Parameters:</B><DD><CODE>jobId</CODE> - - unique job identifier<DD><CODE>long</CODE> - position - next position within the file to read\r
 405 <DT><B>Returns:</B><DD>ChunkHolder - @see ChunkHolder which contains a chuink of data
 406          and a next position within the file from which no data has been
 407          read\r
 408 <DT><B>Throws:</B>\r
 409 <DD><CODE>java.security.InvalidParameterException</CODE> - thrown if jobId is empty or cannot be recognised e.g. in
 410              invalid format and also if the position value is negative</DL>\r
 411 </DD>\r
 412 </DL>\r
 413 <HR>\r
 414 \r
 415 <A NAME="getRunnerOptions()"><!-- --></A><H3>\r
 416 getRunnerOptions</H3>\r
 417 <PRE>\r
 418 <A HREF="../../../compbio/metadata/RunnerConfig.html" title="class in compbio.metadata">RunnerConfig</A>&lt;<A HREF="../../../compbio/data/msa/MsaWS.html" title="type parameter in MsaWS">T</A>&gt; <B>getRunnerOptions</B>()</PRE>\r
 419 <DL>\r
 420 <DD>Get options supported by a web service\r
 421 <P>\r
 422 <DD><DL>\r
 423 \r
 424 <DT><B>Returns:</B><DD>RunnerConfig the list of options and parameters supported by a
 425          web service.</DL>\r
 426 </DD>\r
 427 </DL>\r
 428 <HR>\r
 429 \r
 430 <A NAME="getPresets()"><!-- --></A><H3>\r
 431 getPresets</H3>\r
 432 <PRE>\r
 433 <A HREF="../../../compbio/metadata/PresetManager.html" title="class in compbio.metadata">PresetManager</A>&lt;<A HREF="../../../compbio/data/msa/MsaWS.html" title="type parameter in MsaWS">T</A>&gt; <B>getPresets</B>()</PRE>\r
 434 <DL>\r
 435 <DD>Get presets supported by a web service\r
 436 <P>\r
 437 <DD><DL>\r
 438 \r
 439 <DT><B>Returns:</B><DD>PresetManager the object contains information about presets
 440          supported by a web service</DL>\r
 441 </DD>\r
 442 </DL>\r
 443 <HR>\r
 444 \r
 445 <A NAME="getLimits(java.lang.String)"><!-- --></A><H3>\r
 446 getLimits</H3>\r
 447 <PRE>\r
 448 <A HREF="../../../compbio/metadata/Limit.html" title="class in compbio.metadata">Limit</A>&lt;<A HREF="../../../compbio/data/msa/MsaWS.html" title="type parameter in MsaWS">T</A>&gt; <B>getLimits</B>(java.lang.String&nbsp;presetName)</PRE>\r
 449 <DL>\r
 450 <DD>Get a Limit for a preset.\r
 451 <P>\r
 452 <DD><DL>\r
 453 <DT><B>Parameters:</B><DD><CODE>presetName</CODE> - the name of the preset. if no name is provided, then the
 454             default preset is returned. If no limit for a particular
 455             preset is defined then the default preset is returned\r
 456 <DT><B>Returns:</B><DD>Limit</DL>\r
 457 </DD>\r
 458 </DL>\r
 459 <!-- ========= END OF CLASS DATA ========= -->\r
 460 <HR>\r
 461 \r
 462 \r
 463 <!-- ======= START OF BOTTOM NAVBAR ====== -->\r
 464 <A NAME="navbar_bottom"><!-- --></A>\r
 465 <A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>\r
 466 <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">\r
 467 <TR>\r
 468 <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">\r
 469 <A NAME="navbar_bottom_firstrow"><!-- --></A>\r
 470 <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">\r
 471   <TR ALIGN="center" VALIGN="top">\r
 472   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>\r
 473   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>\r
 474   <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>\r
 475   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="class-use/MsaWS.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>\r
 476   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>\r
 477   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>\r
 478   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../index-files/index-1.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>\r
 479   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>\r
 480   </TR>\r
 481 </TABLE>\r
 482 </TD>\r
 483 <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>\r
 484 </EM>\r
 485 </TD>\r
 486 </TR>\r
 487 \r
 488 <TR>\r
 489 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">\r
 490 &nbsp;PREV CLASS&nbsp;\r
 491 &nbsp;NEXT CLASS</FONT></TD>\r
 492 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">\r
 493   <A HREF="../../../index.html?compbio/data/msa/MsaWS.html" target="_top"><B>FRAMES</B></A>  &nbsp;\r
 494 &nbsp;<A HREF="MsaWS.html" target="_top"><B>NO FRAMES</B></A>  &nbsp;\r
 495 &nbsp;<SCRIPT type="text/javascript">\r
 496   <!--\r
 497   if(window==top) {\r
 498     document.writeln('<A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A>');\r
 499   }\r
 500   //-->\r
 501 </SCRIPT>\r
 502 <NOSCRIPT>\r
 503   <A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A>\r
 504 </NOSCRIPT>\r
 505 \r
 506 \r
 507 </FONT></TD>\r
 508 </TR>\r
 509 <TR>\r
 510 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">\r
 511   SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>\r
 512 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">\r
 513 DETAIL:&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>\r
 514 </TR>\r
 515 </TABLE>\r
 516 <A NAME="skip-navbar_bottom"></A>\r
 517 <!-- ======== END OF BOTTOM NAVBAR ======= -->\r
 518 \r
 519 <HR>\r
 520 \r
 521 </BODY>\r
 522 </HTML>\r