website/dm_javadoc/compbio/metadata/Limit.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 Wed Nov 24 12:17:18 GMT 2010 -->\r
   6 <TITLE>\r
   7 Limit\r
   8 </TITLE>\r
   9 \r
  10 <META NAME="date" CONTENT="2010-11-24">\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="Limit";\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/Limit.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/metadata/JobSubmissionException.html" title="class in compbio.metadata"><B>PREV CLASS</B></A>&nbsp;\r
  59 &nbsp;<A HREF="../../compbio/metadata/LimitExceededException.html" title="class in compbio.metadata"><B>NEXT CLASS</B></A></FONT></TD>\r
  60 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">\r
  61   <A HREF="../../index.html?compbio/metadata/Limit.html" target="_top"><B>FRAMES</B></A>  &nbsp;\r
  62 &nbsp;<A HREF="Limit.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;<A HREF="#constructor_summary">CONSTR</A>&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;<A HREF="#constructor_detail">CONSTR</A>&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.metadata</FONT>\r
  92 <BR>\r
  93 Class Limit&lt;T&gt;</H2>\r
  94 <PRE>\r
  95 <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</A>\r
  96   <IMG SRC="../../resources/inherit.gif" ALT="extended by "><B>compbio.metadata.Limit&lt;T&gt;</B>\r
  97 </PRE>\r
  98 <DL>\r
  99 <DT><DT><B>Type Parameters:</B><DD><CODE>T</CODE> - the type of an executable for which this limit is defined.</DL>\r
 100 <HR>\r
 101 <DL>\r
 102 <DT><PRE>public class <B>Limit&lt;T&gt;</B><DT>extends <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</A></DL>\r
 103 </PRE>\r
 104 \r
 105 <P>\r
 106 A value object containing a maximum number of sequences and a maximum average
 107  sequence length for a preset. Also contains static method for determining the
 108  number of sequence and their average length in the List<FastaSequence>\r
 109 <P>\r
 110 \r
 111 <P>\r
 112 <DL>\r
 113 <DT><B>Version:</B></DT>\r
 114   <DD>1.0 January 2010</DD>\r
 115 <DT><B>Author:</B></DT>\r
 116   <DD>pvtroshin</DD>\r
 117 <DT><B>See Also:</B><DD><A HREF="../../compbio/metadata/LimitsManager.html" title="class in compbio.metadata"><CODE>LimitsManager</CODE></A></DL>\r
 118 <HR>\r
 119 \r
 120 <P>\r
 121 \r
 122 <!-- ======== CONSTRUCTOR SUMMARY ======== -->\r
 123 \r
 124 <A NAME="constructor_summary"><!-- --></A>\r
 125 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">\r
 126 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">\r
 127 <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">\r
 128 <B>Constructor Summary</B></FONT></TH>\r
 129 </TR>\r
 130 <TR BGCOLOR="white" CLASS="TableRowColor">\r
 131 <TD><CODE><B><A HREF="../../compbio/metadata/Limit.html#Limit(int, int, java.lang.String)">Limit</A></B>(int&nbsp;seqNumber,\r
 132       int&nbsp;seqLength,\r
 133       <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;preset)</CODE>\r
 134 \r
 135 <BR>\r
 136 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Instantiate the limit</TD>\r
 137 </TR>\r
 138 <TR BGCOLOR="white" CLASS="TableRowColor">\r
 139 <TD><CODE><B><A HREF="../../compbio/metadata/Limit.html#Limit(int, int, java.lang.String, boolean)">Limit</A></B>(int&nbsp;seqNumber,\r
 140       int&nbsp;seqLength,\r
 141       <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;preset,\r
 142       boolean&nbsp;isDefault)</CODE>\r
 143 \r
 144 <BR>\r
 145 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>\r
 146 </TR>\r
 147 </TABLE>\r
 148 &nbsp;\r
 149 <!-- ========== METHOD SUMMARY =========== -->\r
 150 \r
 151 <A NAME="method_summary"><!-- --></A>\r
 152 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">\r
 153 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">\r
 154 <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">\r
 155 <B>Method Summary</B></FONT></TH>\r
 156 </TR>\r
 157 <TR BGCOLOR="white" CLASS="TableRowColor">\r
 158 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
 159 <CODE>&nbsp;boolean</CODE></FONT></TD>\r
 160 <TD><CODE><B><A HREF="../../compbio/metadata/Limit.html#equals(java.lang.Object)">equals</A></B>(<A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</A>&nbsp;obj)</CODE>\r
 161 \r
 162 <BR>\r
 163 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</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;int</CODE></FONT></TD>\r
 168 <TD><CODE><B><A HREF="../../compbio/metadata/Limit.html#getAvgSeqLength()">getAvgSeqLength</A></B>()</CODE>\r
 169 \r
 170 <BR>\r
 171 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</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>static&nbsp;int</CODE></FONT></TD>\r
 176 <TD><CODE><B><A HREF="../../compbio/metadata/Limit.html#getAvgSequenceLength(java.util.List)">getAvgSequenceLength</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;data)</CODE>\r
 177 \r
 178 <BR>\r
 179 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Calculates an average sequence length of the dataset</TD>\r
 180 </TR>\r
 181 <TR BGCOLOR="white" CLASS="TableRowColor">\r
 182 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
 183 <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
 184 <TD><CODE><B><A HREF="../../compbio/metadata/Limit.html#getPreset()">getPreset</A></B>()</CODE>\r
 185 \r
 186 <BR>\r
 187 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>\r
 188 </TR>\r
 189 <TR BGCOLOR="white" CLASS="TableRowColor">\r
 190 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
 191 <CODE>&nbsp;int</CODE></FONT></TD>\r
 192 <TD><CODE><B><A HREF="../../compbio/metadata/Limit.html#getSeqNumber()">getSeqNumber</A></B>()</CODE>\r
 193 \r
 194 <BR>\r
 195 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>\r
 196 </TR>\r
 197 <TR BGCOLOR="white" CLASS="TableRowColor">\r
 198 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
 199 <CODE>&nbsp;int</CODE></FONT></TD>\r
 200 <TD><CODE><B><A HREF="../../compbio/metadata/Limit.html#hashCode()">hashCode</A></B>()</CODE>\r
 201 \r
 202 <BR>\r
 203 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>\r
 204 </TR>\r
 205 <TR BGCOLOR="white" CLASS="TableRowColor">\r
 206 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
 207 <CODE>&nbsp;boolean</CODE></FONT></TD>\r
 208 <TD><CODE><B><A HREF="../../compbio/metadata/Limit.html#isDefault()">isDefault</A></B>()</CODE>\r
 209 \r
 210 <BR>\r
 211 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>\r
 212 </TR>\r
 213 <TR BGCOLOR="white" CLASS="TableRowColor">\r
 214 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
 215 <CODE>&nbsp;boolean</CODE></FONT></TD>\r
 216 <TD><CODE><B><A HREF="../../compbio/metadata/Limit.html#isExceeded(java.util.List)">isExceeded</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;data)</CODE>\r
 217 \r
 218 <BR>\r
 219 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Checks if the number of sequences or their average length in the dataset
 220  exceeds this limit.</TD>\r
 221 </TR>\r
 222 <TR BGCOLOR="white" CLASS="TableRowColor">\r
 223 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
 224 <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
 225 <TD><CODE><B><A HREF="../../compbio/metadata/Limit.html#toString()">toString</A></B>()</CODE>\r
 226 \r
 227 <BR>\r
 228 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>\r
 229 </TR>\r
 230 </TABLE>\r
 231 &nbsp;<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>\r
 232 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">\r
 233 <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">\r
 234 <TH ALIGN="left"><B>Methods inherited from class java.lang.<A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</A></B></TH>\r
 235 </TR>\r
 236 <TR BGCOLOR="white" CLASS="TableRowColor">\r
 237 <TD><CODE><A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#clone()" title="class or interface in java.lang">clone</A>, <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#finalize()" title="class or interface in java.lang">finalize</A>, <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#getClass()" title="class or interface in java.lang">getClass</A>, <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#notify()" title="class or interface in java.lang">notify</A>, <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#notifyAll()" title="class or interface in java.lang">notifyAll</A>, <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#wait()" title="class or interface in java.lang">wait</A>, <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#wait(long)" title="class or interface in java.lang">wait</A>, <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#wait(long, int)" title="class or interface in java.lang">wait</A></CODE></TD>\r
 238 </TR>\r
 239 </TABLE>\r
 240 &nbsp;\r
 241 <P>\r
 242 \r
 243 <!-- ========= CONSTRUCTOR DETAIL ======== -->\r
 244 \r
 245 <A NAME="constructor_detail"><!-- --></A>\r
 246 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">\r
 247 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">\r
 248 <TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">\r
 249 <B>Constructor Detail</B></FONT></TH>\r
 250 </TR>\r
 251 </TABLE>\r
 252 \r
 253 <A NAME="Limit(int, int, java.lang.String)"><!-- --></A><H3>\r
 254 Limit</H3>\r
 255 <PRE>\r
 256 public <B>Limit</B>(int&nbsp;seqNumber,\r
 257              int&nbsp;seqLength,\r
 258              <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;preset)</PRE>\r
 259 <DL>\r
 260 <DD>Instantiate the limit\r
 261 <P>\r
 262 <DL>\r
 263 <DT><B>Parameters:</B><DD><CODE>seqNumber</CODE> - the maximum number of sequences allowed for calculation.
 264             Required<DD><CODE>seqLength</CODE> - the average length of the sequence, optional<DD><CODE>preset</CODE> - the name of preset if any, optional\r
 265 <DT><B>Throws:</B>\r
 266 <DD><CODE><A HREF="http://java.sun.com/javase/6/docs/api/java/lang/IllegalArgumentException.html?is-external=true" title="class or interface in java.lang">IllegalArgumentException</A></CODE> - if the seqNumber is not supplied or the seqLength is negative</DL>\r
 267 </DL>\r
 268 <HR>\r
 269 \r
 270 <A NAME="Limit(int, int, java.lang.String, boolean)"><!-- --></A><H3>\r
 271 Limit</H3>\r
 272 <PRE>\r
 273 public <B>Limit</B>(int&nbsp;seqNumber,\r
 274              int&nbsp;seqLength,\r
 275              <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;preset,\r
 276              boolean&nbsp;isDefault)</PRE>\r
 277 <DL>\r
 278 </DL>\r
 279 \r
 280 <!-- ============ METHOD DETAIL ========== -->\r
 281 \r
 282 <A NAME="method_detail"><!-- --></A>\r
 283 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">\r
 284 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">\r
 285 <TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">\r
 286 <B>Method Detail</B></FONT></TH>\r
 287 </TR>\r
 288 </TABLE>\r
 289 \r
 290 <A NAME="getPreset()"><!-- --></A><H3>\r
 291 getPreset</H3>\r
 292 <PRE>\r
 293 public <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>getPreset</B>()</PRE>\r
 294 <DL>\r
 295 <DD><DL>\r
 296 </DL>\r
 297 </DD>\r
 298 </DL>\r
 299 <HR>\r
 300 \r
 301 <A NAME="getAvgSeqLength()"><!-- --></A><H3>\r
 302 getAvgSeqLength</H3>\r
 303 <PRE>\r
 304 public int <B>getAvgSeqLength</B>()</PRE>\r
 305 <DL>\r
 306 <DD><DL>\r
 307 \r
 308 <DT><B>Returns:</B><DD>the allowed average sequence length</DL>\r
 309 </DD>\r
 310 </DL>\r
 311 <HR>\r
 312 \r
 313 <A NAME="getSeqNumber()"><!-- --></A><H3>\r
 314 getSeqNumber</H3>\r
 315 <PRE>\r
 316 public int <B>getSeqNumber</B>()</PRE>\r
 317 <DL>\r
 318 <DD><DL>\r
 319 \r
 320 <DT><B>Returns:</B><DD>the maximum number of sequences allowed</DL>\r
 321 </DD>\r
 322 </DL>\r
 323 <HR>\r
 324 \r
 325 <A NAME="isDefault()"><!-- --></A><H3>\r
 326 isDefault</H3>\r
 327 <PRE>\r
 328 public boolean <B>isDefault</B>()</PRE>\r
 329 <DL>\r
 330 <DD><DL>\r
 331 \r
 332 <DT><B>Returns:</B><DD>true is this is a default limit to be used, false otherwise</DL>\r
 333 </DD>\r
 334 </DL>\r
 335 <HR>\r
 336 \r
 337 <A NAME="hashCode()"><!-- --></A><H3>\r
 338 hashCode</H3>\r
 339 <PRE>\r
 340 public int <B>hashCode</B>()</PRE>\r
 341 <DL>\r
 342 <DD><DL>\r
 343 <DT><B>Overrides:</B><DD><CODE><A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#hashCode()" title="class or interface in java.lang">hashCode</A></CODE> in class <CODE><A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</A></CODE></DL>\r
 344 </DD>\r
 345 <DD><DL>\r
 346 </DL>\r
 347 </DD>\r
 348 </DL>\r
 349 <HR>\r
 350 \r
 351 <A NAME="equals(java.lang.Object)"><!-- --></A><H3>\r
 352 equals</H3>\r
 353 <PRE>\r
 354 public boolean <B>equals</B>(<A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</A>&nbsp;obj)</PRE>\r
 355 <DL>\r
 356 <DD><DL>\r
 357 <DT><B>Overrides:</B><DD><CODE><A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#equals(java.lang.Object)" title="class or interface in java.lang">equals</A></CODE> in class <CODE><A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</A></CODE></DL>\r
 358 </DD>\r
 359 <DD><DL>\r
 360 </DL>\r
 361 </DD>\r
 362 </DL>\r
 363 <HR>\r
 364 \r
 365 <A NAME="toString()"><!-- --></A><H3>\r
 366 toString</H3>\r
 367 <PRE>\r
 368 public <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>toString</B>()</PRE>\r
 369 <DL>\r
 370 <DD><DL>\r
 371 <DT><B>Overrides:</B><DD><CODE><A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#toString()" title="class or interface in java.lang">toString</A></CODE> in class <CODE><A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</A></CODE></DL>\r
 372 </DD>\r
 373 <DD><DL>\r
 374 </DL>\r
 375 </DD>\r
 376 </DL>\r
 377 <HR>\r
 378 \r
 379 <A NAME="isExceeded(java.util.List)"><!-- --></A><H3>\r
 380 isExceeded</H3>\r
 381 <PRE>\r
 382 public boolean <B>isExceeded</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;data)</PRE>\r
 383 <DL>\r
 384 <DD>Checks if the number of sequences or their average length in the dataset
 385  exceeds this limit.\r
 386 <P>\r
 387 <DD><DL>\r
 388 <DT><B>Parameters:</B><DD><CODE>data</CODE> - the dataset to measure\r
 389 <DT><B>Returns:</B><DD>true if a limit is exceeded (what is the dataset is larger then
 390          the limit), false otherwise. First check the number of sequences
 391          in the dataset and if it exceeds the limit return true
 392          irrespective of the average length. If the number of sequences in
 393          the dataset is less than the limit and average length is defined,
 394          then check whether the total number of letters (number of
 395          sequence multiplied by the average sequence length) is greater
 396          then the total number of letters in the dataset. Returns true if
 397          the total number of letters in the dataset is greater than the
 398          limit, false otherwise.</DL>\r
 399 </DD>\r
 400 </DL>\r
 401 <HR>\r
 402 \r
 403 <A NAME="getAvgSequenceLength(java.util.List)"><!-- --></A><H3>\r
 404 getAvgSequenceLength</H3>\r
 405 <PRE>\r
 406 public static int <B>getAvgSequenceLength</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;data)</PRE>\r
 407 <DL>\r
 408 <DD>Calculates an average sequence length of the dataset\r
 409 <P>\r
 410 <DD><DL>\r
 411 <DT><B>Parameters:</B><DD><CODE>data</CODE> - \r
 412 <DT><B>Returns:</B><DD>an average sequence length in the input dataset</DL>\r
 413 </DD>\r
 414 </DL>\r
 415 <!-- ========= END OF CLASS DATA ========= -->\r
 416 <HR>\r
 417 \r
 418 \r
 419 <!-- ======= START OF BOTTOM NAVBAR ====== -->\r
 420 <A NAME="navbar_bottom"><!-- --></A>\r
 421 <A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>\r
 422 <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">\r
 423 <TR>\r
 424 <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">\r
 425 <A NAME="navbar_bottom_firstrow"><!-- --></A>\r
 426 <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">\r
 427   <TR ALIGN="center" VALIGN="top">\r
 428   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>\r
 429   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>\r
 430   <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>\r
 431   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="class-use/Limit.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>\r
 432   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>\r
 433   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>\r
 434   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../index-files/index-1.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>\r
 435   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>\r
 436   </TR>\r
 437 </TABLE>\r
 438 </TD>\r
 439 <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>\r
 440 </EM>\r
 441 </TD>\r
 442 </TR>\r
 443 \r
 444 <TR>\r
 445 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">\r
 446 &nbsp;<A HREF="../../compbio/metadata/JobSubmissionException.html" title="class in compbio.metadata"><B>PREV CLASS</B></A>&nbsp;\r
 447 &nbsp;<A HREF="../../compbio/metadata/LimitExceededException.html" title="class in compbio.metadata"><B>NEXT CLASS</B></A></FONT></TD>\r
 448 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">\r
 449   <A HREF="../../index.html?compbio/metadata/Limit.html" target="_top"><B>FRAMES</B></A>  &nbsp;\r
 450 &nbsp;<A HREF="Limit.html" target="_top"><B>NO FRAMES</B></A>  &nbsp;\r
 451 &nbsp;<SCRIPT type="text/javascript">\r
 452   <!--\r
 453   if(window==top) {\r
 454     document.writeln('<A HREF="../../allclasses-noframe.html"><B>All Classes</B></A>');\r
 455   }\r
 456   //-->\r
 457 </SCRIPT>\r
 458 <NOSCRIPT>\r
 459   <A HREF="../../allclasses-noframe.html"><B>All Classes</B></A>\r
 460 </NOSCRIPT>\r
 461 \r
 462 \r
 463 </FONT></TD>\r
 464 </TR>\r
 465 <TR>\r
 466 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">\r
 467   SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>\r
 468 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">\r
 469 DETAIL:&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>\r
 470 </TR>\r
 471 </TABLE>\r
 472 <A NAME="skip-navbar_bottom"></A>\r
 473 <!-- ======== END OF BOTTOM NAVBAR ======= -->\r
 474 \r
 475 <HR>\r
 476 \r
 477 </BODY>\r
 478 </HTML>\r