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