updated javadoc
[jabaws.git] / website / dm_javadoc / compbio / metadata / package-use.html
index 1b8c1e2..75b2196 100644 (file)
@@ -2,12 +2,12 @@
 <!--NewPage-->\r
 <HTML>\r
 <HEAD>\r
-<!-- Generated by javadoc (build 1.6.0_14) on Wed Feb 17 16:46:28 GMT 2010 -->\r
+<!-- Generated by javadoc (build 1.6.0_24) on Fri Aug 12 14:32:04 BST 2011 -->\r
 <TITLE>\r
 Uses of Package compbio.metadata\r
 </TITLE>\r
 \r
-<META NAME="date" CONTENT="2010-02-17">\r
+<META NAME="date" CONTENT="2011-08-12">\r
 \r
 <LINK REL ="stylesheet" TYPE="text/css" HREF="../../stylesheet.css" TITLE="Style">\r
 \r
@@ -90,6 +90,14 @@ function windowTitle()
 Packages that use <A HREF="../../compbio/metadata/package-summary.html">compbio.metadata</A></FONT></TH>\r
 </TR>\r
 <TR BGCOLOR="white" CLASS="TableRowColor">\r
+<TD><A HREF="#compbio.data.msa"><B>compbio.data.msa</B></A></TD>\r
+<TD>Web Service interfaces for JAva Bioinformatics Analysis Web Services.&nbsp;</TD>\r
+</TR>\r
+<TR BGCOLOR="white" CLASS="TableRowColor">\r
+<TD><A HREF="#compbio.data.msa.jaxws"><B>compbio.data.msa.jaxws</B></A></TD>\r
+<TD>&nbsp;&nbsp;</TD>\r
+</TR>\r
+<TR BGCOLOR="white" CLASS="TableRowColor">\r
 <TD><A HREF="#compbio.metadata"><B>compbio.metadata</B></A></TD>\r
 <TD>A meta-data model for multiple sequence alignment web services 
  Classes in this package have no dependencies to other sources in the project.&nbsp;</TD>\r
@@ -97,6 +105,159 @@ Packages that use <A HREF="../../compbio/metadata/package-summary.html">compbio.
 </TABLE>\r
 &nbsp;\r
 <P>\r
+<A NAME="compbio.data.msa"><!-- --></A>\r
+<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">\r
+<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">\r
+<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">\r
+Classes in <A HREF="../../compbio/metadata/package-summary.html">compbio.metadata</A> used by <A HREF="../../compbio/data/msa/package-summary.html">compbio.data.msa</A></FONT></TH>\r
+</TR>\r
+<TR BGCOLOR="white" CLASS="TableRowColor">\r
+<TD><B><A HREF="../../compbio/metadata/class-use/ChunkHolder.html#compbio.data.msa"><B>ChunkHolder</B></A></B>\r
+\r
+<BR>\r
+&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Represents a chunk of a string data together with the position in a file for
+ the next read operation.</TD>\r
+</TR>\r
+<TR BGCOLOR="white" CLASS="TableRowColor">\r
+<TD><B><A HREF="../../compbio/metadata/class-use/JobStatus.html#compbio.data.msa"><B>JobStatus</B></A></B>\r
+\r
+<BR>\r
+&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;The status of the job.</TD>\r
+</TR>\r
+<TR BGCOLOR="white" CLASS="TableRowColor">\r
+<TD><B><A HREF="../../compbio/metadata/class-use/JobSubmissionException.html#compbio.data.msa"><B>JobSubmissionException</B></A></B>\r
+\r
+<BR>\r
+&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Exception for generic problems with JobSubmission it is often thrown as a
+ wrapper for the lower level exceptions like IOException or DrmaaException.</TD>\r
+</TR>\r
+<TR BGCOLOR="white" CLASS="TableRowColor">\r
+<TD><B><A HREF="../../compbio/metadata/class-use/Limit.html#compbio.data.msa"><B>Limit</B></A></B>\r
+\r
+<BR>\r
+&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;A value object containing a maximum number of sequences and a maximum average
+ sequence length for a preset.</TD>\r
+</TR>\r
+<TR BGCOLOR="white" CLASS="TableRowColor">\r
+<TD><B><A HREF="../../compbio/metadata/class-use/LimitExceededException.html#compbio.data.msa"><B>LimitExceededException</B></A></B>\r
+\r
+<BR>\r
+&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;This exception is thrown if the task larger in size that the limit that
+ applies to the calculation.</TD>\r
+</TR>\r
+<TR BGCOLOR="white" CLASS="TableRowColor">\r
+<TD><B><A HREF="../../compbio/metadata/class-use/LimitsManager.html#compbio.data.msa"><B>LimitsManager</B></A></B>\r
+\r
+<BR>\r
+&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;A collection of Limits</TD>\r
+</TR>\r
+<TR BGCOLOR="white" CLASS="TableRowColor">\r
+<TD><B><A HREF="../../compbio/metadata/class-use/Option.html#compbio.data.msa"><B>Option</B></A></B>\r
+\r
+<BR>\r
+&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Command line option/flag or multiple exclusive options with no value.</TD>\r
+</TR>\r
+<TR BGCOLOR="white" CLASS="TableRowColor">\r
+<TD><B><A HREF="../../compbio/metadata/class-use/Preset.html#compbio.data.msa"><B>Preset</B></A></B>\r
+\r
+<BR>\r
+&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Collection of Options and Parameters with their values</TD>\r
+</TR>\r
+<TR BGCOLOR="white" CLASS="TableRowColor">\r
+<TD><B><A HREF="../../compbio/metadata/class-use/PresetManager.html#compbio.data.msa"><B>PresetManager</B></A></B>\r
+\r
+<BR>\r
+&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
+</TR>\r
+<TR BGCOLOR="white" CLASS="TableRowColor">\r
+<TD><B><A HREF="../../compbio/metadata/class-use/ResultNotAvailableException.html#compbio.data.msa"><B>ResultNotAvailableException</B></A></B>\r
+\r
+<BR>\r
+&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;ResultNotAvailableException is thrown wherever the results of the calculation
+ cannot be obtained.</TD>\r
+</TR>\r
+<TR BGCOLOR="white" CLASS="TableRowColor">\r
+<TD><B><A HREF="../../compbio/metadata/class-use/RunnerConfig.html#compbio.data.msa"><B>RunnerConfig</B></A></B>\r
+\r
+<BR>\r
+&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
+</TR>\r
+<TR BGCOLOR="white" CLASS="TableRowColor">\r
+<TD><B><A HREF="../../compbio/metadata/class-use/UnsupportedRuntimeException.html#compbio.data.msa"><B>UnsupportedRuntimeException</B></A></B>\r
+\r
+<BR>\r
+&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Indicates that the server could not execute native executables.</TD>\r
+</TR>\r
+<TR BGCOLOR="white" CLASS="TableRowColor">\r
+<TD><B><A HREF="../../compbio/metadata/class-use/WrongParameterException.html#compbio.data.msa"><B>WrongParameterException</B></A></B>\r
+\r
+<BR>\r
+&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
+ does not match the actual runnable or then attempting to set the value of
+ <A HREF="../../compbio/metadata/Argument.html" title="interface in compbio.metadata"><CODE>Argument</CODE></A> to invalid value.</TD>\r
+</TR>\r
+</TABLE>\r
+&nbsp;\r
+<P>\r
+<A NAME="compbio.data.msa.jaxws"><!-- --></A>\r
+<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">\r
+<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">\r
+<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">\r
+Classes in <A HREF="../../compbio/metadata/package-summary.html">compbio.metadata</A> used by <A HREF="../../compbio/data/msa/jaxws/package-summary.html">compbio.data.msa.jaxws</A></FONT></TH>\r
+</TR>\r
+<TR BGCOLOR="white" CLASS="TableRowColor">\r
+<TD><B><A HREF="../../compbio/metadata/class-use/ChunkHolder.html#compbio.data.msa.jaxws"><B>ChunkHolder</B></A></B>\r
+\r
+<BR>\r
+&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Represents a chunk of a string data together with the position in a file for
+ the next read operation.</TD>\r
+</TR>\r
+<TR BGCOLOR="white" CLASS="TableRowColor">\r
+<TD><B><A HREF="../../compbio/metadata/class-use/JobStatus.html#compbio.data.msa.jaxws"><B>JobStatus</B></A></B>\r
+\r
+<BR>\r
+&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;The status of the job.</TD>\r
+</TR>\r
+<TR BGCOLOR="white" CLASS="TableRowColor">\r
+<TD><B><A HREF="../../compbio/metadata/class-use/Limit.html#compbio.data.msa.jaxws"><B>Limit</B></A></B>\r
+\r
+<BR>\r
+&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;A value object containing a maximum number of sequences and a maximum average
+ sequence length for a preset.</TD>\r
+</TR>\r
+<TR BGCOLOR="white" CLASS="TableRowColor">\r
+<TD><B><A HREF="../../compbio/metadata/class-use/LimitsManager.html#compbio.data.msa.jaxws"><B>LimitsManager</B></A></B>\r
+\r
+<BR>\r
+&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;A collection of Limits</TD>\r
+</TR>\r
+<TR BGCOLOR="white" CLASS="TableRowColor">\r
+<TD><B><A HREF="../../compbio/metadata/class-use/Option.html#compbio.data.msa.jaxws"><B>Option</B></A></B>\r
+\r
+<BR>\r
+&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Command line option/flag or multiple exclusive options with no value.</TD>\r
+</TR>\r
+<TR BGCOLOR="white" CLASS="TableRowColor">\r
+<TD><B><A HREF="../../compbio/metadata/class-use/Preset.html#compbio.data.msa.jaxws"><B>Preset</B></A></B>\r
+\r
+<BR>\r
+&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Collection of Options and Parameters with their values</TD>\r
+</TR>\r
+<TR BGCOLOR="white" CLASS="TableRowColor">\r
+<TD><B><A HREF="../../compbio/metadata/class-use/PresetManager.html#compbio.data.msa.jaxws"><B>PresetManager</B></A></B>\r
+\r
+<BR>\r
+&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
+</TR>\r
+<TR BGCOLOR="white" CLASS="TableRowColor">\r
+<TD><B><A HREF="../../compbio/metadata/class-use/RunnerConfig.html#compbio.data.msa.jaxws"><B>RunnerConfig</B></A></B>\r
+\r
+<BR>\r
+&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
+</TR>\r
+</TABLE>\r
+&nbsp;\r
+<P>\r
 <A NAME="compbio.metadata"><!-- --></A>\r
 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">\r
 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">\r
@@ -134,8 +295,8 @@ Classes in <A HREF="../../compbio/metadata/package-summary.html">compbio.metadat
 <TD><B><A HREF="../../compbio/metadata/class-use/LimitExceededException.html#compbio.metadata"><B>LimitExceededException</B></A></B>\r
 \r
 <BR>\r
-&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Thrown if the task larger in size that the limit that applies to the
- calculation.</TD>\r
+&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;This exception is thrown if the task larger in size that the limit that
+ applies to the calculation.</TD>\r
 </TR>\r
 <TR BGCOLOR="white" CLASS="TableRowColor">\r
 <TD><B><A HREF="../../compbio/metadata/class-use/Option.html#compbio.metadata"><B>Option</B></A></B>\r
@@ -147,7 +308,7 @@ Classes in <A HREF="../../compbio/metadata/package-summary.html">compbio.metadat
 <TD><B><A HREF="../../compbio/metadata/class-use/Parameter.html#compbio.metadata"><B>Parameter</B></A></B>\r
 \r
 <BR>\r
-&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;A single value containing option supported by the web service e.g.</TD>\r
+&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;A single value containing an option supported by the web service e.g.</TD>\r
 </TR>\r
 <TR BGCOLOR="white" CLASS="TableRowColor">\r
 <TD><B><A HREF="../../compbio/metadata/class-use/Preset.html#compbio.metadata"><B>Preset</B></A></B>\r