delete old javadoc to update
[jabaws.git] / website / 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">\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 Parameter\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="Parameter";\r
19     }\r
20 }\r
21 </SCRIPT>\r
22 <NOSCRIPT>\r
23 </NOSCRIPT>\r
24 \r
25 </HEAD>\r
26 \r
27 <BODY BGCOLOR="white" onload="windowTitle();">\r
28 <HR>\r
29 \r
30 \r
31 <!-- ========= START OF TOP NAVBAR ======= -->\r
32 <A NAME="navbar_top"><!-- --></A>\r
33 <A HREF="#skip-navbar_top" title="Skip navigation links"></A>\r
34 <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">\r
35 <TR>\r
36 <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">\r
37 <A NAME="navbar_top_firstrow"><!-- --></A>\r
38 <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">\r
39   <TR ALIGN="center" VALIGN="top">\r
40   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>\r
41   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>\r
42   <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>\r
43   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="class-use/Parameter.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>\r
44   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>\r
45   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>\r
46   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../index-files/index-1.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>\r
47   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>\r
48   </TR>\r
49 </TABLE>\r
50 </TD>\r
51 <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>\r
52 </EM>\r
53 </TD>\r
54 </TR>\r
55 \r
56 <TR>\r
57 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">\r
58 &nbsp;<A HREF="../../compbio/metadata/Option.html" title="class in compbio.metadata"><B>PREV CLASS</B></A>&nbsp;\r
59 &nbsp;<A HREF="../../compbio/metadata/Preset.html" title="class in compbio.metadata"><B>NEXT CLASS</B></A></FONT></TD>\r
60 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">\r
61   <A HREF="../../index.html?compbio/metadata/Parameter.html" target="_top"><B>FRAMES</B></A>  &nbsp;\r
62 &nbsp;<A HREF="Parameter.html" target="_top"><B>NO FRAMES</B></A>  &nbsp;\r
63 &nbsp;<SCRIPT type="text/javascript">\r
64   <!--\r
65   if(window==top) {\r
66     document.writeln('<A HREF="../../allclasses-noframe.html"><B>All Classes</B></A>');\r
67   }\r
68   //-->\r
69 </SCRIPT>\r
70 <NOSCRIPT>\r
71   <A HREF="../../allclasses-noframe.html"><B>All Classes</B></A>\r
72 </NOSCRIPT>\r
73 \r
74 \r
75 </FONT></TD>\r
76 </TR>\r
77 <TR>\r
78 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">\r
79   SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;<A HREF="#fields_inherited_from_class_compbio.metadata.Option">FIELD</A>&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>\r
80 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">\r
81 DETAIL:&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>\r
82 </TR>\r
83 </TABLE>\r
84 <A NAME="skip-navbar_top"></A>\r
85 <!-- ========= END OF TOP NAVBAR ========= -->\r
86 \r
87 <HR>\r
88 <!-- ======== START OF CLASS DATA ======== -->\r
89 <H2>\r
90 <FONT SIZE="-1">\r
91 compbio.metadata</FONT>\r
92 <BR>\r
93 Class Parameter&lt;T&gt;</H2>\r
94 <PRE>\r
95 <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>&lt;T&gt;\r
97       <IMG SRC="../../resources/inherit.gif" ALT="extended by "><B>compbio.metadata.Parameter&lt;T&gt;</B>\r
98 </PRE>\r
99 <DL>\r
100 <DT><B>All Implemented Interfaces:</B> <DD><A HREF="../../compbio/metadata/Argument.html" title="interface in compbio.metadata">Argument</A>&lt;T&gt;</DD>\r
101 </DL>\r
102 <HR>\r
103 <DL>\r
104 <DT><PRE>public class <B>Parameter&lt;T&gt;</B><DT>extends <A HREF="../../compbio/metadata/Option.html" title="class in compbio.metadata">Option</A>&lt;T&gt;</DL>\r
105 </PRE>\r
106 \r
107 <P>\r
108 A single value containing an option supported by the web service e.g.
109  seqType=protein. Where seqType is a optionName and protein is one of
110  possibleValues\r
111 <P>\r
112 \r
113 <P>\r
114 <DL>\r
115 <DT><B>Version:</B></DT>\r
116   <DD>1.0 November 2009</DD>\r
117 <DT><B>Author:</B></DT>\r
118   <DD>pvtroshin</DD>\r
119 <DT><B>See Also:</B><DD><A HREF="../../compbio/metadata/Option.html" title="class in compbio.metadata"><CODE>Option</CODE></A>, \r
120 <A HREF="../../compbio/metadata/Argument.html" title="interface in compbio.metadata"><CODE>Argument</CODE></A></DL>\r
121 <HR>\r
122 \r
123 <P>\r
124 <!-- =========== FIELD SUMMARY =========== -->\r
125 \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
131 </TR>\r
132 </TABLE>\r
133 &nbsp;<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
137 </TR>\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
140 </TR>\r
141 </TABLE>\r
142 &nbsp;\r
143 <!-- ======== CONSTRUCTOR SUMMARY ======== -->\r
144 \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
150 </TR>\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>&nbsp;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>&nbsp;description)</CODE>\r
154 \r
155 <BR>\r
156 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>\r
157 </TR>\r
158 </TABLE>\r
159 &nbsp;\r
160 <!-- ========== METHOD SUMMARY =========== -->\r
161 \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
167 </TR>\r
168 <TR BGCOLOR="white" CLASS="TableRowColor">\r
169 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
170 <CODE>&nbsp;<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>&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
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>...&nbsp;value)</CODE>\r
172 \r
173 <BR>\r
174 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Adds an option to the optionName list</TD>\r
175 </TR>\r
176 <TR BGCOLOR="white" CLASS="TableRowColor">\r
177 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
178 <CODE>&nbsp;<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>&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
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>...&nbsp;value)</CODE>\r
180 \r
181 <BR>\r
182 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>\r
183 </TR>\r
184 <TR BGCOLOR="white" CLASS="TableRowColor">\r
185 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
186 <CODE>&nbsp;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>&nbsp;obj)</CODE>\r
188 \r
189 <BR>\r
190 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>\r
191 </TR>\r
192 <TR BGCOLOR="white" CLASS="TableRowColor">\r
193 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
194 <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
195 <TD><CODE><B><A HREF="../../compbio/metadata/Parameter.html#getOptionName()">getOptionName</A></B>()</CODE>\r
196 \r
197 <BR>\r
198 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>\r
199 </TR>\r
200 <TR BGCOLOR="white" CLASS="TableRowColor">\r
201 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
202 <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
203 <TD><CODE><B><A HREF="../../compbio/metadata/Parameter.html#getPossibleValues()">getPossibleValues</A></B>()</CODE>\r
204 \r
205 <BR>\r
206 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;List is more convenient to work with</TD>\r
207 </TR>\r
208 <TR BGCOLOR="white" CLASS="TableRowColor">\r
209 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
210 <CODE>&nbsp;<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
212 \r
213 <BR>\r
214 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>\r
215 </TR>\r
216 <TR BGCOLOR="white" CLASS="TableRowColor">\r
217 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
218 <CODE>&nbsp;int</CODE></FONT></TD>\r
219 <TD><CODE><B><A HREF="../../compbio/metadata/Parameter.html#hashCode()">hashCode</A></B>()</CODE>\r
220 \r
221 <BR>\r
222 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>\r
223 </TR>\r
224 <TR BGCOLOR="white" CLASS="TableRowColor">\r
225 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
226 <CODE>&nbsp;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>&nbsp;defaultVal)</CODE>\r
228 \r
229 <BR>\r
230 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Sets one of the values defined in optionList as default.</TD>\r
231 </TR>\r
232 <TR BGCOLOR="white" CLASS="TableRowColor">\r
233 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
234 <CODE>&nbsp;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>&nbsp;optionName)</CODE>\r
236 \r
237 <BR>\r
238 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>\r
239 </TR>\r
240 <TR BGCOLOR="white" CLASS="TableRowColor">\r
241 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
242 <CODE>&nbsp;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>&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;&nbsp;optionName)</CODE>\r
244 \r
245 <BR>\r
246 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>\r
247 </TR>\r
248 <TR BGCOLOR="white" CLASS="TableRowColor">\r
249 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
250 <CODE>&nbsp;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>&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;&nbsp;possibleValues)</CODE>\r
252 \r
253 <BR>\r
254 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>\r
255 </TR>\r
256 <TR BGCOLOR="white" CLASS="TableRowColor">\r
257 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
258 <CODE>&nbsp;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>&nbsp;validValue)</CODE>\r
260 \r
261 <BR>\r
262 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>\r
263 </TR>\r
264 <TR BGCOLOR="white" CLASS="TableRowColor">\r
265 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
266 <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
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>&nbsp;nameValueSeparator)</CODE>\r
268 \r
269 <BR>\r
270 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Convert the option to the command string.</TD>\r
271 </TR>\r
272 <TR BGCOLOR="white" CLASS="TableRowColor">\r
273 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
274 <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
275 <TD><CODE><B><A HREF="../../compbio/metadata/Parameter.html#toString()">toString</A></B>()</CODE>\r
276 \r
277 <BR>\r
278 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>\r
279 </TR>\r
280 </TABLE>\r
281 &nbsp;<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
285 </TR>\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
288 </TR>\r
289 </TABLE>\r
290 &nbsp;<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
294 </TR>\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
297 </TR>\r
298 </TABLE>\r
299 &nbsp;\r
300 <P>\r
301 \r
302 <!-- ========= CONSTRUCTOR DETAIL ======== -->\r
303 \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
309 </TR>\r
310 </TABLE>\r
311 \r
312 <A NAME="Parameter(java.lang.String, java.lang.String)"><!-- --></A><H3>\r
313 Parameter</H3>\r
314 <PRE>\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>&nbsp;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>&nbsp;description)</PRE>\r
317 <DL>\r
318 </DL>\r
319 \r
320 <!-- ============ METHOD DETAIL ========== -->\r
321 \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
327 </TR>\r
328 </TABLE>\r
329 \r
330 <A NAME="getValidValue()"><!-- --></A><H3>\r
331 getValidValue</H3>\r
332 <PRE>\r
333 public <A HREF="../../compbio/metadata/ValueConstrain.html" title="class in compbio.metadata">ValueConstrain</A> <B>getValidValue</B>()</PRE>\r
334 <DL>\r
335 <DD><DL>\r
336 </DL>\r
337 </DD>\r
338 </DL>\r
339 <HR>\r
340 \r
341 <A NAME="setValidValue(compbio.metadata.ValueConstrain)"><!-- --></A><H3>\r
342 setValidValue</H3>\r
343 <PRE>\r
344 public void <B>setValidValue</B>(<A HREF="../../compbio/metadata/ValueConstrain.html" title="class in compbio.metadata">ValueConstrain</A>&nbsp;validValue)</PRE>\r
345 <DL>\r
346 <DD><DL>\r
347 </DL>\r
348 </DD>\r
349 </DL>\r
350 <HR>\r
351 \r
352 <A NAME="toString()"><!-- --></A><H3>\r
353 toString</H3>\r
354 <PRE>\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
356 <DL>\r
357 <DD><DL>\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>&lt;<A HREF="../../compbio/metadata/Parameter.html" title="type parameter in Parameter">T</A>&gt;</CODE></DL>\r
359 </DD>\r
360 <DD><DL>\r
361 </DL>\r
362 </DD>\r
363 </DL>\r
364 <HR>\r
365 \r
366 <A NAME="toCommand(java.lang.String)"><!-- --></A><H3>\r
367 toCommand</H3>\r
368 <PRE>\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>&nbsp;nameValueSeparator)</PRE>\r
370 <DL>\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
373 <P>\r
374 <DD><DL>\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>&lt;<A HREF="../../compbio/metadata/Parameter.html" title="type parameter in Parameter">T</A>&gt;</CODE></DL>\r
376 </DD>\r
377 <DD><DL>\r
378 \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
382          be valid.</DL>\r
383 </DD>\r
384 </DL>\r
385 <HR>\r
386 \r
387 <A NAME="equals(java.lang.Object)"><!-- --></A><H3>\r
388 equals</H3>\r
389 <PRE>\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>&nbsp;obj)</PRE>\r
391 <DL>\r
392 <DD><DL>\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>&lt;<A HREF="../../compbio/metadata/Parameter.html" title="type parameter in Parameter">T</A>&gt;</CODE></DL>\r
394 </DD>\r
395 <DD><DL>\r
396 </DL>\r
397 </DD>\r
398 </DL>\r
399 <HR>\r
400 \r
401 <A NAME="getPossibleValues()"><!-- --></A><H3>\r
402 getPossibleValues</H3>\r
403 <PRE>\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>&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
405 <DL>\r
406 <DD>List is more convenient to work with\r
407 <P>\r
408 <DD><DL>\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>&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
410 </DD>\r
411 <DD><DL>\r
412 \r
413 <DT><B>Returns:</B><DD>List of String</DL>\r
414 </DD>\r
415 </DL>\r
416 <HR>\r
417 \r
418 <A NAME="setPossibleValues(java.util.Set)"><!-- --></A><H3>\r
419 setPossibleValues</H3>\r
420 <PRE>\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>&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;&nbsp;possibleValues)</PRE>\r
422 <DL>\r
423 <DD><DL>\r
424 </DL>\r
425 </DD>\r
426 </DL>\r
427 <HR>\r
428 \r
429 <A NAME="addPossibleValues(java.lang.String...)"><!-- --></A><H3>\r
430 addPossibleValues</H3>\r
431 <PRE>\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>&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>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>...&nbsp;value)</PRE>\r
433 <DL>\r
434 <DD><DL>\r
435 </DL>\r
436 </DD>\r
437 </DL>\r
438 <HR>\r
439 \r
440 <A NAME="hashCode()"><!-- --></A><H3>\r
441 hashCode</H3>\r
442 <PRE>\r
443 public int <B>hashCode</B>()</PRE>\r
444 <DL>\r
445 <DD><DL>\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>&lt;<A HREF="../../compbio/metadata/Parameter.html" title="type parameter in Parameter">T</A>&gt;</CODE></DL>\r
447 </DD>\r
448 <DD><DL>\r
449 </DL>\r
450 </DD>\r
451 </DL>\r
452 <HR>\r
453 \r
454 <A NAME="setOptionNames(java.util.Set)"><!-- --></A><H3>\r
455 setOptionNames</H3>\r
456 <PRE>\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>&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;&nbsp;optionName)</PRE>\r
458 <DL>\r
459 <DD><DL>\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>&lt;<A HREF="../../compbio/metadata/Parameter.html" title="type parameter in Parameter">T</A>&gt;</CODE></DL>\r
461 </DD>\r
462 <DD><DL>\r
463 </DL>\r
464 </DD>\r
465 </DL>\r
466 <HR>\r
467 \r
468 <A NAME="addOptionNames(java.lang.String...)"><!-- --></A><H3>\r
469 addOptionNames</H3>\r
470 <PRE>\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>&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>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>...&nbsp;value)</PRE>\r
472 <DL>\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
475 <P>\r
476 <DD><DL>\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>&lt;<A HREF="../../compbio/metadata/Parameter.html" title="type parameter in Parameter">T</A>&gt;</CODE></DL>\r
478 </DD>\r
479 <DD><DL>\r
480 \r
481 <DT><B>Returns:</B><DD>modified optionName list</DL>\r
482 </DD>\r
483 </DL>\r
484 <HR>\r
485 \r
486 <A NAME="getOptionName()"><!-- --></A><H3>\r
487 getOptionName</H3>\r
488 <PRE>\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
490 <DL>\r
491 <DD><DL>\r
492 </DL>\r
493 </DD>\r
494 </DL>\r
495 <HR>\r
496 \r
497 <A NAME="setOptionName(java.lang.String)"><!-- --></A><H3>\r
498 setOptionName</H3>\r
499 <PRE>\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>&nbsp;optionName)</PRE>\r
501 <DL>\r
502 <DD><DL>\r
503 </DL>\r
504 </DD>\r
505 </DL>\r
506 <HR>\r
507 \r
508 <A NAME="setDefaultValue(java.lang.String)"><!-- --></A><H3>\r
509 setDefaultValue</H3>\r
510 <PRE>\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>&nbsp;defaultVal)\r
512                      throws <A HREF="../../compbio/metadata/WrongParameterException.html" title="class in compbio.metadata">WrongParameterException</A></PRE>\r
513 <DL>\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
517 <P>\r
518 <DD><DL>\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>&lt;<A HREF="../../compbio/metadata/Parameter.html" title="type parameter in Parameter">T</A>&gt;</CODE></DL>\r
520 </DD>\r
521 <DD><DL>\r
522 \r
523 <DT><B>Throws:</B>\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
525 </DD>\r
526 </DL>\r
527 <!-- ========= END OF CLASS DATA ========= -->\r
528 <HR>\r
529 \r
530 \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
535 <TR>\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>&nbsp;</TD>\r
541   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>\r
542   <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>\r
543   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="class-use/Parameter.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>\r
544   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>\r
545   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>\r
546   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../index-files/index-1.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>\r
547   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>\r
548   </TR>\r
549 </TABLE>\r
550 </TD>\r
551 <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>\r
552 </EM>\r
553 </TD>\r
554 </TR>\r
555 \r
556 <TR>\r
557 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">\r
558 &nbsp;<A HREF="../../compbio/metadata/Option.html" title="class in compbio.metadata"><B>PREV CLASS</B></A>&nbsp;\r
559 &nbsp;<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>  &nbsp;\r
562 &nbsp;<A HREF="Parameter.html" target="_top"><B>NO FRAMES</B></A>  &nbsp;\r
563 &nbsp;<SCRIPT type="text/javascript">\r
564   <!--\r
565   if(window==top) {\r
566     document.writeln('<A HREF="../../allclasses-noframe.html"><B>All Classes</B></A>');\r
567   }\r
568   //-->\r
569 </SCRIPT>\r
570 <NOSCRIPT>\r
571   <A HREF="../../allclasses-noframe.html"><B>All Classes</B></A>\r
572 </NOSCRIPT>\r
573 \r
574 \r
575 </FONT></TD>\r
576 </TR>\r
577 <TR>\r
578 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">\r
579   SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;<A HREF="#fields_inherited_from_class_compbio.metadata.Option">FIELD</A>&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>\r
580 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">\r
581 DETAIL:&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>\r
582 </TR>\r
583 </TABLE>\r
584 <A NAME="skip-navbar_bottom"></A>\r
585 <!-- ======== END OF BOTTOM NAVBAR ======= -->\r
586 \r
587 <HR>\r
588 \r
589 </BODY>\r
590 </HTML>\r