1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
\r
5 <!-- Generated by javadoc (build 1.6.0_21) on Wed Nov 24 12:17:18 GMT 2010 -->
\r
10 <META NAME="date" CONTENT="2010-11-24">
\r
12 <LINK REL ="stylesheet" TYPE="text/css" HREF="../../stylesheet.css" TITLE="Style">
\r
14 <SCRIPT type="text/javascript">
\r
15 function windowTitle()
\r
17 if (location.href.indexOf('is-external=true') == -1) {
\r
18 parent.document.title="Parameter";
\r
27 <BODY BGCOLOR="white" onload="windowTitle();">
\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
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> </TD>
\r
41 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD>
\r
42 <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD>
\r
43 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/Parameter.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD>
\r
44 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
\r
45 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
\r
46 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../index-files/index-1.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
\r
47 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>
\r
51 <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
\r
57 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
\r
58 <A HREF="../../compbio/metadata/Option.html" title="class in compbio.metadata"><B>PREV CLASS</B></A>
\r
59 <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>
\r
62 <A HREF="Parameter.html" target="_top"><B>NO FRAMES</B></A>
\r
63 <SCRIPT type="text/javascript">
\r
66 document.writeln('<A HREF="../../allclasses-noframe.html"><B>All Classes</B></A>');
\r
71 <A HREF="../../allclasses-noframe.html"><B>All Classes</B></A>
\r
78 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
\r
79 SUMMARY: NESTED | <A HREF="#fields_inherited_from_class_compbio.metadata.Option">FIELD</A> | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD>
\r
80 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
\r
81 DETAIL: FIELD | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD>
\r
84 <A NAME="skip-navbar_top"></A>
\r
85 <!-- ========= END OF TOP NAVBAR ========= -->
\r
88 <!-- ======== START OF CLASS DATA ======== -->
\r
91 compbio.metadata</FONT>
\r
93 Class Parameter<T></H2>
\r
95 <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</A>
\r
96 <IMG SRC="../../resources/inherit.gif" ALT="extended by "><A HREF="../../compbio/metadata/Option.html" title="class in compbio.metadata">compbio.metadata.Option</A><T>
\r
97 <IMG SRC="../../resources/inherit.gif" ALT="extended by "><B>compbio.metadata.Parameter<T></B>
\r
100 <DT><B>All Implemented Interfaces:</B> <DD><A HREF="../../compbio/metadata/Argument.html" title="interface in compbio.metadata">Argument</A><T></DD>
\r
104 <DT><PRE>public class <B>Parameter<T></B><DT>extends <A HREF="../../compbio/metadata/Option.html" title="class in compbio.metadata">Option</A><T></DL>
\r
108 A single value containing an option supported by the web service e.g.
109 seqType=protein. Where seqType is a optionName and protein is one of
115 <DT><B>Version:</B></DT>
\r
116 <DD>1.0 November 2009</DD>
\r
117 <DT><B>Author:</B></DT>
\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
124 <!-- =========== FIELD SUMMARY =========== -->
\r
126 <A NAME="field_summary"><!-- --></A>
\r
127 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
\r
128 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
\r
129 <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
\r
130 <B>Field Summary</B></FONT></TH>
\r
133 <A NAME="fields_inherited_from_class_compbio.metadata.Option"><!-- --></A>
\r
134 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
\r
135 <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
\r
136 <TH ALIGN="left"><B>Fields inherited from class compbio.metadata.<A HREF="../../compbio/metadata/Option.html" title="class in compbio.metadata">Option</A></B></TH>
\r
138 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
139 <TD><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></CODE></TD>
\r
143 <!-- ======== CONSTRUCTOR SUMMARY ======== -->
\r
145 <A NAME="constructor_summary"><!-- --></A>
\r
146 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
\r
147 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
\r
148 <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
\r
149 <B>Constructor Summary</B></FONT></TH>
\r
151 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
152 <TD><CODE><B><A HREF="../../compbio/metadata/Parameter.html#Parameter(java.lang.String, java.lang.String)">Parameter</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> name,
\r
153 <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> description)</CODE>
\r
156 </TD>
\r
160 <!-- ========== METHOD SUMMARY =========== -->
\r
162 <A NAME="method_summary"><!-- --></A>
\r
163 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
\r
164 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
\r
165 <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
\r
166 <B>Method Summary</B></FONT></TH>
\r
168 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
169 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
170 <CODE> <A HREF="http://java.sun.com/javase/6/docs/api/java/util/Set.html?is-external=true" title="class or interface in java.util">Set</A><<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
171 <TD><CODE><B><A HREF="../../compbio/metadata/Parameter.html#addOptionNames(java.lang.String...)">addOptionNames</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>... value)</CODE>
\r
174 Adds an option to the optionName list</TD>
\r
176 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
177 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
178 <CODE> <A HREF="http://java.sun.com/javase/6/docs/api/java/util/Set.html?is-external=true" title="class or interface in java.util">Set</A><<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
179 <TD><CODE><B><A HREF="../../compbio/metadata/Parameter.html#addPossibleValues(java.lang.String...)">addPossibleValues</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>... value)</CODE>
\r
182 </TD>
\r
184 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
185 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
186 <CODE> boolean</CODE></FONT></TD>
\r
187 <TD><CODE><B><A HREF="../../compbio/metadata/Parameter.html#equals(java.lang.Object)">equals</A></B>(<A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</A> obj)</CODE>
\r
190 </TD>
\r
192 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
193 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
194 <CODE> <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
195 <TD><CODE><B><A HREF="../../compbio/metadata/Parameter.html#getOptionName()">getOptionName</A></B>()</CODE>
\r
198 </TD>
\r
200 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
201 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
202 <CODE> <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><<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
203 <TD><CODE><B><A HREF="../../compbio/metadata/Parameter.html#getPossibleValues()">getPossibleValues</A></B>()</CODE>
\r
206 List is more convenient to work with</TD>
\r
208 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
209 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
210 <CODE> <A HREF="../../compbio/metadata/ValueConstrain.html" title="class in compbio.metadata">ValueConstrain</A></CODE></FONT></TD>
\r
211 <TD><CODE><B><A HREF="../../compbio/metadata/Parameter.html#getValidValue()">getValidValue</A></B>()</CODE>
\r
214 </TD>
\r
216 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
217 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
218 <CODE> int</CODE></FONT></TD>
\r
219 <TD><CODE><B><A HREF="../../compbio/metadata/Parameter.html#hashCode()">hashCode</A></B>()</CODE>
\r
222 </TD>
\r
224 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
225 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
226 <CODE> void</CODE></FONT></TD>
\r
227 <TD><CODE><B><A HREF="../../compbio/metadata/Parameter.html#setDefaultValue(java.lang.String)">setDefaultValue</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> defaultVal)</CODE>
\r
230 Sets one of the values defined in optionList as default.</TD>
\r
232 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
233 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
234 <CODE> void</CODE></FONT></TD>
\r
235 <TD><CODE><B><A HREF="../../compbio/metadata/Parameter.html#setOptionName(java.lang.String)">setOptionName</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> optionName)</CODE>
\r
238 </TD>
\r
240 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
241 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
242 <CODE> void</CODE></FONT></TD>
\r
243 <TD><CODE><B><A HREF="../../compbio/metadata/Parameter.html#setOptionNames(java.util.Set)">setOptionNames</A></B>(<A HREF="http://java.sun.com/javase/6/docs/api/java/util/Set.html?is-external=true" title="class or interface in java.util">Set</A><<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>> optionName)</CODE>
\r
246 </TD>
\r
248 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
249 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
250 <CODE> void</CODE></FONT></TD>
\r
251 <TD><CODE><B><A HREF="../../compbio/metadata/Parameter.html#setPossibleValues(java.util.Set)">setPossibleValues</A></B>(<A HREF="http://java.sun.com/javase/6/docs/api/java/util/Set.html?is-external=true" title="class or interface in java.util">Set</A><<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>> possibleValues)</CODE>
\r
254 </TD>
\r
256 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
257 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
258 <CODE> void</CODE></FONT></TD>
\r
259 <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> validValue)</CODE>
\r
262 </TD>
\r
264 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
265 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
266 <CODE> <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
267 <TD><CODE><B><A HREF="../../compbio/metadata/Parameter.html#toCommand(java.lang.String)">toCommand</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> nameValueSeparator)</CODE>
\r
270 Convert the option to the command string.</TD>
\r
272 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
273 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
274 <CODE> <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
275 <TD><CODE><B><A HREF="../../compbio/metadata/Parameter.html#toString()">toString</A></B>()</CODE>
\r
278 </TD>
\r
281 <A NAME="methods_inherited_from_class_compbio.metadata.Option"><!-- --></A>
\r
282 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
\r
283 <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
\r
284 <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
286 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
287 <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
290 <A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
\r
291 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
\r
292 <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
\r
293 <TH ALIGN="left"><B>Methods inherited from class java.lang.<A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</A></B></TH>
\r
295 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
296 <TD><CODE><A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#clone()" title="class or interface in java.lang">clone</A>, <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#finalize()" title="class or interface in java.lang">finalize</A>, <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#getClass()" title="class or interface in java.lang">getClass</A>, <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#notify()" title="class or interface in java.lang">notify</A>, <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#notifyAll()" title="class or interface in java.lang">notifyAll</A>, <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#wait()" title="class or interface in java.lang">wait</A>, <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#wait(long)" title="class or interface in java.lang">wait</A>, <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#wait(long, int)" title="class or interface in java.lang">wait</A></CODE></TD>
\r
302 <!-- ========= CONSTRUCTOR DETAIL ======== -->
\r
304 <A NAME="constructor_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>Constructor Detail</B></FONT></TH>
\r
312 <A NAME="Parameter(java.lang.String, java.lang.String)"><!-- --></A><H3>
\r
315 public <B>Parameter</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> name,
\r
316 <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> description)</PRE>
\r
320 <!-- ============ METHOD DETAIL ========== -->
\r
322 <A NAME="method_detail"><!-- --></A>
\r
323 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
\r
324 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
\r
325 <TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
\r
326 <B>Method Detail</B></FONT></TH>
\r
330 <A NAME="getValidValue()"><!-- --></A><H3>
\r
333 public <A HREF="../../compbio/metadata/ValueConstrain.html" title="class in compbio.metadata">ValueConstrain</A> <B>getValidValue</B>()</PRE>
\r
341 <A NAME="setValidValue(compbio.metadata.ValueConstrain)"><!-- --></A><H3>
\r
344 public void <B>setValidValue</B>(<A HREF="../../compbio/metadata/ValueConstrain.html" title="class in compbio.metadata">ValueConstrain</A> validValue)</PRE>
\r
352 <A NAME="toString()"><!-- --></A><H3>
\r
355 public <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> <B>toString</B>()</PRE>
\r
358 <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><<A HREF="../../compbio/metadata/Parameter.html" title="type parameter in Parameter">T</A>></CODE></DL>
\r
366 <A NAME="toCommand(java.lang.String)"><!-- --></A><H3>
\r
369 public <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> <B>toCommand</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> nameValueSeparator)</PRE>
\r
371 <DD><B>Description copied from class: <CODE><A HREF="../../compbio/metadata/Option.html#toCommand(java.lang.String)">Option</A></CODE></B></DD>
\r
372 <DD>Convert the option to the command string.
\r
375 <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><<A HREF="../../compbio/metadata/Parameter.html" title="type parameter in Parameter">T</A>></CODE></DL>
\r
379 <DT><B>Returns:</B><DD>If only one optionName is defined, than it is returned, if many
380 option names are defined, then the defaultValue is returned.
381 Option must have a default value if there are many optionNames to
387 <A NAME="equals(java.lang.Object)"><!-- --></A><H3>
\r
390 public boolean <B>equals</B>(<A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</A> obj)</PRE>
\r
393 <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><<A HREF="../../compbio/metadata/Parameter.html" title="type parameter in Parameter">T</A>></CODE></DL>
\r
401 <A NAME="getPossibleValues()"><!-- --></A><H3>
\r
402 getPossibleValues</H3>
\r
404 public <A HREF="http://java.sun.com/javase/6/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</A><<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>getPossibleValues</B>()</PRE>
\r
406 <DD>List is more convenient to work with
\r
409 <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><<A HREF="../../compbio/metadata/Parameter.html" title="type parameter in Parameter">T</A>></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><<A HREF="../../compbio/metadata/Parameter.html" title="type parameter in Parameter">T</A>></CODE></DL>
\r
413 <DT><B>Returns:</B><DD>List of String</DL>
\r
418 <A NAME="setPossibleValues(java.util.Set)"><!-- --></A><H3>
\r
419 setPossibleValues</H3>
\r
421 public void <B>setPossibleValues</B>(<A HREF="http://java.sun.com/javase/6/docs/api/java/util/Set.html?is-external=true" title="class or interface in java.util">Set</A><<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>> possibleValues)</PRE>
\r
429 <A NAME="addPossibleValues(java.lang.String...)"><!-- --></A><H3>
\r
430 addPossibleValues</H3>
\r
432 public <A HREF="http://java.sun.com/javase/6/docs/api/java/util/Set.html?is-external=true" title="class or interface in java.util">Set</A><<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>addPossibleValues</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>... value)</PRE>
\r
440 <A NAME="hashCode()"><!-- --></A><H3>
\r
443 public int <B>hashCode</B>()</PRE>
\r
446 <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><<A HREF="../../compbio/metadata/Parameter.html" title="type parameter in Parameter">T</A>></CODE></DL>
\r
454 <A NAME="setOptionNames(java.util.Set)"><!-- --></A><H3>
\r
455 setOptionNames</H3>
\r
457 public void <B>setOptionNames</B>(<A HREF="http://java.sun.com/javase/6/docs/api/java/util/Set.html?is-external=true" title="class or interface in java.util">Set</A><<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>> optionName)</PRE>
\r
460 <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><<A HREF="../../compbio/metadata/Parameter.html" title="type parameter in Parameter">T</A>></CODE></DL>
\r
468 <A NAME="addOptionNames(java.lang.String...)"><!-- --></A><H3>
\r
469 addOptionNames</H3>
\r
471 public <A HREF="http://java.sun.com/javase/6/docs/api/java/util/Set.html?is-external=true" title="class or interface in java.util">Set</A><<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>addOptionNames</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>... value)</PRE>
\r
473 <DD><B>Description copied from class: <CODE><A HREF="../../compbio/metadata/Option.html#addOptionNames(java.lang.String...)">Option</A></CODE></B></DD>
\r
474 <DD>Adds an option to the optionName list
\r
477 <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><<A HREF="../../compbio/metadata/Parameter.html" title="type parameter in Parameter">T</A>></CODE></DL>
\r
481 <DT><B>Returns:</B><DD>modified optionName list</DL>
\r
486 <A NAME="getOptionName()"><!-- --></A><H3>
\r
489 public <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> <B>getOptionName</B>()</PRE>
\r
497 <A NAME="setOptionName(java.lang.String)"><!-- --></A><H3>
\r
500 public void <B>setOptionName</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> optionName)</PRE>
\r
508 <A NAME="setDefaultValue(java.lang.String)"><!-- --></A><H3>
\r
509 setDefaultValue</H3>
\r
511 public void <B>setDefaultValue</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> defaultVal)
\r
512 throws <A HREF="../../compbio/metadata/WrongParameterException.html" title="class in compbio.metadata">WrongParameterException</A></PRE>
\r
514 <DD><B>Description copied from class: <CODE><A HREF="../../compbio/metadata/Option.html#setDefaultValue(java.lang.String)">Option</A></CODE></B></DD>
\r
515 <DD>Sets one of the values defined in optionList as default. Attempting set
516 the value not listed there will result in WrongParameter exception
\r
519 <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><<A HREF="../../compbio/metadata/Parameter.html" title="type parameter in Parameter">T</A>></CODE></DL>
\r
524 <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
527 <!-- ========= END OF CLASS DATA ========= -->
\r
531 <!-- ======= START OF BOTTOM NAVBAR ====== -->
\r
532 <A NAME="navbar_bottom"><!-- --></A>
\r
533 <A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
\r
534 <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
\r
536 <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
\r
537 <A NAME="navbar_bottom_firstrow"><!-- --></A>
\r
538 <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
\r
539 <TR ALIGN="center" VALIGN="top">
\r
540 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD>
\r
541 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD>
\r
542 <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD>
\r
543 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/Parameter.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD>
\r
544 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
\r
545 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
\r
546 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../index-files/index-1.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
\r
547 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>
\r
551 <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
\r
557 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
\r
558 <A HREF="../../compbio/metadata/Option.html" title="class in compbio.metadata"><B>PREV CLASS</B></A>
\r
559 <A HREF="../../compbio/metadata/Preset.html" title="class in compbio.metadata"><B>NEXT CLASS</B></A></FONT></TD>
\r
560 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
\r
561 <A HREF="../../index.html?compbio/metadata/Parameter.html" target="_top"><B>FRAMES</B></A>
\r
562 <A HREF="Parameter.html" target="_top"><B>NO FRAMES</B></A>
\r
563 <SCRIPT type="text/javascript">
\r
566 document.writeln('<A HREF="../../allclasses-noframe.html"><B>All Classes</B></A>');
\r
571 <A HREF="../../allclasses-noframe.html"><B>All Classes</B></A>
\r
578 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
\r
579 SUMMARY: NESTED | <A HREF="#fields_inherited_from_class_compbio.metadata.Option">FIELD</A> | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD>
\r
580 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
\r
581 DETAIL: FIELD | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD>
\r
584 <A NAME="skip-navbar_bottom"></A>
\r
585 <!-- ======== END OF BOTTOM NAVBAR ======= -->
\r