website/full_javadoc/compbio/data/msa/SequenceAnnotation.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:35 BST 2011 -->\r
   6 <TITLE>\r
   7 SequenceAnnotation\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="SequenceAnnotation";\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="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>\r
  43   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="class-use/SequenceAnnotation.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/data/msa/RegistryWS.html" title="interface in compbio.data.msa"><B>PREV CLASS</B></A>&nbsp;\r
  59 &nbsp;NEXT CLASS</FONT></TD>\r
  60 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">\r
  61   <A HREF="../../../index.html?compbio/data/msa/SequenceAnnotation.html" target="_top"><B>FRAMES</B></A>  &nbsp;\r
  62 &nbsp;<A HREF="SequenceAnnotation.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 <TR>\r
  78 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">\r
  79   SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>\r
  80 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">\r
  81 DETAIL:&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>\r
  82 </TR>\r
  83 </TABLE>\r
  84 <A NAME="skip-navbar_top"></A>\r
  85 <!-- ========= END OF TOP NAVBAR ========= -->\r
  86 \r
  87 <HR>\r
  88 <!-- ======== START OF CLASS DATA ======== -->\r
  89 <H2>\r
  90 <FONT SIZE="-1">\r
  91 compbio.data.msa</FONT>\r
  92 <BR>\r
  93 Interface SequenceAnnotation&lt;T&gt;</H2>\r
  94 <DL>\r
  95 <DT><DT><B>Type Parameters:</B><DD><CODE>T</CODE> - executable type / web service type</DL>\r
  96 <DL>\r
  97 <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>&lt;T&gt;</DD>\r
  98 </DL>\r
  99 <DL>\r
 100 <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
 101 </DL>\r
 102 <HR>\r
 103 <DL>\r
 104 <DT><PRE>public interface <B>SequenceAnnotation&lt;T&gt;</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>&lt;T&gt;</DL>\r
 105 </PRE>\r
 106 \r
 107 <P>\r
 108 Interface for tools that results to one or more annotation to sequence(s)
 109
 110  Single, multiple sequences their groups or alignments can be annotated\r
 111 <P>\r
 112 \r
 113 <P>\r
 114 <DL>\r
 115 <DT><B>Version:</B></DT>\r
 116   <DD>1.0 November 2010</DD>\r
 117 <DT><B>Author:</B></DT>\r
 118   <DD>Peter Troshin</DD>\r
 119 </DL>\r
 120 <HR>\r
 121 \r
 122 <P>\r
 123 <!-- =========== FIELD SUMMARY =========== -->\r
 124 \r
 125 <A NAME="field_summary"><!-- --></A>\r
 126 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">\r
 127 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">\r
 128 <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">\r
 129 <B>Field Summary</B></FONT></TH>\r
 130 </TR>\r
 131 </TABLE>\r
 132 &nbsp;<A NAME="fields_inherited_from_class_compbio.data.msa.JABAService"><!-- --></A>\r
 133 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">\r
 134 <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">\r
 135 <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
 136 </TR>\r
 137 <TR BGCOLOR="white" CLASS="TableRowColor">\r
 138 <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
 139 </TR>\r
 140 </TABLE>\r
 141 &nbsp;\r
 142 <!-- ========== METHOD SUMMARY =========== -->\r
 143 \r
 144 <A NAME="method_summary"><!-- --></A>\r
 145 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">\r
 146 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">\r
 147 <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">\r
 148 <B>Method Summary</B></FONT></TH>\r
 149 </TR>\r
 150 <TR BGCOLOR="white" CLASS="TableRowColor">\r
 151 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
 152 <CODE>&nbsp;<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
 153 <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>&lt;<A HREF="../../../compbio/data/sequence/FastaSequence.html" title="class in compbio.data.sequence">FastaSequence</A>&gt;&nbsp;sequences)</CODE>\r
 154 \r
 155 <BR>\r
 156 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Analyse the sequences.</TD>\r
 157 </TR>\r
 158 <TR BGCOLOR="white" CLASS="TableRowColor">\r
 159 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
 160 <CODE>&nbsp;<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
 161 <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>&lt;<A HREF="../../../compbio/data/sequence/FastaSequence.html" title="class in compbio.data.sequence">FastaSequence</A>&gt;&nbsp;sequences,\r
 162               <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>&lt;<A HREF="../../../compbio/metadata/Option.html" title="class in compbio.metadata">Option</A>&lt;<A HREF="../../../compbio/data/msa/SequenceAnnotation.html" title="type parameter in SequenceAnnotation">T</A>&gt;&gt;&nbsp;options)</CODE>\r
 163 \r
 164 <BR>\r
 165 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Analyse the sequences according to custom settings defined in options
 166  list.</TD>\r
 167 </TR>\r
 168 <TR BGCOLOR="white" CLASS="TableRowColor">\r
 169 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
 170 <CODE>&nbsp;<A HREF="../../../compbio/data/sequence/ScoreManager.html" title="class in compbio.data.sequence">ScoreManager</A></CODE></FONT></TD>\r
 171 <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>&nbsp;jobId)</CODE>\r
 172 \r
 173 <BR>\r
 174 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Return the result of the job.</TD>\r
 175 </TR>\r
 176 <TR BGCOLOR="white" CLASS="TableRowColor">\r
 177 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
 178 <CODE>&nbsp;<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
 179 <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>&lt;<A HREF="../../../compbio/data/sequence/FastaSequence.html" title="class in compbio.data.sequence">FastaSequence</A>&gt;&nbsp;sequences,\r
 180               <A HREF="../../../compbio/metadata/Preset.html" title="class in compbio.metadata">Preset</A>&lt;<A HREF="../../../compbio/data/msa/SequenceAnnotation.html" title="type parameter in SequenceAnnotation">T</A>&gt;&nbsp;preset)</CODE>\r
 181 \r
 182 <BR>\r
 183 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Analyse the sequences according to the preset settings.</TD>\r
 184 </TR>\r
 185 </TABLE>\r
 186 &nbsp;<A NAME="methods_inherited_from_class_compbio.data.msa.JManagement"><!-- --></A>\r
 187 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">\r
 188 <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">\r
 189 <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
 190 </TR>\r
 191 <TR BGCOLOR="white" CLASS="TableRowColor">\r
 192 <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
 193 </TR>\r
 194 </TABLE>\r
 195 &nbsp;<A NAME="methods_inherited_from_class_compbio.data.msa.Metadata"><!-- --></A>\r
 196 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">\r
 197 <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">\r
 198 <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
 199 </TR>\r
 200 <TR BGCOLOR="white" CLASS="TableRowColor">\r
 201 <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
 202 </TR>\r
 203 </TABLE>\r
 204 &nbsp;\r
 205 <P>\r
 206 \r
 207 <!-- ============ METHOD DETAIL ========== -->\r
 208 \r
 209 <A NAME="method_detail"><!-- --></A>\r
 210 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">\r
 211 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">\r
 212 <TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">\r
 213 <B>Method Detail</B></FONT></TH>\r
 214 </TR>\r
 215 </TABLE>\r
 216 \r
 217 <A NAME="analize(java.util.List)"><!-- --></A><H3>\r
 218 analize</H3>\r
 219 <PRE>\r
 220 <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>&lt;<A HREF="../../../compbio/data/sequence/FastaSequence.html" title="class in compbio.data.sequence">FastaSequence</A>&gt;&nbsp;sequences)\r
 221                throws <A HREF="../../../compbio/metadata/UnsupportedRuntimeException.html" title="class in compbio.metadata">UnsupportedRuntimeException</A>,\r
 222                       <A HREF="../../../compbio/metadata/LimitExceededException.html" title="class in compbio.metadata">LimitExceededException</A>,\r
 223                       <A HREF="../../../compbio/metadata/JobSubmissionException.html" title="class in compbio.metadata">JobSubmissionException</A></PRE>\r
 224 <DL>\r
 225 <DD>Analyse the sequences. The actual analysis algorithm is defined by the
 226  type T.
 227
 228  Any dataset containing a greater number of sequences or the average
 229  length of the sequences are greater then defined in the default Limit
 230  will not be accepted for an alignment operation and
 231  JobSubmissionException will be thrown.\r
 232 <P>\r
 233 <DD><DL>\r
 234 </DL>\r
 235 </DD>\r
 236 <DD><DL>\r
 237 <DT><B>Parameters:</B><DD><CODE>sequences</CODE> - List of FastaSequence objects. The programme does not perform
 238             any sequence validity checks. Nor does it checks whether the
 239             sequences names are unique. It is responsibility of the caller
 240             to validate this information\r
 241 <DT><B>Returns:</B><DD>jobId - unique identifier for the job\r
 242 <DT><B>Throws:</B>\r
 243 <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
 244              following reasons: 1) The number of sequences in the
 245              submission or their average length is greater then defined by
 246              the default Limit. 2) Any problems on the server side e.g. it
 247              is misconfigured or malfunction, is reported via this
 248              exception. In the first case the information on the limit
 249              could be obtained from an exception.\r
 250 <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
 251 <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
 252              given web service, e.g. JABAWS is deployed on Windows and
 253              Mafft service is called\r
 254 <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
 255              exceeds what is defined by the limit</DL>\r
 256 </DD>\r
 257 </DL>\r
 258 <HR>\r
 259 \r
 260 <A NAME="customAnalize(java.util.List, java.util.List)"><!-- --></A><H3>\r
 261 customAnalize</H3>\r
 262 <PRE>\r
 263 <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>&lt;<A HREF="../../../compbio/data/sequence/FastaSequence.html" title="class in compbio.data.sequence">FastaSequence</A>&gt;&nbsp;sequences,\r
 264                      <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>&lt;<A HREF="../../../compbio/metadata/Option.html" title="class in compbio.metadata">Option</A>&lt;<A HREF="../../../compbio/data/msa/SequenceAnnotation.html" title="type parameter in SequenceAnnotation">T</A>&gt;&gt;&nbsp;options)\r
 265                      throws <A HREF="../../../compbio/metadata/UnsupportedRuntimeException.html" title="class in compbio.metadata">UnsupportedRuntimeException</A>,\r
 266                             <A HREF="../../../compbio/metadata/LimitExceededException.html" title="class in compbio.metadata">LimitExceededException</A>,\r
 267                             <A HREF="../../../compbio/metadata/JobSubmissionException.html" title="class in compbio.metadata">JobSubmissionException</A>,\r
 268                             <A HREF="../../../compbio/metadata/WrongParameterException.html" title="class in compbio.metadata">WrongParameterException</A></PRE>\r
 269 <DL>\r
 270 <DD>Analyse the sequences according to custom settings defined in options
 271  list. The actual analysis algorithm is defined by the type T. Default
 272  Limit is used to decide whether the calculation will be permitted or
 273  denied\r
 274 <P>\r
 275 <DD><DL>\r
 276 </DL>\r
 277 </DD>\r
 278 <DD><DL>\r
 279 <DT><B>Parameters:</B><DD><CODE>sequences</CODE> - List of FastaSequence objects. The programme does not perform
 280             any sequence validity checks. Nor does it checks whether the
 281             sequences names are unique. It is responsibility of the caller
 282             to validate this information<DD><CODE>options</CODE> - A list of Options\r
 283 <DT><B>Returns:</B><DD>jobId - unique identifier for the job\r
 284 <DT><B>Throws:</B>\r
 285 <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
 286              following reasons: 1) The number of sequences in the
 287              submission or their average length is greater then defined by
 288              the default Limit. 2) Any problems on the server side e.g. it
 289              is misconfigured or malfunction, is reported via this
 290              exception. In the first case the information on the limit
 291              could be obtained from an exception.\r
 292 <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
 293              supported, 2) The value of the option is defined outside the
 294              boundaries. In both cases exception object contain the
 295              information on the violating Option.\r
 296 <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
 297 <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
 298              given web service, e.g. JABAWS is deployed on Windows and
 299              Mafft service is called\r
 300 <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
 301              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
 302 </DD>\r
 303 </DL>\r
 304 <HR>\r
 305 \r
 306 <A NAME="presetAnalize(java.util.List, compbio.metadata.Preset)"><!-- --></A><H3>\r
 307 presetAnalize</H3>\r
 308 <PRE>\r
 309 <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>&lt;<A HREF="../../../compbio/data/sequence/FastaSequence.html" title="class in compbio.data.sequence">FastaSequence</A>&gt;&nbsp;sequences,\r
 310                      <A HREF="../../../compbio/metadata/Preset.html" title="class in compbio.metadata">Preset</A>&lt;<A HREF="../../../compbio/data/msa/SequenceAnnotation.html" title="type parameter in SequenceAnnotation">T</A>&gt;&nbsp;preset)\r
 311                      throws <A HREF="../../../compbio/metadata/UnsupportedRuntimeException.html" title="class in compbio.metadata">UnsupportedRuntimeException</A>,\r
 312                             <A HREF="../../../compbio/metadata/LimitExceededException.html" title="class in compbio.metadata">LimitExceededException</A>,\r
 313                             <A HREF="../../../compbio/metadata/JobSubmissionException.html" title="class in compbio.metadata">JobSubmissionException</A>,\r
 314                             <A HREF="../../../compbio/metadata/WrongParameterException.html" title="class in compbio.metadata">WrongParameterException</A></PRE>\r
 315 <DL>\r
 316 <DD>Analyse the sequences according to the preset settings. The actual
 317  analysis algorithm is defined by the type T.
 318
 319  Limit for a presetName is used whether the calculation will be permitted
 320  or denied. If no Limit was defined for a presetName, than default limit
 321  is used.\r
 322 <P>\r
 323 <DD><DL>\r
 324 </DL>\r
 325 </DD>\r
 326 <DD><DL>\r
 327 <DT><B>Parameters:</B><DD><CODE>sequences</CODE> - List of FastaSequence objects. The programme does not perform
 328             any sequence validity checks. Nor does it checks whether the
 329             sequences names are unique. It is responsibility of the caller
 330             to validate this information<DD><CODE>preset</CODE> - A list of Options\r
 331 <DT><B>Returns:</B><DD>String - jobId - unique identifier for the job\r
 332 <DT><B>Throws:</B>\r
 333 <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
 334              following reasons: 1) The number of sequences in the
 335              submission or their average length is greater then defined by
 336              the default Limit. 2) Any problems on the server side e.g. it
 337              is misconfigured or malfunction, is reported via this
 338              exception. In the first case the information on the limit
 339              could be obtained from an exception.\r
 340 <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
 341              supported, 2) The value of the option is defined outside the
 342              boundaries. In both cases exception object contain the
 343              information on the violating Option.\r
 344 <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
 345 <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
 346              given web service, e.g. JABAWS is deployed on Windows and
 347              Mafft service is called\r
 348 <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
 349              exceeds what is defined by the limit</DL>\r
 350 </DD>\r
 351 </DL>\r
 352 <HR>\r
 353 \r
 354 <A NAME="getAnnotation(java.lang.String)"><!-- --></A><H3>\r
 355 getAnnotation</H3>\r
 356 <PRE>\r
 357 <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>&nbsp;jobId)\r
 358                            throws <A HREF="../../../compbio/metadata/ResultNotAvailableException.html" title="class in compbio.metadata">ResultNotAvailableException</A></PRE>\r
 359 <DL>\r
 360 <DD>Return the result of the job.\r
 361 <P>\r
 362 <DD><DL>\r
 363 </DL>\r
 364 </DD>\r
 365 <DD><DL>\r
 366 <DT><B>Parameters:</B><DD><CODE>jobId</CODE> - a unique job identifier\r
 367 <DT><B>Returns:</B><DD>the Map with the sequence names, sequence group names or the word
 368          'Alignment' in case of alignments and values the represented by a
 369          Set of Score objects. The alignment can be represented in as
 370          little as one key->value pair in this map, the list of sequences
 371          will be represented by multiple key->value mappings. If multiple
 372          annotations were calculated, then they are represented as a Set
 373          of Scores.\r
 374 <DT><B>Throws:</B>\r
 375 <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
 376              successful or the result of the execution could not be found.
 377              (e.g. removed). Exception could also be thrown is dues to the
 378              lower level problems on the server i.e. IOException,
 379              FileNotFoundException problems as well as
 380              UnknownFileFormatException.\r
 381 <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
 382              invalid format</DL>\r
 383 </DD>\r
 384 </DL>\r
 385 <!-- ========= END OF CLASS DATA ========= -->\r
 386 <HR>\r
 387 \r
 388 \r
 389 <!-- ======= START OF BOTTOM NAVBAR ====== -->\r
 390 <A NAME="navbar_bottom"><!-- --></A>\r
 391 <A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>\r
 392 <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">\r
 393 <TR>\r
 394 <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">\r
 395 <A NAME="navbar_bottom_firstrow"><!-- --></A>\r
 396 <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">\r
 397   <TR ALIGN="center" VALIGN="top">\r
 398   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>\r
 399   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>\r
 400   <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>\r
 401   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="class-use/SequenceAnnotation.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>\r
 402   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>\r
 403   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>\r
 404   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../index-files/index-1.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>\r
 405   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>\r
 406   </TR>\r
 407 </TABLE>\r
 408 </TD>\r
 409 <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>\r
 410 </EM>\r
 411 </TD>\r
 412 </TR>\r
 413 \r
 414 <TR>\r
 415 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">\r
 416 &nbsp;<A HREF="../../../compbio/data/msa/RegistryWS.html" title="interface in compbio.data.msa"><B>PREV CLASS</B></A>&nbsp;\r
 417 &nbsp;NEXT CLASS</FONT></TD>\r
 418 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">\r
 419   <A HREF="../../../index.html?compbio/data/msa/SequenceAnnotation.html" target="_top"><B>FRAMES</B></A>  &nbsp;\r
 420 &nbsp;<A HREF="SequenceAnnotation.html" target="_top"><B>NO FRAMES</B></A>  &nbsp;\r
 421 &nbsp;<SCRIPT type="text/javascript">\r
 422   <!--\r
 423   if(window==top) {\r
 424     document.writeln('<A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A>');\r
 425   }\r
 426   //-->\r
 427 </SCRIPT>\r
 428 <NOSCRIPT>\r
 429   <A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A>\r
 430 </NOSCRIPT>\r
 431 \r
 432 \r
 433 </FONT></TD>\r
 434 </TR>\r
 435 <TR>\r
 436 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">\r
 437   SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>\r
 438 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">\r
 439 DETAIL:&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>\r
 440 </TR>\r
 441 </TABLE>\r
 442 <A NAME="skip-navbar_bottom"></A>\r
 443 <!-- ======== END OF BOTTOM NAVBAR ======= -->\r
 444 \r
 445 <HR>\r
 446 \r
 447 </BODY>\r
 448 </HTML>\r