website/dm_javadoc/compbio/metadata/Argument.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_21) on Wed Nov 24 12:17:18 GMT 2010 -->\r
   6 <TITLE>\r
   7 Argument\r
   8 </TITLE>\r
   9 \r
  10 <META NAME="date" CONTENT="2010-11-24">\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="Argument";\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/Argument.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;PREV CLASS&nbsp;\r
  59 &nbsp;<A HREF="../../compbio/metadata/ChunkHolder.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/Argument.html" target="_top"><B>FRAMES</B></A>  &nbsp;\r
  62 &nbsp;<A HREF="Argument.html" target="_top"><B>NO FRAMES</B></A>  &nbsp;\r
  63 &nbsp;<SCRIPT type="text/javascript">\r
  64   <!--\r
  65   if(window==top) {\r
  66     document.writeln('<A HREF="../../allclasses-noframe.html"><B>All Classes</B></A>');\r
  67   }\r
  68   //-->\r
  69 </SCRIPT>\r
  70 <NOSCRIPT>\r
  71   <A HREF="../../allclasses-noframe.html"><B>All Classes</B></A>\r
  72 </NOSCRIPT>\r
  73 \r
  74 \r
  75 </FONT></TD>\r
  76 </TR>\r
  77 <TR>\r
  78 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">\r
  79   SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<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;CONSTR&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 Interface Argument&lt;T&gt;</H2>\r
  94 <DL>\r
  95 <DT><DT><B>Type Parameters:</B><DD><CODE>T</CODE> - executable type</DL>\r
  96 <DL>\r
  97 <DT><B>All Known Implementing Classes:</B> <DD><A HREF="../../compbio/metadata/Option.html" title="class in compbio.metadata">Option</A>, <A HREF="../../compbio/metadata/Parameter.html" title="class in compbio.metadata">Parameter</A></DD>\r
  98 </DL>\r
  99 <HR>\r
 100 <DL>\r
 101 <DT><PRE>public interface <B>Argument&lt;T&gt;</B></DL>\r
 102 </PRE>\r
 103 \r
 104 <P>\r
 105 An unmodifiable view for the options and parameters, with one exception - it
 106  allows to set a value\r
 107 <P>\r
 108 \r
 109 <P>\r
 110 <DL>\r
 111 <DT><B>Author:</B></DT>\r
 112   <DD>pvtroshin
 113
 114          Date December 2009</DD>\r
 115 <DT><B>See Also:</B><DD><A HREF="../../compbio/metadata/Parameter.html" title="class in compbio.metadata"><CODE>Parameter</CODE></A>, \r
 116 <A HREF="../../compbio/metadata/Option.html" title="class in compbio.metadata"><CODE>Option</CODE></A></DL>\r
 117 <HR>\r
 118 \r
 119 <P>\r
 120 \r
 121 <!-- ========== METHOD SUMMARY =========== -->\r
 122 \r
 123 <A NAME="method_summary"><!-- --></A>\r
 124 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">\r
 125 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">\r
 126 <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">\r
 127 <B>Method Summary</B></FONT></TH>\r
 128 </TR>\r
 129 <TR BGCOLOR="white" CLASS="TableRowColor">\r
 130 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
 131 <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
 132 <TD><CODE><B><A HREF="../../compbio/metadata/Argument.html#getDefaultValue()">getDefaultValue</A></B>()</CODE>\r
 133 \r
 134 <BR>\r
 135 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>\r
 136 </TR>\r
 137 <TR BGCOLOR="white" CLASS="TableRowColor">\r
 138 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
 139 <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
 140 <TD><CODE><B><A HREF="../../compbio/metadata/Argument.html#getDescription()">getDescription</A></B>()</CODE>\r
 141 \r
 142 <BR>\r
 143 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>\r
 144 </TR>\r
 145 <TR BGCOLOR="white" CLASS="TableRowColor">\r
 146 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
 147 <CODE>&nbsp;<A HREF="http://java.sun.com/javase/6/docs/api/java/net/URL.html?is-external=true" title="class or interface in java.net">URL</A></CODE></FONT></TD>\r
 148 <TD><CODE><B><A HREF="../../compbio/metadata/Argument.html#getFurtherDetails()">getFurtherDetails</A></B>()</CODE>\r
 149 \r
 150 <BR>\r
 151 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>\r
 152 </TR>\r
 153 <TR BGCOLOR="white" CLASS="TableRowColor">\r
 154 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
 155 <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
 156 <TD><CODE><B><A HREF="../../compbio/metadata/Argument.html#getName()">getName</A></B>()</CODE>\r
 157 \r
 158 <BR>\r
 159 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>\r
 160 </TR>\r
 161 <TR BGCOLOR="white" CLASS="TableRowColor">\r
 162 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
 163 <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="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A>&gt;</CODE></FONT></TD>\r
 164 <TD><CODE><B><A HREF="../../compbio/metadata/Argument.html#getPossibleValues()">getPossibleValues</A></B>()</CODE>\r
 165 \r
 166 <BR>\r
 167 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>\r
 168 </TR>\r
 169 <TR BGCOLOR="white" CLASS="TableRowColor">\r
 170 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
 171 <CODE>&nbsp;void</CODE></FONT></TD>\r
 172 <TD><CODE><B><A HREF="../../compbio/metadata/Argument.html#setValue(java.lang.String)">setValue</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;defaultValue)</CODE>\r
 173 \r
 174 <BR>\r
 175 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Set default values for the parameter or an option</TD>\r
 176 </TR>\r
 177 </TABLE>\r
 178 &nbsp;\r
 179 <P>\r
 180 \r
 181 <!-- ============ METHOD DETAIL ========== -->\r
 182 \r
 183 <A NAME="method_detail"><!-- --></A>\r
 184 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">\r
 185 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">\r
 186 <TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">\r
 187 <B>Method Detail</B></FONT></TH>\r
 188 </TR>\r
 189 </TABLE>\r
 190 \r
 191 <A NAME="getFurtherDetails()"><!-- --></A><H3>\r
 192 getFurtherDetails</H3>\r
 193 <PRE>\r
 194 <A HREF="http://java.sun.com/javase/6/docs/api/java/net/URL.html?is-external=true" title="class or interface in java.net">URL</A> <B>getFurtherDetails</B>()</PRE>\r
 195 <DL>\r
 196 <DD><DL>\r
 197 </DL>\r
 198 </DD>\r
 199 </DL>\r
 200 <HR>\r
 201 \r
 202 <A NAME="getDefaultValue()"><!-- --></A><H3>\r
 203 getDefaultValue</H3>\r
 204 <PRE>\r
 205 <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>getDefaultValue</B>()</PRE>\r
 206 <DL>\r
 207 <DD><DL>\r
 208 </DL>\r
 209 </DD>\r
 210 </DL>\r
 211 <HR>\r
 212 \r
 213 <A NAME="getDescription()"><!-- --></A><H3>\r
 214 getDescription</H3>\r
 215 <PRE>\r
 216 <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>getDescription</B>()</PRE>\r
 217 <DL>\r
 218 <DD><DL>\r
 219 </DL>\r
 220 </DD>\r
 221 </DL>\r
 222 <HR>\r
 223 \r
 224 <A NAME="getName()"><!-- --></A><H3>\r
 225 getName</H3>\r
 226 <PRE>\r
 227 <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>getName</B>()</PRE>\r
 228 <DL>\r
 229 <DD><DL>\r
 230 </DL>\r
 231 </DD>\r
 232 </DL>\r
 233 <HR>\r
 234 \r
 235 <A NAME="getPossibleValues()"><!-- --></A><H3>\r
 236 getPossibleValues</H3>\r
 237 <PRE>\r
 238 <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="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A>&gt; <B>getPossibleValues</B>()</PRE>\r
 239 <DL>\r
 240 <DD><DL>\r
 241 \r
 242 <DT><B>Returns:</B><DD>List of values allowed for an Argument</DL>\r
 243 </DD>\r
 244 </DL>\r
 245 <HR>\r
 246 \r
 247 <A NAME="setValue(java.lang.String)"><!-- --></A><H3>\r
 248 setValue</H3>\r
 249 <PRE>\r
 250 void <B>setValue</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;defaultValue)\r
 251               throws <A HREF="../../compbio/metadata/WrongParameterException.html" title="class in compbio.metadata">WrongParameterException</A></PRE>\r
 252 <DL>\r
 253 <DD>Set default values for the parameter or an option\r
 254 <P>\r
 255 <DD><DL>\r
 256 <DT><B>Parameters:</B><DD><CODE>defaultValue</CODE> - the value to be set\r
 257 <DT><B>Throws:</B>\r
 258 <DD><CODE><A HREF="../../compbio/metadata/WrongParameterException.html" title="class in compbio.metadata">WrongParameterException</A></CODE> - - when the value to be set is illegal. Wrong value for
 259              numeric parameter is the value defined outside it , for
 260              string type parameter, wrong value is the one which is not
 261              listed in possible values list<DT><B>See Also:</B><DD><A HREF="../../compbio/metadata/ValueConstrain.html" title="class in compbio.metadata"><CODE>ValueConstrain</CODE></A></DL>\r
 262 </DD>\r
 263 </DL>\r
 264 <!-- ========= END OF CLASS DATA ========= -->\r
 265 <HR>\r
 266 \r
 267 \r
 268 <!-- ======= START OF BOTTOM NAVBAR ====== -->\r
 269 <A NAME="navbar_bottom"><!-- --></A>\r
 270 <A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>\r
 271 <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">\r
 272 <TR>\r
 273 <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">\r
 274 <A NAME="navbar_bottom_firstrow"><!-- --></A>\r
 275 <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">\r
 276   <TR ALIGN="center" VALIGN="top">\r
 277   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>\r
 278   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>\r
 279   <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>\r
 280   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="class-use/Argument.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>\r
 281   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>\r
 282   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>\r
 283   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../index-files/index-1.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>\r
 284   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>\r
 285   </TR>\r
 286 </TABLE>\r
 287 </TD>\r
 288 <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>\r
 289 </EM>\r
 290 </TD>\r
 291 </TR>\r
 292 \r
 293 <TR>\r
 294 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">\r
 295 &nbsp;PREV CLASS&nbsp;\r
 296 &nbsp;<A HREF="../../compbio/metadata/ChunkHolder.html" title="class in compbio.metadata"><B>NEXT CLASS</B></A></FONT></TD>\r
 297 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">\r
 298   <A HREF="../../index.html?compbio/metadata/Argument.html" target="_top"><B>FRAMES</B></A>  &nbsp;\r
 299 &nbsp;<A HREF="Argument.html" target="_top"><B>NO FRAMES</B></A>  &nbsp;\r
 300 &nbsp;<SCRIPT type="text/javascript">\r
 301   <!--\r
 302   if(window==top) {\r
 303     document.writeln('<A HREF="../../allclasses-noframe.html"><B>All Classes</B></A>');\r
 304   }\r
 305   //-->\r
 306 </SCRIPT>\r
 307 <NOSCRIPT>\r
 308   <A HREF="../../allclasses-noframe.html"><B>All Classes</B></A>\r
 309 </NOSCRIPT>\r
 310 \r
 311 \r
 312 </FONT></TD>\r
 313 </TR>\r
 314 <TR>\r
 315 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">\r
 316   SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>\r
 317 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">\r
 318 DETAIL:&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>\r
 319 </TR>\r
 320 </TABLE>\r
 321 <A NAME="skip-navbar_bottom"></A>\r
 322 <!-- ======== END OF BOTTOM NAVBAR ======= -->\r
 323 \r
 324 <HR>\r
 325 \r
 326 </BODY>\r
 327 </HTML>\r