updates to jaba2 from jaba release branch
[jabaws.git] / website / dm_javadoc / compbio / metadata / package-use.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_14) on Wed Feb 17 16:46:28 GMT 2010 -->\r
6 <TITLE>\r
7 Uses of Package compbio.metadata\r
8 </TITLE>\r
9 \r
10 <META NAME="date" CONTENT="2010-02-17">\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="Uses of Package compbio.metadata";\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="#EEEEFF" CLASS="NavBarCell1">    <FONT CLASS="NavBarFont1">Class</FONT>&nbsp;</TD>\r
43   <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Use</B></FONT>&nbsp;</TD>\r
44   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>\r
45   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>\r
46   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../index-files/index-1.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>\r
47   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>\r
48   </TR>\r
49 </TABLE>\r
50 </TD>\r
51 <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>\r
52 </EM>\r
53 </TD>\r
54 </TR>\r
55 \r
56 <TR>\r
57 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">\r
58 &nbsp;PREV&nbsp;\r
59 &nbsp;NEXT</FONT></TD>\r
60 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">\r
61   <A HREF="../../index.html?compbio/metadata/package-use.html" target="_top"><B>FRAMES</B></A>  &nbsp;\r
62 &nbsp;<A HREF="package-use.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 </TABLE>\r
78 <A NAME="skip-navbar_top"></A>\r
79 <!-- ========= END OF TOP NAVBAR ========= -->\r
80 \r
81 <HR>\r
82 <CENTER>\r
83 <H2>\r
84 <B>Uses of Package<br>compbio.metadata</B></H2>\r
85 </CENTER>\r
86 \r
87 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">\r
88 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">\r
89 <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">\r
90 Packages that use <A HREF="../../compbio/metadata/package-summary.html">compbio.metadata</A></FONT></TH>\r
91 </TR>\r
92 <TR BGCOLOR="white" CLASS="TableRowColor">\r
93 <TD><A HREF="#compbio.metadata"><B>compbio.metadata</B></A></TD>\r
94 <TD>A meta-data model for multiple sequence alignment web services 
95  Classes in this package have no dependencies to other sources in the project.&nbsp;</TD>\r
96 </TR>\r
97 </TABLE>\r
98 &nbsp;\r
99 <P>\r
100 <A NAME="compbio.metadata"><!-- --></A>\r
101 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">\r
102 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">\r
103 <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">\r
104 Classes in <A HREF="../../compbio/metadata/package-summary.html">compbio.metadata</A> used by <A HREF="../../compbio/metadata/package-summary.html">compbio.metadata</A></FONT></TH>\r
105 </TR>\r
106 <TR BGCOLOR="white" CLASS="TableRowColor">\r
107 <TD><B><A HREF="../../compbio/metadata/class-use/Argument.html#compbio.metadata"><B>Argument</B></A></B>\r
108 \r
109 <BR>\r
110 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;An unmodifiable view for the options and parameters, with one exception - it
111  allows to set a value</TD>\r
112 </TR>\r
113 <TR BGCOLOR="white" CLASS="TableRowColor">\r
114 <TD><B><A HREF="../../compbio/metadata/class-use/JobStatus.html#compbio.metadata"><B>JobStatus</B></A></B>\r
115 \r
116 <BR>\r
117 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;The status of the job.</TD>\r
118 </TR>\r
119 <TR BGCOLOR="white" CLASS="TableRowColor">\r
120 <TD><B><A HREF="../../compbio/metadata/class-use/JobSubmissionException.html#compbio.metadata"><B>JobSubmissionException</B></A></B>\r
121 \r
122 <BR>\r
123 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Exception for generic problems with JobSubmission it is often thrown as a
124  wrapper for the lower level exceptions like IOException or DrmaaException.</TD>\r
125 </TR>\r
126 <TR BGCOLOR="white" CLASS="TableRowColor">\r
127 <TD><B><A HREF="../../compbio/metadata/class-use/Limit.html#compbio.metadata"><B>Limit</B></A></B>\r
128 \r
129 <BR>\r
130 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;A value object containing a maximum number of sequences and a maximum average
131  sequence length for a preset.</TD>\r
132 </TR>\r
133 <TR BGCOLOR="white" CLASS="TableRowColor">\r
134 <TD><B><A HREF="../../compbio/metadata/class-use/LimitExceededException.html#compbio.metadata"><B>LimitExceededException</B></A></B>\r
135 \r
136 <BR>\r
137 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Thrown if the task larger in size that the limit that applies to the
138  calculation.</TD>\r
139 </TR>\r
140 <TR BGCOLOR="white" CLASS="TableRowColor">\r
141 <TD><B><A HREF="../../compbio/metadata/class-use/Option.html#compbio.metadata"><B>Option</B></A></B>\r
142 \r
143 <BR>\r
144 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Command line option/flag or multiple exclusive options with no value.</TD>\r
145 </TR>\r
146 <TR BGCOLOR="white" CLASS="TableRowColor">\r
147 <TD><B><A HREF="../../compbio/metadata/class-use/Parameter.html#compbio.metadata"><B>Parameter</B></A></B>\r
148 \r
149 <BR>\r
150 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;A single value containing option supported by the web service e.g.</TD>\r
151 </TR>\r
152 <TR BGCOLOR="white" CLASS="TableRowColor">\r
153 <TD><B><A HREF="../../compbio/metadata/class-use/Preset.html#compbio.metadata"><B>Preset</B></A></B>\r
154 \r
155 <BR>\r
156 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Collection of Options and Parameters with their values</TD>\r
157 </TR>\r
158 <TR BGCOLOR="white" CLASS="TableRowColor">\r
159 <TD><B><A HREF="../../compbio/metadata/class-use/PresetManager.html#compbio.metadata"><B>PresetManager</B></A></B>\r
160 \r
161 <BR>\r
162 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Collection of presets and methods to manipulate them @see <A HREF="../../compbio/metadata/Preset.html" title="class in compbio.metadata"><CODE>Preset</CODE></A></TD>\r
163 </TR>\r
164 <TR BGCOLOR="white" CLASS="TableRowColor">\r
165 <TD><B><A HREF="../../compbio/metadata/class-use/RunnerConfig.html#compbio.metadata"><B>RunnerConfig</B></A></B>\r
166 \r
167 <BR>\r
168 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;The list of <A HREF="../../compbio/metadata/Parameter.html" title="class in compbio.metadata"><CODE>Parameter</CODE></A>s and <A HREF="../../compbio/metadata/Option.html" title="class in compbio.metadata"><CODE>Option</CODE></A>s supported by executable.</TD>\r
169 </TR>\r
170 <TR BGCOLOR="white" CLASS="TableRowColor">\r
171 <TD><B><A HREF="../../compbio/metadata/class-use/ValueConstrain.html#compbio.metadata"><B>ValueConstrain</B></A></B>\r
172 \r
173 <BR>\r
174 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;The type and the lower and upper boundaries for numerical value.</TD>\r
175 </TR>\r
176 <TR BGCOLOR="white" CLASS="TableRowColor">\r
177 <TD><B><A HREF="../../compbio/metadata/class-use/ValueConstrain.Type.html#compbio.metadata"><B>ValueConstrain.Type</B></A></B>\r
178 \r
179 <BR>\r
180 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>\r
181 </TR>\r
182 <TR BGCOLOR="white" CLASS="TableRowColor">\r
183 <TD><B><A HREF="../../compbio/metadata/class-use/WrongParameterException.html#compbio.metadata"><B>WrongParameterException</B></A></B>\r
184 \r
185 <BR>\r
186 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;WrongParameterException is thrown wherever the <A HREF="../../compbio/metadata/RunnerConfig.html" title="class in compbio.metadata"><CODE>RunnerConfig</CODE></A> object
187  does not match the actual runnable or then attempting to set the value of
188  <A HREF="../../compbio/metadata/Argument.html" title="interface in compbio.metadata"><CODE>Argument</CODE></A> to invalid value.</TD>\r
189 </TR>\r
190 </TABLE>\r
191 &nbsp;\r
192 <P>\r
193 <HR>\r
194 \r
195 \r
196 <!-- ======= START OF BOTTOM NAVBAR ====== -->\r
197 <A NAME="navbar_bottom"><!-- --></A>\r
198 <A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>\r
199 <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">\r
200 <TR>\r
201 <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">\r
202 <A NAME="navbar_bottom_firstrow"><!-- --></A>\r
203 <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">\r
204   <TR ALIGN="center" VALIGN="top">\r
205   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>\r
206   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>\r
207   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <FONT CLASS="NavBarFont1">Class</FONT>&nbsp;</TD>\r
208   <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Use</B></FONT>&nbsp;</TD>\r
209   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>\r
210   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>\r
211   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../index-files/index-1.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>\r
212   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>\r
213   </TR>\r
214 </TABLE>\r
215 </TD>\r
216 <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>\r
217 </EM>\r
218 </TD>\r
219 </TR>\r
220 \r
221 <TR>\r
222 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">\r
223 &nbsp;PREV&nbsp;\r
224 &nbsp;NEXT</FONT></TD>\r
225 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">\r
226   <A HREF="../../index.html?compbio/metadata/package-use.html" target="_top"><B>FRAMES</B></A>  &nbsp;\r
227 &nbsp;<A HREF="package-use.html" target="_top"><B>NO FRAMES</B></A>  &nbsp;\r
228 &nbsp;<SCRIPT type="text/javascript">\r
229   <!--\r
230   if(window==top) {\r
231     document.writeln('<A HREF="../../allclasses-noframe.html"><B>All Classes</B></A>');\r
232   }\r
233   //-->\r
234 </SCRIPT>\r
235 <NOSCRIPT>\r
236   <A HREF="../../allclasses-noframe.html"><B>All Classes</B></A>\r
237 </NOSCRIPT>\r
238 \r
239 \r
240 </FONT></TD>\r
241 </TR>\r
242 </TABLE>\r
243 <A NAME="skip-navbar_bottom"></A>\r
244 <!-- ======== END OF BOTTOM NAVBAR ======= -->\r
245 \r
246 <HR>\r
247 \r
248 </BODY>\r
249 </HTML>\r