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