1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
\r
5 <!-- Generated by javadoc (build 1.6.0_14) on Wed Feb 17 16:46:50 GMT 2010 -->
\r
10 <META NAME="date" CONTENT="2010-02-17">
\r
12 <LINK REL ="stylesheet" TYPE="text/css" HREF="../../stylesheet.css" TITLE="Style">
\r
14 <SCRIPT type="text/javascript">
\r
15 function windowTitle()
\r
17 if (location.href.indexOf('is-external=true') == -1) {
\r
18 parent.document.title="Limit";
\r
27 <BODY BGCOLOR="white" onload="windowTitle();">
\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
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> </TD>
\r
41 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD>
\r
42 <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD>
\r
43 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/Limit.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD>
\r
44 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
\r
45 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
\r
46 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../index-files/index-1.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
\r
47 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>
\r
51 <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
\r
57 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
\r
58 <A HREF="../../compbio/metadata/JobSubmissionException.html" title="class in compbio.metadata"><B>PREV CLASS</B></A>
\r
59 <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>
\r
62 <A HREF="Limit.html" target="_top"><B>NO FRAMES</B></A>
\r
63 <SCRIPT type="text/javascript">
\r
66 document.writeln('<A HREF="../../allclasses-noframe.html"><B>All Classes</B></A>');
\r
71 <A HREF="../../allclasses-noframe.html"><B>All Classes</B></A>
\r
78 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
\r
79 SUMMARY: NESTED | FIELD | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD>
\r
80 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
\r
81 DETAIL: FIELD | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD>
\r
84 <A NAME="skip-navbar_top"></A>
\r
85 <!-- ========= END OF TOP NAVBAR ========= -->
\r
88 <!-- ======== START OF CLASS DATA ======== -->
\r
91 compbio.metadata</FONT>
\r
93 Class Limit<T></H2>
\r
96 <IMG SRC="../../resources/inherit.gif" ALT="extended by "><B>compbio.metadata.Limit<T></B>
\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
102 <DT><PRE>public class <B>Limit<T></B><DT>extends java.lang.Object</DL>
\r
106 A value object containing a maximum number of sequences and a maximum average
107 sequence length for a preset.
\r
112 <DT><B>Author:</B></DT>
\r
115 Date January 2010</DD>
\r
116 <DT><B>See Also:</B><DD><A HREF="../../compbio/metadata/LimitsManager.html" title="class in compbio.metadata"><CODE>LimitsManager</CODE></A></DL>
\r
121 <!-- ======== CONSTRUCTOR SUMMARY ======== -->
\r
123 <A NAME="constructor_summary"><!-- --></A>
\r
124 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
\r
125 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
\r
126 <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
\r
127 <B>Constructor Summary</B></FONT></TH>
\r
129 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
130 <TD><CODE><B><A HREF="../../compbio/metadata/Limit.html#Limit(int, int, java.lang.String)">Limit</A></B>(int seqNumber,
\r
131 int seqLength,
\r
132 java.lang.String preset)</CODE>
\r
135 </TD>
\r
137 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
138 <TD><CODE><B><A HREF="../../compbio/metadata/Limit.html#Limit(int, int, java.lang.String, boolean)">Limit</A></B>(int seqNumber,
\r
139 int seqLength,
\r
140 java.lang.String preset,
\r
141 boolean isDefault)</CODE>
\r
144 </TD>
\r
148 <!-- ========== METHOD SUMMARY =========== -->
\r
150 <A NAME="method_summary"><!-- --></A>
\r
151 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
\r
152 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
\r
153 <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
\r
154 <B>Method Summary</B></FONT></TH>
\r
156 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
157 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
158 <CODE> boolean</CODE></FONT></TD>
\r
159 <TD><CODE><B><A HREF="../../compbio/metadata/Limit.html#equals(java.lang.Object)">equals</A></B>(java.lang.Object obj)</CODE>
\r
162 </TD>
\r
164 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
165 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
166 <CODE> int</CODE></FONT></TD>
\r
167 <TD><CODE><B><A HREF="../../compbio/metadata/Limit.html#getAvgSeqLength()">getAvgSeqLength</A></B>()</CODE>
\r
170 </TD>
\r
172 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
173 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
174 <CODE>static int</CODE></FONT></TD>
\r
175 <TD><CODE><B><A HREF="../../compbio/metadata/Limit.html#getAvgSequenceLength(java.util.List)">getAvgSequenceLength</A></B>(java.util.List<<A HREF="../../compbio/data/sequence/FastaSequence.html" title="class in compbio.data.sequence">FastaSequence</A>> data)</CODE>
\r
178 Calculates an average sequence length of the dataset</TD>
\r
180 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
181 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
182 <CODE> java.lang.String</CODE></FONT></TD>
\r
183 <TD><CODE><B><A HREF="../../compbio/metadata/Limit.html#getPreset()">getPreset</A></B>()</CODE>
\r
186 </TD>
\r
188 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
189 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
190 <CODE> int</CODE></FONT></TD>
\r
191 <TD><CODE><B><A HREF="../../compbio/metadata/Limit.html#getSeqNumber()">getSeqNumber</A></B>()</CODE>
\r
194 </TD>
\r
196 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
197 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
198 <CODE> int</CODE></FONT></TD>
\r
199 <TD><CODE><B><A HREF="../../compbio/metadata/Limit.html#hashCode()">hashCode</A></B>()</CODE>
\r
202 </TD>
\r
204 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
205 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
206 <CODE> boolean</CODE></FONT></TD>
\r
207 <TD><CODE><B><A HREF="../../compbio/metadata/Limit.html#isDefault()">isDefault</A></B>()</CODE>
\r
210 </TD>
\r
212 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
213 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
214 <CODE> boolean</CODE></FONT></TD>
\r
215 <TD><CODE><B><A HREF="../../compbio/metadata/Limit.html#isExceeded(java.util.List)">isExceeded</A></B>(java.util.List<<A HREF="../../compbio/data/sequence/FastaSequence.html" title="class in compbio.data.sequence">FastaSequence</A>> data)</CODE>
\r
218 Checks if the number of sequences or their average length in the dataset
219 exceeds limits the values defined by this Limit</TD>
\r
221 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
222 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
223 <CODE> java.lang.String</CODE></FONT></TD>
\r
224 <TD><CODE><B><A HREF="../../compbio/metadata/Limit.html#toString()">toString</A></B>()</CODE>
\r
227 </TD>
\r
230 <A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
\r
231 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
\r
232 <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
\r
233 <TH ALIGN="left"><B>Methods inherited from class java.lang.Object</B></TH>
\r
235 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
236 <TD><CODE>getClass, notify, notifyAll, wait, wait, wait</CODE></TD>
\r
242 <!-- ========= CONSTRUCTOR DETAIL ======== -->
\r
244 <A NAME="constructor_detail"><!-- --></A>
\r
245 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
\r
246 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
\r
247 <TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
\r
248 <B>Constructor Detail</B></FONT></TH>
\r
252 <A NAME="Limit(int, int, java.lang.String)"><!-- --></A><H3>
\r
255 public <B>Limit</B>(int seqNumber,
\r
256 int seqLength,
\r
257 java.lang.String preset)</PRE>
\r
262 <A NAME="Limit(int, int, java.lang.String, boolean)"><!-- --></A><H3>
\r
265 public <B>Limit</B>(int seqNumber,
\r
266 int seqLength,
\r
267 java.lang.String preset,
\r
268 boolean isDefault)</PRE>
\r
272 <!-- ============ METHOD DETAIL ========== -->
\r
274 <A NAME="method_detail"><!-- --></A>
\r
275 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
\r
276 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
\r
277 <TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
\r
278 <B>Method Detail</B></FONT></TH>
\r
282 <A NAME="getPreset()"><!-- --></A><H3>
\r
285 public java.lang.String <B>getPreset</B>()</PRE>
\r
293 <A NAME="getAvgSeqLength()"><!-- --></A><H3>
\r
294 getAvgSeqLength</H3>
\r
296 public int <B>getAvgSeqLength</B>()</PRE>
\r
304 <A NAME="getSeqNumber()"><!-- --></A><H3>
\r
307 public int <B>getSeqNumber</B>()</PRE>
\r
315 <A NAME="isDefault()"><!-- --></A><H3>
\r
318 public boolean <B>isDefault</B>()</PRE>
\r
326 <A NAME="hashCode()"><!-- --></A><H3>
\r
329 public int <B>hashCode</B>()</PRE>
\r
332 <DT><B>Overrides:</B><DD><CODE>hashCode</CODE> in class <CODE>java.lang.Object</CODE></DL>
\r
340 <A NAME="equals(java.lang.Object)"><!-- --></A><H3>
\r
343 public boolean <B>equals</B>(java.lang.Object obj)</PRE>
\r
346 <DT><B>Overrides:</B><DD><CODE>equals</CODE> in class <CODE>java.lang.Object</CODE></DL>
\r
354 <A NAME="toString()"><!-- --></A><H3>
\r
357 public java.lang.String <B>toString</B>()</PRE>
\r
360 <DT><B>Overrides:</B><DD><CODE>toString</CODE> in class <CODE>java.lang.Object</CODE></DL>
\r
368 <A NAME="isExceeded(java.util.List)"><!-- --></A><H3>
\r
371 public boolean <B>isExceeded</B>(java.util.List<<A HREF="../../compbio/data/sequence/FastaSequence.html" title="class in compbio.data.sequence">FastaSequence</A>> data)</PRE>
\r
373 <DD>Checks if the number of sequences or their average length in the dataset
374 exceeds limits the values defined by this Limit
\r
377 <DT><B>Parameters:</B><DD><CODE>data</CODE> -
\r
378 <DT><B>Returns:</B><DD>true if a limit is exceeded (what is the dataset is larger then
379 the limit), false otherwise.</DL>
\r
384 <A NAME="getAvgSequenceLength(java.util.List)"><!-- --></A><H3>
\r
385 getAvgSequenceLength</H3>
\r
387 public static int <B>getAvgSequenceLength</B>(java.util.List<<A HREF="../../compbio/data/sequence/FastaSequence.html" title="class in compbio.data.sequence">FastaSequence</A>> data)</PRE>
\r
389 <DD>Calculates an average sequence length of the dataset
\r
392 <DT><B>Parameters:</B><DD><CODE>data</CODE> -
\r
393 <DT><B>Returns:</B><DD>an average sequence length in the input dataset</DL>
\r
396 <!-- ========= END OF CLASS DATA ========= -->
\r
400 <!-- ======= START OF BOTTOM NAVBAR ====== -->
\r
401 <A NAME="navbar_bottom"><!-- --></A>
\r
402 <A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
\r
403 <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
\r
405 <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
\r
406 <A NAME="navbar_bottom_firstrow"><!-- --></A>
\r
407 <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
\r
408 <TR ALIGN="center" VALIGN="top">
\r
409 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD>
\r
410 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD>
\r
411 <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD>
\r
412 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/Limit.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD>
\r
413 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
\r
414 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
\r
415 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../index-files/index-1.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
\r
416 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>
\r
420 <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
\r
426 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
\r
427 <A HREF="../../compbio/metadata/JobSubmissionException.html" title="class in compbio.metadata"><B>PREV CLASS</B></A>
\r
428 <A HREF="../../compbio/metadata/LimitExceededException.html" title="class in compbio.metadata"><B>NEXT CLASS</B></A></FONT></TD>
\r
429 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
\r
430 <A HREF="../../index.html?compbio/metadata/Limit.html" target="_top"><B>FRAMES</B></A>
\r
431 <A HREF="Limit.html" target="_top"><B>NO FRAMES</B></A>
\r
432 <SCRIPT type="text/javascript">
\r
435 document.writeln('<A HREF="../../allclasses-noframe.html"><B>All Classes</B></A>');
\r
440 <A HREF="../../allclasses-noframe.html"><B>All Classes</B></A>
\r
447 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
\r
448 SUMMARY: NESTED | FIELD | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD>
\r
449 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
\r
450 DETAIL: FIELD | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD>
\r
453 <A NAME="skip-navbar_bottom"></A>
\r
454 <!-- ======== END OF BOTTOM NAVBAR ======= -->
\r