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 Thu Dec 09 12:00:29 GMT 2010 -->\r
   6 <TITLE>\r
   7 MsaWS\r
   8 </TITLE>\r
   9 \r
  10 <META NAME="date" CONTENT="2010-12-09">\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;<A HREF="../../../compbio/data/msa/Metadata.html" title="interface in compbio.data.msa"><B>PREV CLASS</B></A>&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 Superinterfaces:</B> <DD><A HREF="../../../compbio/data/msa/JABAService.html" title="interface in compbio.data.msa">JABAService</A>, <A HREF="../../../compbio/data/msa/JManagement.html" title="interface in compbio.data.msa">JManagement</A>, <A HREF="../../../compbio/data/msa/Metadata.html" title="interface in compbio.data.msa">Metadata</A>&lt;T&gt;</DD>\r
  98 </DL>\r
  99 <HR>\r
 100 <DL>\r
 101 <DT><PRE>public interface <B>MsaWS&lt;T&gt;</B><DT>extends <A HREF="../../../compbio/data/msa/JABAService.html" title="interface in compbio.data.msa">JABAService</A>, <A HREF="../../../compbio/data/msa/JManagement.html" title="interface in compbio.data.msa">JManagement</A>, <A HREF="../../../compbio/data/msa/Metadata.html" title="interface in compbio.data.msa">Metadata</A>&lt;T&gt;</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 November 2010</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;<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
 130 <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
 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;<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
 138 <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
 139             <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
 140 \r
 141 <BR>\r
 142 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Align a list of sequences with options.</TD>\r
 143 </TR>\r
 144 <TR BGCOLOR="white" CLASS="TableRowColor">\r
 145 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
 146 <CODE>&nbsp;<A HREF="../../../compbio/data/sequence/Alignment.html" title="class in compbio.data.sequence">Alignment</A></CODE></FONT></TD>\r
 147 <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
 148 \r
 149 <BR>\r
 150 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Return the result of the job.</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="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
 155 <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
 156             <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
 157 \r
 158 <BR>\r
 159 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Align a list of sequences with preset.</TD>\r
 160 </TR>\r
 161 </TABLE>\r
 162 &nbsp;<A NAME="methods_inherited_from_class_compbio.data.msa.JManagement"><!-- --></A>\r
 163 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">\r
 164 <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">\r
 165 <TH ALIGN="left"><B>Methods inherited from interface compbio.data.msa.<A HREF="../../../compbio/data/msa/JManagement.html" title="interface in compbio.data.msa">JManagement</A></B></TH>\r
 166 </TR>\r
 167 <TR BGCOLOR="white" CLASS="TableRowColor">\r
 168 <TD><CODE><A HREF="../../../compbio/data/msa/JManagement.html#cancelJob(java.lang.String)">cancelJob</A>, <A HREF="../../../compbio/data/msa/JManagement.html#getJobStatus(java.lang.String)">getJobStatus</A>, <A HREF="../../../compbio/data/msa/JManagement.html#pullExecStatistics(java.lang.String, long)">pullExecStatistics</A></CODE></TD>\r
 169 </TR>\r
 170 </TABLE>\r
 171 &nbsp;<A NAME="methods_inherited_from_class_compbio.data.msa.Metadata"><!-- --></A>\r
 172 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">\r
 173 <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">\r
 174 <TH ALIGN="left"><B>Methods inherited from interface compbio.data.msa.<A HREF="../../../compbio/data/msa/Metadata.html" title="interface in compbio.data.msa">Metadata</A></B></TH>\r
 175 </TR>\r
 176 <TR BGCOLOR="white" CLASS="TableRowColor">\r
 177 <TD><CODE><A HREF="../../../compbio/data/msa/Metadata.html#getLimit(java.lang.String)">getLimit</A>, <A HREF="../../../compbio/data/msa/Metadata.html#getLimits()">getLimits</A>, <A HREF="../../../compbio/data/msa/Metadata.html#getPresets()">getPresets</A>, <A HREF="../../../compbio/data/msa/Metadata.html#getRunnerOptions()">getRunnerOptions</A></CODE></TD>\r
 178 </TR>\r
 179 </TABLE>\r
 180 &nbsp;\r
 181 <P>\r
 182 \r
 183 <!-- ============ METHOD DETAIL ========== -->\r
 184 \r
 185 <A NAME="method_detail"><!-- --></A>\r
 186 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">\r
 187 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">\r
 188 <TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">\r
 189 <B>Method Detail</B></FONT></TH>\r
 190 </TR>\r
 191 </TABLE>\r
 192 \r
 193 <A NAME="align(java.util.List)"><!-- --></A><H3>\r
 194 align</H3>\r
 195 <PRE>\r
 196 <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
 197              throws <A HREF="../../../compbio/metadata/UnsupportedRuntimeException.html" title="class in compbio.metadata">UnsupportedRuntimeException</A>,\r
 198                     <A HREF="../../../compbio/metadata/LimitExceededException.html" title="class in compbio.metadata">LimitExceededException</A>,\r
 199                     <A HREF="../../../compbio/metadata/JobSubmissionException.html" title="class in compbio.metadata">JobSubmissionException</A></PRE>\r
 200 <DL>\r
 201 <DD>Align a list of sequences with default settings.
 202
 203  Any dataset containing a greater number of sequences or when the average
 204  length of the sequences are greater then defined in the default Limit,
 205  will not be accepted for an alignment operation and
 206  JobSubmissionException will be thrown.\r
 207 <P>\r
 208 <DD><DL>\r
 209 </DL>\r
 210 </DD>\r
 211 <DD><DL>\r
 212 <DT><B>Parameters:</B><DD><CODE>sequences</CODE> - List of FastaSequence objects. The programme does not perform
 213             any sequence validity checks. Nor does it checks whether the
 214             sequences names are unique. It is responsibility of the caller
 215             to make sure of this\r
 216 <DT><B>Returns:</B><DD>jobId - unique identifier for the job\r
 217 <DT><B>Throws:</B>\r
 218 <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
 219              following reasons: 1) The number of sequences in the
 220              submission or their average length is greater then defined by
 221              the default Limit. 2) Any problems on the server side e.g. it
 222              is misconfigured or malfunction, is reported via this
 223              exception. In the first case the information on the limit
 224              could be obtained from an exception.\r
 225 <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
 226 <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
 227              given web service, e.g. JABAWS is deployed on Windows and
 228              Mafft service is called\r
 229 <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
 230              length exceeds what is defined by the limit</DL>\r
 231 </DD>\r
 232 </DL>\r
 233 <HR>\r
 234 \r
 235 <A NAME="customAlign(java.util.List, java.util.List)"><!-- --></A><H3>\r
 236 customAlign</H3>\r
 237 <PRE>\r
 238 <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
 239                    <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
 240                    throws <A HREF="../../../compbio/metadata/UnsupportedRuntimeException.html" title="class in compbio.metadata">UnsupportedRuntimeException</A>,\r
 241                           <A HREF="../../../compbio/metadata/LimitExceededException.html" title="class in compbio.metadata">LimitExceededException</A>,\r
 242                           <A HREF="../../../compbio/metadata/JobSubmissionException.html" title="class in compbio.metadata">JobSubmissionException</A>,\r
 243                           <A HREF="../../../compbio/metadata/WrongParameterException.html" title="class in compbio.metadata">WrongParameterException</A></PRE>\r
 244 <DL>\r
 245 <DD>Align a list of sequences with options.\r
 246 <P>\r
 247 <DD><DL>\r
 248 </DL>\r
 249 </DD>\r
 250 <DD><DL>\r
 251 <DT><B>Parameters:</B><DD><CODE>sequences</CODE> - List of FastaSequence objects. The programme does not perform
 252             any sequence validity checks. Nor does it checks whether the
 253             sequences names are unique. It is responsibility of the caller
 254             to validate this information<DD><CODE>options</CODE> - A list of Options\r
 255 <DT><B>Returns:</B><DD>jobId - unique identifier for the job\r
 256 <DT><B>Throws:</B>\r
 257 <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
 258              following reasons: 1) The number of sequences in the
 259              submission or their average length is greater then defined by
 260              the default Limit. 2) Any problems on the server side e.g. it
 261              is misconfigured or malfunction, is reported via this
 262              exception. In the first case the information on the limit
 263              could be obtained from an exception.\r
 264 <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
 265              supported, 2) The value of the option is defined outside the
 266              boundaries. In both cases exception object contain the
 267              information on the violating Option.\r
 268 <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
 269 <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
 270              given web service, e.g. JABAWS is deployed on Windows and
 271              Mafft service is called\r
 272 <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
 273              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
 274       permitted or denied</CODE></A></DL>\r
 275 </DD>\r
 276 </DL>\r
 277 <HR>\r
 278 \r
 279 <A NAME="presetAlign(java.util.List, compbio.metadata.Preset)"><!-- --></A><H3>\r
 280 presetAlign</H3>\r
 281 <PRE>\r
 282 <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
 283                    <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
 284                    throws <A HREF="../../../compbio/metadata/UnsupportedRuntimeException.html" title="class in compbio.metadata">UnsupportedRuntimeException</A>,\r
 285                           <A HREF="../../../compbio/metadata/LimitExceededException.html" title="class in compbio.metadata">LimitExceededException</A>,\r
 286                           <A HREF="../../../compbio/metadata/JobSubmissionException.html" title="class in compbio.metadata">JobSubmissionException</A>,\r
 287                           <A HREF="../../../compbio/metadata/WrongParameterException.html" title="class in compbio.metadata">WrongParameterException</A></PRE>\r
 288 <DL>\r
 289 <DD>Align a list of sequences with preset.
 290
 291  Limit for a presetName is used whether the calculation will be permitted
 292  or denied. If no Limit was defined for a presetName, than default limit
 293  is used.\r
 294 <P>\r
 295 <DD><DL>\r
 296 </DL>\r
 297 </DD>\r
 298 <DD><DL>\r
 299 <DT><B>Parameters:</B><DD><CODE>sequences</CODE> - List of FastaSequence objects. The programme does not perform
 300             any sequence validity checks. Nor does it checks whether the
 301             sequences names are unique. It is responsibility of the caller
 302             to validate this information<DD><CODE>preset</CODE> - A list of Options\r
 303 <DT><B>Returns:</B><DD>String - jobId - unique identifier for the job\r
 304 <DT><B>Throws:</B>\r
 305 <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
 306              following reasons: 1) The number of sequences in the
 307              submission or their average length is greater then defined by
 308              the default Limit. 2) Any problems on the server side e.g. it
 309              is misconfigured or malfunction, is reported via this
 310              exception. In the first case the information on the limit
 311              could be obtained from an exception.\r
 312 <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
 313              supported, 2) The value of the option is defined outside the
 314              boundaries. In both cases exception object contain the
 315              information on the violating Option.\r
 316 <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
 317 <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
 318              given web service, e.g. JABAWS is deployed on Windows and
 319              Mafft service is called\r
 320 <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
 321              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
 322 </DD>\r
 323 </DL>\r
 324 <HR>\r
 325 \r
 326 <A NAME="getResult(java.lang.String)"><!-- --></A><H3>\r
 327 getResult</H3>\r
 328 <PRE>\r
 329 <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
 330                     throws <A HREF="../../../compbio/metadata/ResultNotAvailableException.html" title="class in compbio.metadata">ResultNotAvailableException</A></PRE>\r
 331 <DL>\r
 332 <DD>Return the result of the job. This method waits for the job
 333  <code>jobId</code> to complete before return.\r
 334 <P>\r
 335 <DD><DL>\r
 336 </DL>\r
 337 </DD>\r
 338 <DD><DL>\r
 339 <DT><B>Parameters:</B><DD><CODE>jobId</CODE> - a unique job identifier\r
 340 <DT><B>Returns:</B><DD>Alignment\r
 341 <DT><B>Throws:</B>\r
 342 <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
 343              successful or the result of the execution could not be found.
 344              (e.g. removed). Exception could also be thrown due to the
 345              lower level problems on the server i.e. IOException,
 346              FileNotFoundException problems as well as
 347              UnknownFileFormatException.\r
 348 <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
 349              format</DL>\r
 350 </DD>\r
 351 </DL>\r
 352 <!-- ========= END OF CLASS DATA ========= -->\r
 353 <HR>\r
 354 \r
 355 \r
 356 <!-- ======= START OF BOTTOM NAVBAR ====== -->\r
 357 <A NAME="navbar_bottom"><!-- --></A>\r
 358 <A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>\r
 359 <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">\r
 360 <TR>\r
 361 <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">\r
 362 <A NAME="navbar_bottom_firstrow"><!-- --></A>\r
 363 <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">\r
 364   <TR ALIGN="center" VALIGN="top">\r
 365   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>\r
 366   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>\r
 367   <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>\r
 368   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="class-use/MsaWS.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>\r
 369   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>\r
 370   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>\r
 371   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../index-files/index-1.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>\r
 372   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>\r
 373   </TR>\r
 374 </TABLE>\r
 375 </TD>\r
 376 <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>\r
 377 </EM>\r
 378 </TD>\r
 379 </TR>\r
 380 \r
 381 <TR>\r
 382 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">\r
 383 &nbsp;<A HREF="../../../compbio/data/msa/Metadata.html" title="interface in compbio.data.msa"><B>PREV CLASS</B></A>&nbsp;\r
 384 &nbsp;NEXT CLASS</FONT></TD>\r
 385 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">\r
 386   <A HREF="../../../index.html?compbio/data/msa/MsaWS.html" target="_top"><B>FRAMES</B></A>  &nbsp;\r
 387 &nbsp;<A HREF="MsaWS.html" target="_top"><B>NO FRAMES</B></A>  &nbsp;\r
 388 &nbsp;<SCRIPT type="text/javascript">\r
 389   <!--\r
 390   if(window==top) {\r
 391     document.writeln('<A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A>');\r
 392   }\r
 393   //-->\r
 394 </SCRIPT>\r
 395 <NOSCRIPT>\r
 396   <A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A>\r
 397 </NOSCRIPT>\r
 398 \r
 399 \r
 400 </FONT></TD>\r
 401 </TR>\r
 402 <TR>\r
 403 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">\r
 404   SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>\r
 405 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">\r
 406 DETAIL:&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>\r
 407 </TR>\r
 408 </TABLE>\r
 409 <A NAME="skip-navbar_bottom"></A>\r
 410 <!-- ======== END OF BOTTOM NAVBAR ======= -->\r
 411 \r
 412 <HR>\r
 413 \r
 414 </BODY>\r
 415 </HTML>\r