website/full_javadoc/compbio/metadata/package-summary.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_24) on Fri Aug 12 14:32:36 BST 2011 -->\r
   6 <TITLE>\r
   7 compbio.metadata\r
   8 </TITLE>\r
   9 \r
  10 <META NAME="date" CONTENT="2011-08-12">\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="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="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Package</B></FONT>&nbsp;</TD>\r
  42   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <FONT CLASS="NavBarFont1">Class</FONT>&nbsp;</TD>\r
  43   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-use.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/engine/local/package-summary.html"><B>PREV PACKAGE</B></A>&nbsp;\r
  59 &nbsp;<A HREF="../../compbio/pipeline/_jpred/package-summary.html"><B>NEXT PACKAGE</B></A></FONT></TD>\r
  60 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">\r
  61   <A HREF="../../index.html?compbio/metadata/package-summary.html" target="_top"><B>FRAMES</B></A>  &nbsp;\r
  62 &nbsp;<A HREF="package-summary.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 <H2>\r
  83 Package compbio.metadata\r
  84 </H2>\r
  85 A meta-data model for multiple sequence alignment web services
  86  Classes in this package have no dependencies to other sources in the project.\r
  87 <P>\r
  88 <B>See:</B>\r
  89 <BR>\r
  90 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<A HREF="#package_description"><B>Description</B></A>\r
  91 <P>\r
  92 \r
  93 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">\r
  94 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">\r
  95 <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">\r
  96 <B>Interface Summary</B></FONT></TH>\r
  97 </TR>\r
  98 <TR BGCOLOR="white" CLASS="TableRowColor">\r
  99 <TD WIDTH="15%"><B><A HREF="../../compbio/metadata/Argument.html" title="interface in compbio.metadata">Argument&lt;T&gt;</A></B></TD>\r
 100 <TD>An unmodifiable view for the options and parameters, with one exception - it
 101  allows to set a value</TD>\r
 102 </TR>\r
 103 </TABLE>\r
 104 &nbsp;\r
 105 \r
 106 <P>\r
 107 \r
 108 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">\r
 109 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">\r
 110 <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">\r
 111 <B>Class Summary</B></FONT></TH>\r
 112 </TR>\r
 113 <TR BGCOLOR="white" CLASS="TableRowColor">\r
 114 <TD WIDTH="15%"><B><A HREF="../../compbio/metadata/ChunkHolder.html" title="class in compbio.metadata">ChunkHolder</A></B></TD>\r
 115 <TD>Represents a chunk of a string data together with the position in a file for
 116  the next read operation.</TD>\r
 117 </TR>\r
 118 <TR BGCOLOR="white" CLASS="TableRowColor">\r
 119 <TD WIDTH="15%"><B><A HREF="../../compbio/metadata/Limit.html" title="class in compbio.metadata">Limit&lt;T&gt;</A></B></TD>\r
 120 <TD>A value object containing a maximum number of sequences and a maximum average
 121  sequence length for a preset.</TD>\r
 122 </TR>\r
 123 <TR BGCOLOR="white" CLASS="TableRowColor">\r
 124 <TD WIDTH="15%"><B><A HREF="../../compbio/metadata/LimitsManager.html" title="class in compbio.metadata">LimitsManager&lt;T&gt;</A></B></TD>\r
 125 <TD>A collection of Limits</TD>\r
 126 </TR>\r
 127 <TR BGCOLOR="white" CLASS="TableRowColor">\r
 128 <TD WIDTH="15%"><B><A HREF="../../compbio/metadata/Option.html" title="class in compbio.metadata">Option&lt;T&gt;</A></B></TD>\r
 129 <TD>Command line option/flag or multiple exclusive options with no value.</TD>\r
 130 </TR>\r
 131 <TR BGCOLOR="white" CLASS="TableRowColor">\r
 132 <TD WIDTH="15%"><B><A HREF="../../compbio/metadata/Parameter.html" title="class in compbio.metadata">Parameter&lt;T&gt;</A></B></TD>\r
 133 <TD>A single value containing an option supported by the web service e.g.</TD>\r
 134 </TR>\r
 135 <TR BGCOLOR="white" CLASS="TableRowColor">\r
 136 <TD WIDTH="15%"><B><A HREF="../../compbio/metadata/Preset.html" title="class in compbio.metadata">Preset&lt;T&gt;</A></B></TD>\r
 137 <TD>Collection of Options and Parameters with their values</TD>\r
 138 </TR>\r
 139 <TR BGCOLOR="white" CLASS="TableRowColor">\r
 140 <TD WIDTH="15%"><B><A HREF="../../compbio/metadata/PresetManager.html" title="class in compbio.metadata">PresetManager&lt;T&gt;</A></B></TD>\r
 141 <TD>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
 142 </TR>\r
 143 <TR BGCOLOR="white" CLASS="TableRowColor">\r
 144 <TD WIDTH="15%"><B><A HREF="../../compbio/metadata/RunnerConfig.html" title="class in compbio.metadata">RunnerConfig&lt;T&gt;</A></B></TD>\r
 145 <TD>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
 146 </TR>\r
 147 <TR BGCOLOR="white" CLASS="TableRowColor">\r
 148 <TD WIDTH="15%"><B><A HREF="../../compbio/metadata/ValueConstrain.html" title="class in compbio.metadata">ValueConstrain</A></B></TD>\r
 149 <TD>The type and the lower and upper boundaries for numerical value.</TD>\r
 150 </TR>\r
 151 </TABLE>\r
 152 &nbsp;\r
 153 \r
 154 <P>\r
 155 \r
 156 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">\r
 157 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">\r
 158 <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">\r
 159 <B>Enum Summary</B></FONT></TH>\r
 160 </TR>\r
 161 <TR BGCOLOR="white" CLASS="TableRowColor">\r
 162 <TD WIDTH="15%"><B><A HREF="../../compbio/metadata/JobStatus.html" title="enum in compbio.metadata">JobStatus</A></B></TD>\r
 163 <TD>The status of the job.</TD>\r
 164 </TR>\r
 165 <TR BGCOLOR="white" CLASS="TableRowColor">\r
 166 <TD WIDTH="15%"><B><A HREF="../../compbio/metadata/ValueConstrain.Type.html" title="enum in compbio.metadata">ValueConstrain.Type</A></B></TD>\r
 167 <TD>&nbsp;</TD>\r
 168 </TR>\r
 169 </TABLE>\r
 170 &nbsp;\r
 171 \r
 172 <P>\r
 173 \r
 174 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">\r
 175 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">\r
 176 <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">\r
 177 <B>Exception Summary</B></FONT></TH>\r
 178 </TR>\r
 179 <TR BGCOLOR="white" CLASS="TableRowColor">\r
 180 <TD WIDTH="15%"><B><A HREF="../../compbio/metadata/JobExecutionException.html" title="class in compbio.metadata">JobExecutionException</A></B></TD>\r
 181 <TD>JobExecutionException is thrown wherever the results of the calculation
 182  cannot be obtained.</TD>\r
 183 </TR>\r
 184 <TR BGCOLOR="white" CLASS="TableRowColor">\r
 185 <TD WIDTH="15%"><B><A HREF="../../compbio/metadata/JobSubmissionException.html" title="class in compbio.metadata">JobSubmissionException</A></B></TD>\r
 186 <TD>Exception for generic problems with JobSubmission it is often thrown as a
 187  wrapper for the lower level exceptions like IOException or DrmaaException.</TD>\r
 188 </TR>\r
 189 <TR BGCOLOR="white" CLASS="TableRowColor">\r
 190 <TD WIDTH="15%"><B><A HREF="../../compbio/metadata/LimitExceededException.html" title="class in compbio.metadata">LimitExceededException</A></B></TD>\r
 191 <TD>This exception is thrown if the task larger in size that the limit that
 192  applies to the calculation.</TD>\r
 193 </TR>\r
 194 <TR BGCOLOR="white" CLASS="TableRowColor">\r
 195 <TD WIDTH="15%"><B><A HREF="../../compbio/metadata/ResultNotAvailableException.html" title="class in compbio.metadata">ResultNotAvailableException</A></B></TD>\r
 196 <TD>ResultNotAvailableException is thrown wherever the results of the calculation
 197  cannot be obtained.</TD>\r
 198 </TR>\r
 199 <TR BGCOLOR="white" CLASS="TableRowColor">\r
 200 <TD WIDTH="15%"><B><A HREF="../../compbio/metadata/UnsupportedRuntimeException.html" title="class in compbio.metadata">UnsupportedRuntimeException</A></B></TD>\r
 201 <TD>Indicates that the server could not execute native executables.</TD>\r
 202 </TR>\r
 203 <TR BGCOLOR="white" CLASS="TableRowColor">\r
 204 <TD WIDTH="15%"><B><A HREF="../../compbio/metadata/WrongParameterException.html" title="class in compbio.metadata">WrongParameterException</A></B></TD>\r
 205 <TD>WrongParameterException is thrown wherever the <A HREF="../../compbio/metadata/RunnerConfig.html" title="class in compbio.metadata"><CODE>RunnerConfig</CODE></A> object
 206  does not match the actual runnable or then attempting to set the value of
 207  <A HREF="../../compbio/metadata/Argument.html" title="interface in compbio.metadata"><CODE>Argument</CODE></A> to invalid value.</TD>\r
 208 </TR>\r
 209 </TABLE>\r
 210 &nbsp;\r
 211 \r
 212 <P>\r
 213 <A NAME="package_description"><!-- --></A><H2>\r
 214 Package compbio.metadata Description\r
 215 </H2>\r
 216 \r
 217 <P>\r
 218 A meta-data model for multiple sequence alignment web services
 219  Classes in this package have no dependencies to other sources in the project.
 220  They form a base layer of JAva Bioinformatics Analysis Web Services (JABAWS)\r
 221 <P>\r
 222 \r
 223 <P>\r
 224 <DL>\r
 225 <DT><B>Version:</B></DT>\r
 226   <DD>1.0 January 2010</DD>\r
 227 <DT><B>Author:</B></DT>\r
 228   <DD>Peter Troshin</DD>\r
 229 </DL>\r
 230 <HR>\r
 231 \r
 232 \r
 233 <!-- ======= START OF BOTTOM NAVBAR ====== -->\r
 234 <A NAME="navbar_bottom"><!-- --></A>\r
 235 <A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>\r
 236 <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">\r
 237 <TR>\r
 238 <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">\r
 239 <A NAME="navbar_bottom_firstrow"><!-- --></A>\r
 240 <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">\r
 241   <TR ALIGN="center" VALIGN="top">\r
 242   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>\r
 243   <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Package</B></FONT>&nbsp;</TD>\r
 244   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <FONT CLASS="NavBarFont1">Class</FONT>&nbsp;</TD>\r
 245   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-use.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>\r
 246   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>\r
 247   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>\r
 248   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../index-files/index-1.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>\r
 249   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>\r
 250   </TR>\r
 251 </TABLE>\r
 252 </TD>\r
 253 <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>\r
 254 </EM>\r
 255 </TD>\r
 256 </TR>\r
 257 \r
 258 <TR>\r
 259 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">\r
 260 &nbsp;<A HREF="../../compbio/engine/local/package-summary.html"><B>PREV PACKAGE</B></A>&nbsp;\r
 261 &nbsp;<A HREF="../../compbio/pipeline/_jpred/package-summary.html"><B>NEXT PACKAGE</B></A></FONT></TD>\r
 262 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">\r
 263   <A HREF="../../index.html?compbio/metadata/package-summary.html" target="_top"><B>FRAMES</B></A>  &nbsp;\r
 264 &nbsp;<A HREF="package-summary.html" target="_top"><B>NO FRAMES</B></A>  &nbsp;\r
 265 &nbsp;<SCRIPT type="text/javascript">\r
 266   <!--\r
 267   if(window==top) {\r
 268     document.writeln('<A HREF="../../allclasses-noframe.html"><B>All Classes</B></A>');\r
 269   }\r
 270   //-->\r
 271 </SCRIPT>\r
 272 <NOSCRIPT>\r
 273   <A HREF="../../allclasses-noframe.html"><B>All Classes</B></A>\r
 274 </NOSCRIPT>\r
 275 \r
 276 \r
 277 </FONT></TD>\r
 278 </TR>\r
 279 </TABLE>\r
 280 <A NAME="skip-navbar_bottom"></A>\r
 281 <!-- ======== END OF BOTTOM NAVBAR ======= -->\r
 282 \r
 283 <HR>\r
 284 \r
 285 </BODY>\r
 286 </HTML>\r