website/full_javadoc/compbio/engine/client/PipedExecutable.html

   1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">\r
   2 <!--NewPage-->\r
   3 <HTML>\r
   4 <HEAD>\r
   5 <!-- Generated by javadoc (build 1.6.0_24) on Fri Aug 12 14:32:35 BST 2011 -->\r
   6 <TITLE>\r
   7 PipedExecutable\r
   8 </TITLE>\r
   9 \r
  10 <META NAME="date" CONTENT="2011-08-12">\r
  11 \r
  12 <LINK REL ="stylesheet" TYPE="text/css" HREF="../../../stylesheet.css" TITLE="Style">\r
  13 \r
  14 <SCRIPT type="text/javascript">\r
  15 function windowTitle()\r
  16 {\r
  17     if (location.href.indexOf('is-external=true') == -1) {\r
  18         parent.document.title="PipedExecutable";\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/PipedExecutable.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>\r
  44   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>\r
  45   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>\r
  46   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../index-files/index-1.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>\r
  47   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>\r
  48   </TR>\r
  49 </TABLE>\r
  50 </TD>\r
  51 <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>\r
  52 </EM>\r
  53 </TD>\r
  54 </TR>\r
  55 \r
  56 <TR>\r
  57 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">\r
  58 &nbsp;<A HREF="../../../compbio/engine/client/PathValidator.html" title="class in compbio.engine.client"><B>PREV CLASS</B></A>&nbsp;\r
  59 &nbsp;<A HREF="../../../compbio/engine/client/RunConfiguration.html" title="class in compbio.engine.client"><B>NEXT CLASS</B></A></FONT></TD>\r
  60 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">\r
  61   <A HREF="../../../index.html?compbio/engine/client/PipedExecutable.html" target="_top"><B>FRAMES</B></A>  &nbsp;\r
  62 &nbsp;<A HREF="PipedExecutable.html" target="_top"><B>NO FRAMES</B></A>  &nbsp;\r
  63 &nbsp;<SCRIPT type="text/javascript">\r
  64   <!--\r
  65   if(window==top) {\r
  66     document.writeln('<A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A>');\r
  67   }\r
  68   //-->\r
  69 </SCRIPT>\r
  70 <NOSCRIPT>\r
  71   <A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A>\r
  72 </NOSCRIPT>\r
  73 \r
  74 \r
  75 </FONT></TD>\r
  76 </TR>\r
  77 <TR>\r
  78 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">\r
  79   SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;METHOD</FONT></TD>\r
  80 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">\r
  81 DETAIL:&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;METHOD</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.engine.client</FONT>\r
  92 <BR>\r
  93 Interface PipedExecutable&lt;T&gt;</H2>\r
  94 <DL>\r
  95 <DT><DT><B>Type Parameters:</B><DD><CODE>T</CODE> - </DL>\r
  96 <DL>\r
  97 <DT><B>All Superinterfaces:</B> <DD><A HREF="../../../compbio/engine/client/Executable.html" title="interface in compbio.engine.client">Executable</A>&lt;T&gt;</DD>\r
  98 </DL>\r
  99 <DL>\r
 100 <DT><B>All Known Subinterfaces:</B> <DD><A HREF="../../../compbio/engine/client/ConfiguredExecutable.html" title="interface in compbio.engine.client">ConfiguredExecutable</A>&lt;T&gt;</DD>\r
 101 </DL>\r
 102 <DL>\r
 103 <DT><B>All Known Implementing Classes:</B> <DD><A HREF="../../../compbio/engine/client/ConfExecutable.html" title="class in compbio.engine.client">ConfExecutable</A>, <A HREF="../../../compbio/runner/disorder/Disembl.html" title="class in compbio.runner.disorder">Disembl</A>, <A HREF="../../../compbio/runner/disorder/GlobPlot.html" title="class in compbio.runner.disorder">GlobPlot</A>, <A HREF="../../../compbio/runner/msa/Mafft.html" title="class in compbio.runner.msa">Mafft</A>, <A HREF="../../../compbio/runner/msa/Probcons.html" title="class in compbio.runner.msa">Probcons</A>, <A HREF="../../../compbio/runner/msa/Tcoffee.html" title="class in compbio.runner.msa">Tcoffee</A></DD>\r
 104 </DL>\r
 105 <HR>\r
 106 <DL>\r
 107 <DT><PRE>public interface <B>PipedExecutable&lt;T&gt;</B><DT>extends <A HREF="../../../compbio/engine/client/Executable.html" title="interface in compbio.engine.client">Executable</A>&lt;T&gt;</DL>\r
 108 </PRE>\r
 109 \r
 110 <P>\r
 111 This is a marker interface to indicate that the output of the process must be
 112  captured. It is in generally better for the process to manage its own
 113  streams, but some executables are not capable of this thus require different
 114  handling\r
 115 <P>\r
 116 \r
 117 <P>\r
 118 <DL>\r
 119 <DT><B>Version:</B></DT>\r
 120   <DD>1.0 October 2009</DD>\r
 121 <DT><B>Author:</B></DT>\r
 122   <DD>pvtroshin</DD>\r
 123 </DL>\r
 124 <HR>\r
 125 \r
 126 <P>\r
 127 <!-- ======== NESTED CLASS SUMMARY ======== -->\r
 128 \r
 129 <A NAME="nested_class_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>Nested Class Summary</B></FONT></TH>\r
 134 </TR>\r
 135 </TABLE>\r
 136 &nbsp;<A NAME="nested_classes_inherited_from_class_compbio.engine.client.Executable"><!-- --></A>\r
 137 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">\r
 138 <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">\r
 139 <TH ALIGN="left"><B>Nested classes/interfaces inherited from interface compbio.engine.client.<A HREF="../../../compbio/engine/client/Executable.html" title="interface in compbio.engine.client">Executable</A></B></TH>\r
 140 </TR>\r
 141 <TR BGCOLOR="white" CLASS="TableRowColor">\r
 142 <TD><CODE><A HREF="../../../compbio/engine/client/Executable.ExecProvider.html" title="enum in compbio.engine.client">Executable.ExecProvider</A></CODE></TD>\r
 143 </TR>\r
 144 </TABLE>\r
 145 &nbsp;\r
 146 \r
 147 <!-- ========== METHOD SUMMARY =========== -->\r
 148 \r
 149 <A NAME="method_summary"><!-- --></A>\r
 150 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">\r
 151 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">\r
 152 <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">\r
 153 <B>Method Summary</B></FONT></TH>\r
 154 </TR>\r
 155 </TABLE>\r
 156 &nbsp;<A NAME="methods_inherited_from_class_compbio.engine.client.Executable"><!-- --></A>\r
 157 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">\r
 158 <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">\r
 159 <TH ALIGN="left"><B>Methods inherited from interface compbio.engine.client.<A HREF="../../../compbio/engine/client/Executable.html" title="interface in compbio.engine.client">Executable</A></B></TH>\r
 160 </TR>\r
 161 <TR BGCOLOR="white" CLASS="TableRowColor">\r
 162 <TD><CODE><A HREF="../../../compbio/engine/client/Executable.html#addParameters(java.util.List)">addParameters</A>, <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#getResults(java.lang.String)">getResults</A>, <A HREF="../../../compbio/engine/client/Executable.html#loadRunConfiguration(compbio.engine.client.RunConfiguration)">loadRunConfiguration</A></CODE></TD>\r
 163 </TR>\r
 164 </TABLE>\r
 165 &nbsp;\r
 166 <P>\r
 167 <!-- ========= END OF CLASS DATA ========= -->\r
 168 <HR>\r
 169 \r
 170 \r
 171 <!-- ======= START OF BOTTOM NAVBAR ====== -->\r
 172 <A NAME="navbar_bottom"><!-- --></A>\r
 173 <A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>\r
 174 <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">\r
 175 <TR>\r
 176 <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">\r
 177 <A NAME="navbar_bottom_firstrow"><!-- --></A>\r
 178 <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">\r
 179   <TR ALIGN="center" VALIGN="top">\r
 180   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>\r
 181   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>\r
 182   <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>\r
 183   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="class-use/PipedExecutable.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>\r
 184   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>\r
 185   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>\r
 186   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../index-files/index-1.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>\r
 187   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>\r
 188   </TR>\r
 189 </TABLE>\r
 190 </TD>\r
 191 <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>\r
 192 </EM>\r
 193 </TD>\r
 194 </TR>\r
 195 \r
 196 <TR>\r
 197 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">\r
 198 &nbsp;<A HREF="../../../compbio/engine/client/PathValidator.html" title="class in compbio.engine.client"><B>PREV CLASS</B></A>&nbsp;\r
 199 &nbsp;<A HREF="../../../compbio/engine/client/RunConfiguration.html" title="class in compbio.engine.client"><B>NEXT CLASS</B></A></FONT></TD>\r
 200 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">\r
 201   <A HREF="../../../index.html?compbio/engine/client/PipedExecutable.html" target="_top"><B>FRAMES</B></A>  &nbsp;\r
 202 &nbsp;<A HREF="PipedExecutable.html" target="_top"><B>NO FRAMES</B></A>  &nbsp;\r
 203 &nbsp;<SCRIPT type="text/javascript">\r
 204   <!--\r
 205   if(window==top) {\r
 206     document.writeln('<A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A>');\r
 207   }\r
 208   //-->\r
 209 </SCRIPT>\r
 210 <NOSCRIPT>\r
 211   <A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A>\r
 212 </NOSCRIPT>\r
 213 \r
 214 \r
 215 </FONT></TD>\r
 216 </TR>\r
 217 <TR>\r
 218 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">\r
 219   SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;METHOD</FONT></TD>\r
 220 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">\r
 221 DETAIL:&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;METHOD</FONT></TD>\r
 222 </TR>\r
 223 </TABLE>\r
 224 <A NAME="skip-navbar_bottom"></A>\r
 225 <!-- ======== END OF BOTTOM NAVBAR ======= -->\r
 226 \r
 227 <HR>\r
 228 \r
 229 </BODY>\r
 230 </HTML>\r