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