--- /dev/null
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">\r
+<!--NewPage-->\r
+<HTML>\r
+<HEAD>\r
+<!-- Generated by javadoc (build 1.6.0_24) on Wed Dec 07 12:30:41 GMT 2011 -->\r
+<TITLE>\r
+SequenceAnnotation\r
+</TITLE>\r
+\r
+<META NAME="date" CONTENT="2011-12-07">\r
+\r
+<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../stylesheet.css" TITLE="Style">\r
+\r
+<SCRIPT type="text/javascript">\r
+function windowTitle()\r
+{\r
+ if (location.href.indexOf('is-external=true') == -1) {\r
+ parent.document.title="SequenceAnnotation";\r
+ }\r
+}\r
+</SCRIPT>\r
+<NOSCRIPT>\r
+</NOSCRIPT>\r
+\r
+</HEAD>\r
+\r
+<BODY BGCOLOR="white" onload="windowTitle();">\r
+<HR>\r
+\r
+\r
+<!-- ========= START OF TOP NAVBAR ======= -->\r
+<A NAME="navbar_top"><!-- --></A>\r
+<A HREF="#skip-navbar_top" title="Skip navigation links"></A>\r
+<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">\r
+<TR>\r
+<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">\r
+<A NAME="navbar_top_firstrow"><!-- --></A>\r
+<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">\r
+ <TR ALIGN="center" VALIGN="top">\r
+ <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD>\r
+ <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD>\r
+ <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD>\r
+ <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/SequenceAnnotation.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD>\r
+ <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>\r
+ <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>\r
+ <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../index-files/index-1.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>\r
+ <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>\r
+ </TR>\r
+</TABLE>\r
+</TD>\r
+<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>\r
+</EM>\r
+</TD>\r
+</TR>\r
+\r
+<TR>\r
+<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">\r
+ <A HREF="../../../compbio/data/msa/RegistryWS.html" title="interface in compbio.data.msa"><B>PREV CLASS</B></A> \r
+ NEXT CLASS</FONT></TD>\r
+<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">\r
+ <A HREF="../../../index.html?compbio/data/msa/SequenceAnnotation.html" target="_top"><B>FRAMES</B></A> \r
+ <A HREF="SequenceAnnotation.html" target="_top"><B>NO FRAMES</B></A> \r
+ <SCRIPT type="text/javascript">\r
+ <!--\r
+ if(window==top) {\r
+ document.writeln('<A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A>');\r
+ }\r
+ //-->\r
+</SCRIPT>\r
+<NOSCRIPT>\r
+ <A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A>\r
+</NOSCRIPT>\r
+\r
+\r
+</FONT></TD>\r
+</TR>\r
+<TR>\r
+<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">\r
+ SUMMARY: NESTED | FIELD | CONSTR | <A HREF="#method_summary">METHOD</A></FONT></TD>\r
+<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">\r
+DETAIL: FIELD | CONSTR | <A HREF="#method_detail">METHOD</A></FONT></TD>\r
+</TR>\r
+</TABLE>\r
+<A NAME="skip-navbar_top"></A>\r
+<!-- ========= END OF TOP NAVBAR ========= -->\r
+\r
+<HR>\r
+<!-- ======== START OF CLASS DATA ======== -->\r
+<H2>\r
+<FONT SIZE="-1">\r
+compbio.data.msa</FONT>\r
+<BR>\r
+Interface SequenceAnnotation<T></H2>\r
+<DL>\r
+<DT><DT><B>Type Parameters:</B><DD><CODE>T</CODE> - executable type / web service type</DL>\r
+<DL>\r
+<DT><B>All Superinterfaces:</B> <DD><A HREF="../../../compbio/data/msa/JABAService.html" title="interface in compbio.data.msa">JABAService</A>, <A HREF="../../../compbio/data/msa/JManagement.html" title="interface in compbio.data.msa">JManagement</A>, <A HREF="../../../compbio/data/msa/Metadata.html" title="interface in compbio.data.msa">Metadata</A><T></DD>\r
+</DL>\r
+<DL>\r
+<DT><B>All Known Implementing Classes:</B> <DD><A HREF="../../../compbio/ws/server/AAConWS.html" title="class in compbio.ws.server">AAConWS</A>, <A HREF="../../../compbio/ws/server/DisemblWS.html" title="class in compbio.ws.server">DisemblWS</A>, <A HREF="../../../compbio/ws/server/GlobPlotWS.html" title="class in compbio.ws.server">GlobPlotWS</A>, <A HREF="../../../compbio/ws/server/IUPredWS.html" title="class in compbio.ws.server">IUPredWS</A>, <A HREF="../../../compbio/ws/server/JronnWS.html" title="class in compbio.ws.server">JronnWS</A></DD>\r
+</DL>\r
+<HR>\r
+<DL>\r
+<DT><PRE>public interface <B>SequenceAnnotation<T></B><DT>extends <A HREF="../../../compbio/data/msa/JABAService.html" title="interface in compbio.data.msa">JABAService</A>, <A HREF="../../../compbio/data/msa/JManagement.html" title="interface in compbio.data.msa">JManagement</A>, <A HREF="../../../compbio/data/msa/Metadata.html" title="interface in compbio.data.msa">Metadata</A><T></DL>\r
+</PRE>\r
+\r
+<P>\r
+Interface for tools that results to one or more annotation to sequence(s)
+
+ Single, multiple sequences their groups or alignments can be annotated\r
+<P>\r
+\r
+<P>\r
+<DL>\r
+<DT><B>Version:</B></DT>\r
+ <DD>1.0 November 2010</DD>\r
+<DT><B>Author:</B></DT>\r
+ <DD>Peter Troshin</DD>\r
+</DL>\r
+<HR>\r
+\r
+<P>\r
+<!-- =========== FIELD SUMMARY =========== -->\r
+\r
+<A NAME="field_summary"><!-- --></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
+<B>Field Summary</B></FONT></TH>\r
+</TR>\r
+</TABLE>\r
+ <A NAME="fields_inherited_from_class_compbio.data.msa.JABAService"><!-- --></A>\r
+<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">\r
+<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">\r
+<TH ALIGN="left"><B>Fields inherited from interface compbio.data.msa.<A HREF="../../../compbio/data/msa/JABAService.html" title="interface in compbio.data.msa">JABAService</A></B></TH>\r
+</TR>\r
+<TR BGCOLOR="white" CLASS="TableRowColor">\r
+<TD><CODE><A HREF="../../../compbio/data/msa/JABAService.html#SERVICE_NAMESPACE">SERVICE_NAMESPACE</A>, <A HREF="../../../compbio/data/msa/JABAService.html#V2_SERVICE_NAMESPACE">V2_SERVICE_NAMESPACE</A></CODE></TD>\r
+</TR>\r
+</TABLE>\r
+ \r
+<!-- ========== METHOD SUMMARY =========== -->\r
+\r
+<A NAME="method_summary"><!-- --></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
+<B>Method Summary</B></FONT></TH>\r
+</TR>\r
+<TR BGCOLOR="white" CLASS="TableRowColor">\r
+<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
+<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
+<TD><CODE><B><A HREF="../../../compbio/data/msa/SequenceAnnotation.html#analize(java.util.List)">analize</A></B>(<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="../../../compbio/data/sequence/FastaSequence.html" title="class in compbio.data.sequence">FastaSequence</A>> sequences)</CODE>\r
+\r
+<BR>\r
+ Analyse the sequences.</TD>\r
+</TR>\r
+<TR BGCOLOR="white" CLASS="TableRowColor">\r
+<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
+<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
+<TD><CODE><B><A HREF="../../../compbio/data/msa/SequenceAnnotation.html#customAnalize(java.util.List, java.util.List)">customAnalize</A></B>(<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="../../../compbio/data/sequence/FastaSequence.html" title="class in compbio.data.sequence">FastaSequence</A>> sequences,\r
+ <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="../../../compbio/metadata/Option.html" title="class in compbio.metadata">Option</A><<A HREF="../../../compbio/data/msa/SequenceAnnotation.html" title="type parameter in SequenceAnnotation">T</A>>> options)</CODE>\r
+\r
+<BR>\r
+ Analyse the sequences according to custom settings defined in options
+ list.</TD>\r
+</TR>\r
+<TR BGCOLOR="white" CLASS="TableRowColor">\r
+<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
+<CODE> <A HREF="../../../compbio/data/sequence/ScoreManager.html" title="class in compbio.data.sequence">ScoreManager</A></CODE></FONT></TD>\r
+<TD><CODE><B><A HREF="../../../compbio/data/msa/SequenceAnnotation.html#getAnnotation(java.lang.String)">getAnnotation</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> jobId)</CODE>\r
+\r
+<BR>\r
+ Return the result of the job.</TD>\r
+</TR>\r
+<TR BGCOLOR="white" CLASS="TableRowColor">\r
+<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
+<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
+<TD><CODE><B><A HREF="../../../compbio/data/msa/SequenceAnnotation.html#presetAnalize(java.util.List, compbio.metadata.Preset)">presetAnalize</A></B>(<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="../../../compbio/data/sequence/FastaSequence.html" title="class in compbio.data.sequence">FastaSequence</A>> sequences,\r
+ <A HREF="../../../compbio/metadata/Preset.html" title="class in compbio.metadata">Preset</A><<A HREF="../../../compbio/data/msa/SequenceAnnotation.html" title="type parameter in SequenceAnnotation">T</A>> preset)</CODE>\r
+\r
+<BR>\r
+ Analyse the sequences according to the preset settings.</TD>\r
+</TR>\r
+</TABLE>\r
+ <A NAME="methods_inherited_from_class_compbio.data.msa.JManagement"><!-- --></A>\r
+<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">\r
+<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">\r
+<TH ALIGN="left"><B>Methods inherited from interface compbio.data.msa.<A HREF="../../../compbio/data/msa/JManagement.html" title="interface in compbio.data.msa">JManagement</A></B></TH>\r
+</TR>\r
+<TR BGCOLOR="white" CLASS="TableRowColor">\r
+<TD><CODE><A HREF="../../../compbio/data/msa/JManagement.html#cancelJob(java.lang.String)">cancelJob</A>, <A HREF="../../../compbio/data/msa/JManagement.html#getJobStatus(java.lang.String)">getJobStatus</A>, <A HREF="../../../compbio/data/msa/JManagement.html#pullExecStatistics(java.lang.String, long)">pullExecStatistics</A></CODE></TD>\r
+</TR>\r
+</TABLE>\r
+ <A NAME="methods_inherited_from_class_compbio.data.msa.Metadata"><!-- --></A>\r
+<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">\r
+<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">\r
+<TH ALIGN="left"><B>Methods inherited from interface compbio.data.msa.<A HREF="../../../compbio/data/msa/Metadata.html" title="interface in compbio.data.msa">Metadata</A></B></TH>\r
+</TR>\r
+<TR BGCOLOR="white" CLASS="TableRowColor">\r
+<TD><CODE><A HREF="../../../compbio/data/msa/Metadata.html#getLimit(java.lang.String)">getLimit</A>, <A HREF="../../../compbio/data/msa/Metadata.html#getLimits()">getLimits</A>, <A HREF="../../../compbio/data/msa/Metadata.html#getPresets()">getPresets</A>, <A HREF="../../../compbio/data/msa/Metadata.html#getRunnerOptions()">getRunnerOptions</A></CODE></TD>\r
+</TR>\r
+</TABLE>\r
+ \r
+<P>\r
+\r
+<!-- ============ METHOD DETAIL ========== -->\r
+\r
+<A NAME="method_detail"><!-- --></A>\r
+<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">\r
+<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">\r
+<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">\r
+<B>Method Detail</B></FONT></TH>\r
+</TR>\r
+</TABLE>\r
+\r
+<A NAME="analize(java.util.List)"><!-- --></A><H3>\r
+analize</H3>\r
+<PRE>\r
+<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>analize</B>(<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="../../../compbio/data/sequence/FastaSequence.html" title="class in compbio.data.sequence">FastaSequence</A>> sequences)\r
+ throws <A HREF="../../../compbio/metadata/UnsupportedRuntimeException.html" title="class in compbio.metadata">UnsupportedRuntimeException</A>,\r
+ <A HREF="../../../compbio/metadata/LimitExceededException.html" title="class in compbio.metadata">LimitExceededException</A>,\r
+ <A HREF="../../../compbio/metadata/JobSubmissionException.html" title="class in compbio.metadata">JobSubmissionException</A></PRE>\r
+<DL>\r
+<DD>Analyse the sequences. The actual analysis algorithm is defined by the
+ type T.
+
+ Any dataset containing a greater number of sequences or the average
+ length of the sequences are greater then defined in the default Limit
+ will not be accepted for an alignment operation and
+ JobSubmissionException will be thrown.\r
+<P>\r
+<DD><DL>\r
+</DL>\r
+</DD>\r
+<DD><DL>\r
+<DT><B>Parameters:</B><DD><CODE>sequences</CODE> - List of FastaSequence objects. The programme does not perform
+ any sequence validity checks. Nor does it checks whether the
+ sequences names are unique. It is responsibility of the caller
+ to validate this information\r
+<DT><B>Returns:</B><DD>jobId - unique identifier for the job\r
+<DT><B>Throws:</B>\r
+<DD><CODE><A HREF="../../../compbio/metadata/JobSubmissionException.html" title="class in compbio.metadata">JobSubmissionException</A></CODE> - is thrown when the job could not be submitted due to the
+ following reasons: 1) The number of sequences in the
+ submission or their average length is greater then defined by
+ the default Limit. 2) Any problems on the server side e.g. it
+ is misconfigured or malfunction, is reported via this
+ exception. In the first case the information on the limit
+ could be obtained from an exception.\r
+<DD><CODE><A HREF="http://java.sun.com/javase/6/docs/api/java/security/InvalidParameterException.html?is-external=true" title="class or interface in java.security">InvalidParameterException</A></CODE> - thrown if input list of fasta sequence is null or empty\r
+<DD><CODE><A HREF="../../../compbio/metadata/UnsupportedRuntimeException.html" title="class in compbio.metadata">UnsupportedRuntimeException</A></CODE> - thrown if server OS does not support native executables for a
+ given web service, e.g. JABAWS is deployed on Windows and
+ Mafft service is called\r
+<DD><CODE><A HREF="../../../compbio/metadata/LimitExceededException.html" title="class in compbio.metadata">LimitExceededException</A></CODE> - is throw if the input sequences number or average length
+ exceeds what is defined by the limit</DL>\r
+</DD>\r
+</DL>\r
+<HR>\r
+\r
+<A NAME="customAnalize(java.util.List, java.util.List)"><!-- --></A><H3>\r
+customAnalize</H3>\r
+<PRE>\r
+<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>customAnalize</B>(<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="../../../compbio/data/sequence/FastaSequence.html" title="class in compbio.data.sequence">FastaSequence</A>> sequences,\r
+ <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="../../../compbio/metadata/Option.html" title="class in compbio.metadata">Option</A><<A HREF="../../../compbio/data/msa/SequenceAnnotation.html" title="type parameter in SequenceAnnotation">T</A>>> options)\r
+ throws <A HREF="../../../compbio/metadata/UnsupportedRuntimeException.html" title="class in compbio.metadata">UnsupportedRuntimeException</A>,\r
+ <A HREF="../../../compbio/metadata/LimitExceededException.html" title="class in compbio.metadata">LimitExceededException</A>,\r
+ <A HREF="../../../compbio/metadata/JobSubmissionException.html" title="class in compbio.metadata">JobSubmissionException</A>,\r
+ <A HREF="../../../compbio/metadata/WrongParameterException.html" title="class in compbio.metadata">WrongParameterException</A></PRE>\r
+<DL>\r
+<DD>Analyse the sequences according to custom settings defined in options
+ list. The actual analysis algorithm is defined by the type T. Default
+ Limit is used to decide whether the calculation will be permitted or
+ denied\r
+<P>\r
+<DD><DL>\r
+</DL>\r
+</DD>\r
+<DD><DL>\r
+<DT><B>Parameters:</B><DD><CODE>sequences</CODE> - List of FastaSequence objects. The programme does not perform
+ any sequence validity checks. Nor does it checks whether the
+ sequences names are unique. It is responsibility of the caller
+ to validate this information<DD><CODE>options</CODE> - A list of Options\r
+<DT><B>Returns:</B><DD>jobId - unique identifier for the job\r
+<DT><B>Throws:</B>\r
+<DD><CODE><A HREF="../../../compbio/metadata/JobSubmissionException.html" title="class in compbio.metadata">JobSubmissionException</A></CODE> - is thrown when the job could not be submitted due to the
+ following reasons: 1) The number of sequences in the
+ submission or their average length is greater then defined by
+ the default Limit. 2) Any problems on the server side e.g. it
+ is misconfigured or malfunction, is reported via this
+ exception. In the first case the information on the limit
+ could be obtained from an exception.\r
+<DD><CODE><A HREF="../../../compbio/metadata/WrongParameterException.html" title="class in compbio.metadata">WrongParameterException</A></CODE> - is throws when 1) One of the Options provided is not
+ supported, 2) The value of the option is defined outside the
+ boundaries. In both cases exception object contain the
+ information on the violating Option.\r
+<DD><CODE><A HREF="http://java.sun.com/javase/6/docs/api/java/security/InvalidParameterException.html?is-external=true" title="class or interface in java.security">InvalidParameterException</A></CODE> - thrown if input list of fasta sequence is null or empty\r
+<DD><CODE><A HREF="../../../compbio/metadata/UnsupportedRuntimeException.html" title="class in compbio.metadata">UnsupportedRuntimeException</A></CODE> - thrown if server OS does not support native executables for a
+ given web service, e.g. JABAWS is deployed on Windows and
+ Mafft service is called\r
+<DD><CODE><A HREF="../../../compbio/metadata/LimitExceededException.html" title="class in compbio.metadata">LimitExceededException</A></CODE> - is throw if the input sequences number or average length
+ exceeds what is defined by the limit<DT><B>See Also:</B><DD><A HREF="../../../compbio/metadata/Option.html" title="class in compbio.metadata"><CODE>Option</CODE></A></DL>\r
+</DD>\r
+</DL>\r
+<HR>\r
+\r
+<A NAME="presetAnalize(java.util.List, compbio.metadata.Preset)"><!-- --></A><H3>\r
+presetAnalize</H3>\r
+<PRE>\r
+<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>presetAnalize</B>(<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="../../../compbio/data/sequence/FastaSequence.html" title="class in compbio.data.sequence">FastaSequence</A>> sequences,\r
+ <A HREF="../../../compbio/metadata/Preset.html" title="class in compbio.metadata">Preset</A><<A HREF="../../../compbio/data/msa/SequenceAnnotation.html" title="type parameter in SequenceAnnotation">T</A>> preset)\r
+ throws <A HREF="../../../compbio/metadata/UnsupportedRuntimeException.html" title="class in compbio.metadata">UnsupportedRuntimeException</A>,\r
+ <A HREF="../../../compbio/metadata/LimitExceededException.html" title="class in compbio.metadata">LimitExceededException</A>,\r
+ <A HREF="../../../compbio/metadata/JobSubmissionException.html" title="class in compbio.metadata">JobSubmissionException</A>,\r
+ <A HREF="../../../compbio/metadata/WrongParameterException.html" title="class in compbio.metadata">WrongParameterException</A></PRE>\r
+<DL>\r
+<DD>Analyse the sequences according to the preset settings. The actual
+ analysis algorithm is defined by the type T.
+
+ Limit for a presetName is used whether the calculation will be permitted
+ or denied. If no Limit was defined for a presetName, than default limit
+ is used.\r
+<P>\r
+<DD><DL>\r
+</DL>\r
+</DD>\r
+<DD><DL>\r
+<DT><B>Parameters:</B><DD><CODE>sequences</CODE> - List of FastaSequence objects. The programme does not perform
+ any sequence validity checks. Nor does it checks whether the
+ sequences names are unique. It is responsibility of the caller
+ to validate this information<DD><CODE>preset</CODE> - A list of Options\r
+<DT><B>Returns:</B><DD>String - jobId - unique identifier for the job\r
+<DT><B>Throws:</B>\r
+<DD><CODE><A HREF="../../../compbio/metadata/JobSubmissionException.html" title="class in compbio.metadata">JobSubmissionException</A></CODE> - is thrown when the job could not be submitted due to the
+ following reasons: 1) The number of sequences in the
+ submission or their average length is greater then defined by
+ the default Limit. 2) Any problems on the server side e.g. it
+ is misconfigured or malfunction, is reported via this
+ exception. In the first case the information on the limit
+ could be obtained from an exception.\r
+<DD><CODE><A HREF="../../../compbio/metadata/WrongParameterException.html" title="class in compbio.metadata">WrongParameterException</A></CODE> - is throws when 1) One of the Options provided is not
+ supported, 2) The value of the option is defined outside the
+ boundaries. In both cases exception object contain the
+ information on the violating Option.\r
+<DD><CODE><A HREF="http://java.sun.com/javase/6/docs/api/java/security/InvalidParameterException.html?is-external=true" title="class or interface in java.security">InvalidParameterException</A></CODE> - thrown if input list of fasta sequence is null or empty\r
+<DD><CODE><A HREF="../../../compbio/metadata/UnsupportedRuntimeException.html" title="class in compbio.metadata">UnsupportedRuntimeException</A></CODE> - thrown if server OS does not support native executables for a
+ given web service, e.g. JABAWS is deployed on Windows and
+ Mafft service is called\r
+<DD><CODE><A HREF="../../../compbio/metadata/LimitExceededException.html" title="class in compbio.metadata">LimitExceededException</A></CODE> - is throw if the input sequences number or average length
+ exceeds what is defined by the limit</DL>\r
+</DD>\r
+</DL>\r
+<HR>\r
+\r
+<A NAME="getAnnotation(java.lang.String)"><!-- --></A><H3>\r
+getAnnotation</H3>\r
+<PRE>\r
+<A HREF="../../../compbio/data/sequence/ScoreManager.html" title="class in compbio.data.sequence">ScoreManager</A> <B>getAnnotation</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> jobId)\r
+ throws <A HREF="../../../compbio/metadata/ResultNotAvailableException.html" title="class in compbio.metadata">ResultNotAvailableException</A></PRE>\r
+<DL>\r
+<DD>Return the result of the job.\r
+<P>\r
+<DD><DL>\r
+</DL>\r
+</DD>\r
+<DD><DL>\r
+<DT><B>Parameters:</B><DD><CODE>jobId</CODE> - a unique job identifier\r
+<DT><B>Returns:</B><DD>the Map with the sequence names, sequence group names or the word
+ 'Alignment' in case of alignments and values the represented by a
+ Set of Score objects. The alignment can be represented in as
+ little as one key->value pair in this map, the list of sequences
+ will be represented by multiple key->value mappings. If multiple
+ annotations were calculated, then they are represented as a Set
+ of Scores.\r
+<DT><B>Throws:</B>\r
+<DD><CODE><A HREF="../../../compbio/metadata/ResultNotAvailableException.html" title="class in compbio.metadata">ResultNotAvailableException</A></CODE> - this exception is throw if the job execution was not
+ successful or the result of the execution could not be found.
+ (e.g. removed). Exception could also be thrown is dues to the
+ lower level problems on the server i.e. IOException,
+ FileNotFoundException problems as well as
+ UnknownFileFormatException.\r
+<DD><CODE><A HREF="http://java.sun.com/javase/6/docs/api/java/security/InvalidParameterException.html?is-external=true" title="class or interface in java.security">InvalidParameterException</A></CODE> - thrown if jobId is empty or cannot be recognised e.g. in
+ invalid format</DL>\r
+</DD>\r
+</DL>\r
+<!-- ========= END OF CLASS DATA ========= -->\r
+<HR>\r
+\r
+\r
+<!-- ======= START OF BOTTOM NAVBAR ====== -->\r
+<A NAME="navbar_bottom"><!-- --></A>\r
+<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>\r
+<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">\r
+<TR>\r
+<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">\r
+<A NAME="navbar_bottom_firstrow"><!-- --></A>\r
+<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">\r
+ <TR ALIGN="center" VALIGN="top">\r
+ <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD>\r
+ <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD>\r
+ <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD>\r
+ <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/SequenceAnnotation.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD>\r
+ <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>\r
+ <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>\r
+ <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../index-files/index-1.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>\r
+ <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>\r
+ </TR>\r
+</TABLE>\r
+</TD>\r
+<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>\r
+</EM>\r
+</TD>\r
+</TR>\r
+\r
+<TR>\r
+<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">\r
+ <A HREF="../../../compbio/data/msa/RegistryWS.html" title="interface in compbio.data.msa"><B>PREV CLASS</B></A> \r
+ NEXT CLASS</FONT></TD>\r
+<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">\r
+ <A HREF="../../../index.html?compbio/data/msa/SequenceAnnotation.html" target="_top"><B>FRAMES</B></A> \r
+ <A HREF="SequenceAnnotation.html" target="_top"><B>NO FRAMES</B></A> \r
+ <SCRIPT type="text/javascript">\r
+ <!--\r
+ if(window==top) {\r
+ document.writeln('<A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A>');\r
+ }\r
+ //-->\r
+</SCRIPT>\r
+<NOSCRIPT>\r
+ <A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A>\r
+</NOSCRIPT>\r
+\r
+\r
+</FONT></TD>\r
+</TR>\r
+<TR>\r
+<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">\r
+ SUMMARY: NESTED | FIELD | CONSTR | <A HREF="#method_summary">METHOD</A></FONT></TD>\r
+<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">\r
+DETAIL: FIELD | CONSTR | <A HREF="#method_detail">METHOD</A></FONT></TD>\r
+</TR>\r
+</TABLE>\r
+<A NAME="skip-navbar_bottom"></A>\r
+<!-- ======== END OF BOTTOM NAVBAR ======= -->\r
+\r
+<HR>\r
+\r
+</BODY>\r
+</HTML>\r
git://source.jalview.org / jabaws.git / blobdiff