updated javadoc for the system as well as new redirect address for download app
[jabaws.git] / website / dm_javadoc / compbio / metadata / Parameter.html
diff --git a/website/dm_javadoc/compbio/metadata/Parameter.html b/website/dm_javadoc/compbio/metadata/Parameter.html
new file mode 100644 (file)
index 0000000..7d92155
--- /dev/null
@@ -0,0 +1,572 @@
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">\r
+<!--NewPage-->\r
+<HTML>\r
+<HEAD>\r
+<!-- Generated by javadoc (build 1.6.0_24) on Wed Dec 07 12:08:24 GMT 2011 -->\r
+<TITLE>\r
+Parameter\r
+</TITLE>\r
+\r
+<META NAME="date" CONTENT="2011-12-07">\r
+\r
+<LINK REL ="stylesheet" TYPE="text/css" HREF="../../stylesheet.css" TITLE="Style">\r
+\r
+<SCRIPT type="text/javascript">\r
+function windowTitle()\r
+{\r
+    if (location.href.indexOf('is-external=true') == -1) {\r
+        parent.document.title="Parameter";\r
+    }\r
+}\r
+</SCRIPT>\r
+<NOSCRIPT>\r
+</NOSCRIPT>\r
+\r
+</HEAD>\r
+\r
+<BODY BGCOLOR="white" onload="windowTitle();">\r
+<HR>\r
+\r
+\r
+<!-- ========= START OF TOP NAVBAR ======= -->\r
+<A NAME="navbar_top"><!-- --></A>\r
+<A HREF="#skip-navbar_top" title="Skip navigation links"></A>\r
+<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">\r
+<TR>\r
+<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">\r
+<A NAME="navbar_top_firstrow"><!-- --></A>\r
+<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">\r
+  <TR ALIGN="center" VALIGN="top">\r
+  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>\r
+  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>\r
+  <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>\r
+  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="class-use/Parameter.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>\r
+  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>\r
+  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>\r
+  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../index-files/index-1.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>\r
+  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>\r
+  </TR>\r
+</TABLE>\r
+</TD>\r
+<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>\r
+</EM>\r
+</TD>\r
+</TR>\r
+\r
+<TR>\r
+<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">\r
+&nbsp;<A HREF="../../compbio/metadata/Option.html" title="class in compbio.metadata"><B>PREV CLASS</B></A>&nbsp;\r
+&nbsp;<A HREF="../../compbio/metadata/Preset.html" title="class in compbio.metadata"><B>NEXT CLASS</B></A></FONT></TD>\r
+<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">\r
+  <A HREF="../../index.html?compbio/metadata/Parameter.html" target="_top"><B>FRAMES</B></A>  &nbsp;\r
+&nbsp;<A HREF="Parameter.html" target="_top"><B>NO FRAMES</B></A>  &nbsp;\r
+&nbsp;<SCRIPT type="text/javascript">\r
+  <!--\r
+  if(window==top) {\r
+    document.writeln('<A HREF="../../allclasses-noframe.html"><B>All Classes</B></A>');\r
+  }\r
+  //-->\r
+</SCRIPT>\r
+<NOSCRIPT>\r
+  <A HREF="../../allclasses-noframe.html"><B>All Classes</B></A>\r
+</NOSCRIPT>\r
+\r
+\r
+</FONT></TD>\r
+</TR>\r
+<TR>\r
+<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">\r
+  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
+<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">\r
+DETAIL:&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>\r
+</TR>\r
+</TABLE>\r
+<A NAME="skip-navbar_top"></A>\r
+<!-- ========= END OF TOP NAVBAR ========= -->\r
+\r
+<HR>\r
+<!-- ======== START OF CLASS DATA ======== -->\r
+<H2>\r
+<FONT SIZE="-1">\r
+compbio.metadata</FONT>\r
+<BR>\r
+Class Parameter&lt;T&gt;</H2>\r
+<PRE>\r
+java.lang.Object\r
+  <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
+      <IMG SRC="../../resources/inherit.gif" ALT="extended by "><B>compbio.metadata.Parameter&lt;T&gt;</B>\r
+</PRE>\r
+<DL>\r
+<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
+</DL>\r
+<HR>\r
+<DL>\r
+<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
+</PRE>\r
+\r
+<P>\r
+A single value containing an option supported by the web service e.g.
+ seqType=protein. Where seqType is a optionName and protein is one of
+ possibleValues\r
+<P>\r
+\r
+<P>\r
+<DL>\r
+<DT><B>Version:</B></DT>\r
+  <DD>1.0 November 2009</DD>\r
+<DT><B>Author:</B></DT>\r
+  <DD>pvtroshin</DD>\r
+<DT><B>See Also:</B><DD><A HREF="../../compbio/metadata/Option.html" title="class in compbio.metadata"><CODE>Option</CODE></A>, \r
+<A HREF="../../compbio/metadata/Argument.html" title="interface in compbio.metadata"><CODE>Argument</CODE></A></DL>\r
+<HR>\r
+\r
+<P>\r
+\r
+<!-- ======== CONSTRUCTOR SUMMARY ======== -->\r
+\r
+<A NAME="constructor_summary"><!-- --></A>\r
+<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">\r
+<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">\r
+<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">\r
+<B>Constructor Summary</B></FONT></TH>\r
+</TR>\r
+<TR BGCOLOR="white" CLASS="TableRowColor">\r
+<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
+          java.lang.String&nbsp;description)</CODE>\r
+\r
+<BR>\r
+&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>\r
+</TR>\r
+</TABLE>\r
+&nbsp;\r
+<!-- ========== METHOD SUMMARY =========== -->\r
+\r
+<A NAME="method_summary"><!-- --></A>\r
+<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">\r
+<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">\r
+<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">\r
+<B>Method Summary</B></FONT></TH>\r
+</TR>\r
+<TR BGCOLOR="white" CLASS="TableRowColor">\r
+<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
+<CODE>&nbsp;java.util.Set&lt;java.lang.String&gt;</CODE></FONT></TD>\r
+<TD><CODE><B><A HREF="../../compbio/metadata/Parameter.html#addOptionNames(java.lang.String...)">addOptionNames</A></B>(java.lang.String...&nbsp;value)</CODE>\r
+\r
+<BR>\r
+&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Adds an option to the optionName list</TD>\r
+</TR>\r
+<TR BGCOLOR="white" CLASS="TableRowColor">\r
+<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
+<CODE>&nbsp;java.util.Set&lt;java.lang.String&gt;</CODE></FONT></TD>\r
+<TD><CODE><B><A HREF="../../compbio/metadata/Parameter.html#addPossibleValues(java.lang.String...)">addPossibleValues</A></B>(java.lang.String...&nbsp;value)</CODE>\r
+\r
+<BR>\r
+&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>\r
+</TR>\r
+<TR BGCOLOR="white" CLASS="TableRowColor">\r
+<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
+<CODE>&nbsp;boolean</CODE></FONT></TD>\r
+<TD><CODE><B><A HREF="../../compbio/metadata/Parameter.html#equals(java.lang.Object)">equals</A></B>(java.lang.Object&nbsp;obj)</CODE>\r
+\r
+<BR>\r
+&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>\r
+</TR>\r
+<TR BGCOLOR="white" CLASS="TableRowColor">\r
+<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
+<CODE>&nbsp;java.lang.String</CODE></FONT></TD>\r
+<TD><CODE><B><A HREF="../../compbio/metadata/Parameter.html#getOptionName()">getOptionName</A></B>()</CODE>\r
+\r
+<BR>\r
+&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>\r
+</TR>\r
+<TR BGCOLOR="white" CLASS="TableRowColor">\r
+<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
+<CODE>&nbsp;java.util.List&lt;java.lang.String&gt;</CODE></FONT></TD>\r
+<TD><CODE><B><A HREF="../../compbio/metadata/Parameter.html#getPossibleValues()">getPossibleValues</A></B>()</CODE>\r
+\r
+<BR>\r
+&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;List is more convenient to work with</TD>\r
+</TR>\r
+<TR BGCOLOR="white" CLASS="TableRowColor">\r
+<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
+<CODE>&nbsp;<A HREF="../../compbio/metadata/ValueConstrain.html" title="class in compbio.metadata">ValueConstrain</A></CODE></FONT></TD>\r
+<TD><CODE><B><A HREF="../../compbio/metadata/Parameter.html#getValidValue()">getValidValue</A></B>()</CODE>\r
+\r
+<BR>\r
+&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>\r
+</TR>\r
+<TR BGCOLOR="white" CLASS="TableRowColor">\r
+<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
+<CODE>&nbsp;int</CODE></FONT></TD>\r
+<TD><CODE><B><A HREF="../../compbio/metadata/Parameter.html#hashCode()">hashCode</A></B>()</CODE>\r
+\r
+<BR>\r
+&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>\r
+</TR>\r
+<TR BGCOLOR="white" CLASS="TableRowColor">\r
+<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
+<CODE>&nbsp;void</CODE></FONT></TD>\r
+<TD><CODE><B><A HREF="../../compbio/metadata/Parameter.html#setDefaultValue(java.lang.String)">setDefaultValue</A></B>(java.lang.String&nbsp;defaultVal)</CODE>\r
+\r
+<BR>\r
+&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Sets one of the values defined in optionList as default.</TD>\r
+</TR>\r
+<TR BGCOLOR="white" CLASS="TableRowColor">\r
+<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
+<CODE>&nbsp;void</CODE></FONT></TD>\r
+<TD><CODE><B><A HREF="../../compbio/metadata/Parameter.html#setOptionName(java.lang.String)">setOptionName</A></B>(java.lang.String&nbsp;optionName)</CODE>\r
+\r
+<BR>\r
+&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>\r
+</TR>\r
+<TR BGCOLOR="white" CLASS="TableRowColor">\r
+<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
+<CODE>&nbsp;void</CODE></FONT></TD>\r
+<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
+\r
+<BR>\r
+&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>\r
+</TR>\r
+<TR BGCOLOR="white" CLASS="TableRowColor">\r
+<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
+<CODE>&nbsp;void</CODE></FONT></TD>\r
+<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
+\r
+<BR>\r
+&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>\r
+</TR>\r
+<TR BGCOLOR="white" CLASS="TableRowColor">\r
+<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
+<CODE>&nbsp;void</CODE></FONT></TD>\r
+<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
+\r
+<BR>\r
+&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>\r
+</TR>\r
+<TR BGCOLOR="white" CLASS="TableRowColor">\r
+<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
+<CODE>&nbsp;java.lang.String</CODE></FONT></TD>\r
+<TD><CODE><B><A HREF="../../compbio/metadata/Parameter.html#toCommand(java.lang.String)">toCommand</A></B>(java.lang.String&nbsp;nameValueSeparator)</CODE>\r
+\r
+<BR>\r
+&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Convert the option to the command string.</TD>\r
+</TR>\r
+<TR BGCOLOR="white" CLASS="TableRowColor">\r
+<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
+<CODE>&nbsp;java.lang.String</CODE></FONT></TD>\r
+<TD><CODE><B><A HREF="../../compbio/metadata/Parameter.html#toString()">toString</A></B>()</CODE>\r
+\r
+<BR>\r
+&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>\r
+</TR>\r
+</TABLE>\r
+&nbsp;<A NAME="methods_inherited_from_class_compbio.metadata.Option"><!-- --></A>\r
+<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">\r
+<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">\r
+<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
+</TR>\r
+<TR BGCOLOR="white" CLASS="TableRowColor">\r
+<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
+</TR>\r
+</TABLE>\r
+&nbsp;<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>\r
+<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">\r
+<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">\r
+<TH ALIGN="left"><B>Methods inherited from class java.lang.Object</B></TH>\r
+</TR>\r
+<TR BGCOLOR="white" CLASS="TableRowColor">\r
+<TD><CODE>getClass, notify, notifyAll, wait, wait, wait</CODE></TD>\r
+</TR>\r
+</TABLE>\r
+&nbsp;\r
+<P>\r
+\r
+<!-- ========= CONSTRUCTOR DETAIL ======== -->\r
+\r
+<A NAME="constructor_detail"><!-- --></A>\r
+<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">\r
+<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">\r
+<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">\r
+<B>Constructor Detail</B></FONT></TH>\r
+</TR>\r
+</TABLE>\r
+\r
+<A NAME="Parameter(java.lang.String, java.lang.String)"><!-- --></A><H3>\r
+Parameter</H3>\r
+<PRE>\r
+public <B>Parameter</B>(java.lang.String&nbsp;name,\r
+                 java.lang.String&nbsp;description)</PRE>\r
+<DL>\r
+</DL>\r
+\r
+<!-- ============ METHOD DETAIL ========== -->\r
+\r
+<A NAME="method_detail"><!-- --></A>\r
+<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">\r
+<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">\r
+<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">\r
+<B>Method Detail</B></FONT></TH>\r
+</TR>\r
+</TABLE>\r
+\r
+<A NAME="getValidValue()"><!-- --></A><H3>\r
+getValidValue</H3>\r
+<PRE>\r
+public <A HREF="../../compbio/metadata/ValueConstrain.html" title="class in compbio.metadata">ValueConstrain</A> <B>getValidValue</B>()</PRE>\r
+<DL>\r
+<DD><DL>\r
+</DL>\r
+</DD>\r
+</DL>\r
+<HR>\r
+\r
+<A NAME="setValidValue(compbio.metadata.ValueConstrain)"><!-- --></A><H3>\r
+setValidValue</H3>\r
+<PRE>\r
+public void <B>setValidValue</B>(<A HREF="../../compbio/metadata/ValueConstrain.html" title="class in compbio.metadata">ValueConstrain</A>&nbsp;validValue)</PRE>\r
+<DL>\r
+<DD><DL>\r
+</DL>\r
+</DD>\r
+</DL>\r
+<HR>\r
+\r
+<A NAME="toString()"><!-- --></A><H3>\r
+toString</H3>\r
+<PRE>\r
+public java.lang.String <B>toString</B>()</PRE>\r
+<DL>\r
+<DD><DL>\r
+<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
+</DD>\r
+<DD><DL>\r
+</DL>\r
+</DD>\r
+</DL>\r
+<HR>\r
+\r
+<A NAME="toCommand(java.lang.String)"><!-- --></A><H3>\r
+toCommand</H3>\r
+<PRE>\r
+public java.lang.String <B>toCommand</B>(java.lang.String&nbsp;nameValueSeparator)</PRE>\r
+<DL>\r
+<DD><B>Description copied from class: <CODE><A HREF="../../compbio/metadata/Option.html#toCommand(java.lang.String)">Option</A></CODE></B></DD>\r
+<DD>Convert the option to the command string.\r
+<P>\r
+<DD><DL>\r
+<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
+</DD>\r
+<DD><DL>\r
+\r
+<DT><B>Returns:</B><DD>If only one optionName is defined, than it is returned, if many
+         option names are defined, then the defaultValue is returned.
+         Option must have a default value if there are many optionNames to
+         be valid.</DL>\r
+</DD>\r
+</DL>\r
+<HR>\r
+\r
+<A NAME="equals(java.lang.Object)"><!-- --></A><H3>\r
+equals</H3>\r
+<PRE>\r
+public boolean <B>equals</B>(java.lang.Object&nbsp;obj)</PRE>\r
+<DL>\r
+<DD><DL>\r
+<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
+</DD>\r
+<DD><DL>\r
+</DL>\r
+</DD>\r
+</DL>\r
+<HR>\r
+\r
+<A NAME="getPossibleValues()"><!-- --></A><H3>\r
+getPossibleValues</H3>\r
+<PRE>\r
+public java.util.List&lt;java.lang.String&gt; <B>getPossibleValues</B>()</PRE>\r
+<DL>\r
+<DD>List is more convenient to work with\r
+<P>\r
+<DD><DL>\r
+<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
+</DD>\r
+<DD><DL>\r
+\r
+<DT><B>Returns:</B><DD>List of String</DL>\r
+</DD>\r
+</DL>\r
+<HR>\r
+\r
+<A NAME="setPossibleValues(java.util.Set)"><!-- --></A><H3>\r
+setPossibleValues</H3>\r
+<PRE>\r
+public void <B>setPossibleValues</B>(java.util.Set&lt;java.lang.String&gt;&nbsp;possibleValues)</PRE>\r
+<DL>\r
+<DD><DL>\r
+</DL>\r
+</DD>\r
+</DL>\r
+<HR>\r
+\r
+<A NAME="addPossibleValues(java.lang.String...)"><!-- --></A><H3>\r
+addPossibleValues</H3>\r
+<PRE>\r
+public java.util.Set&lt;java.lang.String&gt; <B>addPossibleValues</B>(java.lang.String...&nbsp;value)</PRE>\r
+<DL>\r
+<DD><DL>\r
+</DL>\r
+</DD>\r
+</DL>\r
+<HR>\r
+\r
+<A NAME="hashCode()"><!-- --></A><H3>\r
+hashCode</H3>\r
+<PRE>\r
+public int <B>hashCode</B>()</PRE>\r
+<DL>\r
+<DD><DL>\r
+<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
+</DD>\r
+<DD><DL>\r
+</DL>\r
+</DD>\r
+</DL>\r
+<HR>\r
+\r
+<A NAME="setOptionNames(java.util.Set)"><!-- --></A><H3>\r
+setOptionNames</H3>\r
+<PRE>\r
+public void <B>setOptionNames</B>(java.util.Set&lt;java.lang.String&gt;&nbsp;optionName)</PRE>\r
+<DL>\r
+<DD><DL>\r
+<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
+</DD>\r
+<DD><DL>\r
+</DL>\r
+</DD>\r
+</DL>\r
+<HR>\r
+\r
+<A NAME="addOptionNames(java.lang.String...)"><!-- --></A><H3>\r
+addOptionNames</H3>\r
+<PRE>\r
+public java.util.Set&lt;java.lang.String&gt; <B>addOptionNames</B>(java.lang.String...&nbsp;value)</PRE>\r
+<DL>\r
+<DD><B>Description copied from class: <CODE><A HREF="../../compbio/metadata/Option.html#addOptionNames(java.lang.String...)">Option</A></CODE></B></DD>\r
+<DD>Adds an option to the optionName list\r
+<P>\r
+<DD><DL>\r
+<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
+</DD>\r
+<DD><DL>\r
+\r
+<DT><B>Returns:</B><DD>modified optionName list</DL>\r
+</DD>\r
+</DL>\r
+<HR>\r
+\r
+<A NAME="getOptionName()"><!-- --></A><H3>\r
+getOptionName</H3>\r
+<PRE>\r
+public java.lang.String <B>getOptionName</B>()</PRE>\r
+<DL>\r
+<DD><DL>\r
+</DL>\r
+</DD>\r
+</DL>\r
+<HR>\r
+\r
+<A NAME="setOptionName(java.lang.String)"><!-- --></A><H3>\r
+setOptionName</H3>\r
+<PRE>\r
+public void <B>setOptionName</B>(java.lang.String&nbsp;optionName)</PRE>\r
+<DL>\r
+<DD><DL>\r
+</DL>\r
+</DD>\r
+</DL>\r
+<HR>\r
+\r
+<A NAME="setDefaultValue(java.lang.String)"><!-- --></A><H3>\r
+setDefaultValue</H3>\r
+<PRE>\r
+public void <B>setDefaultValue</B>(java.lang.String&nbsp;defaultVal)\r
+                     throws <A HREF="../../compbio/metadata/WrongParameterException.html" title="class in compbio.metadata">WrongParameterException</A></PRE>\r
+<DL>\r
+<DD><B>Description copied from class: <CODE><A HREF="../../compbio/metadata/Option.html#setDefaultValue(java.lang.String)">Option</A></CODE></B></DD>\r
+<DD>Sets one of the values defined in optionList as default. Attempting set
+ the value not listed there will result in WrongParameter exception\r
+<P>\r
+<DD><DL>\r
+<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
+</DD>\r
+<DD><DL>\r
+\r
+<DT><B>Throws:</B>\r
+<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
+</DD>\r
+</DL>\r
+<!-- ========= END OF CLASS DATA ========= -->\r
+<HR>\r
+\r
+\r
+<!-- ======= START OF BOTTOM NAVBAR ====== -->\r
+<A NAME="navbar_bottom"><!-- --></A>\r
+<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>\r
+<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">\r
+<TR>\r
+<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">\r
+<A NAME="navbar_bottom_firstrow"><!-- --></A>\r
+<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">\r
+  <TR ALIGN="center" VALIGN="top">\r
+  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>\r
+  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>\r
+  <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>\r
+  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="class-use/Parameter.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>\r
+  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>\r
+  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>\r
+  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../index-files/index-1.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>\r
+  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>\r
+  </TR>\r
+</TABLE>\r
+</TD>\r
+<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>\r
+</EM>\r
+</TD>\r
+</TR>\r
+\r
+<TR>\r
+<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">\r
+&nbsp;<A HREF="../../compbio/metadata/Option.html" title="class in compbio.metadata"><B>PREV CLASS</B></A>&nbsp;\r
+&nbsp;<A HREF="../../compbio/metadata/Preset.html" title="class in compbio.metadata"><B>NEXT CLASS</B></A></FONT></TD>\r
+<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">\r
+  <A HREF="../../index.html?compbio/metadata/Parameter.html" target="_top"><B>FRAMES</B></A>  &nbsp;\r
+&nbsp;<A HREF="Parameter.html" target="_top"><B>NO FRAMES</B></A>  &nbsp;\r
+&nbsp;<SCRIPT type="text/javascript">\r
+  <!--\r
+  if(window==top) {\r
+    document.writeln('<A HREF="../../allclasses-noframe.html"><B>All Classes</B></A>');\r
+  }\r
+  //-->\r
+</SCRIPT>\r
+<NOSCRIPT>\r
+  <A HREF="../../allclasses-noframe.html"><B>All Classes</B></A>\r
+</NOSCRIPT>\r
+\r
+\r
+</FONT></TD>\r
+</TR>\r
+<TR>\r
+<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">\r
+  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
+<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">\r
+DETAIL:&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>\r
+</TR>\r
+</TABLE>\r
+<A NAME="skip-navbar_bottom"></A>\r
+<!-- ======== END OF BOTTOM NAVBAR ======= -->\r
+\r
+<HR>\r
+\r
+</BODY>\r
+</HTML>\r