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