09d707247f43f85049949fcc1355020e9cdd0997
[jabaws.git] / website / full_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 17 16:46:50 GMT 2010 -->\r
6 <TITLE>\r
7 ClustalWS\r
8 </TITLE>\r
9 \r
10 <META NAME="date" CONTENT="2010-02-17">\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;<A HREF="../../../compbio/runner/msa/ClustalW.html" title="class in compbio.runner.msa">ClustalW</A>&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;<A HREF="../../../compbio/runner/msa/ClustalW.html" title="class in compbio.runner.msa">ClustalW</A>&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;<A HREF="../../../compbio/runner/msa/ClustalW.html" title="class in compbio.runner.msa">ClustalW</A>&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;<A HREF="../../../compbio/runner/msa/ClustalW.html" title="class in compbio.runner.msa">ClustalW</A>&gt;</CODE></FONT></TD>\r
171 <TD><CODE><B><A HREF="../../../compbio/ws/server/ClustalWS.html#getLimit(java.lang.String)">getLimit</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/LimitsManager.html" title="class in compbio.metadata">LimitsManager</A>&lt;<A HREF="../../../compbio/runner/msa/ClustalW.html" title="class in compbio.runner.msa">ClustalW</A>&gt;</CODE></FONT></TD>\r
179 <TD><CODE><B><A HREF="../../../compbio/ws/server/ClustalWS.html#getLimits()">getLimits</A></B>()</CODE>\r
180 \r
181 <BR>\r
182 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;List Limits 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/metadata/PresetManager.html" title="class in compbio.metadata">PresetManager</A>&lt;<A HREF="../../../compbio/runner/msa/ClustalW.html" title="class in compbio.runner.msa">ClustalW</A>&gt;</CODE></FONT></TD>\r
187 <TD><CODE><B><A HREF="../../../compbio/ws/server/ClustalWS.html#getPresets()">getPresets</A></B>()</CODE>\r
188 \r
189 <BR>\r
190 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Get presets supported by a web service</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/data/sequence/Alignment.html" title="class in compbio.data.sequence">Alignment</A></CODE></FONT></TD>\r
195 <TD><CODE><B><A HREF="../../../compbio/ws/server/ClustalWS.html#getResult(java.lang.String)">getResult</A></B>(java.lang.String&nbsp;jobId)</CODE>\r
196 \r
197 <BR>\r
198 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Return the result of the job.</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;<A HREF="../../../compbio/metadata/RunnerConfig.html" title="class in compbio.metadata">RunnerConfig</A>&lt;<A HREF="../../../compbio/runner/msa/ClustalW.html" title="class in compbio.runner.msa">ClustalW</A>&gt;</CODE></FONT></TD>\r
203 <TD><CODE><B><A HREF="../../../compbio/ws/server/ClustalWS.html#getRunnerOptions()">getRunnerOptions</A></B>()</CODE>\r
204 \r
205 <BR>\r
206 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Get options supported by a web service</TD>\r
207 </TR>\r
208 <TR BGCOLOR="white" CLASS="TableRowColor">\r
209 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
210 <CODE>&nbsp;java.lang.String</CODE></FONT></TD>\r
211 <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
212             <A HREF="../../../compbio/metadata/Preset.html" title="class in compbio.metadata">Preset</A>&lt;<A HREF="../../../compbio/runner/msa/ClustalW.html" title="class in compbio.runner.msa">ClustalW</A>&gt;&nbsp;preset)</CODE>\r
213 \r
214 <BR>\r
215 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Align a list of sequences with preset.</TD>\r
216 </TR>\r
217 <TR BGCOLOR="white" CLASS="TableRowColor">\r
218 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
219 <CODE>&nbsp;<A HREF="../../../compbio/metadata/ChunkHolder.html" title="class in compbio.metadata">ChunkHolder</A></CODE></FONT></TD>\r
220 <TD><CODE><B><A HREF="../../../compbio/ws/server/ClustalWS.html#pullExecStatistics(java.lang.String, long)">pullExecStatistics</A></B>(java.lang.String&nbsp;jobId,\r
221                    long&nbsp;position)</CODE>\r
222 \r
223 <BR>\r
224 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Reads 1kb chunk from the statistics file which is specific to a given web
225  service from the position.</TD>\r
226 </TR>\r
227 </TABLE>\r
228 &nbsp;<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>\r
229 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">\r
230 <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">\r
231 <TH ALIGN="left"><B>Methods inherited from class java.lang.Object</B></TH>\r
232 </TR>\r
233 <TR BGCOLOR="white" CLASS="TableRowColor">\r
234 <TD><CODE>equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</CODE></TD>\r
235 </TR>\r
236 </TABLE>\r
237 &nbsp;\r
238 <P>\r
239 \r
240 <!-- ========= CONSTRUCTOR DETAIL ======== -->\r
241 \r
242 <A NAME="constructor_detail"><!-- --></A>\r
243 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">\r
244 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">\r
245 <TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">\r
246 <B>Constructor Detail</B></FONT></TH>\r
247 </TR>\r
248 </TABLE>\r
249 \r
250 <A NAME="ClustalWS()"><!-- --></A><H3>\r
251 ClustalWS</H3>\r
252 <PRE>\r
253 public <B>ClustalWS</B>()</PRE>\r
254 <DL>\r
255 </DL>\r
256 \r
257 <!-- ============ METHOD DETAIL ========== -->\r
258 \r
259 <A NAME="method_detail"><!-- --></A>\r
260 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">\r
261 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">\r
262 <TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">\r
263 <B>Method Detail</B></FONT></TH>\r
264 </TR>\r
265 </TABLE>\r
266 \r
267 <A NAME="align(java.util.List)"><!-- --></A><H3>\r
268 align</H3>\r
269 <PRE>\r
270 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
271                        throws <A HREF="../../../compbio/metadata/JobSubmissionException.html" title="class in compbio.metadata">JobSubmissionException</A></PRE>\r
272 <DL>\r
273 <DD><B>Description copied from interface: <CODE><A HREF="../../../compbio/data/msa/MsaWS.html#align(java.util.List)">MsaWS</A></CODE></B></DD>\r
274 <DD>Align a list of sequences with default settings.
275  
276  Any dataset containing a greater number of sequences or the average
277  length of the sequences are greater then defined in the default Limit
278  will not be accepted for an alignment operation and
279  JobSubmissionException will be thrown.\r
280 <P>\r
281 <DD><DL>\r
282 <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;<A HREF="../../../compbio/runner/msa/ClustalW.html" title="class in compbio.runner.msa">ClustalW</A>&gt;</CODE></DL>\r
283 </DD>\r
284 <DD><DL>\r
285 <DT><B>Parameters:</B><DD><CODE>sequences</CODE> - List of FastaSequence objects. The programme does not perform
286             any sequence validity checks. Nor does it checks whether the
287             sequences names are unique. It is responsibility of the caller
288             to validate this information\r
289 <DT><B>Returns:</B><DD>jobId - unique identifier for the job\r
290 <DT><B>Throws:</B>\r
291 <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
292              given web service, e.g. JWS2 is deployed on Windows and Mafft
293              service is called\r
294 <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
295              exceeds what is defined by the limit\r
296 <DD><CODE><A HREF="../../../compbio/metadata/JobSubmissionException.html" title="class in compbio.metadata">JobSubmissionException</A></CODE></DL>\r
297 </DD>\r
298 </DL>\r
299 <HR>\r
300 \r
301 <A NAME="presetAlign(java.util.List, compbio.metadata.Preset)"><!-- --></A><H3>\r
302 presetAlign</H3>\r
303 <PRE>\r
304 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
305                                     <A HREF="../../../compbio/metadata/Preset.html" title="class in compbio.metadata">Preset</A>&lt;<A HREF="../../../compbio/runner/msa/ClustalW.html" title="class in compbio.runner.msa">ClustalW</A>&gt;&nbsp;preset)\r
306                              throws <A HREF="../../../compbio/metadata/JobSubmissionException.html" title="class in compbio.metadata">JobSubmissionException</A>,\r
307                                     <A HREF="../../../compbio/metadata/WrongParameterException.html" title="class in compbio.metadata">WrongParameterException</A></PRE>\r
308 <DL>\r
309 <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
310 <DD>Align a list of sequences with preset. @see 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 <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;<A HREF="../../../compbio/runner/msa/ClustalW.html" title="class in compbio.runner.msa">ClustalW</A>&gt;</CODE></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/UnsupportedRuntimeException.html" title="class in compbio.metadata">UnsupportedRuntimeException</A></CODE> - thrown if server OS does not support native executables for a
327              given web service, e.g. JWS2 is deployed on Windows and Mafft
328              service is called\r
329 <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
330              exceeds what is defined by the limit\r
331 <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
332              supported, 2) The value of the option is defined outside the
333              boundaries. In both cases exception object contain the
334              information on the violating Option.\r
335 <DD><CODE><A HREF="../../../compbio/metadata/JobSubmissionException.html" title="class in compbio.metadata">JobSubmissionException</A></CODE></DL>\r
336 </DD>\r
337 </DL>\r
338 <HR>\r
339 \r
340 <A NAME="customAlign(java.util.List, java.util.List)"><!-- --></A><H3>\r
341 customAlign</H3>\r
342 <PRE>\r
343 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
344                                     java.util.List&lt;<A HREF="../../../compbio/metadata/Option.html" title="class in compbio.metadata">Option</A>&lt;<A HREF="../../../compbio/runner/msa/ClustalW.html" title="class in compbio.runner.msa">ClustalW</A>&gt;&gt;&nbsp;options)\r
345                              throws <A HREF="../../../compbio/metadata/JobSubmissionException.html" title="class in compbio.metadata">JobSubmissionException</A>,\r
346                                     <A HREF="../../../compbio/metadata/WrongParameterException.html" title="class in compbio.metadata">WrongParameterException</A></PRE>\r
347 <DL>\r
348 <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
349 <DD>Align a list of sequences with options.\r
350 <P>\r
351 <DD><DL>\r
352 <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;<A HREF="../../../compbio/runner/msa/ClustalW.html" title="class in compbio.runner.msa">ClustalW</A>&gt;</CODE></DL>\r
353 </DD>\r
354 <DD><DL>\r
355 <DT><B>Parameters:</B><DD><CODE>sequences</CODE> - List of FastaSequence objects. The programme does not perform
356             any sequence validity checks. Nor does it checks whether the
357             sequences names are unique. It is responsibility of the caller
358             to validate this information<DD><CODE>options</CODE> - A list of Options\r
359 <DT><B>Returns:</B><DD>jobId - unique identifier for the job\r
360 <DT><B>Throws:</B>\r
361 <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
362              given web service, e.g. JWS2 is deployed on Windows and Mafft
363              service is called\r
364 <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
365              exceeds what is defined by the limit\r
366 <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
367              supported, 2) The value of the option is defined outside the
368              boundaries. In both cases exception object contain the
369              information on the violating Option.\r
370 <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
371       permitted or denied</CODE></A></DL>\r
372 </DD>\r
373 </DL>\r
374 <HR>\r
375 \r
376 <A NAME="getRunnerOptions()"><!-- --></A><H3>\r
377 getRunnerOptions</H3>\r
378 <PRE>\r
379 public <A HREF="../../../compbio/metadata/RunnerConfig.html" title="class in compbio.metadata">RunnerConfig</A>&lt;<A HREF="../../../compbio/runner/msa/ClustalW.html" title="class in compbio.runner.msa">ClustalW</A>&gt; <B>getRunnerOptions</B>()</PRE>\r
380 <DL>\r
381 <DD><B>Description copied from interface: <CODE><A HREF="../../../compbio/data/msa/MsaWS.html#getRunnerOptions()">MsaWS</A></CODE></B></DD>\r
382 <DD>Get options supported by a web service\r
383 <P>\r
384 <DD><DL>\r
385 <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;<A HREF="../../../compbio/runner/msa/ClustalW.html" title="class in compbio.runner.msa">ClustalW</A>&gt;</CODE></DL>\r
386 </DD>\r
387 <DD><DL>\r
388 \r
389 <DT><B>Returns:</B><DD>RunnerConfig the list of options and parameters supported by a
390          web service.</DL>\r
391 </DD>\r
392 </DL>\r
393 <HR>\r
394 \r
395 <A NAME="getResult(java.lang.String)"><!-- --></A><H3>\r
396 getResult</H3>\r
397 <PRE>\r
398 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
399                     throws <A HREF="../../../compbio/metadata/ResultNotAvailableException.html" title="class in compbio.metadata">ResultNotAvailableException</A></PRE>\r
400 <DL>\r
401 <DD><B>Description copied from interface: <CODE><A HREF="../../../compbio/data/msa/MsaWS.html#getResult(java.lang.String)">MsaWS</A></CODE></B></DD>\r
402 <DD>Return the result of the job.\r
403 <P>\r
404 <DD><DL>\r
405 <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;<A HREF="../../../compbio/runner/msa/ClustalW.html" title="class in compbio.runner.msa">ClustalW</A>&gt;</CODE></DL>\r
406 </DD>\r
407 <DD><DL>\r
408 <DT><B>Parameters:</B><DD><CODE>jobId</CODE> - a unique job identifier\r
409 <DT><B>Returns:</B><DD>Alignment\r
410 <DT><B>Throws:</B>\r
411 <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
412              successful or the result of the execution could not be found.
413              (e.g. removed). Exception could also be thrown is dues to the
414              lower level problems on the server i.e. IOException,
415              FileNotFoundException problems as well as
416              UnknownFileFormatException.</DL>\r
417 </DD>\r
418 </DL>\r
419 <HR>\r
420 \r
421 <A NAME="getLimit(java.lang.String)"><!-- --></A><H3>\r
422 getLimit</H3>\r
423 <PRE>\r
424 public <A HREF="../../../compbio/metadata/Limit.html" title="class in compbio.metadata">Limit</A>&lt;<A HREF="../../../compbio/runner/msa/ClustalW.html" title="class in compbio.runner.msa">ClustalW</A>&gt; <B>getLimit</B>(java.lang.String&nbsp;presetName)</PRE>\r
425 <DL>\r
426 <DD><B>Description copied from interface: <CODE><A HREF="../../../compbio/data/msa/MsaWS.html#getLimit(java.lang.String)">MsaWS</A></CODE></B></DD>\r
427 <DD>Get a Limit for a preset.\r
428 <P>\r
429 <DD><DL>\r
430 <DT><B>Specified by:</B><DD><CODE><A HREF="../../../compbio/data/msa/MsaWS.html#getLimit(java.lang.String)">getLimit</A></CODE> in interface <CODE><A HREF="../../../compbio/data/msa/MsaWS.html" title="interface in compbio.data.msa">MsaWS</A>&lt;<A HREF="../../../compbio/runner/msa/ClustalW.html" title="class in compbio.runner.msa">ClustalW</A>&gt;</CODE></DL>\r
431 </DD>\r
432 <DD><DL>\r
433 <DT><B>Parameters:</B><DD><CODE>presetName</CODE> - the name of the preset. if no name is provided, then the
434             default preset is returned. If no limit for a particular
435             preset is defined then the default preset is returned\r
436 <DT><B>Returns:</B><DD>Limit</DL>\r
437 </DD>\r
438 </DL>\r
439 <HR>\r
440 \r
441 <A NAME="getLimits()"><!-- --></A><H3>\r
442 getLimits</H3>\r
443 <PRE>\r
444 public <A HREF="../../../compbio/metadata/LimitsManager.html" title="class in compbio.metadata">LimitsManager</A>&lt;<A HREF="../../../compbio/runner/msa/ClustalW.html" title="class in compbio.runner.msa">ClustalW</A>&gt; <B>getLimits</B>()</PRE>\r
445 <DL>\r
446 <DD><B>Description copied from interface: <CODE><A HREF="../../../compbio/data/msa/MsaWS.html#getLimits()">MsaWS</A></CODE></B></DD>\r
447 <DD>List Limits supported by a web service.\r
448 <P>\r
449 <DD><DL>\r
450 <DT><B>Specified by:</B><DD><CODE><A HREF="../../../compbio/data/msa/MsaWS.html#getLimits()">getLimits</A></CODE> in interface <CODE><A HREF="../../../compbio/data/msa/MsaWS.html" title="interface in compbio.data.msa">MsaWS</A>&lt;<A HREF="../../../compbio/runner/msa/ClustalW.html" title="class in compbio.runner.msa">ClustalW</A>&gt;</CODE></DL>\r
451 </DD>\r
452 <DD><DL>\r
453 \r
454 <DT><B>Returns:</B><DD>LimitManager</DL>\r
455 </DD>\r
456 </DL>\r
457 <HR>\r
458 \r
459 <A NAME="cancelJob(java.lang.String)"><!-- --></A><H3>\r
460 cancelJob</H3>\r
461 <PRE>\r
462 public boolean <B>cancelJob</B>(java.lang.String&nbsp;jobId)</PRE>\r
463 <DL>\r
464 <DD><B>Description copied from interface: <CODE><A HREF="../../../compbio/data/msa/MsaWS.html#cancelJob(java.lang.String)">MsaWS</A></CODE></B></DD>\r
465 <DD>Stop running job but leave its output untouched\r
466 <P>\r
467 <DD><DL>\r
468 <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;<A HREF="../../../compbio/runner/msa/ClustalW.html" title="class in compbio.runner.msa">ClustalW</A>&gt;</CODE></DL>\r
469 </DD>\r
470 <DD><DL>\r
471 \r
472 <DT><B>Returns:</B><DD>true if job was cancelled successfully, false otherwise</DL>\r
473 </DD>\r
474 </DL>\r
475 <HR>\r
476 \r
477 <A NAME="getJobStatus(java.lang.String)"><!-- --></A><H3>\r
478 getJobStatus</H3>\r
479 <PRE>\r
480 public <A HREF="../../../compbio/metadata/JobStatus.html" title="enum in compbio.metadata">JobStatus</A> <B>getJobStatus</B>(java.lang.String&nbsp;jobId)</PRE>\r
481 <DL>\r
482 <DD><B>Description copied from interface: <CODE><A HREF="../../../compbio/data/msa/MsaWS.html#getJobStatus(java.lang.String)">MsaWS</A></CODE></B></DD>\r
483 <DD>Return the status of the job. @see JobStatus\r
484 <P>\r
485 <DD><DL>\r
486 <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;<A HREF="../../../compbio/runner/msa/ClustalW.html" title="class in compbio.runner.msa">ClustalW</A>&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>JobStatus - status of the job</DL>\r
491 </DD>\r
492 </DL>\r
493 <HR>\r
494 \r
495 <A NAME="getPresets()"><!-- --></A><H3>\r
496 getPresets</H3>\r
497 <PRE>\r
498 public <A HREF="../../../compbio/metadata/PresetManager.html" title="class in compbio.metadata">PresetManager</A>&lt;<A HREF="../../../compbio/runner/msa/ClustalW.html" title="class in compbio.runner.msa">ClustalW</A>&gt; <B>getPresets</B>()</PRE>\r
499 <DL>\r
500 <DD><B>Description copied from interface: <CODE><A HREF="../../../compbio/data/msa/MsaWS.html#getPresets()">MsaWS</A></CODE></B></DD>\r
501 <DD>Get presets supported by a web service\r
502 <P>\r
503 <DD><DL>\r
504 <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;<A HREF="../../../compbio/runner/msa/ClustalW.html" title="class in compbio.runner.msa">ClustalW</A>&gt;</CODE></DL>\r
505 </DD>\r
506 <DD><DL>\r
507 \r
508 <DT><B>Returns:</B><DD>PresetManager the object contains information about presets
509          supported by a web service</DL>\r
510 </DD>\r
511 </DL>\r
512 <HR>\r
513 \r
514 <A NAME="pullExecStatistics(java.lang.String, long)"><!-- --></A><H3>\r
515 pullExecStatistics</H3>\r
516 <PRE>\r
517 public <A HREF="../../../compbio/metadata/ChunkHolder.html" title="class in compbio.metadata">ChunkHolder</A> <B>pullExecStatistics</B>(java.lang.String&nbsp;jobId,\r
518                                       long&nbsp;position)</PRE>\r
519 <DL>\r
520 <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
521 <DD>Reads 1kb chunk from the statistics file which is specific to a given web
522  service from the position. If in time of a request less then 1kb data is
523  available from the position to the end of the file, then it returns all
524  the data available from the position to the end of the file.\r
525 <P>\r
526 <DD><DL>\r
527 <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;<A HREF="../../../compbio/runner/msa/ClustalW.html" title="class in compbio.runner.msa">ClustalW</A>&gt;</CODE></DL>\r
528 </DD>\r
529 <DD><DL>\r
530 <DT><B>Parameters:</B><DD><CODE>jobId</CODE> - - unique job identifier<DD><CODE>position</CODE> - - next position within the file to read\r
531 <DT><B>Returns:</B><DD>ChunkHolder - @see ChunkHolder which contains a chuink of data
532          and a next position within the file from which no data has been
533          read</DL>\r
534 </DD>\r
535 </DL>\r
536 <!-- ========= END OF CLASS DATA ========= -->\r
537 <HR>\r
538 \r
539 \r
540 <!-- ======= START OF BOTTOM NAVBAR ====== -->\r
541 <A NAME="navbar_bottom"><!-- --></A>\r
542 <A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>\r
543 <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">\r
544 <TR>\r
545 <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">\r
546 <A NAME="navbar_bottom_firstrow"><!-- --></A>\r
547 <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">\r
548   <TR ALIGN="center" VALIGN="top">\r
549   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>\r
550   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>\r
551   <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>\r
552   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="class-use/ClustalWS.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>\r
553   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>\r
554   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>\r
555   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../index-files/index-1.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>\r
556   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>\r
557   </TR>\r
558 </TABLE>\r
559 </TD>\r
560 <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>\r
561 </EM>\r
562 </TD>\r
563 </TR>\r
564 \r
565 <TR>\r
566 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">\r
567 &nbsp;PREV CLASS&nbsp;\r
568 &nbsp;<A HREF="../../../compbio/ws/server/MafftWS.html" title="class in compbio.ws.server"><B>NEXT CLASS</B></A></FONT></TD>\r
569 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">\r
570   <A HREF="../../../index.html?compbio/ws/server/ClustalWS.html" target="_top"><B>FRAMES</B></A>  &nbsp;\r
571 &nbsp;<A HREF="ClustalWS.html" target="_top"><B>NO FRAMES</B></A>  &nbsp;\r
572 &nbsp;<SCRIPT type="text/javascript">\r
573   <!--\r
574   if(window==top) {\r
575     document.writeln('<A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A>');\r
576   }\r
577   //-->\r
578 </SCRIPT>\r
579 <NOSCRIPT>\r
580   <A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A>\r
581 </NOSCRIPT>\r
582 \r
583 \r
584 </FONT></TD>\r
585 </TR>\r
586 <TR>\r
587 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">\r
588   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
589 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">\r
590 DETAIL:&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>\r
591 </TR>\r
592 </TABLE>\r
593 <A NAME="skip-navbar_bottom"></A>\r
594 <!-- ======== END OF BOTTOM NAVBAR ======= -->\r
595 \r
596 <HR>\r
597 \r
598 </BODY>\r
599 </HTML>\r