website/full_javadoc/compbio/metadata/Parameter.html

   1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">\r
   2 <!--NewPage-->\r
   3 <HTML>\r
   4 <HEAD>\r
   5 <!-- Generated by javadoc (build 1.6.0_14) on Wed Feb 17 16:46:50 GMT 2010 -->\r
   6 <TITLE>\r
   7 Parameter\r
   8 </TITLE>\r
   9 \r
  10 <META NAME="date" CONTENT="2010-02-17">\r
  11 \r
  12 <LINK REL ="stylesheet" TYPE="text/css" HREF="../../stylesheet.css" TITLE="Style">\r
  13 \r
  14 <SCRIPT type="text/javascript">\r
  15 function windowTitle()\r
  16 {\r
  17     if (location.href.indexOf('is-external=true') == -1) {\r
  18         parent.document.title="Parameter";\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/Parameter.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/Option.html" title="class in compbio.metadata"><B>PREV CLASS</B></A>&nbsp;\r
  59 &nbsp;<A HREF="../../compbio/metadata/Preset.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/Parameter.html" target="_top"><B>FRAMES</B></A>  &nbsp;\r
  62 &nbsp;<A HREF="Parameter.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 Parameter&lt;T&gt;</H2>\r
  94 <PRE>\r
  95 java.lang.Object\r
  96   <IMG SRC="../../resources/inherit.gif" ALT="extended by "><A HREF="../../compbio/metadata/Option.html" title="class in compbio.metadata">compbio.metadata.Option</A>&lt;T&gt;\r
  97       <IMG SRC="../../resources/inherit.gif" ALT="extended by "><B>compbio.metadata.Parameter&lt;T&gt;</B>\r
  98 </PRE>\r
  99 <DL>\r
 100 <DT><B>All Implemented Interfaces:</B> <DD><A HREF="../../compbio/metadata/Argument.html" title="interface in compbio.metadata">Argument</A>&lt;T&gt;</DD>\r
 101 </DL>\r
 102 <HR>\r
 103 <DL>\r
 104 <DT><PRE>public class <B>Parameter&lt;T&gt;</B><DT>extends <A HREF="../../compbio/metadata/Option.html" title="class in compbio.metadata">Option</A>&lt;T&gt;</DL>\r
 105 </PRE>\r
 106 \r
 107 <P>\r
 108 A single value containing option supported by the web service e.g.
 109  seqType=protein. Where seqType is a optionName and protein is one of
 110  possibleValues\r
 111 <P>\r
 112 \r
 113 <P>\r
 114 <DL>\r
 115 <DT><B>Author:</B></DT>\r
 116   <DD>pvtroshin
 117
 118          Date November 2009</DD>\r
 119 <DT><B>See Also:</B><DD><A HREF="../../compbio/metadata/Option.html" title="class in compbio.metadata"><CODE>Option</CODE></A>, \r
 120 <A HREF="../../compbio/metadata/Argument.html" title="interface in compbio.metadata"><CODE>Argument</CODE></A></DL>\r
 121 <HR>\r
 122 \r
 123 <P>\r
 124 \r
 125 <!-- ======== CONSTRUCTOR SUMMARY ======== -->\r
 126 \r
 127 <A NAME="constructor_summary"><!-- --></A>\r
 128 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">\r
 129 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">\r
 130 <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">\r
 131 <B>Constructor Summary</B></FONT></TH>\r
 132 </TR>\r
 133 <TR BGCOLOR="white" CLASS="TableRowColor">\r
 134 <TD><CODE><B><A HREF="../../compbio/metadata/Parameter.html#Parameter(java.lang.String, java.lang.String)">Parameter</A></B>(java.lang.String&nbsp;name,\r
 135           java.lang.String&nbsp;description)</CODE>\r
 136 \r
 137 <BR>\r
 138 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>\r
 139 </TR>\r
 140 </TABLE>\r
 141 &nbsp;\r
 142 <!-- ========== METHOD SUMMARY =========== -->\r
 143 \r
 144 <A NAME="method_summary"><!-- --></A>\r
 145 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">\r
 146 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">\r
 147 <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">\r
 148 <B>Method Summary</B></FONT></TH>\r
 149 </TR>\r
 150 <TR BGCOLOR="white" CLASS="TableRowColor">\r
 151 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
 152 <CODE>&nbsp;java.util.Set&lt;java.lang.String&gt;</CODE></FONT></TD>\r
 153 <TD><CODE><B><A HREF="../../compbio/metadata/Parameter.html#addOptionNames(java.lang.String...)">addOptionNames</A></B>(java.lang.String...&nbsp;value)</CODE>\r
 154 \r
 155 <BR>\r
 156 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Adds an option to the optionName list</TD>\r
 157 </TR>\r
 158 <TR BGCOLOR="white" CLASS="TableRowColor">\r
 159 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
 160 <CODE>&nbsp;java.util.Set&lt;java.lang.String&gt;</CODE></FONT></TD>\r
 161 <TD><CODE><B><A HREF="../../compbio/metadata/Parameter.html#addPossibleValues(java.lang.String...)">addPossibleValues</A></B>(java.lang.String...&nbsp;value)</CODE>\r
 162 \r
 163 <BR>\r
 164 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>\r
 165 </TR>\r
 166 <TR BGCOLOR="white" CLASS="TableRowColor">\r
 167 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
 168 <CODE>&nbsp;boolean</CODE></FONT></TD>\r
 169 <TD><CODE><B><A HREF="../../compbio/metadata/Parameter.html#equals(java.lang.Object)">equals</A></B>(java.lang.Object&nbsp;obj)</CODE>\r
 170 \r
 171 <BR>\r
 172 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>\r
 173 </TR>\r
 174 <TR BGCOLOR="white" CLASS="TableRowColor">\r
 175 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
 176 <CODE>&nbsp;java.lang.String</CODE></FONT></TD>\r
 177 <TD><CODE><B><A HREF="../../compbio/metadata/Parameter.html#getOptionName()">getOptionName</A></B>()</CODE>\r
 178 \r
 179 <BR>\r
 180 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>\r
 181 </TR>\r
 182 <TR BGCOLOR="white" CLASS="TableRowColor">\r
 183 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
 184 <CODE>&nbsp;java.util.List&lt;java.lang.String&gt;</CODE></FONT></TD>\r
 185 <TD><CODE><B><A HREF="../../compbio/metadata/Parameter.html#getPossibleValues()">getPossibleValues</A></B>()</CODE>\r
 186 \r
 187 <BR>\r
 188 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;List is more convenient to work with</TD>\r
 189 </TR>\r
 190 <TR BGCOLOR="white" CLASS="TableRowColor">\r
 191 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
 192 <CODE>&nbsp;<A HREF="../../compbio/metadata/ValueConstrain.html" title="class in compbio.metadata">ValueConstrain</A></CODE></FONT></TD>\r
 193 <TD><CODE><B><A HREF="../../compbio/metadata/Parameter.html#getValidValue()">getValidValue</A></B>()</CODE>\r
 194 \r
 195 <BR>\r
 196 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>\r
 197 </TR>\r
 198 <TR BGCOLOR="white" CLASS="TableRowColor">\r
 199 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
 200 <CODE>&nbsp;int</CODE></FONT></TD>\r
 201 <TD><CODE><B><A HREF="../../compbio/metadata/Parameter.html#hashCode()">hashCode</A></B>()</CODE>\r
 202 \r
 203 <BR>\r
 204 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>\r
 205 </TR>\r
 206 <TR BGCOLOR="white" CLASS="TableRowColor">\r
 207 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
 208 <CODE>&nbsp;void</CODE></FONT></TD>\r
 209 <TD><CODE><B><A HREF="../../compbio/metadata/Parameter.html#setDefaultValue(java.lang.String)">setDefaultValue</A></B>(java.lang.String&nbsp;defaultVal)</CODE>\r
 210 \r
 211 <BR>\r
 212 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Sets one of the values defined in optionList as default.</TD>\r
 213 </TR>\r
 214 <TR BGCOLOR="white" CLASS="TableRowColor">\r
 215 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
 216 <CODE>&nbsp;void</CODE></FONT></TD>\r
 217 <TD><CODE><B><A HREF="../../compbio/metadata/Parameter.html#setOptionName(java.lang.String)">setOptionName</A></B>(java.lang.String&nbsp;optionName)</CODE>\r
 218 \r
 219 <BR>\r
 220 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>\r
 221 </TR>\r
 222 <TR BGCOLOR="white" CLASS="TableRowColor">\r
 223 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
 224 <CODE>&nbsp;void</CODE></FONT></TD>\r
 225 <TD><CODE><B><A HREF="../../compbio/metadata/Parameter.html#setOptionNames(java.util.Set)">setOptionNames</A></B>(java.util.Set&lt;java.lang.String&gt;&nbsp;optionName)</CODE>\r
 226 \r
 227 <BR>\r
 228 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>\r
 229 </TR>\r
 230 <TR BGCOLOR="white" CLASS="TableRowColor">\r
 231 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
 232 <CODE>&nbsp;void</CODE></FONT></TD>\r
 233 <TD><CODE><B><A HREF="../../compbio/metadata/Parameter.html#setPossibleValues(java.util.Set)">setPossibleValues</A></B>(java.util.Set&lt;java.lang.String&gt;&nbsp;possibleValues)</CODE>\r
 234 \r
 235 <BR>\r
 236 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>\r
 237 </TR>\r
 238 <TR BGCOLOR="white" CLASS="TableRowColor">\r
 239 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
 240 <CODE>&nbsp;void</CODE></FONT></TD>\r
 241 <TD><CODE><B><A HREF="../../compbio/metadata/Parameter.html#setValidValue(compbio.metadata.ValueConstrain)">setValidValue</A></B>(<A HREF="../../compbio/metadata/ValueConstrain.html" title="class in compbio.metadata">ValueConstrain</A>&nbsp;validValue)</CODE>\r
 242 \r
 243 <BR>\r
 244 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>\r
 245 </TR>\r
 246 <TR BGCOLOR="white" CLASS="TableRowColor">\r
 247 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
 248 <CODE>&nbsp;java.lang.String</CODE></FONT></TD>\r
 249 <TD><CODE><B><A HREF="../../compbio/metadata/Parameter.html#toCommand(java.lang.String)">toCommand</A></B>(java.lang.String&nbsp;nameValueSeparator)</CODE>\r
 250 \r
 251 <BR>\r
 252 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Convert the option to the command string.</TD>\r
 253 </TR>\r
 254 <TR BGCOLOR="white" CLASS="TableRowColor">\r
 255 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
 256 <CODE>&nbsp;java.lang.String</CODE></FONT></TD>\r
 257 <TD><CODE><B><A HREF="../../compbio/metadata/Parameter.html#toString()">toString</A></B>()</CODE>\r
 258 \r
 259 <BR>\r
 260 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>\r
 261 </TR>\r
 262 </TABLE>\r
 263 &nbsp;<A NAME="methods_inherited_from_class_compbio.metadata.Option"><!-- --></A>\r
 264 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">\r
 265 <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">\r
 266 <TH ALIGN="left"><B>Methods inherited from class compbio.metadata.<A HREF="../../compbio/metadata/Option.html" title="class in compbio.metadata">Option</A></B></TH>\r
 267 </TR>\r
 268 <TR BGCOLOR="white" CLASS="TableRowColor">\r
 269 <TD><CODE><A HREF="../../compbio/metadata/Option.html#getDefaultValue()">getDefaultValue</A>, <A HREF="../../compbio/metadata/Option.html#getDescription()">getDescription</A>, <A HREF="../../compbio/metadata/Option.html#getFurtherDetails()">getFurtherDetails</A>, <A HREF="../../compbio/metadata/Option.html#getName()">getName</A>, <A HREF="../../compbio/metadata/Option.html#getOptionNames()">getOptionNames</A>, <A HREF="../../compbio/metadata/Option.html#isRequired()">isRequired</A>, <A HREF="../../compbio/metadata/Option.html#setDescription(java.lang.String)">setDescription</A>, <A HREF="../../compbio/metadata/Option.html#setFurtherDetails(java.net.URL)">setFurtherDetails</A>, <A HREF="../../compbio/metadata/Option.html#setName(java.lang.String)">setName</A>, <A HREF="../../compbio/metadata/Option.html#setRequired(boolean)">setRequired</A>, <A HREF="../../compbio/metadata/Option.html#setValue(java.lang.String)">setValue</A></CODE></TD>\r
 270 </TR>\r
 271 </TABLE>\r
 272 &nbsp;<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>\r
 273 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">\r
 274 <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">\r
 275 <TH ALIGN="left"><B>Methods inherited from class java.lang.Object</B></TH>\r
 276 </TR>\r
 277 <TR BGCOLOR="white" CLASS="TableRowColor">\r
 278 <TD><CODE>getClass, notify, notifyAll, wait, wait, wait</CODE></TD>\r
 279 </TR>\r
 280 </TABLE>\r
 281 &nbsp;\r
 282 <P>\r
 283 \r
 284 <!-- ========= CONSTRUCTOR DETAIL ======== -->\r
 285 \r
 286 <A NAME="constructor_detail"><!-- --></A>\r
 287 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">\r
 288 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">\r
 289 <TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">\r
 290 <B>Constructor Detail</B></FONT></TH>\r
 291 </TR>\r
 292 </TABLE>\r
 293 \r
 294 <A NAME="Parameter(java.lang.String, java.lang.String)"><!-- --></A><H3>\r
 295 Parameter</H3>\r
 296 <PRE>\r
 297 public <B>Parameter</B>(java.lang.String&nbsp;name,\r
 298                  java.lang.String&nbsp;description)</PRE>\r
 299 <DL>\r
 300 </DL>\r
 301 \r
 302 <!-- ============ METHOD DETAIL ========== -->\r
 303 \r
 304 <A NAME="method_detail"><!-- --></A>\r
 305 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">\r
 306 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">\r
 307 <TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">\r
 308 <B>Method Detail</B></FONT></TH>\r
 309 </TR>\r
 310 </TABLE>\r
 311 \r
 312 <A NAME="getValidValue()"><!-- --></A><H3>\r
 313 getValidValue</H3>\r
 314 <PRE>\r
 315 public <A HREF="../../compbio/metadata/ValueConstrain.html" title="class in compbio.metadata">ValueConstrain</A> <B>getValidValue</B>()</PRE>\r
 316 <DL>\r
 317 <DD><DL>\r
 318 </DL>\r
 319 </DD>\r
 320 </DL>\r
 321 <HR>\r
 322 \r
 323 <A NAME="setValidValue(compbio.metadata.ValueConstrain)"><!-- --></A><H3>\r
 324 setValidValue</H3>\r
 325 <PRE>\r
 326 public void <B>setValidValue</B>(<A HREF="../../compbio/metadata/ValueConstrain.html" title="class in compbio.metadata">ValueConstrain</A>&nbsp;validValue)</PRE>\r
 327 <DL>\r
 328 <DD><DL>\r
 329 </DL>\r
 330 </DD>\r
 331 </DL>\r
 332 <HR>\r
 333 \r
 334 <A NAME="toString()"><!-- --></A><H3>\r
 335 toString</H3>\r
 336 <PRE>\r
 337 public java.lang.String <B>toString</B>()</PRE>\r
 338 <DL>\r
 339 <DD><DL>\r
 340 <DT><B>Overrides:</B><DD><CODE><A HREF="../../compbio/metadata/Option.html#toString()">toString</A></CODE> in class <CODE><A HREF="../../compbio/metadata/Option.html" title="class in compbio.metadata">Option</A>&lt;<A HREF="../../compbio/metadata/Parameter.html" title="type parameter in Parameter">T</A>&gt;</CODE></DL>\r
 341 </DD>\r
 342 <DD><DL>\r
 343 </DL>\r
 344 </DD>\r
 345 </DL>\r
 346 <HR>\r
 347 \r
 348 <A NAME="toCommand(java.lang.String)"><!-- --></A><H3>\r
 349 toCommand</H3>\r
 350 <PRE>\r
 351 public java.lang.String <B>toCommand</B>(java.lang.String&nbsp;nameValueSeparator)</PRE>\r
 352 <DL>\r
 353 <DD><B>Description copied from class: <CODE><A HREF="../../compbio/metadata/Option.html#toCommand(java.lang.String)">Option</A></CODE></B></DD>\r
 354 <DD>Convert the option to the command string.\r
 355 <P>\r
 356 <DD><DL>\r
 357 <DT><B>Overrides:</B><DD><CODE><A HREF="../../compbio/metadata/Option.html#toCommand(java.lang.String)">toCommand</A></CODE> in class <CODE><A HREF="../../compbio/metadata/Option.html" title="class in compbio.metadata">Option</A>&lt;<A HREF="../../compbio/metadata/Parameter.html" title="type parameter in Parameter">T</A>&gt;</CODE></DL>\r
 358 </DD>\r
 359 <DD><DL>\r
 360 \r
 361 <DT><B>Returns:</B><DD>If only one optionName is defined, than it is returned, if many
 362          option names are defined, then the defaultValue is returned.
 363          Option must have a default value if there are many optionNames to
 364          be valid.</DL>\r
 365 </DD>\r
 366 </DL>\r
 367 <HR>\r
 368 \r
 369 <A NAME="equals(java.lang.Object)"><!-- --></A><H3>\r
 370 equals</H3>\r
 371 <PRE>\r
 372 public boolean <B>equals</B>(java.lang.Object&nbsp;obj)</PRE>\r
 373 <DL>\r
 374 <DD><DL>\r
 375 <DT><B>Overrides:</B><DD><CODE><A HREF="../../compbio/metadata/Option.html#equals(java.lang.Object)">equals</A></CODE> in class <CODE><A HREF="../../compbio/metadata/Option.html" title="class in compbio.metadata">Option</A>&lt;<A HREF="../../compbio/metadata/Parameter.html" title="type parameter in Parameter">T</A>&gt;</CODE></DL>\r
 376 </DD>\r
 377 <DD><DL>\r
 378 </DL>\r
 379 </DD>\r
 380 </DL>\r
 381 <HR>\r
 382 \r
 383 <A NAME="getPossibleValues()"><!-- --></A><H3>\r
 384 getPossibleValues</H3>\r
 385 <PRE>\r
 386 public java.util.List&lt;java.lang.String&gt; <B>getPossibleValues</B>()</PRE>\r
 387 <DL>\r
 388 <DD>List is more convenient to work with\r
 389 <P>\r
 390 <DD><DL>\r
 391 <DT><B>Specified by:</B><DD><CODE><A HREF="../../compbio/metadata/Argument.html#getPossibleValues()">getPossibleValues</A></CODE> in interface <CODE><A HREF="../../compbio/metadata/Argument.html" title="interface in compbio.metadata">Argument</A>&lt;<A HREF="../../compbio/metadata/Parameter.html" title="type parameter in Parameter">T</A>&gt;</CODE><DT><B>Overrides:</B><DD><CODE><A HREF="../../compbio/metadata/Option.html#getPossibleValues()">getPossibleValues</A></CODE> in class <CODE><A HREF="../../compbio/metadata/Option.html" title="class in compbio.metadata">Option</A>&lt;<A HREF="../../compbio/metadata/Parameter.html" title="type parameter in Parameter">T</A>&gt;</CODE></DL>\r
 392 </DD>\r
 393 <DD><DL>\r
 394 \r
 395 <DT><B>Returns:</B><DD>List of String</DL>\r
 396 </DD>\r
 397 </DL>\r
 398 <HR>\r
 399 \r
 400 <A NAME="setPossibleValues(java.util.Set)"><!-- --></A><H3>\r
 401 setPossibleValues</H3>\r
 402 <PRE>\r
 403 public void <B>setPossibleValues</B>(java.util.Set&lt;java.lang.String&gt;&nbsp;possibleValues)</PRE>\r
 404 <DL>\r
 405 <DD><DL>\r
 406 </DL>\r
 407 </DD>\r
 408 </DL>\r
 409 <HR>\r
 410 \r
 411 <A NAME="addPossibleValues(java.lang.String...)"><!-- --></A><H3>\r
 412 addPossibleValues</H3>\r
 413 <PRE>\r
 414 public java.util.Set&lt;java.lang.String&gt; <B>addPossibleValues</B>(java.lang.String...&nbsp;value)</PRE>\r
 415 <DL>\r
 416 <DD><DL>\r
 417 </DL>\r
 418 </DD>\r
 419 </DL>\r
 420 <HR>\r
 421 \r
 422 <A NAME="hashCode()"><!-- --></A><H3>\r
 423 hashCode</H3>\r
 424 <PRE>\r
 425 public int <B>hashCode</B>()</PRE>\r
 426 <DL>\r
 427 <DD><DL>\r
 428 <DT><B>Overrides:</B><DD><CODE><A HREF="../../compbio/metadata/Option.html#hashCode()">hashCode</A></CODE> in class <CODE><A HREF="../../compbio/metadata/Option.html" title="class in compbio.metadata">Option</A>&lt;<A HREF="../../compbio/metadata/Parameter.html" title="type parameter in Parameter">T</A>&gt;</CODE></DL>\r
 429 </DD>\r
 430 <DD><DL>\r
 431 </DL>\r
 432 </DD>\r
 433 </DL>\r
 434 <HR>\r
 435 \r
 436 <A NAME="setOptionNames(java.util.Set)"><!-- --></A><H3>\r
 437 setOptionNames</H3>\r
 438 <PRE>\r
 439 public void <B>setOptionNames</B>(java.util.Set&lt;java.lang.String&gt;&nbsp;optionName)</PRE>\r
 440 <DL>\r
 441 <DD><DL>\r
 442 <DT><B>Overrides:</B><DD><CODE><A HREF="../../compbio/metadata/Option.html#setOptionNames(java.util.Set)">setOptionNames</A></CODE> in class <CODE><A HREF="../../compbio/metadata/Option.html" title="class in compbio.metadata">Option</A>&lt;<A HREF="../../compbio/metadata/Parameter.html" title="type parameter in Parameter">T</A>&gt;</CODE></DL>\r
 443 </DD>\r
 444 <DD><DL>\r
 445 </DL>\r
 446 </DD>\r
 447 </DL>\r
 448 <HR>\r
 449 \r
 450 <A NAME="addOptionNames(java.lang.String...)"><!-- --></A><H3>\r
 451 addOptionNames</H3>\r
 452 <PRE>\r
 453 public java.util.Set&lt;java.lang.String&gt; <B>addOptionNames</B>(java.lang.String...&nbsp;value)</PRE>\r
 454 <DL>\r
 455 <DD><B>Description copied from class: <CODE><A HREF="../../compbio/metadata/Option.html#addOptionNames(java.lang.String...)">Option</A></CODE></B></DD>\r
 456 <DD>Adds an option to the optionName list\r
 457 <P>\r
 458 <DD><DL>\r
 459 <DT><B>Overrides:</B><DD><CODE><A HREF="../../compbio/metadata/Option.html#addOptionNames(java.lang.String...)">addOptionNames</A></CODE> in class <CODE><A HREF="../../compbio/metadata/Option.html" title="class in compbio.metadata">Option</A>&lt;<A HREF="../../compbio/metadata/Parameter.html" title="type parameter in Parameter">T</A>&gt;</CODE></DL>\r
 460 </DD>\r
 461 <DD><DL>\r
 462 \r
 463 <DT><B>Returns:</B><DD>modified optionName list</DL>\r
 464 </DD>\r
 465 </DL>\r
 466 <HR>\r
 467 \r
 468 <A NAME="getOptionName()"><!-- --></A><H3>\r
 469 getOptionName</H3>\r
 470 <PRE>\r
 471 public java.lang.String <B>getOptionName</B>()</PRE>\r
 472 <DL>\r
 473 <DD><DL>\r
 474 </DL>\r
 475 </DD>\r
 476 </DL>\r
 477 <HR>\r
 478 \r
 479 <A NAME="setOptionName(java.lang.String)"><!-- --></A><H3>\r
 480 setOptionName</H3>\r
 481 <PRE>\r
 482 public void <B>setOptionName</B>(java.lang.String&nbsp;optionName)</PRE>\r
 483 <DL>\r
 484 <DD><DL>\r
 485 </DL>\r
 486 </DD>\r
 487 </DL>\r
 488 <HR>\r
 489 \r
 490 <A NAME="setDefaultValue(java.lang.String)"><!-- --></A><H3>\r
 491 setDefaultValue</H3>\r
 492 <PRE>\r
 493 public void <B>setDefaultValue</B>(java.lang.String&nbsp;defaultVal)\r
 494                      throws <A HREF="../../compbio/metadata/WrongParameterException.html" title="class in compbio.metadata">WrongParameterException</A></PRE>\r
 495 <DL>\r
 496 <DD><B>Description copied from class: <CODE><A HREF="../../compbio/metadata/Option.html#setDefaultValue(java.lang.String)">Option</A></CODE></B></DD>\r
 497 <DD>Sets one of the values defined in optionList as default. Attempting set
 498  the value not listed there will result in WrongParameter exception\r
 499 <P>\r
 500 <DD><DL>\r
 501 <DT><B>Overrides:</B><DD><CODE><A HREF="../../compbio/metadata/Option.html#setDefaultValue(java.lang.String)">setDefaultValue</A></CODE> in class <CODE><A HREF="../../compbio/metadata/Option.html" title="class in compbio.metadata">Option</A>&lt;<A HREF="../../compbio/metadata/Parameter.html" title="type parameter in Parameter">T</A>&gt;</CODE></DL>\r
 502 </DD>\r
 503 <DD><DL>\r
 504 \r
 505 <DT><B>Throws:</B>\r
 506 <DD><CODE><A HREF="../../compbio/metadata/WrongParameterException.html" title="class in compbio.metadata">WrongParameterException</A></CODE> - is thrown if the defaultValue is not found in optionList</DL>\r
 507 </DD>\r
 508 </DL>\r
 509 <!-- ========= END OF CLASS DATA ========= -->\r
 510 <HR>\r
 511 \r
 512 \r
 513 <!-- ======= START OF BOTTOM NAVBAR ====== -->\r
 514 <A NAME="navbar_bottom"><!-- --></A>\r
 515 <A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>\r
 516 <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">\r
 517 <TR>\r
 518 <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">\r
 519 <A NAME="navbar_bottom_firstrow"><!-- --></A>\r
 520 <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">\r
 521   <TR ALIGN="center" VALIGN="top">\r
 522   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>\r
 523   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>\r
 524   <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>\r
 525   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="class-use/Parameter.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>\r
 526   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>\r
 527   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>\r
 528   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../index-files/index-1.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>\r
 529   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>\r
 530   </TR>\r
 531 </TABLE>\r
 532 </TD>\r
 533 <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>\r
 534 </EM>\r
 535 </TD>\r
 536 </TR>\r
 537 \r
 538 <TR>\r
 539 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">\r
 540 &nbsp;<A HREF="../../compbio/metadata/Option.html" title="class in compbio.metadata"><B>PREV CLASS</B></A>&nbsp;\r
 541 &nbsp;<A HREF="../../compbio/metadata/Preset.html" title="class in compbio.metadata"><B>NEXT CLASS</B></A></FONT></TD>\r
 542 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">\r
 543   <A HREF="../../index.html?compbio/metadata/Parameter.html" target="_top"><B>FRAMES</B></A>  &nbsp;\r
 544 &nbsp;<A HREF="Parameter.html" target="_top"><B>NO FRAMES</B></A>  &nbsp;\r
 545 &nbsp;<SCRIPT type="text/javascript">\r
 546   <!--\r
 547   if(window==top) {\r
 548     document.writeln('<A HREF="../../allclasses-noframe.html"><B>All Classes</B></A>');\r
 549   }\r
 550   //-->\r
 551 </SCRIPT>\r
 552 <NOSCRIPT>\r
 553   <A HREF="../../allclasses-noframe.html"><B>All Classes</B></A>\r
 554 </NOSCRIPT>\r
 555 \r
 556 \r
 557 </FONT></TD>\r
 558 </TR>\r
 559 <TR>\r
 560 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">\r
 561   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
 562 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">\r
 563 DETAIL:&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>\r
 564 </TR>\r
 565 </TABLE>\r
 566 <A NAME="skip-navbar_bottom"></A>\r
 567 <!-- ======== END OF BOTTOM NAVBAR ======= -->\r
 568 \r
 569 <HR>\r
 570 \r
 571 </BODY>\r
 572 </HTML>\r