1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
5 <!-- Generated by javadoc (1.8.0_121) on Fri Apr 21 15:32:50 BST 2017 -->
7 <meta name="date" content="2017-04-21">
8 <link rel="stylesheet" type="text/css" href="../../../stylesheet.css" title="Style">
9 <script type="text/javascript" src="../../../script.js"></script>
12 <script type="text/javascript"><!--
14 if (location.href.indexOf('is-external=true') == -1) {
15 parent.document.title="WSUtil";
21 var methods = {"i0":9,"i1":9,"i2":9,"i3":9,"i4":9,"i5":9,"i6":9,"i7":9,"i8":9,"i9":9,"i10":9,"i11":9,"i12":9,"i13":9};
22 var tabs = {65535:["t0","All Methods"],1:["t1","Static Methods"],8:["t4","Concrete Methods"]};
23 var altColor = "altColor";
24 var rowColor = "rowColor";
25 var tableTab = "tableTab";
26 var activeTableTab = "activeTableTab";
29 <div>JavaScript is disabled on your browser.</div>
31 <!-- ========= START OF TOP NAVBAR ======= -->
32 <div class="topNav"><a name="navbar.top">
35 <div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
36 <a name="navbar.top.firstrow">
39 <ul class="navList" title="Navigation">
40 <li><a href="../../../overview-summary.html">Overview</a></li>
41 <li><a href="package-summary.html">Package</a></li>
42 <li class="navBarCell1Rev">Class</li>
43 <li><a href="class-use/WSUtil.html">Use</a></li>
44 <li><a href="package-tree.html">Tree</a></li>
45 <li><a href="../../../deprecated-list.html">Deprecated</a></li>
46 <li><a href="../../../index-files/index-1.html">Index</a></li>
47 <li><a href="../../../help-doc.html">Help</a></li>
52 <li><a href="../../../compbio/ws/server/TcoffeeWS.html" title="class in compbio.ws.server"><span class="typeNameLink">Prev Class</span></a></li>
53 <li>Next Class</li>
56 <li><a href="../../../index.html?compbio/ws/server/WSUtil.html" target="_top">Frames</a></li>
57 <li><a href="WSUtil.html" target="_top">No Frames</a></li>
59 <ul class="navList" id="allclasses_navbar_top">
60 <li><a href="../../../allclasses-noframe.html">All Classes</a></li>
63 <script type="text/javascript"><!--
64 allClassesLink = document.getElementById("allclasses_navbar_top");
66 allClassesLink.style.display = "block";
69 allClassesLink.style.display = "none";
75 <ul class="subNavList">
76 <li>Summary: </li>
77 <li>Nested | </li>
78 <li>Field | </li>
79 <li><a href="#constructor.summary">Constr</a> | </li>
80 <li><a href="#method.summary">Method</a></li>
82 <ul class="subNavList">
83 <li>Detail: </li>
84 <li>Field | </li>
85 <li><a href="#constructor.detail">Constr</a> | </li>
86 <li><a href="#method.detail">Method</a></li>
89 <a name="skip.navbar.top">
92 <!-- ========= END OF TOP NAVBAR ========= -->
93 <!-- ======== START OF CLASS DATA ======== -->
95 <div class="subTitle">compbio.ws.server</div>
96 <h2 title="Class WSUtil" class="title">Class WSUtil</h2>
98 <div class="contentContainer">
99 <ul class="inheritance">
100 <li>java.lang.Object</li>
102 <ul class="inheritance">
103 <li>compbio.ws.server.WSUtil</li>
107 <div class="description">
108 <ul class="blockList">
109 <li class="blockList">
112 <pre>public final class <span class="typeNameLabel">WSUtil</span>
113 extends java.lang.Object</pre>
117 <div class="summary">
118 <ul class="blockList">
119 <li class="blockList">
120 <!-- ======== CONSTRUCTOR SUMMARY ======== -->
121 <ul class="blockList">
122 <li class="blockList"><a name="constructor.summary">
125 <h3>Constructor Summary</h3>
126 <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
127 <caption><span>Constructors</span><span class="tabEnd"> </span></caption>
129 <th class="colOne" scope="col">Constructor and Description</th>
131 <tr class="altColor">
132 <td class="colOne"><code><span class="memberNameLink"><a href="../../../compbio/ws/server/WSUtil.html#WSUtil--">WSUtil</a></span>()</code> </td>
137 <!-- ========== METHOD SUMMARY =========== -->
138 <ul class="blockList">
139 <li class="blockList"><a name="method.summary">
142 <h3>Method Summary</h3>
143 <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
144 <caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t1" class="tableTab"><span><a href="javascript:show(1);">Static Methods</a></span><span class="tabEnd"> </span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd"> </span></span></caption>
146 <th class="colFirst" scope="col">Modifier and Type</th>
147 <th class="colLast" scope="col">Method and Description</th>
149 <tr id="i0" class="altColor">
150 <td class="colFirst"><code>static <T> java.lang.String</code></td>
151 <td class="colLast"><code><span class="memberNameLink"><a href="../../../compbio/ws/server/WSUtil.html#align-java.util.List-compbio.engine.client.ConfiguredExecutable-org.apache.log4j.Logger-java.lang.String-compbio.metadata.Limit-">align</a></span>(java.util.List<<a href="../../../compbio/data/sequence/FastaSequence.html" title="class in compbio.data.sequence">FastaSequence</a>> sequences,
152 <a href="../../../compbio/engine/client/ConfiguredExecutable.html" title="interface in compbio.engine.client">ConfiguredExecutable</a><T> confExec,
153 org.apache.log4j.Logger logger,
154 java.lang.String callingMethod,
155 <a href="../../../compbio/metadata/Limit.html" title="class in compbio.metadata">Limit</a><T> limit)</code> </td>
157 <tr id="i1" class="rowColor">
158 <td class="colFirst"><code>static <T> java.lang.String</code></td>
159 <td class="colLast"><code><span class="memberNameLink"><a href="../../../compbio/ws/server/WSUtil.html#analize-java.util.List-compbio.engine.client.ConfiguredExecutable-org.apache.log4j.Logger-java.lang.String-compbio.metadata.Limit-">analize</a></span>(java.util.List<<a href="../../../compbio/data/sequence/FastaSequence.html" title="class in compbio.data.sequence">FastaSequence</a>> sequences,
160 <a href="../../../compbio/engine/client/ConfiguredExecutable.html" title="interface in compbio.engine.client">ConfiguredExecutable</a><T> confExec,
161 org.apache.log4j.Logger log,
162 java.lang.String method,
163 <a href="../../../compbio/metadata/Limit.html" title="class in compbio.metadata">Limit</a><T> limit)</code> </td>
165 <tr id="i2" class="altColor">
166 <td class="colFirst"><code>static boolean</code></td>
167 <td class="colLast"><code><span class="memberNameLink"><a href="../../../compbio/ws/server/WSUtil.html#cancelJob-java.lang.String-">cancelJob</a></span>(java.lang.String jobId)</code> </td>
169 <tr id="i3" class="rowColor">
170 <td class="colFirst"><code>static <T> java.lang.String</code></td>
171 <td class="colLast"><code><span class="memberNameLink"><a href="../../../compbio/ws/server/WSUtil.html#fold-java.util.List-compbio.engine.client.ConfiguredExecutable-org.apache.log4j.Logger-java.lang.String-compbio.metadata.Limit-">fold</a></span>(java.util.List<<a href="../../../compbio/data/sequence/FastaSequence.html" title="class in compbio.data.sequence">FastaSequence</a>> sequences,
172 <a href="../../../compbio/engine/client/ConfiguredExecutable.html" title="interface in compbio.engine.client">ConfiguredExecutable</a><T> confExec,
173 org.apache.log4j.Logger log,
174 java.lang.String method,
175 <a href="../../../compbio/metadata/Limit.html" title="class in compbio.metadata">Limit</a><T> limit)</code> </td>
177 <tr id="i4" class="altColor">
178 <td class="colFirst"><code>static <T> <a href="../../../compbio/data/sequence/ScoreManager.html" title="class in compbio.data.sequence">ScoreManager</a></code></td>
179 <td class="colLast"><code><span class="memberNameLink"><a href="../../../compbio/ws/server/WSUtil.html#getAnnotation-java.lang.String-org.apache.log4j.Logger-">getAnnotation</a></span>(java.lang.String jobId,
180 org.apache.log4j.Logger log)</code> </td>
182 <tr id="i5" class="rowColor">
183 <td class="colFirst"><code>static <T> java.util.List<java.lang.String></code></td>
184 <td class="colLast"><code><span class="memberNameLink"><a href="../../../compbio/ws/server/WSUtil.html#getCommands-java.util.List-java.lang.String-">getCommands</a></span>(java.util.List<<a href="../../../compbio/metadata/Option.html" title="class in compbio.metadata">Option</a><T>> options,
185 java.lang.String keyValueSeparator)</code> </td>
187 <tr id="i6" class="altColor">
188 <td class="colFirst"><code>static <a href="../../../compbio/engine/AsyncExecutor.html" title="interface in compbio.engine">AsyncExecutor</a></code></td>
189 <td class="colLast"><code><span class="memberNameLink"><a href="../../../compbio/ws/server/WSUtil.html#getEngine-compbio.engine.client.ConfiguredExecutable-">getEngine</a></span>(<a href="../../../compbio/engine/client/ConfiguredExecutable.html" title="interface in compbio.engine.client">ConfiguredExecutable</a><?> confClustal)</code> </td>
191 <tr id="i7" class="rowColor">
192 <td class="colFirst"><code>static <a href="../../../compbio/metadata/JobStatus.html" title="enum in compbio.metadata">JobStatus</a></code></td>
193 <td class="colLast"><code><span class="memberNameLink"><a href="../../../compbio/ws/server/WSUtil.html#getJobStatus-java.lang.String-">getJobStatus</a></span>(java.lang.String jobId)</code> </td>
195 <tr id="i8" class="altColor">
196 <td class="colFirst"><code>static byte</code></td>
197 <td class="colLast"><code><span class="memberNameLink"><a href="../../../compbio/ws/server/WSUtil.html#getProgress-java.lang.String-">getProgress</a></span>(java.lang.String jobId)</code> </td>
199 <tr id="i9" class="rowColor">
200 <td class="colFirst"><code>static <a href="../../../compbio/metadata/ChunkHolder.html" title="class in compbio.metadata">ChunkHolder</a></code></td>
201 <td class="colLast"><code><span class="memberNameLink"><a href="../../../compbio/ws/server/WSUtil.html#pullFile-java.lang.String-long-">pullFile</a></span>(java.lang.String file,
202 long position)</code> </td>
204 <tr id="i10" class="altColor">
205 <td class="colFirst"><code>(package private) static <T> void</code></td>
206 <td class="colLast"><code><span class="memberNameLink"><a href="../../../compbio/ws/server/WSUtil.html#reportUsage-compbio.engine.client.ConfiguredExecutable-org.apache.log4j.Logger-">reportUsage</a></span>(<a href="../../../compbio/engine/client/ConfiguredExecutable.html" title="interface in compbio.engine.client">ConfiguredExecutable</a><T> confExec,
207 org.apache.log4j.Logger logger)</code> </td>
209 <tr id="i11" class="rowColor">
210 <td class="colFirst"><code>static void</code></td>
211 <td class="colLast"><code><span class="memberNameLink"><a href="../../../compbio/ws/server/WSUtil.html#validateAAConInput-java.util.List-">validateAAConInput</a></span>(java.util.List<<a href="../../../compbio/data/sequence/FastaSequence.html" title="class in compbio.data.sequence">FastaSequence</a>> sequences)</code> </td>
213 <tr id="i12" class="altColor">
214 <td class="colFirst"><code>static void</code></td>
215 <td class="colLast"><code><span class="memberNameLink"><a href="../../../compbio/ws/server/WSUtil.html#validateFastaInput-java.util.List-">validateFastaInput</a></span>(java.util.List<<a href="../../../compbio/data/sequence/FastaSequence.html" title="class in compbio.data.sequence">FastaSequence</a>> sequences)</code> </td>
217 <tr id="i13" class="rowColor">
218 <td class="colFirst"><code>static void</code></td>
219 <td class="colLast"><code><span class="memberNameLink"><a href="../../../compbio/ws/server/WSUtil.html#validateJobId-java.lang.String-">validateJobId</a></span>(java.lang.String jobId)</code> </td>
222 <ul class="blockList">
223 <li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
226 <h3>Methods inherited from class java.lang.Object</h3>
227 <code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li>
234 <div class="details">
235 <ul class="blockList">
236 <li class="blockList">
237 <!-- ========= CONSTRUCTOR DETAIL ======== -->
238 <ul class="blockList">
239 <li class="blockList"><a name="constructor.detail">
242 <h3>Constructor Detail</h3>
246 <ul class="blockListLast">
247 <li class="blockList">
249 <pre>public WSUtil()</pre>
254 <!-- ============ METHOD DETAIL ========== -->
255 <ul class="blockList">
256 <li class="blockList"><a name="method.detail">
259 <h3>Method Detail</h3>
260 <a name="validateJobId-java.lang.String-">
263 <ul class="blockList">
264 <li class="blockList">
265 <h4>validateJobId</h4>
266 <pre>public static final void validateJobId(java.lang.String jobId)
267 throws java.security.InvalidParameterException</pre>
269 <dt><span class="throwsLabel">Throws:</span></dt>
270 <dd><code>java.security.InvalidParameterException</code></dd>
274 <a name="validateFastaInput-java.util.List-">
277 <ul class="blockList">
278 <li class="blockList">
279 <h4>validateFastaInput</h4>
280 <pre>public static final void validateFastaInput(java.util.List<<a href="../../../compbio/data/sequence/FastaSequence.html" title="class in compbio.data.sequence">FastaSequence</a>> sequences)
281 throws <a href="../../../compbio/metadata/JobSubmissionException.html" title="class in compbio.metadata">JobSubmissionException</a></pre>
283 <dt><span class="throwsLabel">Throws:</span></dt>
284 <dd><code><a href="../../../compbio/metadata/JobSubmissionException.html" title="class in compbio.metadata">JobSubmissionException</a></code></dd>
288 <a name="getJobStatus-java.lang.String-">
291 <ul class="blockList">
292 <li class="blockList">
293 <h4>getJobStatus</h4>
294 <pre>public static <a href="../../../compbio/metadata/JobStatus.html" title="enum in compbio.metadata">JobStatus</a> getJobStatus(java.lang.String jobId)</pre>
297 <a name="pullFile-java.lang.String-long-">
300 <ul class="blockList">
301 <li class="blockList">
303 <pre>public static <a href="../../../compbio/metadata/ChunkHolder.html" title="class in compbio.metadata">ChunkHolder</a> pullFile(java.lang.String file,
304 long position)</pre>
307 <a name="getProgress-java.lang.String-">
310 <ul class="blockList">
311 <li class="blockList">
313 <pre>public static byte getProgress(java.lang.String jobId)</pre>
316 <a name="getEngine-compbio.engine.client.ConfiguredExecutable-">
319 <ul class="blockList">
320 <li class="blockList">
322 <pre>public static <a href="../../../compbio/engine/AsyncExecutor.html" title="interface in compbio.engine">AsyncExecutor</a> getEngine(<a href="../../../compbio/engine/client/ConfiguredExecutable.html" title="interface in compbio.engine.client">ConfiguredExecutable</a><?> confClustal)</pre>
325 <a name="cancelJob-java.lang.String-">
328 <ul class="blockList">
329 <li class="blockList">
331 <pre>public static boolean cancelJob(java.lang.String jobId)</pre>
334 <a name="align-java.util.List-compbio.engine.client.ConfiguredExecutable-org.apache.log4j.Logger-java.lang.String-compbio.metadata.Limit-">
337 <ul class="blockList">
338 <li class="blockList">
340 <pre>public static <T> java.lang.String align(java.util.List<<a href="../../../compbio/data/sequence/FastaSequence.html" title="class in compbio.data.sequence">FastaSequence</a>> sequences,
341 <a href="../../../compbio/engine/client/ConfiguredExecutable.html" title="interface in compbio.engine.client">ConfiguredExecutable</a><T> confExec,
342 org.apache.log4j.Logger logger,
343 java.lang.String callingMethod,
344 <a href="../../../compbio/metadata/Limit.html" title="class in compbio.metadata">Limit</a><T> limit)
345 throws <a href="../../../compbio/metadata/LimitExceededException.html" title="class in compbio.metadata">LimitExceededException</a>,
346 <a href="../../../compbio/metadata/JobSubmissionException.html" title="class in compbio.metadata">JobSubmissionException</a></pre>
348 <dt><span class="throwsLabel">Throws:</span></dt>
349 <dd><code><a href="../../../compbio/metadata/LimitExceededException.html" title="class in compbio.metadata">LimitExceededException</a></code></dd>
350 <dd><code><a href="../../../compbio/metadata/JobSubmissionException.html" title="class in compbio.metadata">JobSubmissionException</a></code></dd>
354 <a name="reportUsage-compbio.engine.client.ConfiguredExecutable-org.apache.log4j.Logger-">
357 <ul class="blockList">
358 <li class="blockList">
360 <pre>static <T> void reportUsage(<a href="../../../compbio/engine/client/ConfiguredExecutable.html" title="interface in compbio.engine.client">ConfiguredExecutable</a><T> confExec,
361 org.apache.log4j.Logger logger)</pre>
364 <a name="analize-java.util.List-compbio.engine.client.ConfiguredExecutable-org.apache.log4j.Logger-java.lang.String-compbio.metadata.Limit-">
367 <ul class="blockList">
368 <li class="blockList">
370 <pre>public static <T> java.lang.String analize(java.util.List<<a href="../../../compbio/data/sequence/FastaSequence.html" title="class in compbio.data.sequence">FastaSequence</a>> sequences,
371 <a href="../../../compbio/engine/client/ConfiguredExecutable.html" title="interface in compbio.engine.client">ConfiguredExecutable</a><T> confExec,
372 org.apache.log4j.Logger log,
373 java.lang.String method,
374 <a href="../../../compbio/metadata/Limit.html" title="class in compbio.metadata">Limit</a><T> limit)
375 throws <a href="../../../compbio/metadata/JobSubmissionException.html" title="class in compbio.metadata">JobSubmissionException</a></pre>
377 <dt><span class="throwsLabel">Throws:</span></dt>
378 <dd><code><a href="../../../compbio/metadata/JobSubmissionException.html" title="class in compbio.metadata">JobSubmissionException</a></code></dd>
382 <a name="fold-java.util.List-compbio.engine.client.ConfiguredExecutable-org.apache.log4j.Logger-java.lang.String-compbio.metadata.Limit-">
385 <ul class="blockList">
386 <li class="blockList">
388 <pre>public static <T> java.lang.String fold(java.util.List<<a href="../../../compbio/data/sequence/FastaSequence.html" title="class in compbio.data.sequence">FastaSequence</a>> sequences,
389 <a href="../../../compbio/engine/client/ConfiguredExecutable.html" title="interface in compbio.engine.client">ConfiguredExecutable</a><T> confExec,
390 org.apache.log4j.Logger log,
391 java.lang.String method,
392 <a href="../../../compbio/metadata/Limit.html" title="class in compbio.metadata">Limit</a><T> limit)
393 throws <a href="../../../compbio/metadata/JobSubmissionException.html" title="class in compbio.metadata">JobSubmissionException</a></pre>
395 <dt><span class="throwsLabel">Throws:</span></dt>
396 <dd><code><a href="../../../compbio/metadata/JobSubmissionException.html" title="class in compbio.metadata">JobSubmissionException</a></code></dd>
400 <a name="getCommands-java.util.List-java.lang.String-">
403 <ul class="blockList">
404 <li class="blockList">
406 <pre>public static final <T> java.util.List<java.lang.String> getCommands(java.util.List<<a href="../../../compbio/metadata/Option.html" title="class in compbio.metadata">Option</a><T>> options,
407 java.lang.String keyValueSeparator)</pre>
410 <a name="validateAAConInput-java.util.List-">
413 <ul class="blockList">
414 <li class="blockList">
415 <h4>validateAAConInput</h4>
416 <pre>public static void validateAAConInput(java.util.List<<a href="../../../compbio/data/sequence/FastaSequence.html" title="class in compbio.data.sequence">FastaSequence</a>> sequences)
417 throws <a href="../../../compbio/metadata/JobSubmissionException.html" title="class in compbio.metadata">JobSubmissionException</a></pre>
419 <dt><span class="throwsLabel">Throws:</span></dt>
420 <dd><code><a href="../../../compbio/metadata/JobSubmissionException.html" title="class in compbio.metadata">JobSubmissionException</a></code></dd>
424 <a name="getAnnotation-java.lang.String-org.apache.log4j.Logger-">
427 <ul class="blockListLast">
428 <li class="blockList">
429 <h4>getAnnotation</h4>
430 <pre>public static <T> <a href="../../../compbio/data/sequence/ScoreManager.html" title="class in compbio.data.sequence">ScoreManager</a> getAnnotation(java.lang.String jobId,
431 org.apache.log4j.Logger log)
432 throws <a href="../../../compbio/metadata/ResultNotAvailableException.html" title="class in compbio.metadata">ResultNotAvailableException</a></pre>
434 <dt><span class="throwsLabel">Throws:</span></dt>
435 <dd><code><a href="../../../compbio/metadata/ResultNotAvailableException.html" title="class in compbio.metadata">ResultNotAvailableException</a></code></dd>
445 <!-- ========= END OF CLASS DATA ========= -->
446 <!-- ======= START OF BOTTOM NAVBAR ====== -->
447 <div class="bottomNav"><a name="navbar.bottom">
450 <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
451 <a name="navbar.bottom.firstrow">
454 <ul class="navList" title="Navigation">
455 <li><a href="../../../overview-summary.html">Overview</a></li>
456 <li><a href="package-summary.html">Package</a></li>
457 <li class="navBarCell1Rev">Class</li>
458 <li><a href="class-use/WSUtil.html">Use</a></li>
459 <li><a href="package-tree.html">Tree</a></li>
460 <li><a href="../../../deprecated-list.html">Deprecated</a></li>
461 <li><a href="../../../index-files/index-1.html">Index</a></li>
462 <li><a href="../../../help-doc.html">Help</a></li>
467 <li><a href="../../../compbio/ws/server/TcoffeeWS.html" title="class in compbio.ws.server"><span class="typeNameLink">Prev Class</span></a></li>
468 <li>Next Class</li>
471 <li><a href="../../../index.html?compbio/ws/server/WSUtil.html" target="_top">Frames</a></li>
472 <li><a href="WSUtil.html" target="_top">No Frames</a></li>
474 <ul class="navList" id="allclasses_navbar_bottom">
475 <li><a href="../../../allclasses-noframe.html">All Classes</a></li>
478 <script type="text/javascript"><!--
479 allClassesLink = document.getElementById("allclasses_navbar_bottom");
481 allClassesLink.style.display = "block";
484 allClassesLink.style.display = "none";
490 <ul class="subNavList">
491 <li>Summary: </li>
492 <li>Nested | </li>
493 <li>Field | </li>
494 <li><a href="#constructor.summary">Constr</a> | </li>
495 <li><a href="#method.summary">Method</a></li>
497 <ul class="subNavList">
498 <li>Detail: </li>
499 <li>Field | </li>
500 <li><a href="#constructor.detail">Constr</a> | </li>
501 <li><a href="#method.detail">Method</a></li>
504 <a name="skip.navbar.bottom">
507 <!-- ======== END OF BOTTOM NAVBAR ======= -->