website/dm_javadoc/compbio/metadata/RunnerConfig.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:03 BST 2011 -->\r
   6 <TITLE>\r
   7 RunnerConfig\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="RunnerConfig";\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/RunnerConfig.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/metadata/ResultNotAvailableException.html" title="class in compbio.metadata"><B>PREV CLASS</B></A>&nbsp;\r
  59 &nbsp;<A HREF="../../compbio/metadata/UnsupportedRuntimeException.html" title="class in compbio.metadata"><B>NEXT CLASS</B></A></FONT></TD>\r
  60 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">\r
  61   <A HREF="../../index.html?compbio/metadata/RunnerConfig.html" target="_top"><B>FRAMES</B></A>  &nbsp;\r
  62 &nbsp;<A HREF="RunnerConfig.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.metadata</FONT>\r
  92 <BR>\r
  93 Class RunnerConfig&lt;T&gt;</H2>\r
  94 <PRE>\r
  95 <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</A>\r
  96   <IMG SRC="../../resources/inherit.gif" ALT="extended by "><B>compbio.metadata.RunnerConfig&lt;T&gt;</B>\r
  97 </PRE>\r
  98 <DL>\r
  99 <DT><DT><B>Type Parameters:</B><DD><CODE>T</CODE> - type of an Executable</DL>\r
 100 <HR>\r
 101 <DL>\r
 102 <DT><PRE><FONT SIZE="-1">@NotThreadSafe\r
 103 </FONT>public class <B>RunnerConfig&lt;T&gt;</B><DT>extends <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</A></DL>\r
 104 </PRE>\r
 105 \r
 106 <P>\r
 107 The list of <A HREF="../../compbio/metadata/Parameter.html" title="class in compbio.metadata"><CODE>Parameter</CODE></A>s and <A HREF="../../compbio/metadata/Option.html" title="class in compbio.metadata"><CODE>Option</CODE></A>s supported by executable.
 108  The lists is defined in and loaded from <ExecutableName>Parameters.xml file.\r
 109 <P>\r
 110 \r
 111 <P>\r
 112 <DL>\r
 113 <DT><B>Version:</B></DT>\r
 114   <DD>1.0 October 2009</DD>\r
 115 <DT><B>Author:</B></DT>\r
 116   <DD>pvtroshin</DD>\r
 117 </DL>\r
 118 <HR>\r
 119 \r
 120 <P>\r
 121 \r
 122 <!-- ======== CONSTRUCTOR SUMMARY ======== -->\r
 123 \r
 124 <A NAME="constructor_summary"><!-- --></A>\r
 125 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">\r
 126 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">\r
 127 <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">\r
 128 <B>Constructor Summary</B></FONT></TH>\r
 129 </TR>\r
 130 <TR BGCOLOR="white" CLASS="TableRowColor">\r
 131 <TD><CODE><B><A HREF="../../compbio/metadata/RunnerConfig.html#RunnerConfig()">RunnerConfig</A></B>()</CODE>\r
 132 \r
 133 <BR>\r
 134 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>\r
 135 </TR>\r
 136 </TABLE>\r
 137 &nbsp;\r
 138 <!-- ========== METHOD SUMMARY =========== -->\r
 139 \r
 140 <A NAME="method_summary"><!-- --></A>\r
 141 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">\r
 142 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">\r
 143 <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">\r
 144 <B>Method Summary</B></FONT></TH>\r
 145 </TR>\r
 146 <TR BGCOLOR="white" CLASS="TableRowColor">\r
 147 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
 148 <CODE>&nbsp;void</CODE></FONT></TD>\r
 149 <TD><CODE><B><A HREF="../../compbio/metadata/RunnerConfig.html#addOption(compbio.metadata.Option)">addOption</A></B>(<A HREF="../../compbio/metadata/Option.html" title="class in compbio.metadata">Option</A>&lt;<A HREF="../../compbio/metadata/RunnerConfig.html" title="type parameter in RunnerConfig">T</A>&gt;&nbsp;option)</CODE>\r
 150 \r
 151 <BR>\r
 152 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Adds Option to the internal list of options</TD>\r
 153 </TR>\r
 154 <TR BGCOLOR="white" CLASS="TableRowColor">\r
 155 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
 156 <CODE>&nbsp;void</CODE></FONT></TD>\r
 157 <TD><CODE><B><A HREF="../../compbio/metadata/RunnerConfig.html#addParameter(compbio.metadata.Parameter)">addParameter</A></B>(<A HREF="../../compbio/metadata/Parameter.html" title="class in compbio.metadata">Parameter</A>&lt;<A HREF="../../compbio/metadata/RunnerConfig.html" title="type parameter in RunnerConfig">T</A>&gt;&nbsp;param)</CODE>\r
 158 \r
 159 <BR>\r
 160 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Adds parameter to the internal parameter list</TD>\r
 161 </TR>\r
 162 <TR BGCOLOR="white" CLASS="TableRowColor">\r
 163 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
 164 <CODE>&nbsp;<A HREF="../../compbio/metadata/RunnerConfig.html" title="class in compbio.metadata">RunnerConfig</A>&lt;<A HREF="../../compbio/metadata/RunnerConfig.html" title="type parameter in RunnerConfig">T</A>&gt;</CODE></FONT></TD>\r
 165 <TD><CODE><B><A HREF="../../compbio/metadata/RunnerConfig.html#copyAndValidateRConfig(compbio.metadata.RunnerConfig)">copyAndValidateRConfig</A></B>(<A HREF="../../compbio/metadata/RunnerConfig.html" title="class in compbio.metadata">RunnerConfig</A>&lt;?&gt;&nbsp;runnerConf)</CODE>\r
 166 \r
 167 <BR>\r
 168 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>\r
 169 </TR>\r
 170 <TR BGCOLOR="white" CLASS="TableRowColor">\r
 171 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
 172 <CODE>&nbsp;boolean</CODE></FONT></TD>\r
 173 <TD><CODE><B><A HREF="../../compbio/metadata/RunnerConfig.html#equals(java.lang.Object)">equals</A></B>(<A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</A>&nbsp;obj)</CODE>\r
 174 \r
 175 <BR>\r
 176 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>\r
 177 </TR>\r
 178 <TR BGCOLOR="white" CLASS="TableRowColor">\r
 179 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
 180 <CODE>&nbsp;<A HREF="../../compbio/metadata/Option.html" title="class in compbio.metadata">Option</A>&lt;<A HREF="../../compbio/metadata/RunnerConfig.html" title="type parameter in RunnerConfig">T</A>&gt;</CODE></FONT></TD>\r
 181 <TD><CODE><B><A HREF="../../compbio/metadata/RunnerConfig.html#getArgument(java.lang.String)">getArgument</A></B>(<A HREF="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A>&nbsp;name)</CODE>\r
 182 \r
 183 <BR>\r
 184 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns the argument by its name if found, NULL otherwise.</TD>\r
 185 </TR>\r
 186 <TR BGCOLOR="white" CLASS="TableRowColor">\r
 187 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
 188 <CODE>&nbsp;<A HREF="../../compbio/metadata/Option.html" title="class in compbio.metadata">Option</A>&lt;<A HREF="../../compbio/metadata/RunnerConfig.html" title="type parameter in RunnerConfig">T</A>&gt;</CODE></FONT></TD>\r
 189 <TD><CODE><B><A HREF="../../compbio/metadata/RunnerConfig.html#getArgumentByOptionName(java.lang.String)">getArgumentByOptionName</A></B>(<A HREF="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A>&nbsp;optionName)</CODE>\r
 190 \r
 191 <BR>\r
 192 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns the argument by option name, NULL if the argument is not found</TD>\r
 193 </TR>\r
 194 <TR BGCOLOR="white" CLASS="TableRowColor">\r
 195 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
 196 <CODE>&nbsp;<A HREF="http://java.sun.com/javase/6/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</A>&lt;<A HREF="../../compbio/metadata/Option.html" title="class in compbio.metadata">Option</A>&lt;<A HREF="../../compbio/metadata/RunnerConfig.html" title="type parameter in RunnerConfig">T</A>&gt;&gt;</CODE></FONT></TD>\r
 197 <TD><CODE><B><A HREF="../../compbio/metadata/RunnerConfig.html#getArguments()">getArguments</A></B>()</CODE>\r
 198 \r
 199 <BR>\r
 200 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns list of <A HREF="../../compbio/metadata/Parameter.html" title="class in compbio.metadata"><CODE>Parameter</CODE></A> and <A HREF="../../compbio/metadata/Option.html" title="class in compbio.metadata"><CODE>Option</CODE></A> supported by current
 201  runner</TD>\r
 202 </TR>\r
 203 <TR BGCOLOR="white" CLASS="TableRowColor">\r
 204 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
 205 <CODE>&nbsp;<A HREF="http://java.sun.com/javase/6/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</A>&lt;<A HREF="../../compbio/metadata/Option.html" title="class in compbio.metadata">Option</A>&lt;<A HREF="../../compbio/metadata/RunnerConfig.html" title="type parameter in RunnerConfig">T</A>&gt;&gt;</CODE></FONT></TD>\r
 206 <TD><CODE><B><A HREF="../../compbio/metadata/RunnerConfig.html#getOptions()">getOptions</A></B>()</CODE>\r
 207 \r
 208 <BR>\r
 209 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns the list of the Options supported by the executable of type T</TD>\r
 210 </TR>\r
 211 <TR BGCOLOR="white" CLASS="TableRowColor">\r
 212 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
 213 <CODE>&nbsp;<A HREF="http://java.sun.com/javase/6/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</A>&lt;<A HREF="../../compbio/metadata/Parameter.html" title="class in compbio.metadata">Parameter</A>&lt;<A HREF="../../compbio/metadata/RunnerConfig.html" title="type parameter in RunnerConfig">T</A>&gt;&gt;</CODE></FONT></TD>\r
 214 <TD><CODE><B><A HREF="../../compbio/metadata/RunnerConfig.html#getParameters()">getParameters</A></B>()</CODE>\r
 215 \r
 216 <BR>\r
 217 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns the list of parameters supported executable of type T.</TD>\r
 218 </TR>\r
 219 <TR BGCOLOR="white" CLASS="TableRowColor">\r
 220 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
 221 <CODE>&nbsp;<A HREF="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A></CODE></FONT></TD>\r
 222 <TD><CODE><B><A HREF="../../compbio/metadata/RunnerConfig.html#getPrmSeparator()">getPrmSeparator</A></B>()</CODE>\r
 223 \r
 224 <BR>\r
 225 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>\r
 226 </TR>\r
 227 <TR BGCOLOR="white" CLASS="TableRowColor">\r
 228 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
 229 <CODE>&nbsp;<A HREF="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A></CODE></FONT></TD>\r
 230 <TD><CODE><B><A HREF="../../compbio/metadata/RunnerConfig.html#getRunnerClassName()">getRunnerClassName</A></B>()</CODE>\r
 231 \r
 232 <BR>\r
 233 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>\r
 234 </TR>\r
 235 <TR BGCOLOR="white" CLASS="TableRowColor">\r
 236 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
 237 <CODE>&nbsp;boolean</CODE></FONT></TD>\r
 238 <TD><CODE><B><A HREF="../../compbio/metadata/RunnerConfig.html#removeArgument(java.lang.String)">removeArgument</A></B>(<A HREF="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A>&nbsp;name)</CODE>\r
 239 \r
 240 <BR>\r
 241 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Removes the argument <A HREF="../../compbio/metadata/Argument.html" title="interface in compbio.metadata"><CODE>Argument</CODE></A> if found.</TD>\r
 242 </TR>\r
 243 <TR BGCOLOR="white" CLASS="TableRowColor">\r
 244 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
 245 <CODE>&nbsp;boolean</CODE></FONT></TD>\r
 246 <TD><CODE><B><A HREF="../../compbio/metadata/RunnerConfig.html#removeArgumentByOptionName(java.lang.String)">removeArgumentByOptionName</A></B>(<A HREF="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A>&nbsp;optionName)</CODE>\r
 247 \r
 248 <BR>\r
 249 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Removes the argument which can be a Parameter or an Option instance by
 250  the value in <optionNames> element of the runner configuration
 251  descriptor.</TD>\r
 252 </TR>\r
 253 <TR BGCOLOR="white" CLASS="TableRowColor">\r
 254 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
 255 <CODE>&nbsp;void</CODE></FONT></TD>\r
 256 <TD><CODE><B><A HREF="../../compbio/metadata/RunnerConfig.html#setOptions(java.util.List)">setOptions</A></B>(<A HREF="http://java.sun.com/javase/6/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</A>&lt;<A HREF="../../compbio/metadata/Option.html" title="class in compbio.metadata">Option</A>&lt;<A HREF="../../compbio/metadata/RunnerConfig.html" title="type parameter in RunnerConfig">T</A>&gt;&gt;&nbsp;parameters)</CODE>\r
 257 \r
 258 <BR>\r
 259 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Adds the list of options or parameters to the internal list of options</TD>\r
 260 </TR>\r
 261 <TR BGCOLOR="white" CLASS="TableRowColor">\r
 262 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
 263 <CODE>&nbsp;void</CODE></FONT></TD>\r
 264 <TD><CODE><B><A HREF="../../compbio/metadata/RunnerConfig.html#setParameters(java.util.List)">setParameters</A></B>(<A HREF="http://java.sun.com/javase/6/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</A>&lt;<A HREF="../../compbio/metadata/Parameter.html" title="class in compbio.metadata">Parameter</A>&lt;<A HREF="../../compbio/metadata/RunnerConfig.html" title="type parameter in RunnerConfig">T</A>&gt;&gt;&nbsp;parameters)</CODE>\r
 265 \r
 266 <BR>\r
 267 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Sets the list of parameters as internal list</TD>\r
 268 </TR>\r
 269 <TR BGCOLOR="white" CLASS="TableRowColor">\r
 270 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
 271 <CODE>&nbsp;void</CODE></FONT></TD>\r
 272 <TD><CODE><B><A HREF="../../compbio/metadata/RunnerConfig.html#setPrmSeparator(java.lang.String)">setPrmSeparator</A></B>(<A HREF="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A>&nbsp;prmSeparator)</CODE>\r
 273 \r
 274 <BR>\r
 275 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Sets name value separator character</TD>\r
 276 </TR>\r
 277 <TR BGCOLOR="white" CLASS="TableRowColor">\r
 278 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
 279 <CODE>&nbsp;void</CODE></FONT></TD>\r
 280 <TD><CODE><B><A HREF="../../compbio/metadata/RunnerConfig.html#setRunnerClassName(java.lang.String)">setRunnerClassName</A></B>(<A HREF="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A>&nbsp;runnerClassName)</CODE>\r
 281 \r
 282 <BR>\r
 283 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Set the name of a runner class</TD>\r
 284 </TR>\r
 285 <TR BGCOLOR="white" CLASS="TableRowColor">\r
 286 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
 287 <CODE>&nbsp;<A HREF="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A></CODE></FONT></TD>\r
 288 <TD><CODE><B><A HREF="../../compbio/metadata/RunnerConfig.html#toString()">toString</A></B>()</CODE>\r
 289 \r
 290 <BR>\r
 291 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>\r
 292 </TR>\r
 293 <TR BGCOLOR="white" CLASS="TableRowColor">\r
 294 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
 295 <CODE>&nbsp;void</CODE></FONT></TD>\r
 296 <TD><CODE><B><A HREF="../../compbio/metadata/RunnerConfig.html#validate()">validate</A></B>()</CODE>\r
 297 \r
 298 <BR>\r
 299 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Validate the value of the argument.</TD>\r
 300 </TR>\r
 301 </TABLE>\r
 302 &nbsp;<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>\r
 303 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">\r
 304 <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">\r
 305 <TH ALIGN="left"><B>Methods inherited from class java.lang.<A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</A></B></TH>\r
 306 </TR>\r
 307 <TR BGCOLOR="white" CLASS="TableRowColor">\r
 308 <TD><CODE><A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#getClass()" title="class or interface in java.lang">getClass</A>, <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#hashCode()" title="class or interface in java.lang">hashCode</A>, <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#notify()" title="class or interface in java.lang">notify</A>, <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#notifyAll()" title="class or interface in java.lang">notifyAll</A>, <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#wait()" title="class or interface in java.lang">wait</A>, <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#wait(long)" title="class or interface in java.lang">wait</A>, <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#wait(long, int)" title="class or interface in java.lang">wait</A></CODE></TD>\r
 309 </TR>\r
 310 </TABLE>\r
 311 &nbsp;\r
 312 <P>\r
 313 \r
 314 <!-- ========= CONSTRUCTOR DETAIL ======== -->\r
 315 \r
 316 <A NAME="constructor_detail"><!-- --></A>\r
 317 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">\r
 318 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">\r
 319 <TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">\r
 320 <B>Constructor Detail</B></FONT></TH>\r
 321 </TR>\r
 322 </TABLE>\r
 323 \r
 324 <A NAME="RunnerConfig()"><!-- --></A><H3>\r
 325 RunnerConfig</H3>\r
 326 <PRE>\r
 327 public <B>RunnerConfig</B>()</PRE>\r
 328 <DL>\r
 329 </DL>\r
 330 \r
 331 <!-- ============ METHOD DETAIL ========== -->\r
 332 \r
 333 <A NAME="method_detail"><!-- --></A>\r
 334 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">\r
 335 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">\r
 336 <TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">\r
 337 <B>Method Detail</B></FONT></TH>\r
 338 </TR>\r
 339 </TABLE>\r
 340 \r
 341 <A NAME="copyAndValidateRConfig(compbio.metadata.RunnerConfig)"><!-- --></A><H3>\r
 342 copyAndValidateRConfig</H3>\r
 343 <PRE>\r
 344 public <A HREF="../../compbio/metadata/RunnerConfig.html" title="class in compbio.metadata">RunnerConfig</A>&lt;<A HREF="../../compbio/metadata/RunnerConfig.html" title="type parameter in RunnerConfig">T</A>&gt; <B>copyAndValidateRConfig</B>(<A HREF="../../compbio/metadata/RunnerConfig.html" title="class in compbio.metadata">RunnerConfig</A>&lt;?&gt;&nbsp;runnerConf)</PRE>\r
 345 <DL>\r
 346 <DD><DL>\r
 347 </DL>\r
 348 </DD>\r
 349 </DL>\r
 350 <HR>\r
 351 \r
 352 <A NAME="getOptions()"><!-- --></A><H3>\r
 353 getOptions</H3>\r
 354 <PRE>\r
 355 public <A HREF="http://java.sun.com/javase/6/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</A>&lt;<A HREF="../../compbio/metadata/Option.html" title="class in compbio.metadata">Option</A>&lt;<A HREF="../../compbio/metadata/RunnerConfig.html" title="type parameter in RunnerConfig">T</A>&gt;&gt; <B>getOptions</B>()</PRE>\r
 356 <DL>\r
 357 <DD>Returns the list of the Options supported by the executable of type T\r
 358 <P>\r
 359 <DD><DL>\r
 360 \r
 361 <DT><B>Returns:</B><DD>list of <A HREF="../../compbio/metadata/Option.html" title="class in compbio.metadata"><CODE>Option</CODE></A> supported by type T<DT><B>See Also:</B><DD><A HREF="../../compbio/metadata/Option.html" title="class in compbio.metadata"><CODE>Option</CODE></A></DL>\r
 362 </DD>\r
 363 </DL>\r
 364 <HR>\r
 365 \r
 366 <A NAME="addParameter(compbio.metadata.Parameter)"><!-- --></A><H3>\r
 367 addParameter</H3>\r
 368 <PRE>\r
 369 public void <B>addParameter</B>(<A HREF="../../compbio/metadata/Parameter.html" title="class in compbio.metadata">Parameter</A>&lt;<A HREF="../../compbio/metadata/RunnerConfig.html" title="type parameter in RunnerConfig">T</A>&gt;&nbsp;param)</PRE>\r
 370 <DL>\r
 371 <DD>Adds parameter to the internal parameter list\r
 372 <P>\r
 373 <DD><DL>\r
 374 <DT><B>Parameters:</B><DD><CODE>param</CODE> - the <A HREF="../../compbio/metadata/Parameter.html" title="class in compbio.metadata"><CODE>Parameter</CODE></A> to add<DT><B>See Also:</B><DD><A HREF="../../compbio/metadata/Parameter.html" title="class in compbio.metadata"><CODE>Parameter</CODE></A></DL>\r
 375 </DD>\r
 376 </DL>\r
 377 <HR>\r
 378 \r
 379 <A NAME="addOption(compbio.metadata.Option)"><!-- --></A><H3>\r
 380 addOption</H3>\r
 381 <PRE>\r
 382 public void <B>addOption</B>(<A HREF="../../compbio/metadata/Option.html" title="class in compbio.metadata">Option</A>&lt;<A HREF="../../compbio/metadata/RunnerConfig.html" title="type parameter in RunnerConfig">T</A>&gt;&nbsp;option)</PRE>\r
 383 <DL>\r
 384 <DD>Adds Option to the internal list of options\r
 385 <P>\r
 386 <DD><DL>\r
 387 <DT><B>Parameters:</B><DD><CODE>option</CODE> - the <A HREF="../../compbio/metadata/Option.html" title="class in compbio.metadata"><CODE>Option</CODE></A> to add</DL>\r
 388 </DD>\r
 389 </DL>\r
 390 <HR>\r
 391 \r
 392 <A NAME="getArguments()"><!-- --></A><H3>\r
 393 getArguments</H3>\r
 394 <PRE>\r
 395 public <A HREF="http://java.sun.com/javase/6/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</A>&lt;<A HREF="../../compbio/metadata/Option.html" title="class in compbio.metadata">Option</A>&lt;<A HREF="../../compbio/metadata/RunnerConfig.html" title="type parameter in RunnerConfig">T</A>&gt;&gt; <B>getArguments</B>()</PRE>\r
 396 <DL>\r
 397 <DD>Returns list of <A HREF="../../compbio/metadata/Parameter.html" title="class in compbio.metadata"><CODE>Parameter</CODE></A> and <A HREF="../../compbio/metadata/Option.html" title="class in compbio.metadata"><CODE>Option</CODE></A> supported by current
 398  runner\r
 399 <P>\r
 400 <DD><DL>\r
 401 \r
 402 <DT><B>Returns:</B><DD>list of <A HREF="../../compbio/metadata/Option.html" title="class in compbio.metadata"><CODE>Option</CODE></A> and <A HREF="../../compbio/metadata/Parameter.html" title="class in compbio.metadata"><CODE>Parameter</CODE></A> supported by type T</DL>\r
 403 </DD>\r
 404 </DL>\r
 405 <HR>\r
 406 \r
 407 <A NAME="getPrmSeparator()"><!-- --></A><H3>\r
 408 getPrmSeparator</H3>\r
 409 <PRE>\r
 410 public <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> <B>getPrmSeparator</B>()</PRE>\r
 411 <DL>\r
 412 <DD><DL>\r
 413 \r
 414 <DT><B>Returns:</B><DD>name value separator character</DL>\r
 415 </DD>\r
 416 </DL>\r
 417 <HR>\r
 418 \r
 419 <A NAME="setPrmSeparator(java.lang.String)"><!-- --></A><H3>\r
 420 setPrmSeparator</H3>\r
 421 <PRE>\r
 422 public void <B>setPrmSeparator</B>(<A HREF="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A>&nbsp;prmSeparator)</PRE>\r
 423 <DL>\r
 424 <DD>Sets name value separator character\r
 425 <P>\r
 426 <DD><DL>\r
 427 <DT><B>Parameters:</B><DD><CODE>prmSeparator</CODE> - the separator char</DL>\r
 428 </DD>\r
 429 </DL>\r
 430 <HR>\r
 431 \r
 432 <A NAME="setOptions(java.util.List)"><!-- --></A><H3>\r
 433 setOptions</H3>\r
 434 <PRE>\r
 435 public void <B>setOptions</B>(<A HREF="http://java.sun.com/javase/6/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</A>&lt;<A HREF="../../compbio/metadata/Option.html" title="class in compbio.metadata">Option</A>&lt;<A HREF="../../compbio/metadata/RunnerConfig.html" title="type parameter in RunnerConfig">T</A>&gt;&gt;&nbsp;parameters)</PRE>\r
 436 <DL>\r
 437 <DD>Adds the list of options or parameters to the internal list of options\r
 438 <P>\r
 439 <DD><DL>\r
 440 <DT><B>Parameters:</B><DD><CODE>parameters</CODE> - the list of parameters to add</DL>\r
 441 </DD>\r
 442 </DL>\r
 443 <HR>\r
 444 \r
 445 <A NAME="getRunnerClassName()"><!-- --></A><H3>\r
 446 getRunnerClassName</H3>\r
 447 <PRE>\r
 448 public <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> <B>getRunnerClassName</B>()</PRE>\r
 449 <DL>\r
 450 <DD><DL>\r
 451 \r
 452 <DT><B>Returns:</B><DD>fully qualified class name for type T</DL>\r
 453 </DD>\r
 454 </DL>\r
 455 <HR>\r
 456 \r
 457 <A NAME="setRunnerClassName(java.lang.String)"><!-- --></A><H3>\r
 458 setRunnerClassName</H3>\r
 459 <PRE>\r
 460 public void <B>setRunnerClassName</B>(<A HREF="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A>&nbsp;runnerClassName)</PRE>\r
 461 <DL>\r
 462 <DD>Set the name of a runner class\r
 463 <P>\r
 464 <DD><DL>\r
 465 <DT><B>Parameters:</B><DD><CODE>runnerClassName</CODE> - the name of the executable wrapping class</DL>\r
 466 </DD>\r
 467 </DL>\r
 468 <HR>\r
 469 \r
 470 <A NAME="setParameters(java.util.List)"><!-- --></A><H3>\r
 471 setParameters</H3>\r
 472 <PRE>\r
 473 public void <B>setParameters</B>(<A HREF="http://java.sun.com/javase/6/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</A>&lt;<A HREF="../../compbio/metadata/Parameter.html" title="class in compbio.metadata">Parameter</A>&lt;<A HREF="../../compbio/metadata/RunnerConfig.html" title="type parameter in RunnerConfig">T</A>&gt;&gt;&nbsp;parameters)</PRE>\r
 474 <DL>\r
 475 <DD>Sets the list of parameters as internal list\r
 476 <P>\r
 477 <DD><DL>\r
 478 <DT><B>Parameters:</B><DD><CODE>parameters</CODE> - the list of parameters</DL>\r
 479 </DD>\r
 480 </DL>\r
 481 <HR>\r
 482 \r
 483 <A NAME="getParameters()"><!-- --></A><H3>\r
 484 getParameters</H3>\r
 485 <PRE>\r
 486 public <A HREF="http://java.sun.com/javase/6/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</A>&lt;<A HREF="../../compbio/metadata/Parameter.html" title="class in compbio.metadata">Parameter</A>&lt;<A HREF="../../compbio/metadata/RunnerConfig.html" title="type parameter in RunnerConfig">T</A>&gt;&gt; <B>getParameters</B>()</PRE>\r
 487 <DL>\r
 488 <DD>Returns the list of parameters supported executable of type T. Where
 489  <A HREF="../../compbio/metadata/Parameter.html" title="class in compbio.metadata"><CODE>Parameter</CODE></A> is an <A HREF="../../compbio/metadata/Option.html" title="class in compbio.metadata"><CODE>Option</CODE></A> with value.\r
 490 <P>\r
 491 <DD><DL>\r
 492 \r
 493 <DT><B>Returns:</B><DD>List of <A HREF="../../compbio/metadata/Parameter.html" title="class in compbio.metadata"><CODE>Parameter</CODE></A> supported by type T.</DL>\r
 494 </DD>\r
 495 </DL>\r
 496 <HR>\r
 497 \r
 498 <A NAME="toString()"><!-- --></A><H3>\r
 499 toString</H3>\r
 500 <PRE>\r
 501 public <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> <B>toString</B>()</PRE>\r
 502 <DL>\r
 503 <DD><DL>\r
 504 <DT><B>Overrides:</B><DD><CODE><A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#toString()" title="class or interface in java.lang">toString</A></CODE> in class <CODE><A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</A></CODE></DL>\r
 505 </DD>\r
 506 <DD><DL>\r
 507 </DL>\r
 508 </DD>\r
 509 </DL>\r
 510 <HR>\r
 511 \r
 512 <A NAME="equals(java.lang.Object)"><!-- --></A><H3>\r
 513 equals</H3>\r
 514 <PRE>\r
 515 public boolean <B>equals</B>(<A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</A>&nbsp;obj)</PRE>\r
 516 <DL>\r
 517 <DD><DL>\r
 518 <DT><B>Overrides:</B><DD><CODE><A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#equals(java.lang.Object)" title="class or interface in java.lang">equals</A></CODE> in class <CODE><A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</A></CODE></DL>\r
 519 </DD>\r
 520 <DD><DL>\r
 521 </DL>\r
 522 </DD>\r
 523 </DL>\r
 524 <HR>\r
 525 \r
 526 <A NAME="getArgument(java.lang.String)"><!-- --></A><H3>\r
 527 getArgument</H3>\r
 528 <PRE>\r
 529 public <A HREF="../../compbio/metadata/Option.html" title="class in compbio.metadata">Option</A>&lt;<A HREF="../../compbio/metadata/RunnerConfig.html" title="type parameter in RunnerConfig">T</A>&gt; <B>getArgument</B>(<A HREF="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A>&nbsp;name)</PRE>\r
 530 <DL>\r
 531 <DD>Returns the argument by its name if found, NULL otherwise. Where the
 532  Argument is a common interface for <A HREF="../../compbio/metadata/Option.html" title="class in compbio.metadata"><CODE>Option</CODE></A> and <A HREF="../../compbio/metadata/Parameter.html" title="class in compbio.metadata"><CODE>Parameter</CODE></A>
 533  therefore this method can return either. If you need to retrieve the
 534  Option by its optionNames use @link
 535  <A HREF="../../compbio/metadata/RunnerConfig.html#getArgumentByOptionName(java.lang.String)"><CODE>getArgumentByOptionName(String)</CODE></A> method. The
 536  difference between option name and optionName is explained by the
 537  following example:
 538
 539  <pre>
 540  <name>Sequence type</name>
 541          <description>
 542          --nuc - Assume the sequences are nucleotide.
 543          --amino - Assume the sequences are amino acid. </description>
 544          <optionNames>--amino</optionNames>
 545          <optionNames>--nuc</optionNames>
 546          <optionNames>--auto</optionNames>
 547  </pre>
 548
 549  In the example, the "Sequence type" is a name whereas --amino, --nuc and
 550  --auto are all optionNames. This dichotomy only manifests in
 551  <code>Option</code> never in <code>Parameters</code> as the latter can
 552  only have single <optioNames> element\r
 553 <P>\r
 554 <DD><DL>\r
 555 <DT><B>Parameters:</B><DD><CODE>name</CODE> - the Parameter of Option name\r
 556 <DT><B>Returns:</B><DD><A HREF="../../compbio/metadata/Argument.html" title="interface in compbio.metadata"><CODE>Argument</CODE></A></DL>\r
 557 </DD>\r
 558 </DL>\r
 559 <HR>\r
 560 \r
 561 <A NAME="removeArgument(java.lang.String)"><!-- --></A><H3>\r
 562 removeArgument</H3>\r
 563 <PRE>\r
 564 public boolean <B>removeArgument</B>(<A HREF="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A>&nbsp;name)</PRE>\r
 565 <DL>\r
 566 <DD>Removes the argument <A HREF="../../compbio/metadata/Argument.html" title="interface in compbio.metadata"><CODE>Argument</CODE></A> if found. Where Argument is either
 567  <A HREF="../../compbio/metadata/Option.html" title="class in compbio.metadata"><CODE>Option</CODE></A> or <A HREF="../../compbio/metadata/Parameter.html" title="class in compbio.metadata"><CODE>Parameter</CODE></A>.\r
 568 <P>\r
 569 <DD><DL>\r
 570 <DT><B>Parameters:</B><DD><CODE>name</CODE> - of the argument\r
 571 <DT><B>Returns:</B><DD>true if argument was removed, false otherwise</DL>\r
 572 </DD>\r
 573 </DL>\r
 574 <HR>\r
 575 \r
 576 <A NAME="getArgumentByOptionName(java.lang.String)"><!-- --></A><H3>\r
 577 getArgumentByOptionName</H3>\r
 578 <PRE>\r
 579 public <A HREF="../../compbio/metadata/Option.html" title="class in compbio.metadata">Option</A>&lt;<A HREF="../../compbio/metadata/RunnerConfig.html" title="type parameter in RunnerConfig">T</A>&gt; <B>getArgumentByOptionName</B>(<A HREF="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A>&nbsp;optionName)</PRE>\r
 580 <DL>\r
 581 <DD>Returns the argument by option name, NULL if the argument is not found\r
 582 <P>\r
 583 <DD><DL>\r
 584 <DT><B>Parameters:</B><DD><CODE>optionName</CODE> - - the optionName. This is not the same as an Option name.
 585
 586             For example:
 587
 588             <pre>
 589             <name>Output sequences order</name>
 590                           <description>--inputorder - Output order: same as input.
 591                            --reorder - Output order: aligned. Default: same as input</description>
 592                           <optionNames>--inputorder</optionNames>
 593                           <optionNames>--reorder</optionNames>
 594  </pre>
 595
 596             The name of the option in the example is
 597             "Output sequences order" whereas optionNames are
 598             "--inputorder" and "--reorder". If you need to retrieve the
 599             Option or Parameter by its names use
 600             <A HREF="../../compbio/metadata/RunnerConfig.html#getArgument(java.lang.String)"><CODE>getArgument(String)</CODE></A> method\r
 601 <DT><B>Returns:</B><DD>Option</DL>\r
 602 </DD>\r
 603 </DL>\r
 604 <HR>\r
 605 \r
 606 <A NAME="removeArgumentByOptionName(java.lang.String)"><!-- --></A><H3>\r
 607 removeArgumentByOptionName</H3>\r
 608 <PRE>\r
 609 public boolean <B>removeArgumentByOptionName</B>(<A HREF="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A>&nbsp;optionName)</PRE>\r
 610 <DL>\r
 611 <DD>Removes the argument which can be a Parameter or an Option instance by
 612  the value in <optionNames> element of the runner configuration
 613  descriptor.\r
 614 <P>\r
 615 <DD><DL>\r
 616 <DT><B>Parameters:</B><DD><CODE>optionName</CODE> - the optionName of the option, do not confuse with the name!\r
 617 <DT><B>Returns:</B><DD>true if argument with optionName exists and was removed, false
 618          otherwise<DT><B>See Also:</B><DD><A HREF="../../compbio/metadata/RunnerConfig.html#getArgumentByOptionName(java.lang.String)"><CODE>for destinctions
 619       between optionNames and the name of the Option</CODE></A></DL>\r
 620 </DD>\r
 621 </DL>\r
 622 <HR>\r
 623 \r
 624 <A NAME="validate()"><!-- --></A><H3>\r
 625 validate</H3>\r
 626 <PRE>\r
 627 public void <B>validate</B>()\r
 628               throws <A HREF="http://java.sun.com/javase/6/docs/api/javax/xml/bind/ValidationException.html?is-external=true" title="class or interface in javax.xml.bind">ValidationException</A></PRE>\r
 629 <DL>\r
 630 <DD>Validate the value of the argument. Checks whether the argument value is
 631  in the valid values range.\r
 632 <P>\r
 633 <DD><DL>\r
 634 \r
 635 <DT><B>Throws:</B>\r
 636 <DD><CODE><A HREF="http://java.sun.com/javase/6/docs/api/javax/xml/bind/ValidationException.html?is-external=true" title="class or interface in javax.xml.bind">ValidationException</A></CODE> - if any of the arguments found invalid which is when
 637              <dl>
 638              <li>Parameter value outside <A HREF="../../compbio/metadata/ValueConstrain.html" title="class in compbio.metadata"><CODE>ValueConstrain</CODE></A> boundary</li>
 639              <li>Parameter name is not listed in possible values</li>
 640              </dl></DL>\r
 641 </DD>\r
 642 </DL>\r
 643 <!-- ========= END OF CLASS DATA ========= -->\r
 644 <HR>\r
 645 \r
 646 \r
 647 <!-- ======= START OF BOTTOM NAVBAR ====== -->\r
 648 <A NAME="navbar_bottom"><!-- --></A>\r
 649 <A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>\r
 650 <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">\r
 651 <TR>\r
 652 <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">\r
 653 <A NAME="navbar_bottom_firstrow"><!-- --></A>\r
 654 <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">\r
 655   <TR ALIGN="center" VALIGN="top">\r
 656   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>\r
 657   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>\r
 658   <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>\r
 659   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="class-use/RunnerConfig.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>\r
 660   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>\r
 661   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>\r
 662   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../index-files/index-1.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>\r
 663   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>\r
 664   </TR>\r
 665 </TABLE>\r
 666 </TD>\r
 667 <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>\r
 668 </EM>\r
 669 </TD>\r
 670 </TR>\r
 671 \r
 672 <TR>\r
 673 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">\r
 674 &nbsp;<A HREF="../../compbio/metadata/ResultNotAvailableException.html" title="class in compbio.metadata"><B>PREV CLASS</B></A>&nbsp;\r
 675 &nbsp;<A HREF="../../compbio/metadata/UnsupportedRuntimeException.html" title="class in compbio.metadata"><B>NEXT CLASS</B></A></FONT></TD>\r
 676 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">\r
 677   <A HREF="../../index.html?compbio/metadata/RunnerConfig.html" target="_top"><B>FRAMES</B></A>  &nbsp;\r
 678 &nbsp;<A HREF="RunnerConfig.html" target="_top"><B>NO FRAMES</B></A>  &nbsp;\r
 679 &nbsp;<SCRIPT type="text/javascript">\r
 680   <!--\r
 681   if(window==top) {\r
 682     document.writeln('<A HREF="../../allclasses-noframe.html"><B>All Classes</B></A>');\r
 683   }\r
 684   //-->\r
 685 </SCRIPT>\r
 686 <NOSCRIPT>\r
 687   <A HREF="../../allclasses-noframe.html"><B>All Classes</B></A>\r
 688 </NOSCRIPT>\r
 689 \r
 690 \r
 691 </FONT></TD>\r
 692 </TR>\r
 693 <TR>\r
 694 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">\r
 695   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
 696 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">\r
 697 DETAIL:&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>\r
 698 </TR>\r
 699 </TABLE>\r
 700 <A NAME="skip-navbar_bottom"></A>\r
 701 <!-- ======== END OF BOTTOM NAVBAR ======= -->\r
 702 \r
 703 <HR>\r
 704 \r
 705 </BODY>\r
 706 </HTML>\r