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