website/docs/dm_javadoc/compbio/metadata/Parameter.html

   1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
   2 <!-- NewPage -->
   3 <html lang="en">
   4 <head>
   5 <!-- Generated by javadoc (1.8.0_121) on Fri Apr 21 15:31:59 BST 2017 -->
   6 <title>Parameter</title>
   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>
  10 </head>
  11 <body>
  12 <script type="text/javascript"><!--
  13     try {
  14         if (location.href.indexOf('is-external=true') == -1) {
  15             parent.document.title="Parameter";
  16         }
  17     }
  18     catch(err) {
  19     }
  20 //-->
  21 var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":10,"i9":10,"i10":10,"i11":10,"i12":10,"i13":10,"i14":10,"i15":10,"i16":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";
  27 </script>
  28 <noscript>
  29 <div>JavaScript is disabled on your browser.</div>
  30 </noscript>
  31 <!-- ========= START OF TOP NAVBAR ======= -->
  32 <div class="topNav"><a name="navbar.top">
  33 <!--   -->
  34 </a>
  35 <div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
  36 <a name="navbar.top.firstrow">
  37 <!--   -->
  38 </a>
  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/Parameter.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>
  48 </ul>
  49 </div>
  50 <div class="subNav">
  51 <ul class="navList">
  52 <li><a href="../../compbio/metadata/Option.html" title="class in compbio.metadata"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
  53 <li><a href="../../compbio/metadata/Preset.html" title="class in compbio.metadata"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
  54 </ul>
  55 <ul class="navList">
  56 <li><a href="../../index.html?compbio/metadata/Parameter.html" target="_top">Frames</a></li>
  57 <li><a href="Parameter.html" target="_top">No&nbsp;Frames</a></li>
  58 </ul>
  59 <ul class="navList" id="allclasses_navbar_top">
  60 <li><a href="../../allclasses-noframe.html">All&nbsp;Classes</a></li>
  61 </ul>
  62 <div>
  63 <script type="text/javascript"><!--
  64   allClassesLink = document.getElementById("allclasses_navbar_top");
  65   if(window==top) {
  66     allClassesLink.style.display = "block";
  67   }
  68   else {
  69     allClassesLink.style.display = "none";
  70   }
  71   //-->
  72 </script>
  73 </div>
  74 <div>
  75 <ul class="subNavList">
  76 <li>Summary:&nbsp;</li>
  77 <li>Nested&nbsp;|&nbsp;</li>
  78 <li><a href="#field.summary">Field</a>&nbsp;|&nbsp;</li>
  79 <li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
  80 <li><a href="#method.summary">Method</a></li>
  81 </ul>
  82 <ul class="subNavList">
  83 <li>Detail:&nbsp;</li>
  84 <li><a href="#field.detail">Field</a>&nbsp;|&nbsp;</li>
  85 <li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
  86 <li><a href="#method.detail">Method</a></li>
  87 </ul>
  88 </div>
  89 <a name="skip.navbar.top">
  90 <!--   -->
  91 </a></div>
  92 <!-- ========= END OF TOP NAVBAR ========= -->
  93 <!-- ======== START OF CLASS DATA ======== -->
  94 <div class="header">
  95 <div class="subTitle">compbio.metadata</div>
  96 <h2 title="Class Parameter" class="title">Class Parameter&lt;T&gt;</h2>
  97 </div>
  98 <div class="contentContainer">
  99 <ul class="inheritance">
 100 <li>java.lang.Object</li>
 101 <li>
 102 <ul class="inheritance">
 103 <li><a href="../../compbio/metadata/Option.html" title="class in compbio.metadata">compbio.metadata.Option</a>&lt;T&gt;</li>
 104 <li>
 105 <ul class="inheritance">
 106 <li>compbio.metadata.Parameter&lt;T&gt;</li>
 107 </ul>
 108 </li>
 109 </ul>
 110 </li>
 111 </ul>
 112 <div class="description">
 113 <ul class="blockList">
 114 <li class="blockList">
 115 <dl>
 116 <dt>All Implemented Interfaces:</dt>
 117 <dd><a href="../../compbio/metadata/Argument.html" title="interface in compbio.metadata">Argument</a>&lt;T&gt;</dd>
 118 </dl>
 119 <hr>
 120 <br>
 121 <pre>public class <span class="typeNameLabel">Parameter&lt;T&gt;</span>
 122 extends <a href="../../compbio/metadata/Option.html" title="class in compbio.metadata">Option</a>&lt;T&gt;</pre>
 123 <div class="block">A single value containing an option supported by the web service e.g.
 124  seqType=protein. Where seqType is a optionName and protein is one of
 125  possibleValues</div>
 126 <dl>
 127 <dt><span class="simpleTagLabel">Version:</span></dt>
 128 <dd>1.0 November 2009</dd>
 129 <dt><span class="simpleTagLabel">Author:</span></dt>
 130 <dd>pvtroshin</dd>
 131 <dt><span class="seeLabel">See Also:</span></dt>
 132 <dd><a href="../../compbio/metadata/Option.html" title="class in compbio.metadata"><code>Option</code></a>,
 133 <a href="../../compbio/metadata/Argument.html" title="interface in compbio.metadata"><code>Argument</code></a></dd>
 134 </dl>
 135 </li>
 136 </ul>
 137 </div>
 138 <div class="summary">
 139 <ul class="blockList">
 140 <li class="blockList">
 141 <!-- =========== FIELD SUMMARY =========== -->
 142 <ul class="blockList">
 143 <li class="blockList"><a name="field.summary">
 144 <!--   -->
 145 </a>
 146 <h3>Field Summary</h3>
 147 <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation">
 148 <caption><span>Fields</span><span class="tabEnd">&nbsp;</span></caption>
 149 <tr>
 150 <th class="colFirst" scope="col">Modifier and Type</th>
 151 <th class="colLast" scope="col">Field and Description</th>
 152 </tr>
 153 <tr class="altColor">
 154 <td class="colFirst"><code>(package private) java.util.Set&lt;java.lang.String&gt;</code></td>
 155 <td class="colLast"><code><span class="memberNameLink"><a href="../../compbio/metadata/Parameter.html#possibleValues">possibleValues</a></span></code>&nbsp;</td>
 156 </tr>
 157 <tr class="rowColor">
 158 <td class="colFirst"><code>(package private) <a href="../../compbio/metadata/ValueConstrain.html" title="class in compbio.metadata">ValueConstrain</a></code></td>
 159 <td class="colLast"><code><span class="memberNameLink"><a href="../../compbio/metadata/Parameter.html#validValue">validValue</a></span></code>&nbsp;</td>
 160 </tr>
 161 </table>
 162 <ul class="blockList">
 163 <li class="blockList"><a name="fields.inherited.from.class.compbio.metadata.Option">
 164 <!--   -->
 165 </a>
 166 <h3>Fields inherited from class&nbsp;compbio.metadata.<a href="../../compbio/metadata/Option.html" title="class in compbio.metadata">Option</a></h3>
 167 <code><a href="../../compbio/metadata/Option.html#defaultValue">defaultValue</a>, <a href="../../compbio/metadata/Option.html#description">description</a>, <a href="../../compbio/metadata/Option.html#furtherDetails">furtherDetails</a>, <a href="../../compbio/metadata/Option.html#isRequired">isRequired</a>, <a href="../../compbio/metadata/Option.html#name">name</a>, <a href="../../compbio/metadata/Option.html#optionNames">optionNames</a></code></li>
 168 </ul>
 169 </li>
 170 </ul>
 171 <!-- ======== CONSTRUCTOR SUMMARY ======== -->
 172 <ul class="blockList">
 173 <li class="blockList"><a name="constructor.summary">
 174 <!--   -->
 175 </a>
 176 <h3>Constructor Summary</h3>
 177 <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
 178 <caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
 179 <tr>
 180 <th class="colFirst" scope="col">Modifier</th>
 181 <th class="colLast" scope="col">Constructor and Description</th>
 182 </tr>
 183 <tr class="altColor">
 184 <td class="colFirst"><code>private </code></td>
 185 <td class="colLast"><code><span class="memberNameLink"><a href="../../compbio/metadata/Parameter.html#Parameter--">Parameter</a></span>()</code>&nbsp;</td>
 186 </tr>
 187 <tr class="rowColor">
 188 <td class="colFirst"><code>&nbsp;</code></td>
 189 <td class="colLast"><code><span class="memberNameLink"><a href="../../compbio/metadata/Parameter.html#Parameter-java.lang.String-java.lang.String-">Parameter</a></span>(java.lang.String&nbsp;name,
 190          java.lang.String&nbsp;description)</code>&nbsp;</td>
 191 </tr>
 192 </table>
 193 </li>
 194 </ul>
 195 <!-- ========== METHOD SUMMARY =========== -->
 196 <ul class="blockList">
 197 <li class="blockList"><a name="method.summary">
 198 <!--   -->
 199 </a>
 200 <h3>Method Summary</h3>
 201 <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
 202 <caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd">&nbsp;</span></span></caption>
 203 <tr>
 204 <th class="colFirst" scope="col">Modifier and Type</th>
 205 <th class="colLast" scope="col">Method and Description</th>
 206 </tr>
 207 <tr id="i0" class="altColor">
 208 <td class="colFirst"><code>java.util.Set&lt;java.lang.String&gt;</code></td>
 209 <td class="colLast"><code><span class="memberNameLink"><a href="../../compbio/metadata/Parameter.html#addOptionNames-java.lang.String...-">addOptionNames</a></span>(java.lang.String...&nbsp;value)</code>
 210 <div class="block">Adds an option to the optionName list</div>
 211 </td>
 212 </tr>
 213 <tr id="i1" class="rowColor">
 214 <td class="colFirst"><code>java.util.Set&lt;java.lang.String&gt;</code></td>
 215 <td class="colLast"><code><span class="memberNameLink"><a href="../../compbio/metadata/Parameter.html#addPossibleValues-java.lang.String...-">addPossibleValues</a></span>(java.lang.String...&nbsp;value)</code>&nbsp;</td>
 216 </tr>
 217 <tr id="i2" class="altColor">
 218 <td class="colFirst"><code>boolean</code></td>
 219 <td class="colLast"><code><span class="memberNameLink"><a href="../../compbio/metadata/Parameter.html#equals-java.lang.Object-">equals</a></span>(java.lang.Object&nbsp;obj)</code>&nbsp;</td>
 220 </tr>
 221 <tr id="i3" class="rowColor">
 222 <td class="colFirst"><code>java.lang.String</code></td>
 223 <td class="colLast"><code><span class="memberNameLink"><a href="../../compbio/metadata/Parameter.html#getOptionName--">getOptionName</a></span>()</code>&nbsp;</td>
 224 </tr>
 225 <tr id="i4" class="altColor">
 226 <td class="colFirst"><code>java.util.List&lt;java.lang.String&gt;</code></td>
 227 <td class="colLast"><code><span class="memberNameLink"><a href="../../compbio/metadata/Parameter.html#getPossibleValues--">getPossibleValues</a></span>()</code>
 228 <div class="block">List is more convenient to work with</div>
 229 </td>
 230 </tr>
 231 <tr id="i5" class="rowColor">
 232 <td class="colFirst"><code><a href="../../compbio/metadata/ValueConstrain.html" title="class in compbio.metadata">ValueConstrain</a></code></td>
 233 <td class="colLast"><code><span class="memberNameLink"><a href="../../compbio/metadata/Parameter.html#getValidValue--">getValidValue</a></span>()</code>&nbsp;</td>
 234 </tr>
 235 <tr id="i6" class="altColor">
 236 <td class="colFirst"><code>(package private) java.lang.String</code></td>
 237 <td class="colLast"><code><span class="memberNameLink"><a href="../../compbio/metadata/Parameter.html#getValue--">getValue</a></span>()</code>&nbsp;</td>
 238 </tr>
 239 <tr id="i7" class="rowColor">
 240 <td class="colFirst"><code>int</code></td>
 241 <td class="colLast"><code><span class="memberNameLink"><a href="../../compbio/metadata/Parameter.html#hashCode--">hashCode</a></span>()</code>&nbsp;</td>
 242 </tr>
 243 <tr id="i8" class="altColor">
 244 <td class="colFirst"><code>(package private) boolean</code></td>
 245 <td class="colLast"><code><span class="memberNameLink"><a href="../../compbio/metadata/Parameter.html#isValidValue-java.lang.String-">isValidValue</a></span>(java.lang.String&nbsp;value)</code>&nbsp;</td>
 246 </tr>
 247 <tr id="i9" class="rowColor">
 248 <td class="colFirst"><code>void</code></td>
 249 <td class="colLast"><code><span class="memberNameLink"><a href="../../compbio/metadata/Parameter.html#setDefaultValue-java.lang.String-">setDefaultValue</a></span>(java.lang.String&nbsp;defaultVal)</code>
 250 <div class="block">Sets one of the values defined in optionList as default.</div>
 251 </td>
 252 </tr>
 253 <tr id="i10" class="altColor">
 254 <td class="colFirst"><code>void</code></td>
 255 <td class="colLast"><code><span class="memberNameLink"><a href="../../compbio/metadata/Parameter.html#setOptionName-java.lang.String-">setOptionName</a></span>(java.lang.String&nbsp;optionName)</code>&nbsp;</td>
 256 </tr>
 257 <tr id="i11" class="rowColor">
 258 <td class="colFirst"><code>void</code></td>
 259 <td class="colLast"><code><span class="memberNameLink"><a href="../../compbio/metadata/Parameter.html#setOptionNames-java.util.Set-">setOptionNames</a></span>(java.util.Set&lt;java.lang.String&gt;&nbsp;optionName)</code>&nbsp;</td>
 260 </tr>
 261 <tr id="i12" class="altColor">
 262 <td class="colFirst"><code>void</code></td>
 263 <td class="colLast"><code><span class="memberNameLink"><a href="../../compbio/metadata/Parameter.html#setPossibleValues-java.util.Set-">setPossibleValues</a></span>(java.util.Set&lt;java.lang.String&gt;&nbsp;possibleValues)</code>&nbsp;</td>
 264 </tr>
 265 <tr id="i13" class="rowColor">
 266 <td class="colFirst"><code>void</code></td>
 267 <td class="colLast"><code><span class="memberNameLink"><a href="../../compbio/metadata/Parameter.html#setValidValue-compbio.metadata.ValueConstrain-">setValidValue</a></span>(<a href="../../compbio/metadata/ValueConstrain.html" title="class in compbio.metadata">ValueConstrain</a>&nbsp;validValue)</code>&nbsp;</td>
 268 </tr>
 269 <tr id="i14" class="altColor">
 270 <td class="colFirst"><code>java.lang.String</code></td>
 271 <td class="colLast"><code><span class="memberNameLink"><a href="../../compbio/metadata/Parameter.html#toCommand-java.lang.String-">toCommand</a></span>(java.lang.String&nbsp;nameValueSeparator)</code>
 272 <div class="block">Convert the option to the command string.</div>
 273 </td>
 274 </tr>
 275 <tr id="i15" class="rowColor">
 276 <td class="colFirst"><code>java.lang.String</code></td>
 277 <td class="colLast"><code><span class="memberNameLink"><a href="../../compbio/metadata/Parameter.html#toString--">toString</a></span>()</code>&nbsp;</td>
 278 </tr>
 279 <tr id="i16" class="altColor">
 280 <td class="colFirst"><code>(package private) void</code></td>
 281 <td class="colLast"><code><span class="memberNameLink"><a href="../../compbio/metadata/Parameter.html#validate--">validate</a></span>()</code>
 282 <div class="block">Validate the option</div>
 283 </td>
 284 </tr>
 285 </table>
 286 <ul class="blockList">
 287 <li class="blockList"><a name="methods.inherited.from.class.compbio.metadata.Option">
 288 <!--   -->
 289 </a>
 290 <h3>Methods inherited from class&nbsp;compbio.metadata.<a href="../../compbio/metadata/Option.html" title="class in compbio.metadata">Option</a></h3>
 291 <code><a href="../../compbio/metadata/Option.html#getBasicURL--">getBasicURL</a>, <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#setBasicURL-java.net.URL-">setBasicURL</a>, <a href="../../compbio/metadata/Option.html#setDescription-java.lang.String-">setDescription</a>, <a href="../../compbio/metadata/Option.html#setFurtherDetails-java.lang.String-">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>, <a href="../../compbio/metadata/Option.html#valueExist-java.lang.String-java.util.List-">valueExist</a></code></li>
 292 </ul>
 293 <ul class="blockList">
 294 <li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
 295 <!--   -->
 296 </a>
 297 <h3>Methods inherited from class&nbsp;java.lang.Object</h3>
 298 <code>clone, finalize, getClass, notify, notifyAll, wait, wait, wait</code></li>
 299 </ul>
 300 </li>
 301 </ul>
 302 </li>
 303 </ul>
 304 </div>
 305 <div class="details">
 306 <ul class="blockList">
 307 <li class="blockList">
 308 <!-- ============ FIELD DETAIL =========== -->
 309 <ul class="blockList">
 310 <li class="blockList"><a name="field.detail">
 311 <!--   -->
 312 </a>
 313 <h3>Field Detail</h3>
 314 <a name="possibleValues">
 315 <!--   -->
 316 </a>
 317 <ul class="blockList">
 318 <li class="blockList">
 319 <h4>possibleValues</h4>
 320 <pre>java.util.Set&lt;java.lang.String&gt; possibleValues</pre>
 321 </li>
 322 </ul>
 323 <a name="validValue">
 324 <!--   -->
 325 </a>
 326 <ul class="blockListLast">
 327 <li class="blockList">
 328 <h4>validValue</h4>
 329 <pre><a href="../../compbio/metadata/ValueConstrain.html" title="class in compbio.metadata">ValueConstrain</a> validValue</pre>
 330 </li>
 331 </ul>
 332 </li>
 333 </ul>
 334 <!-- ========= CONSTRUCTOR DETAIL ======== -->
 335 <ul class="blockList">
 336 <li class="blockList"><a name="constructor.detail">
 337 <!--   -->
 338 </a>
 339 <h3>Constructor Detail</h3>
 340 <a name="Parameter--">
 341 <!--   -->
 342 </a>
 343 <ul class="blockList">
 344 <li class="blockList">
 345 <h4>Parameter</h4>
 346 <pre>private&nbsp;Parameter()</pre>
 347 </li>
 348 </ul>
 349 <a name="Parameter-java.lang.String-java.lang.String-">
 350 <!--   -->
 351 </a>
 352 <ul class="blockListLast">
 353 <li class="blockList">
 354 <h4>Parameter</h4>
 355 <pre>public&nbsp;Parameter(java.lang.String&nbsp;name,
 356                  java.lang.String&nbsp;description)</pre>
 357 </li>
 358 </ul>
 359 </li>
 360 </ul>
 361 <!-- ============ METHOD DETAIL ========== -->
 362 <ul class="blockList">
 363 <li class="blockList"><a name="method.detail">
 364 <!--   -->
 365 </a>
 366 <h3>Method Detail</h3>
 367 <a name="getValidValue--">
 368 <!--   -->
 369 </a>
 370 <ul class="blockList">
 371 <li class="blockList">
 372 <h4>getValidValue</h4>
 373 <pre>public&nbsp;<a href="../../compbio/metadata/ValueConstrain.html" title="class in compbio.metadata">ValueConstrain</a>&nbsp;getValidValue()</pre>
 374 </li>
 375 </ul>
 376 <a name="setValidValue-compbio.metadata.ValueConstrain-">
 377 <!--   -->
 378 </a>
 379 <ul class="blockList">
 380 <li class="blockList">
 381 <h4>setValidValue</h4>
 382 <pre>public&nbsp;void&nbsp;setValidValue(<a href="../../compbio/metadata/ValueConstrain.html" title="class in compbio.metadata">ValueConstrain</a>&nbsp;validValue)</pre>
 383 </li>
 384 </ul>
 385 <a name="toString--">
 386 <!--   -->
 387 </a>
 388 <ul class="blockList">
 389 <li class="blockList">
 390 <h4>toString</h4>
 391 <pre>public&nbsp;java.lang.String&nbsp;toString()</pre>
 392 <dl>
 393 <dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
 394 <dd><code><a href="../../compbio/metadata/Option.html#toString--">toString</a></code>&nbsp;in class&nbsp;<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></dd>
 395 </dl>
 396 </li>
 397 </ul>
 398 <a name="toCommand-java.lang.String-">
 399 <!--   -->
 400 </a>
 401 <ul class="blockList">
 402 <li class="blockList">
 403 <h4>toCommand</h4>
 404 <pre>public&nbsp;java.lang.String&nbsp;toCommand(java.lang.String&nbsp;nameValueSeparator)</pre>
 405 <div class="block"><span class="descfrmTypeLabel">Description copied from class:&nbsp;<code><a href="../../compbio/metadata/Option.html#toCommand-java.lang.String-">Option</a></code></span></div>
 406 <div class="block">Convert the option to the command string.</div>
 407 <dl>
 408 <dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
 409 <dd><code><a href="../../compbio/metadata/Option.html#toCommand-java.lang.String-">toCommand</a></code>&nbsp;in class&nbsp;<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></dd>
 410 <dt><span class="returnLabel">Returns:</span></dt>
 411 <dd>If only one optionName is defined, than it is returned, if many
 412          option names are defined, then the defaultValue is returned.
 413          Option must have a default value if there are many optionNames to
 414          be valid.</dd>
 415 </dl>
 416 </li>
 417 </ul>
 418 <a name="equals-java.lang.Object-">
 419 <!--   -->
 420 </a>
 421 <ul class="blockList">
 422 <li class="blockList">
 423 <h4>equals</h4>
 424 <pre>public&nbsp;boolean&nbsp;equals(java.lang.Object&nbsp;obj)</pre>
 425 <dl>
 426 <dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
 427 <dd><code><a href="../../compbio/metadata/Option.html#equals-java.lang.Object-">equals</a></code>&nbsp;in class&nbsp;<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></dd>
 428 </dl>
 429 </li>
 430 </ul>
 431 <a name="getPossibleValues--">
 432 <!--   -->
 433 </a>
 434 <ul class="blockList">
 435 <li class="blockList">
 436 <h4>getPossibleValues</h4>
 437 <pre>public&nbsp;java.util.List&lt;java.lang.String&gt;&nbsp;getPossibleValues()</pre>
 438 <div class="block">List is more convenient to work with</div>
 439 <dl>
 440 <dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
 441 <dd><code><a href="../../compbio/metadata/Argument.html#getPossibleValues--">getPossibleValues</a></code>&nbsp;in interface&nbsp;<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></dd>
 442 <dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
 443 <dd><code><a href="../../compbio/metadata/Option.html#getPossibleValues--">getPossibleValues</a></code>&nbsp;in class&nbsp;<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></dd>
 444 <dt><span class="returnLabel">Returns:</span></dt>
 445 <dd>List of String</dd>
 446 </dl>
 447 </li>
 448 </ul>
 449 <a name="setPossibleValues-java.util.Set-">
 450 <!--   -->
 451 </a>
 452 <ul class="blockList">
 453 <li class="blockList">
 454 <h4>setPossibleValues</h4>
 455 <pre>public&nbsp;void&nbsp;setPossibleValues(java.util.Set&lt;java.lang.String&gt;&nbsp;possibleValues)</pre>
 456 </li>
 457 </ul>
 458 <a name="addPossibleValues-java.lang.String...-">
 459 <!--   -->
 460 </a>
 461 <ul class="blockList">
 462 <li class="blockList">
 463 <h4>addPossibleValues</h4>
 464 <pre>public&nbsp;java.util.Set&lt;java.lang.String&gt;&nbsp;addPossibleValues(java.lang.String...&nbsp;value)</pre>
 465 </li>
 466 </ul>
 467 <a name="hashCode--">
 468 <!--   -->
 469 </a>
 470 <ul class="blockList">
 471 <li class="blockList">
 472 <h4>hashCode</h4>
 473 <pre>public&nbsp;int&nbsp;hashCode()</pre>
 474 <dl>
 475 <dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
 476 <dd><code><a href="../../compbio/metadata/Option.html#hashCode--">hashCode</a></code>&nbsp;in class&nbsp;<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></dd>
 477 </dl>
 478 </li>
 479 </ul>
 480 <a name="setOptionNames-java.util.Set-">
 481 <!--   -->
 482 </a>
 483 <ul class="blockList">
 484 <li class="blockList">
 485 <h4>setOptionNames</h4>
 486 <pre>public&nbsp;void&nbsp;setOptionNames(java.util.Set&lt;java.lang.String&gt;&nbsp;optionName)</pre>
 487 <dl>
 488 <dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
 489 <dd><code><a href="../../compbio/metadata/Option.html#setOptionNames-java.util.Set-">setOptionNames</a></code>&nbsp;in class&nbsp;<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></dd>
 490 </dl>
 491 </li>
 492 </ul>
 493 <a name="addOptionNames-java.lang.String...-">
 494 <!--   -->
 495 </a>
 496 <ul class="blockList">
 497 <li class="blockList">
 498 <h4>addOptionNames</h4>
 499 <pre>public&nbsp;java.util.Set&lt;java.lang.String&gt;&nbsp;addOptionNames(java.lang.String...&nbsp;value)</pre>
 500 <div class="block"><span class="descfrmTypeLabel">Description copied from class:&nbsp;<code><a href="../../compbio/metadata/Option.html#addOptionNames-java.lang.String...-">Option</a></code></span></div>
 501 <div class="block">Adds an option to the optionName list</div>
 502 <dl>
 503 <dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
 504 <dd><code><a href="../../compbio/metadata/Option.html#addOptionNames-java.lang.String...-">addOptionNames</a></code>&nbsp;in class&nbsp;<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></dd>
 505 <dt><span class="returnLabel">Returns:</span></dt>
 506 <dd>modified optionName list</dd>
 507 </dl>
 508 </li>
 509 </ul>
 510 <a name="getOptionName--">
 511 <!--   -->
 512 </a>
 513 <ul class="blockList">
 514 <li class="blockList">
 515 <h4>getOptionName</h4>
 516 <pre>public&nbsp;java.lang.String&nbsp;getOptionName()</pre>
 517 </li>
 518 </ul>
 519 <a name="setOptionName-java.lang.String-">
 520 <!--   -->
 521 </a>
 522 <ul class="blockList">
 523 <li class="blockList">
 524 <h4>setOptionName</h4>
 525 <pre>public&nbsp;void&nbsp;setOptionName(java.lang.String&nbsp;optionName)</pre>
 526 </li>
 527 </ul>
 528 <a name="getValue--">
 529 <!--   -->
 530 </a>
 531 <ul class="blockList">
 532 <li class="blockList">
 533 <h4>getValue</h4>
 534 <pre>java.lang.String&nbsp;getValue()</pre>
 535 </li>
 536 </ul>
 537 <a name="validate--">
 538 <!--   -->
 539 </a>
 540 <ul class="blockList">
 541 <li class="blockList">
 542 <h4>validate</h4>
 543 <pre>void&nbsp;validate()
 544        throws javax.xml.bind.ValidationException</pre>
 545 <div class="block"><span class="descfrmTypeLabel">Description copied from class:&nbsp;<code><a href="../../compbio/metadata/Option.html#validate--">Option</a></code></span></div>
 546 <div class="block">Validate the option</div>
 547 <dl>
 548 <dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
 549 <dd><code><a href="../../compbio/metadata/Option.html#validate--">validate</a></code>&nbsp;in class&nbsp;<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></dd>
 550 <dt><span class="throwsLabel">Throws:</span></dt>
 551 <dd><code>javax.xml.bind.ValidationException</code> - is the option is invalid. This happens if option does not
 552              have a default value but have multiple option names, or no
 553              option names is defined</dd>
 554 </dl>
 555 </li>
 556 </ul>
 557 <a name="isValidValue-java.lang.String-">
 558 <!--   -->
 559 </a>
 560 <ul class="blockList">
 561 <li class="blockList">
 562 <h4>isValidValue</h4>
 563 <pre>boolean&nbsp;isValidValue(java.lang.String&nbsp;value)</pre>
 564 </li>
 565 </ul>
 566 <a name="setDefaultValue-java.lang.String-">
 567 <!--   -->
 568 </a>
 569 <ul class="blockListLast">
 570 <li class="blockList">
 571 <h4>setDefaultValue</h4>
 572 <pre>public&nbsp;void&nbsp;setDefaultValue(java.lang.String&nbsp;defaultVal)
 573                      throws <a href="../../compbio/metadata/WrongParameterException.html" title="class in compbio.metadata">WrongParameterException</a></pre>
 574 <div class="block"><span class="descfrmTypeLabel">Description copied from class:&nbsp;<code><a href="../../compbio/metadata/Option.html#setDefaultValue-java.lang.String-">Option</a></code></span></div>
 575 <div class="block">Sets one of the values defined in optionList as default. Attempting set
 576  the value not listed there will result in WrongParameter exception</div>
 577 <dl>
 578 <dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
 579 <dd><code><a href="../../compbio/metadata/Option.html#setDefaultValue-java.lang.String-">setDefaultValue</a></code>&nbsp;in class&nbsp;<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></dd>
 580 <dt><span class="throwsLabel">Throws:</span></dt>
 581 <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</dd>
 582 </dl>
 583 </li>
 584 </ul>
 585 </li>
 586 </ul>
 587 </li>
 588 </ul>
 589 </div>
 590 </div>
 591 <!-- ========= END OF CLASS DATA ========= -->
 592 <!-- ======= START OF BOTTOM NAVBAR ====== -->
 593 <div class="bottomNav"><a name="navbar.bottom">
 594 <!--   -->
 595 </a>
 596 <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
 597 <a name="navbar.bottom.firstrow">
 598 <!--   -->
 599 </a>
 600 <ul class="navList" title="Navigation">
 601 <li><a href="../../overview-summary.html">Overview</a></li>
 602 <li><a href="package-summary.html">Package</a></li>
 603 <li class="navBarCell1Rev">Class</li>
 604 <li><a href="class-use/Parameter.html">Use</a></li>
 605 <li><a href="package-tree.html">Tree</a></li>
 606 <li><a href="../../deprecated-list.html">Deprecated</a></li>
 607 <li><a href="../../index-files/index-1.html">Index</a></li>
 608 <li><a href="../../help-doc.html">Help</a></li>
 609 </ul>
 610 </div>
 611 <div class="subNav">
 612 <ul class="navList">
 613 <li><a href="../../compbio/metadata/Option.html" title="class in compbio.metadata"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
 614 <li><a href="../../compbio/metadata/Preset.html" title="class in compbio.metadata"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
 615 </ul>
 616 <ul class="navList">
 617 <li><a href="../../index.html?compbio/metadata/Parameter.html" target="_top">Frames</a></li>
 618 <li><a href="Parameter.html" target="_top">No&nbsp;Frames</a></li>
 619 </ul>
 620 <ul class="navList" id="allclasses_navbar_bottom">
 621 <li><a href="../../allclasses-noframe.html">All&nbsp;Classes</a></li>
 622 </ul>
 623 <div>
 624 <script type="text/javascript"><!--
 625   allClassesLink = document.getElementById("allclasses_navbar_bottom");
 626   if(window==top) {
 627     allClassesLink.style.display = "block";
 628   }
 629   else {
 630     allClassesLink.style.display = "none";
 631   }
 632   //-->
 633 </script>
 634 </div>
 635 <div>
 636 <ul class="subNavList">
 637 <li>Summary:&nbsp;</li>
 638 <li>Nested&nbsp;|&nbsp;</li>
 639 <li><a href="#field.summary">Field</a>&nbsp;|&nbsp;</li>
 640 <li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
 641 <li><a href="#method.summary">Method</a></li>
 642 </ul>
 643 <ul class="subNavList">
 644 <li>Detail:&nbsp;</li>
 645 <li><a href="#field.detail">Field</a>&nbsp;|&nbsp;</li>
 646 <li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
 647 <li><a href="#method.detail">Method</a></li>
 648 </ul>
 649 </div>
 650 <a name="skip.navbar.bottom">
 651 <!--   -->
 652 </a></div>
 653 <!-- ======== END OF BOTTOM NAVBAR ======= -->
 654 </body>
 655 </html>