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_24) on Wed Dec 07 12:30:41 GMT 2011 -->
\r
10 <META NAME="date" CONTENT="2011-12-07">
\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="Argument";
\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/Argument.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 PREV CLASS
\r
59 <A HREF="../../compbio/metadata/ChunkHolder.html" title="class in compbio.metadata"><B>NEXT CLASS</B></A></FONT></TD>
\r
60 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
\r
61 <A HREF="../../index.html?compbio/metadata/Argument.html" target="_top"><B>FRAMES</B></A>
\r
62 <A HREF="Argument.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 | FIELD | CONSTR | <A HREF="#method_summary">METHOD</A></FONT></TD>
\r
80 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
\r
81 DETAIL: FIELD | CONSTR | <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 Interface Argument<T></H2>
\r
95 <DT><DT><B>Type Parameters:</B><DD><CODE>T</CODE> - executable type</DL>
\r
97 <DT><B>All Known Implementing Classes:</B> <DD><A HREF="../../compbio/metadata/Option.html" title="class in compbio.metadata">Option</A>, <A HREF="../../compbio/metadata/Parameter.html" title="class in compbio.metadata">Parameter</A></DD>
\r
101 <DT><PRE>public interface <B>Argument<T></B></DL>
\r
105 An unmodifiable view for the options and parameters, with one exception - it
106 allows to set a value
\r
111 <DT><B>Author:</B></DT>
\r
114 Date December 2009</DD>
\r
115 <DT><B>See Also:</B><DD><A HREF="../../compbio/metadata/Parameter.html" title="class in compbio.metadata"><CODE>Parameter</CODE></A>,
\r
116 <A HREF="../../compbio/metadata/Option.html" title="class in compbio.metadata"><CODE>Option</CODE></A></DL>
\r
121 <!-- ========== METHOD SUMMARY =========== -->
\r
123 <A NAME="method_summary"><!-- --></A>
\r
124 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
\r
125 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
\r
126 <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
\r
127 <B>Method Summary</B></FONT></TH>
\r
129 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
130 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
131 <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
132 <TD><CODE><B><A HREF="../../compbio/metadata/Argument.html#getDefaultValue()">getDefaultValue</A></B>()</CODE>
\r
135 </TD>
\r
137 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
138 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
139 <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
140 <TD><CODE><B><A HREF="../../compbio/metadata/Argument.html#getDescription()">getDescription</A></B>()</CODE>
\r
143 </TD>
\r
145 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
146 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
147 <CODE> <A HREF="http://java.sun.com/javase/6/docs/api/java/net/URL.html?is-external=true" title="class or interface in java.net">URL</A></CODE></FONT></TD>
\r
148 <TD><CODE><B><A HREF="../../compbio/metadata/Argument.html#getFurtherDetails()">getFurtherDetails</A></B>()</CODE>
\r
151 </TD>
\r
153 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
154 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
155 <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
156 <TD><CODE><B><A HREF="../../compbio/metadata/Argument.html#getName()">getName</A></B>()</CODE>
\r
159 </TD>
\r
161 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
162 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
163 <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
164 <TD><CODE><B><A HREF="../../compbio/metadata/Argument.html#getPossibleValues()">getPossibleValues</A></B>()</CODE>
\r
167 </TD>
\r
169 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
170 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
171 <CODE> void</CODE></FONT></TD>
\r
172 <TD><CODE><B><A HREF="../../compbio/metadata/Argument.html#setValue(java.lang.String)">setValue</A></B>(<A HREF="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> defaultValue)</CODE>
\r
175 Set default values for the parameter or an option</TD>
\r
181 <!-- ============ METHOD DETAIL ========== -->
\r
183 <A NAME="method_detail"><!-- --></A>
\r
184 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
\r
185 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
\r
186 <TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
\r
187 <B>Method Detail</B></FONT></TH>
\r
191 <A NAME="getFurtherDetails()"><!-- --></A><H3>
\r
192 getFurtherDetails</H3>
\r
194 <A HREF="http://java.sun.com/javase/6/docs/api/java/net/URL.html?is-external=true" title="class or interface in java.net">URL</A> <B>getFurtherDetails</B>()</PRE>
\r
202 <A NAME="getDefaultValue()"><!-- --></A><H3>
\r
203 getDefaultValue</H3>
\r
205 <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> <B>getDefaultValue</B>()</PRE>
\r
213 <A NAME="getDescription()"><!-- --></A><H3>
\r
214 getDescription</H3>
\r
216 <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> <B>getDescription</B>()</PRE>
\r
224 <A NAME="getName()"><!-- --></A><H3>
\r
227 <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> <B>getName</B>()</PRE>
\r
235 <A NAME="getPossibleValues()"><!-- --></A><H3>
\r
236 getPossibleValues</H3>
\r
238 <A HREF="http://java.sun.com/javase/6/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</A><<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
242 <DT><B>Returns:</B><DD>List of values allowed for an Argument</DL>
\r
247 <A NAME="setValue(java.lang.String)"><!-- --></A><H3>
\r
250 void <B>setValue</B>(<A HREF="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> defaultValue)
\r
251 throws <A HREF="../../compbio/metadata/WrongParameterException.html" title="class in compbio.metadata">WrongParameterException</A></PRE>
\r
253 <DD>Set default values for the parameter or an option
\r
256 <DT><B>Parameters:</B><DD><CODE>defaultValue</CODE> - the value to be set
\r
258 <DD><CODE><A HREF="../../compbio/metadata/WrongParameterException.html" title="class in compbio.metadata">WrongParameterException</A></CODE> - - when the value to be set is illegal. Wrong value for
259 numeric parameter is the value defined outside it , for
260 string type parameter, wrong value is the one which is not
261 listed in possible values list<DT><B>See Also:</B><DD><A HREF="../../compbio/metadata/ValueConstrain.html" title="class in compbio.metadata"><CODE>ValueConstrain</CODE></A></DL>
\r
264 <!-- ========= END OF CLASS DATA ========= -->
\r
268 <!-- ======= START OF BOTTOM NAVBAR ====== -->
\r
269 <A NAME="navbar_bottom"><!-- --></A>
\r
270 <A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
\r
271 <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
\r
273 <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
\r
274 <A NAME="navbar_bottom_firstrow"><!-- --></A>
\r
275 <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
\r
276 <TR ALIGN="center" VALIGN="top">
\r
277 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD>
\r
278 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD>
\r
279 <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD>
\r
280 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/Argument.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD>
\r
281 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
\r
282 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
\r
283 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../index-files/index-1.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
\r
284 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>
\r
288 <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
\r
294 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
\r
295 PREV CLASS
\r
296 <A HREF="../../compbio/metadata/ChunkHolder.html" title="class in compbio.metadata"><B>NEXT CLASS</B></A></FONT></TD>
\r
297 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
\r
298 <A HREF="../../index.html?compbio/metadata/Argument.html" target="_top"><B>FRAMES</B></A>
\r
299 <A HREF="Argument.html" target="_top"><B>NO FRAMES</B></A>
\r
300 <SCRIPT type="text/javascript">
\r
303 document.writeln('<A HREF="../../allclasses-noframe.html"><B>All Classes</B></A>');
\r
308 <A HREF="../../allclasses-noframe.html"><B>All Classes</B></A>
\r
315 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
\r
316 SUMMARY: NESTED | FIELD | CONSTR | <A HREF="#method_summary">METHOD</A></FONT></TD>
\r
317 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
\r
318 DETAIL: FIELD | CONSTR | <A HREF="#method_detail">METHOD</A></FONT></TD>
\r
321 <A NAME="skip-navbar_bottom"></A>
\r
322 <!-- ======== END OF BOTTOM NAVBAR ======= -->
\r