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="Mafft";
21 var methods = {"i0":10,"i1":10,"i2":10,"i3":10};
22 var tabs = {65535:["t0","All Methods"],2:["t2","Instance 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/Mafft.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/runner/msa/GLprobs.html" title="class in compbio.runner.msa"><span class="typeNameLink">Prev Class</span></a></li>
53 <li><a href="../../../compbio/runner/msa/MSAprobs.html" title="class in compbio.runner.msa"><span class="typeNameLink">Next Class</span></a></li>
56 <li><a href="../../../index.html?compbio/runner/msa/Mafft.html" target="_top">Frames</a></li>
57 <li><a href="Mafft.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><a href="#field.summary">Field</a> | </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><a href="#field.detail">Field</a> | </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.runner.msa</div>
96 <h2 title="Class Mafft" class="title">Class Mafft</h2>
98 <div class="contentContainer">
99 <ul class="inheritance">
100 <li>java.lang.Object</li>
102 <ul class="inheritance">
103 <li><a href="../../../compbio/engine/client/SkeletalExecutable.html" title="class in compbio.engine.client">compbio.engine.client.SkeletalExecutable</a><<a href="../../../compbio/runner/msa/Mafft.html" title="class in compbio.runner.msa">Mafft</a>></li>
105 <ul class="inheritance">
106 <li>compbio.runner.msa.Mafft</li>
112 <div class="description">
113 <ul class="blockList">
114 <li class="blockList">
116 <dt>All Implemented Interfaces:</dt>
117 <dd><a href="../../../compbio/engine/client/Executable.html" title="interface in compbio.engine.client">Executable</a><<a href="../../../compbio/runner/msa/Mafft.html" title="class in compbio.runner.msa">Mafft</a>>, <a href="../../../compbio/engine/client/PipedExecutable.html" title="interface in compbio.engine.client">PipedExecutable</a><<a href="../../../compbio/runner/msa/Mafft.html" title="class in compbio.runner.msa">Mafft</a>></dd>
121 <pre>public class <span class="typeNameLabel">Mafft</span>
122 extends <a href="../../../compbio/engine/client/SkeletalExecutable.html" title="class in compbio.engine.client">SkeletalExecutable</a><<a href="../../../compbio/runner/msa/Mafft.html" title="class in compbio.runner.msa">Mafft</a>>
123 implements <a href="../../../compbio/engine/client/PipedExecutable.html" title="interface in compbio.engine.client">PipedExecutable</a><<a href="../../../compbio/runner/msa/Mafft.html" title="class in compbio.runner.msa">Mafft</a>></pre>
125 <dt><span class="simpleTagLabel">Author:</span></dt>
131 <div class="summary">
132 <ul class="blockList">
133 <li class="blockList">
134 <!-- ======== NESTED CLASS SUMMARY ======== -->
135 <ul class="blockList">
136 <li class="blockList"><a name="nested.class.summary">
139 <h3>Nested Class Summary</h3>
140 <ul class="blockList">
141 <li class="blockList"><a name="nested.classes.inherited.from.class.compbio.engine.client.Executable">
144 <h3>Nested classes/interfaces inherited from interface compbio.engine.client.<a href="../../../compbio/engine/client/Executable.html" title="interface in compbio.engine.client">Executable</a></h3>
145 <code><a href="../../../compbio/engine/client/Executable.ExecProvider.html" title="enum in compbio.engine.client">Executable.ExecProvider</a></code></li>
149 <!-- =========== FIELD SUMMARY =========== -->
150 <ul class="blockList">
151 <li class="blockList"><a name="field.summary">
154 <h3>Field Summary</h3>
155 <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation">
156 <caption><span>Fields</span><span class="tabEnd"> </span></caption>
158 <th class="colFirst" scope="col">Modifier and Type</th>
159 <th class="colLast" scope="col">Field and Description</th>
161 <tr class="altColor">
162 <td class="colFirst"><code>private static java.lang.String</code></td>
163 <td class="colLast"><code><span class="memberNameLink"><a href="../../../compbio/runner/msa/Mafft.html#autoOption">autoOption</a></span></code> </td>
165 <tr class="rowColor">
166 <td class="colFirst"><code>static java.lang.String</code></td>
167 <td class="colLast"><code><span class="memberNameLink"><a href="../../../compbio/runner/msa/Mafft.html#KEY_VALUE_SEPARATOR">KEY_VALUE_SEPARATOR</a></span></code> </td>
169 <tr class="altColor">
170 <td class="colFirst"><code>private static org.apache.log4j.Logger</code></td>
171 <td class="colLast"><code><span class="memberNameLink"><a href="../../../compbio/runner/msa/Mafft.html#log">log</a></span></code> </td>
173 <tr class="rowColor">
174 <td class="colFirst"><code>private java.lang.String</code></td>
175 <td class="colLast"><code><span class="memberNameLink"><a href="../../../compbio/runner/msa/Mafft.html#MATRIX_PAR_NAME">MATRIX_PAR_NAME</a></span></code> </td>
178 <ul class="blockList">
179 <li class="blockList"><a name="fields.inherited.from.class.compbio.engine.client.SkeletalExecutable">
182 <h3>Fields inherited from class compbio.engine.client.<a href="../../../compbio/engine/client/SkeletalExecutable.html" title="class in compbio.engine.client">SkeletalExecutable</a></h3>
183 <code><a href="../../../compbio/engine/client/SkeletalExecutable.html#cbuilder">cbuilder</a>, <a href="../../../compbio/engine/client/SkeletalExecutable.html#ERROR">ERROR</a>, <a href="../../../compbio/engine/client/SkeletalExecutable.html#errorFile">errorFile</a>, <a href="../../../compbio/engine/client/SkeletalExecutable.html#INPUT">INPUT</a>, <a href="../../../compbio/engine/client/SkeletalExecutable.html#inputFile">inputFile</a>, <a href="../../../compbio/engine/client/SkeletalExecutable.html#OUTPUT">OUTPUT</a>, <a href="../../../compbio/engine/client/SkeletalExecutable.html#outputFile">outputFile</a>, <a href="../../../compbio/engine/client/SkeletalExecutable.html#ph">ph</a></code></li>
187 <!-- ======== CONSTRUCTOR SUMMARY ======== -->
188 <ul class="blockList">
189 <li class="blockList"><a name="constructor.summary">
192 <h3>Constructor Summary</h3>
193 <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
194 <caption><span>Constructors</span><span class="tabEnd"> </span></caption>
196 <th class="colOne" scope="col">Constructor and Description</th>
198 <tr class="altColor">
199 <td class="colOne"><code><span class="memberNameLink"><a href="../../../compbio/runner/msa/Mafft.html#Mafft--">Mafft</a></span>()</code> </td>
204 <!-- ========== METHOD SUMMARY =========== -->
205 <ul class="blockList">
206 <li class="blockList"><a name="method.summary">
209 <h3>Method Summary</h3>
210 <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
211 <caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance 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>
213 <th class="colFirst" scope="col">Modifier and Type</th>
214 <th class="colLast" scope="col">Method and Description</th>
216 <tr id="i0" class="altColor">
217 <td class="colFirst"><code><a href="../../../compbio/runner/msa/Mafft.html" title="class in compbio.runner.msa">Mafft</a></code></td>
218 <td class="colLast"><code><span class="memberNameLink"><a href="../../../compbio/runner/msa/Mafft.html#addParameters-java.util.List-">addParameters</a></span>(java.util.List<java.lang.String> parameters)</code>
219 <div class="block">Mafft input must always be the last parameter!</div>
222 <tr id="i1" class="rowColor">
223 <td class="colFirst"><code><a href="../../../compbio/data/sequence/Alignment.html" title="class in compbio.data.sequence">Alignment</a></code></td>
224 <td class="colLast"><code><span class="memberNameLink"><a href="../../../compbio/runner/msa/Mafft.html#getResults-java.lang.String-">getResults</a></span>(java.lang.String workDirectory)</code> </td>
226 <tr id="i2" class="altColor">
227 <td class="colFirst"><code>java.lang.Class<<a href="../../../compbio/runner/msa/Mafft.html" title="class in compbio.runner.msa">Mafft</a>></code></td>
228 <td class="colLast"><code><span class="memberNameLink"><a href="../../../compbio/runner/msa/Mafft.html#getType--">getType</a></span>()</code> </td>
230 <tr id="i3" class="rowColor">
231 <td class="colFirst"><code><a href="../../../compbio/runner/msa/Mafft.html" title="class in compbio.runner.msa">Mafft</a></code></td>
232 <td class="colLast"><code><span class="memberNameLink"><a href="../../../compbio/runner/msa/Mafft.html#setInput-java.lang.String-">setInput</a></span>(java.lang.String inFile)</code> </td>
235 <ul class="blockList">
236 <li class="blockList"><a name="methods.inherited.from.class.compbio.engine.client.SkeletalExecutable">
239 <h3>Methods inherited from class compbio.engine.client.<a href="../../../compbio/engine/client/SkeletalExecutable.html" title="class in compbio.engine.client">SkeletalExecutable</a></h3>
240 <code><a href="../../../compbio/engine/client/SkeletalExecutable.html#equals-java.lang.Object-">equals</a>, <a href="../../../compbio/engine/client/SkeletalExecutable.html#getClusterCpuNum-java.lang.Class-">getClusterCpuNum</a>, <a href="../../../compbio/engine/client/SkeletalExecutable.html#getClusterJobSettings--">getClusterJobSettings</a>, <a href="../../../compbio/engine/client/SkeletalExecutable.html#getCreatedFiles--">getCreatedFiles</a>, <a href="../../../compbio/engine/client/SkeletalExecutable.html#getError--">getError</a>, <a href="../../../compbio/engine/client/SkeletalExecutable.html#getInput--">getInput</a>, <a href="../../../compbio/engine/client/SkeletalExecutable.html#getLimit-java.lang.String-">getLimit</a>, <a href="../../../compbio/engine/client/SkeletalExecutable.html#getLimits--">getLimits</a>, <a href="../../../compbio/engine/client/SkeletalExecutable.html#getOutput--">getOutput</a>, <a href="../../../compbio/engine/client/SkeletalExecutable.html#getParameters-compbio.engine.client.Executable.ExecProvider-">getParameters</a>, <a href="../../../compbio/engine/client/SkeletalExecutable.html#hashCode--">hashCode</a>, <a href="../../../compbio/engine/client/SkeletalExecutable.html#isErrorSet--">isErrorSet</a>, <a href="../../../compbio/engine/client/SkeletalExecutable.html#isInputSet--">isInputSet</a>, <a href="../../../compbio/engine/client/SkeletalExecutable.html#isOutputSet--">isOutputSet</a>, <a href="../../../compbio/engine/client/SkeletalExecutable.html#loadRunConfiguration-compbio.engine.client.RunConfiguration-">loadRunConfiguration</a>, <a href="../../../compbio/engine/client/SkeletalExecutable.html#setError-java.lang.String-">setError</a>, <a href="../../../compbio/engine/client/SkeletalExecutable.html#setOutput-java.lang.String-">setOutput</a>, <a href="../../../compbio/engine/client/SkeletalExecutable.html#setParameter-java.lang.String-">setParameter</a>, <a href="../../../compbio/engine/client/SkeletalExecutable.html#toString--">toString</a></code></li>
242 <ul class="blockList">
243 <li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
246 <h3>Methods inherited from class java.lang.Object</h3>
247 <code>clone, finalize, getClass, notify, notifyAll, wait, wait, wait</code></li>
249 <ul class="blockList">
250 <li class="blockList"><a name="methods.inherited.from.class.compbio.engine.client.Executable">
253 <h3>Methods inherited from interface compbio.engine.client.<a href="../../../compbio/engine/client/Executable.html" title="interface in compbio.engine.client">Executable</a></h3>
254 <code><a href="../../../compbio/engine/client/Executable.html#getClusterJobSettings--">getClusterJobSettings</a>, <a href="../../../compbio/engine/client/Executable.html#getCreatedFiles--">getCreatedFiles</a>, <a href="../../../compbio/engine/client/Executable.html#getError--">getError</a>, <a href="../../../compbio/engine/client/Executable.html#getInput--">getInput</a>, <a href="../../../compbio/engine/client/Executable.html#getLimit-java.lang.String-">getLimit</a>, <a href="../../../compbio/engine/client/Executable.html#getLimits--">getLimits</a>, <a href="../../../compbio/engine/client/Executable.html#getOutput--">getOutput</a>, <a href="../../../compbio/engine/client/Executable.html#getParameters-compbio.engine.client.Executable.ExecProvider-">getParameters</a>, <a href="../../../compbio/engine/client/Executable.html#loadRunConfiguration-compbio.engine.client.RunConfiguration-">loadRunConfiguration</a></code></li>
261 <div class="details">
262 <ul class="blockList">
263 <li class="blockList">
264 <!-- ============ FIELD DETAIL =========== -->
265 <ul class="blockList">
266 <li class="blockList"><a name="field.detail">
269 <h3>Field Detail</h3>
273 <ul class="blockList">
274 <li class="blockList">
276 <pre>private static org.apache.log4j.Logger log</pre>
279 <a name="autoOption">
282 <ul class="blockList">
283 <li class="blockList">
285 <pre>private static java.lang.String autoOption</pre>
288 <a name="MATRIX_PAR_NAME">
291 <ul class="blockList">
292 <li class="blockList">
293 <h4>MATRIX_PAR_NAME</h4>
294 <pre>private final java.lang.String MATRIX_PAR_NAME</pre>
296 <dt><span class="seeLabel">See Also:</span></dt>
297 <dd><a href="../../../constant-values.html#compbio.runner.msa.Mafft.MATRIX_PAR_NAME">Constant Field Values</a></dd>
301 <a name="KEY_VALUE_SEPARATOR">
304 <ul class="blockListLast">
305 <li class="blockList">
306 <h4>KEY_VALUE_SEPARATOR</h4>
307 <pre>public static final java.lang.String KEY_VALUE_SEPARATOR</pre>
309 <dt><span class="seeLabel">See Also:</span></dt>
310 <dd><a href="../../../constant-values.html#compbio.runner.msa.Mafft.KEY_VALUE_SEPARATOR">Constant Field Values</a></dd>
316 <!-- ========= CONSTRUCTOR DETAIL ======== -->
317 <ul class="blockList">
318 <li class="blockList"><a name="constructor.detail">
321 <h3>Constructor Detail</h3>
325 <ul class="blockListLast">
326 <li class="blockList">
328 <pre>public Mafft()</pre>
333 <!-- ============ METHOD DETAIL ========== -->
334 <ul class="blockList">
335 <li class="blockList"><a name="method.detail">
338 <h3>Method Detail</h3>
339 <a name="getResults-java.lang.String-">
342 <ul class="blockList">
343 <li class="blockList">
345 <pre>public <a href="../../../compbio/data/sequence/Alignment.html" title="class in compbio.data.sequence">Alignment</a> getResults(java.lang.String workDirectory)
346 throws <a href="../../../compbio/metadata/ResultNotAvailableException.html" title="class in compbio.metadata">ResultNotAvailableException</a></pre>
348 <dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
349 <dd><code><a href="../../../compbio/engine/client/Executable.html#getResults-java.lang.String-">getResults</a></code> in interface <code><a href="../../../compbio/engine/client/Executable.html" title="interface in compbio.engine.client">Executable</a><<a href="../../../compbio/runner/msa/Mafft.html" title="class in compbio.runner.msa">Mafft</a>></code></dd>
350 <dt><span class="throwsLabel">Throws:</span></dt>
351 <dd><code><a href="../../../compbio/metadata/ResultNotAvailableException.html" title="class in compbio.metadata">ResultNotAvailableException</a></code></dd>
355 <a name="setInput-java.lang.String-">
358 <ul class="blockList">
359 <li class="blockList">
361 <pre>public <a href="../../../compbio/runner/msa/Mafft.html" title="class in compbio.runner.msa">Mafft</a> setInput(java.lang.String inFile)</pre>
363 <dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
364 <dd><code><a href="../../../compbio/engine/client/SkeletalExecutable.html#setInput-java.lang.String-">setInput</a></code> in class <code><a href="../../../compbio/engine/client/SkeletalExecutable.html" title="class in compbio.engine.client">SkeletalExecutable</a><<a href="../../../compbio/runner/msa/Mafft.html" title="class in compbio.runner.msa">Mafft</a>></code></dd>
368 <a name="addParameters-java.util.List-">
371 <ul class="blockList">
372 <li class="blockList">
373 <h4>addParameters</h4>
374 <pre>public <a href="../../../compbio/runner/msa/Mafft.html" title="class in compbio.runner.msa">Mafft</a> addParameters(java.util.List<java.lang.String> parameters)</pre>
375 <div class="block">Mafft input must always be the last parameter!</div>
377 <dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
378 <dd><code><a href="../../../compbio/engine/client/Executable.html#addParameters-java.util.List-">addParameters</a></code> in interface <code><a href="../../../compbio/engine/client/Executable.html" title="interface in compbio.engine.client">Executable</a><<a href="../../../compbio/runner/msa/Mafft.html" title="class in compbio.runner.msa">Mafft</a>></code></dd>
379 <dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
380 <dd><code><a href="../../../compbio/engine/client/SkeletalExecutable.html#addParameters-java.util.List-">addParameters</a></code> in class <code><a href="../../../compbio/engine/client/SkeletalExecutable.html" title="class in compbio.engine.client">SkeletalExecutable</a><<a href="../../../compbio/runner/msa/Mafft.html" title="class in compbio.runner.msa">Mafft</a>></code></dd>
381 <dt><span class="returnLabel">Returns:</span></dt>
382 <dd>this Executable</dd>
389 <ul class="blockListLast">
390 <li class="blockList">
392 <pre>public java.lang.Class<<a href="../../../compbio/runner/msa/Mafft.html" title="class in compbio.runner.msa">Mafft</a>> getType()</pre>
394 <dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
395 <dd><code><a href="../../../compbio/engine/client/SkeletalExecutable.html#getType--">getType</a></code> in class <code><a href="../../../compbio/engine/client/SkeletalExecutable.html" title="class in compbio.engine.client">SkeletalExecutable</a><<a href="../../../compbio/runner/msa/Mafft.html" title="class in compbio.runner.msa">Mafft</a>></code></dd>
396 <dt><span class="returnLabel">Returns:</span></dt>
397 <dd>subclasses must return their type</dd>
407 <!-- ========= END OF CLASS DATA ========= -->
408 <!-- ======= START OF BOTTOM NAVBAR ====== -->
409 <div class="bottomNav"><a name="navbar.bottom">
412 <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
413 <a name="navbar.bottom.firstrow">
416 <ul class="navList" title="Navigation">
417 <li><a href="../../../overview-summary.html">Overview</a></li>
418 <li><a href="package-summary.html">Package</a></li>
419 <li class="navBarCell1Rev">Class</li>
420 <li><a href="class-use/Mafft.html">Use</a></li>
421 <li><a href="package-tree.html">Tree</a></li>
422 <li><a href="../../../deprecated-list.html">Deprecated</a></li>
423 <li><a href="../../../index-files/index-1.html">Index</a></li>
424 <li><a href="../../../help-doc.html">Help</a></li>
429 <li><a href="../../../compbio/runner/msa/GLprobs.html" title="class in compbio.runner.msa"><span class="typeNameLink">Prev Class</span></a></li>
430 <li><a href="../../../compbio/runner/msa/MSAprobs.html" title="class in compbio.runner.msa"><span class="typeNameLink">Next Class</span></a></li>
433 <li><a href="../../../index.html?compbio/runner/msa/Mafft.html" target="_top">Frames</a></li>
434 <li><a href="Mafft.html" target="_top">No Frames</a></li>
436 <ul class="navList" id="allclasses_navbar_bottom">
437 <li><a href="../../../allclasses-noframe.html">All Classes</a></li>
440 <script type="text/javascript"><!--
441 allClassesLink = document.getElementById("allclasses_navbar_bottom");
443 allClassesLink.style.display = "block";
446 allClassesLink.style.display = "none";
452 <ul class="subNavList">
453 <li>Summary: </li>
454 <li>Nested | </li>
455 <li><a href="#field.summary">Field</a> | </li>
456 <li><a href="#constructor.summary">Constr</a> | </li>
457 <li><a href="#method.summary">Method</a></li>
459 <ul class="subNavList">
460 <li>Detail: </li>
461 <li><a href="#field.detail">Field</a> | </li>
462 <li><a href="#constructor.detail">Constr</a> | </li>
463 <li><a href="#method.detail">Method</a></li>
466 <a name="skip.navbar.bottom">
469 <!-- ======== END OF BOTTOM NAVBAR ======= -->