website/full_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 17 16:46:50 GMT 2010 -->\r
   6 <TITLE>\r
   7 MsaWS\r
   8 </TITLE>\r
   9 \r
  10 <META NAME="date" CONTENT="2010-02-17">\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 / web service 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\r
 112  \r
 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#getLimit(java.lang.String)">getLimit</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/LimitsManager.html" title="class in compbio.metadata">LimitsManager</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#getLimits()">getLimits</A></B>()</CODE>\r
 172 \r
 173 <BR>\r
 174 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;List Limits 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/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
 179 <TD><CODE><B><A HREF="../../../compbio/data/msa/MsaWS.html#getPresets()">getPresets</A></B>()</CODE>\r
 180 \r
 181 <BR>\r
 182 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Get presets supported by a web service</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/data/sequence/Alignment.html" title="class in compbio.data.sequence">Alignment</A></CODE></FONT></TD>\r
 187 <TD><CODE><B><A HREF="../../../compbio/data/msa/MsaWS.html#getResult(java.lang.String)">getResult</A></B>(java.lang.String&nbsp;jobId)</CODE>\r
 188 \r
 189 <BR>\r
 190 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Return the result of the job.</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;<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
 195 <TD><CODE><B><A HREF="../../../compbio/data/msa/MsaWS.html#getRunnerOptions()">getRunnerOptions</A></B>()</CODE>\r
 196 \r
 197 <BR>\r
 198 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Get options supported by a web service</TD>\r
 199 </TR>\r
 200 <TR BGCOLOR="white" CLASS="TableRowColor">\r
 201 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
 202 <CODE>&nbsp;java.lang.String</CODE></FONT></TD>\r
 203 <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
 204             <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
 205 \r
 206 <BR>\r
 207 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Align a list of sequences with preset.</TD>\r
 208 </TR>\r
 209 <TR BGCOLOR="white" CLASS="TableRowColor">\r
 210 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
 211 <CODE>&nbsp;<A HREF="../../../compbio/metadata/ChunkHolder.html" title="class in compbio.metadata">ChunkHolder</A></CODE></FONT></TD>\r
 212 <TD><CODE><B><A HREF="../../../compbio/data/msa/MsaWS.html#pullExecStatistics(java.lang.String, long)">pullExecStatistics</A></B>(java.lang.String&nbsp;jobId,\r
 213                    long&nbsp;position)</CODE>\r
 214 \r
 215 <BR>\r
 216 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Reads 1kb chunk from the statistics file which is specific to a given web\r
 217  service from the position.</TD>\r
 218 </TR>\r
 219 </TABLE>\r
 220 &nbsp;\r
 221 <P>\r
 222 \r
 223 <!-- ============ METHOD DETAIL ========== -->\r
 224 \r
 225 <A NAME="method_detail"><!-- --></A>\r
 226 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">\r
 227 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">\r
 228 <TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">\r
 229 <B>Method Detail</B></FONT></TH>\r
 230 </TR>\r
 231 </TABLE>\r
 232 \r
 233 <A NAME="align(java.util.List)"><!-- --></A><H3>\r
 234 align</H3>\r
 235 <PRE>\r
 236 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
 237                        throws <A HREF="../../../compbio/metadata/UnsupportedRuntimeException.html" title="class in compbio.metadata">UnsupportedRuntimeException</A>,\r
 238                               <A HREF="../../../compbio/metadata/LimitExceededException.html" title="class in compbio.metadata">LimitExceededException</A>,\r
 239                               <A HREF="../../../compbio/metadata/JobSubmissionException.html" title="class in compbio.metadata">JobSubmissionException</A></PRE>\r
 240 <DL>\r
 241 <DD>Align a list of sequences with default settings.\r
 242  \r
 243  Any dataset containing a greater number of sequences or the average\r
 244  length of the sequences are greater then defined in the default Limit\r
 245  will not be accepted for an alignment operation and\r
 246  JobSubmissionException will be thrown.\r
 247 <P>\r
 248 <DD><DL>\r
 249 <DT><B>Parameters:</B><DD><CODE>sequences</CODE> - List of FastaSequence objects. The programme does not perform\r
 250             any sequence validity checks. Nor does it checks whether the\r
 251             sequences names are unique. It is responsibility of the caller\r
 252             to validate this information\r
 253 <DT><B>Returns:</B><DD>jobId - unique identifier for the job\r
 254 <DT><B>Throws:</B>\r
 255 <DD><CODE>JobSubmissionException.</CODE> - This\r
 256              exception is thrown when the job could not be submitted due\r
 257              to the following reasons: 1) The number of sequences in the\r
 258              submission or their average length is greater then defined by\r
 259              the default Limit. 2) Any problems on the server side e.g. it\r
 260              is misconfigured or malfunction, is reported via this\r
 261              exception. In the first case the information on the limit\r
 262              could be obtained from an exception.\r
 263 <DD><CODE>java.security.InvalidParameterException</CODE> - thrown if input list of fasta sequence is null or empty\r
 264 <DD><CODE><A HREF="../../../compbio/metadata/UnsupportedRuntimeException.html" title="class in compbio.metadata">UnsupportedRuntimeException</A></CODE> - thrown if server OS does not support native executables for a\r
 265              given web service, e.g. JABAWS is deployed on Windows and Mafft\r
 266              service is called\r
 267 <DD><CODE><A HREF="../../../compbio/metadata/LimitExceededException.html" title="class in compbio.metadata">LimitExceededException</A></CODE> - is throw if the input sequences number or average length\r
 268              exceeds what is defined by the limit\r
 269 <DD><CODE><A HREF="../../../compbio/metadata/JobSubmissionException.html" title="class in compbio.metadata">JobSubmissionException</A></CODE></DL>\r
 270 </DD>\r
 271 </DL>\r
 272 <HR>\r
 273 \r
 274 <A NAME="customAlign(java.util.List, java.util.List)"><!-- --></A><H3>\r
 275 customAlign</H3>\r
 276 <PRE>\r
 277 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
 278                              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
 279                              throws <A HREF="../../../compbio/metadata/UnsupportedRuntimeException.html" title="class in compbio.metadata">UnsupportedRuntimeException</A>,\r
 280                                     <A HREF="../../../compbio/metadata/LimitExceededException.html" title="class in compbio.metadata">LimitExceededException</A>,\r
 281                                     <A HREF="../../../compbio/metadata/JobSubmissionException.html" title="class in compbio.metadata">JobSubmissionException</A>,\r
 282                                     <A HREF="../../../compbio/metadata/WrongParameterException.html" title="class in compbio.metadata">WrongParameterException</A></PRE>\r
 283 <DL>\r
 284 <DD>Align a list of sequences with options.\r
 285 <P>\r
 286 <DD><DL>\r
 287 <DT><B>Parameters:</B><DD><CODE>sequences</CODE> - List of FastaSequence objects. The programme does not perform\r
 288             any sequence validity checks. Nor does it checks whether the\r
 289             sequences names are unique. It is responsibility of the caller\r
 290             to validate this information<DD><CODE>options</CODE> - A list of Options\r
 291 <DT><B>Returns:</B><DD>jobId - unique identifier for the job\r
 292 <DT><B>Throws:</B>\r
 293 <DD><CODE>JobSubmissionException.</CODE> - This\r
 294              exception is thrown when the job could not be submitted due\r
 295              to the following reasons: 1) The number of sequences in the\r
 296              submission or their average length is greater then defined by\r
 297              the default Limit. 2) Any problems on the server side e.g. it\r
 298              is misconfigured or malfunction, is reported via this\r
 299              exception. In the first case the information on the limit\r
 300              could be obtained from an exception.\r
 301 <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\r
 302              supported, 2) The value of the option is defined outside the\r
 303              boundaries. In both cases exception object contain the\r
 304              information on the violating Option.\r
 305 <DD><CODE>java.security.InvalidParameterException</CODE> - thrown if input list of fasta sequence is null or empty\r
 306 <DD><CODE><A HREF="../../../compbio/metadata/UnsupportedRuntimeException.html" title="class in compbio.metadata">UnsupportedRuntimeException</A></CODE> - thrown if server OS does not support native executables for a\r
 307              given web service, e.g. JABAWS is deployed on Windows and Mafft\r
 308              service is called\r
 309 <DD><CODE><A HREF="../../../compbio/metadata/LimitExceededException.html" title="class in compbio.metadata">LimitExceededException</A></CODE> - is throw if the input sequences number or average length\r
 310              exceeds what is defined by the limit\r
 311 <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\r
 312       permitted or denied</CODE></A></DL>\r
 313 </DD>\r
 314 </DL>\r
 315 <HR>\r
 316 \r
 317 <A NAME="presetAlign(java.util.List, compbio.metadata.Preset)"><!-- --></A><H3>\r
 318 presetAlign</H3>\r
 319 <PRE>\r
 320 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
 321                              <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
 322                              throws <A HREF="../../../compbio/metadata/UnsupportedRuntimeException.html" title="class in compbio.metadata">UnsupportedRuntimeException</A>,\r
 323                                     <A HREF="../../../compbio/metadata/LimitExceededException.html" title="class in compbio.metadata">LimitExceededException</A>,\r
 324                                     <A HREF="../../../compbio/metadata/JobSubmissionException.html" title="class in compbio.metadata">JobSubmissionException</A>,\r
 325                                     <A HREF="../../../compbio/metadata/WrongParameterException.html" title="class in compbio.metadata">WrongParameterException</A></PRE>\r
 326 <DL>\r
 327 <DD>Align a list of sequences with preset. @see Preset\r
 328  \r
 329  Limit for a presetName is used whether the calculation will be permitted\r
 330  or denied. If no Limit was defined for a presetName, than default limit\r
 331  is used.\r
 332 <P>\r
 333 <DD><DL>\r
 334 <DT><B>Parameters:</B><DD><CODE>sequences</CODE> - List of FastaSequence objects. The programme does not perform\r
 335             any sequence validity checks. Nor does it checks whether the\r
 336             sequences names are unique. It is responsibility of the caller\r
 337             to validate this information<DD><CODE>preset</CODE> - A list of Options\r
 338 <DT><B>Returns:</B><DD>String - jobId - unique identifier for the job\r
 339 <DT><B>Throws:</B>\r
 340 <DD><CODE>JobSubmissionException.</CODE> - This\r
 341              exception is thrown when the job could not be submitted due\r
 342              to the following reasons: 1) The number of sequences in the\r
 343              submission or their average length is greater then defined by\r
 344              the default Limit. 2) Any problems on the server side e.g. it\r
 345              is misconfigured or malfunction, is reported via this\r
 346              exception. In the first case the information on the limit\r
 347              could be obtained from an exception.\r
 348 <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\r
 349              supported, 2) The value of the option is defined outside the\r
 350              boundaries. In both cases exception object contain the\r
 351              information on the violating Option.\r
 352 <DD><CODE>java.security.InvalidParameterException</CODE> - thrown if input list of fasta sequence is null or empty\r
 353 <DD><CODE><A HREF="../../../compbio/metadata/UnsupportedRuntimeException.html" title="class in compbio.metadata">UnsupportedRuntimeException</A></CODE> - thrown if server OS does not support native executables for a\r
 354              given web service, e.g. JABAWS is deployed on Windows and Mafft\r
 355              service is called\r
 356 <DD><CODE><A HREF="../../../compbio/metadata/LimitExceededException.html" title="class in compbio.metadata">LimitExceededException</A></CODE> - is throw if the input sequences number or average length\r
 357              exceeds what is defined by the limit\r
 358 <DD><CODE><A HREF="../../../compbio/metadata/JobSubmissionException.html" title="class in compbio.metadata">JobSubmissionException</A></CODE></DL>\r
 359 </DD>\r
 360 </DL>\r
 361 <HR>\r
 362 \r
 363 <A NAME="getResult(java.lang.String)"><!-- --></A><H3>\r
 364 getResult</H3>\r
 365 <PRE>\r
 366 <A HREF="../../../compbio/data/sequence/Alignment.html" title="class in compbio.data.sequence">Alignment</A> <B>getResult</B>(java.lang.String&nbsp;jobId)\r
 367                     throws <A HREF="../../../compbio/metadata/ResultNotAvailableException.html" title="class in compbio.metadata">ResultNotAvailableException</A></PRE>\r
 368 <DL>\r
 369 <DD>Return the result of the job.\r
 370 <P>\r
 371 <DD><DL>\r
 372 <DT><B>Parameters:</B><DD><CODE>jobId</CODE> - a unique job identifier\r
 373 <DT><B>Returns:</B><DD>Alignment\r
 374 <DT><B>Throws:</B>\r
 375 <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\r
 376              successful or the result of the execution could not be found.\r
 377              (e.g. removed). Exception could also be thrown is dues to the\r
 378              lower level problems on the server i.e. IOException,\r
 379              FileNotFoundException problems as well as\r
 380              UnknownFileFormatException.\r
 381 <DD><CODE>java.security.InvalidParameterException</CODE> - thrown if jobId is empty or cannot be recognised e.g. in\r
 382              invalid format</DL>\r
 383 </DD>\r
 384 </DL>\r
 385 <HR>\r
 386 \r
 387 <A NAME="cancelJob(java.lang.String)"><!-- --></A><H3>\r
 388 cancelJob</H3>\r
 389 <PRE>\r
 390 boolean <B>cancelJob</B>(java.lang.String&nbsp;jobId)</PRE>\r
 391 <DL>\r
 392 <DD>Stop running job but leave its output untouched\r
 393 <P>\r
 394 <DD><DL>\r
 395 \r
 396 <DT><B>Returns:</B><DD>true if job was cancelled successfully, false otherwise\r
 397 <DT><B>Throws:</B>\r
 398 <DD><CODE>java.security.InvalidParameterException</CODE> - thrown if jobId is empty or cannot be recognised e.g. in\r
 399              invalid format</DL>\r
 400 </DD>\r
 401 </DL>\r
 402 <HR>\r
 403 \r
 404 <A NAME="getJobStatus(java.lang.String)"><!-- --></A><H3>\r
 405 getJobStatus</H3>\r
 406 <PRE>\r
 407 <A HREF="../../../compbio/metadata/JobStatus.html" title="enum in compbio.metadata">JobStatus</A> <B>getJobStatus</B>(java.lang.String&nbsp;jobId)</PRE>\r
 408 <DL>\r
 409 <DD>Return the status of the job. @see JobStatus\r
 410 <P>\r
 411 <DD><DL>\r
 412 <DT><B>Parameters:</B><DD><CODE>jobId</CODE> - - unique job identifier\r
 413 <DT><B>Returns:</B><DD>JobStatus - status of the job\r
 414 <DT><B>Throws:</B>\r
 415 <DD><CODE>java.security.InvalidParameterException</CODE> - thrown if jobId is empty or cannot be recognised e.g. in\r
 416              invalid format</DL>\r
 417 </DD>\r
 418 </DL>\r
 419 <HR>\r
 420 \r
 421 <A NAME="pullExecStatistics(java.lang.String, long)"><!-- --></A><H3>\r
 422 pullExecStatistics</H3>\r
 423 <PRE>\r
 424 <A HREF="../../../compbio/metadata/ChunkHolder.html" title="class in compbio.metadata">ChunkHolder</A> <B>pullExecStatistics</B>(java.lang.String&nbsp;jobId,\r
 425                                long&nbsp;position)</PRE>\r
 426 <DL>\r
 427 <DD>Reads 1kb chunk from the statistics file which is specific to a given web\r
 428  service from the position. If in time of a request less then 1kb data is\r
 429  available from the position to the end of the file, then it returns all\r
 430  the data available from the position to the end of the file.\r
 431 <P>\r
 432 <DD><DL>\r
 433 <DT><B>Parameters:</B><DD><CODE>jobId</CODE> - - unique job identifier<DD><CODE>position</CODE> - - next position within the file to read\r
 434 <DT><B>Returns:</B><DD>ChunkHolder - @see ChunkHolder which contains a chuink of data\r
 435          and a next position within the file from which no data has been\r
 436          read\r
 437 <DT><B>Throws:</B>\r
 438 <DD><CODE>java.security.InvalidParameterException</CODE> - thrown if jobId is empty or cannot be recognised e.g. in\r
 439              invalid format and also if the position value is negative</DL>\r
 440 </DD>\r
 441 </DL>\r
 442 <HR>\r
 443 \r
 444 <A NAME="getRunnerOptions()"><!-- --></A><H3>\r
 445 getRunnerOptions</H3>\r
 446 <PRE>\r
 447 <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
 448 <DL>\r
 449 <DD>Get options supported by a web service\r
 450 <P>\r
 451 <DD><DL>\r
 452 \r
 453 <DT><B>Returns:</B><DD>RunnerConfig the list of options and parameters supported by a\r
 454          web service.</DL>\r
 455 </DD>\r
 456 </DL>\r
 457 <HR>\r
 458 \r
 459 <A NAME="getPresets()"><!-- --></A><H3>\r
 460 getPresets</H3>\r
 461 <PRE>\r
 462 <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
 463 <DL>\r
 464 <DD>Get presets supported by a web service\r
 465 <P>\r
 466 <DD><DL>\r
 467 \r
 468 <DT><B>Returns:</B><DD>PresetManager the object contains information about presets\r
 469          supported by a web service</DL>\r
 470 </DD>\r
 471 </DL>\r
 472 <HR>\r
 473 \r
 474 <A NAME="getLimit(java.lang.String)"><!-- --></A><H3>\r
 475 getLimit</H3>\r
 476 <PRE>\r
 477 <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>getLimit</B>(java.lang.String&nbsp;presetName)</PRE>\r
 478 <DL>\r
 479 <DD>Get a Limit for a preset.\r
 480 <P>\r
 481 <DD><DL>\r
 482 <DT><B>Parameters:</B><DD><CODE>presetName</CODE> - the name of the preset. if no name is provided, then the\r
 483             default preset is returned. If no limit for a particular\r
 484             preset is defined then the default preset is returned\r
 485 <DT><B>Returns:</B><DD>Limit</DL>\r
 486 </DD>\r
 487 </DL>\r
 488 <HR>\r
 489 \r
 490 <A NAME="getLimits()"><!-- --></A><H3>\r
 491 getLimits</H3>\r
 492 <PRE>\r
 493 <A HREF="../../../compbio/metadata/LimitsManager.html" title="class in compbio.metadata">LimitsManager</A>&lt;<A HREF="../../../compbio/data/msa/MsaWS.html" title="type parameter in MsaWS">T</A>&gt; <B>getLimits</B>()</PRE>\r
 494 <DL>\r
 495 <DD>List Limits supported by a web service.\r
 496 <P>\r
 497 <DD><DL>\r
 498 <DT><B>Parameters:</B><DD><CODE>presetName</CODE> - the name of the preset. if no name is provided, then the\r
 499             default preset is returned. If no limit for a particular\r
 500             preset is defined then the default preset is returned\r
 501 <DT><B>Returns:</B><DD>LimitManager</DL>\r
 502 </DD>\r
 503 </DL>\r
 504 <!-- ========= END OF CLASS DATA ========= -->\r
 505 <HR>\r
 506 \r
 507 \r
 508 <!-- ======= START OF BOTTOM NAVBAR ====== -->\r
 509 <A NAME="navbar_bottom"><!-- --></A>\r
 510 <A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>\r
 511 <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">\r
 512 <TR>\r
 513 <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">\r
 514 <A NAME="navbar_bottom_firstrow"><!-- --></A>\r
 515 <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">\r
 516   <TR ALIGN="center" VALIGN="top">\r
 517   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>\r
 518   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>\r
 519   <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>\r
 520   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="class-use/MsaWS.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>\r
 521   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>\r
 522   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>\r
 523   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../index-files/index-1.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>\r
 524   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>\r
 525   </TR>\r
 526 </TABLE>\r
 527 </TD>\r
 528 <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>\r
 529 </EM>\r
 530 </TD>\r
 531 </TR>\r
 532 \r
 533 <TR>\r
 534 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">\r
 535 &nbsp;PREV CLASS&nbsp;\r
 536 &nbsp;NEXT CLASS</FONT></TD>\r
 537 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">\r
 538   <A HREF="../../../index.html?compbio/data/msa/MsaWS.html" target="_top"><B>FRAMES</B></A>  &nbsp;\r
 539 &nbsp;<A HREF="MsaWS.html" target="_top"><B>NO FRAMES</B></A>  &nbsp;\r
 540 &nbsp;<SCRIPT type="text/javascript">\r
 541   <!--\r
 542   if(window==top) {\r
 543     document.writeln('<A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A>');\r
 544   }\r
 545   //-->\r
 546 </SCRIPT>\r
 547 <NOSCRIPT>\r
 548   <A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A>\r
 549 </NOSCRIPT>\r
 550 \r
 551 \r
 552 </FONT></TD>\r
 553 </TR>\r
 554 <TR>\r
 555 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">\r
 556   SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>\r
 557 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">\r
 558 DETAIL:&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>\r
 559 </TR>\r
 560 </TABLE>\r
 561 <A NAME="skip-navbar_bottom"></A>\r
 562 <!-- ======== END OF BOTTOM NAVBAR ======= -->\r
 563 \r
 564 <HR>\r
 565 \r
 566 </BODY>\r
 567 </HTML>\r