website/dm_javadoc/compbio/ws/server/ClustalWS.html

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