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_24) on Wed Dec 07 12:30:41 GMT 2011 -->
\r
10 <META NAME="date" CONTENT="2011-12-07">
\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="LimitsManager";
\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/LimitsManager.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/LimitExceededException.html" title="class in compbio.metadata"><B>PREV CLASS</B></A>
\r
59 <A HREF="../../compbio/metadata/Option.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/LimitsManager.html" target="_top"><B>FRAMES</B></A>
\r
62 <A HREF="LimitsManager.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 LimitsManager<T></H2>
\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.LimitsManager<T></B>
\r
99 <DT><DT><B>Type Parameters:</B><DD><CODE>T</CODE> - executable type</DL>
\r
102 <DT><PRE>public class <B>LimitsManager<T></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
106 A collection of Limits
\r
111 <DT><B>Version:</B></DT>
\r
112 <DD>1.0 January 2010</DD>
\r
113 <DT><B>Author:</B></DT>
\r
115 <DT><B>See Also:</B><DD><A HREF="../../compbio/metadata/Limit.html" title="class in compbio.metadata"><CODE>Limit</CODE></A></DL>
\r
120 <!-- ======== CONSTRUCTOR SUMMARY ======== -->
\r
122 <A NAME="constructor_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>Constructor Summary</B></FONT></TH>
\r
128 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
129 <TD><CODE><B><A HREF="../../compbio/metadata/LimitsManager.html#LimitsManager()">LimitsManager</A></B>()</CODE>
\r
132 </TD>
\r
136 <!-- ========== METHOD SUMMARY =========== -->
\r
138 <A NAME="method_summary"><!-- --></A>
\r
139 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
\r
140 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
\r
141 <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
\r
142 <B>Method Summary</B></FONT></TH>
\r
144 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
145 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
146 <CODE> <A HREF="../../compbio/metadata/Limit.html" title="class in compbio.metadata">Limit</A><<A HREF="../../compbio/metadata/LimitsManager.html" title="type parameter in LimitsManager">T</A>></CODE></FONT></TD>
\r
147 <TD><CODE><B><A HREF="../../compbio/metadata/LimitsManager.html#getDefaultLimit()">getDefaultLimit</A></B>()</CODE>
\r
150 </TD>
\r
152 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
153 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
154 <CODE> <A HREF="../../compbio/metadata/Limit.html" title="class in compbio.metadata">Limit</A><<A HREF="../../compbio/metadata/LimitsManager.html" title="type parameter in LimitsManager">T</A>></CODE></FONT></TD>
\r
155 <TD><CODE><B><A HREF="../../compbio/metadata/LimitsManager.html#getLimitByName(java.lang.String)">getLimitByName</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> presetName)</CODE>
\r
158 </TD>
\r
160 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
161 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
162 <CODE> <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><<A HREF="../../compbio/metadata/Limit.html" title="class in compbio.metadata">Limit</A><<A HREF="../../compbio/metadata/LimitsManager.html" title="type parameter in LimitsManager">T</A>>></CODE></FONT></TD>
\r
163 <TD><CODE><B><A HREF="../../compbio/metadata/LimitsManager.html#getLimits()">getLimits</A></B>()</CODE>
\r
166 </TD>
\r
168 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
169 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
170 <CODE> <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
171 <TD><CODE><B><A HREF="../../compbio/metadata/LimitsManager.html#toString()">toString</A></B>()</CODE>
\r
174 </TD>
\r
176 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
177 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
178 <CODE> void</CODE></FONT></TD>
\r
179 <TD><CODE><B><A HREF="../../compbio/metadata/LimitsManager.html#validate(compbio.metadata.PresetManager)">validate</A></B>(<A HREF="../../compbio/metadata/PresetManager.html" title="class in compbio.metadata">PresetManager</A><<A HREF="../../compbio/metadata/LimitsManager.html" title="type parameter in LimitsManager">T</A>> presets)</CODE>
\r
182 Validate Limits</TD>
\r
185 <A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
\r
186 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
\r
187 <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
\r
188 <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
190 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
191 <TD><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>, <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#hashCode()" title="class or interface in java.lang">hashCode</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
197 <!-- ========= CONSTRUCTOR DETAIL ======== -->
\r
199 <A NAME="constructor_detail"><!-- --></A>
\r
200 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
\r
201 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
\r
202 <TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
\r
203 <B>Constructor Detail</B></FONT></TH>
\r
207 <A NAME="LimitsManager()"><!-- --></A><H3>
\r
210 public <B>LimitsManager</B>()</PRE>
\r
214 <!-- ============ METHOD DETAIL ========== -->
\r
216 <A NAME="method_detail"><!-- --></A>
\r
217 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
\r
218 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
\r
219 <TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
\r
220 <B>Method Detail</B></FONT></TH>
\r
224 <A NAME="getLimits()"><!-- --></A><H3>
\r
227 public <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><<A HREF="../../compbio/metadata/Limit.html" title="class in compbio.metadata">Limit</A><<A HREF="../../compbio/metadata/LimitsManager.html" title="type parameter in LimitsManager">T</A>>> <B>getLimits</B>()</PRE>
\r
231 <DT><B>Returns:</B><DD>all limits defined for an executable T</DL>
\r
236 <A NAME="toString()"><!-- --></A><H3>
\r
239 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
242 <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
250 <A NAME="getLimitByName(java.lang.String)"><!-- --></A><H3>
\r
251 getLimitByName</H3>
\r
253 public <A HREF="../../compbio/metadata/Limit.html" title="class in compbio.metadata">Limit</A><<A HREF="../../compbio/metadata/LimitsManager.html" title="type parameter in LimitsManager">T</A>> <B>getLimitByName</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> presetName)</PRE>
\r
256 <DT><B>Parameters:</B><DD><CODE>presetName</CODE> -
\r
257 <DT><B>Returns:</B><DD>Limit defined for the executable T and presetName. If no limit is
258 defined for the presetName then default Limit is returned. If
259 presetName is empty or null than the default Limit will be
260 returned. If not limit defined for the type T than NULL will be
266 <A NAME="getDefaultLimit()"><!-- --></A><H3>
\r
267 getDefaultLimit</H3>
\r
269 public <A HREF="../../compbio/metadata/Limit.html" title="class in compbio.metadata">Limit</A><<A HREF="../../compbio/metadata/LimitsManager.html" title="type parameter in LimitsManager">T</A>> <B>getDefaultLimit</B>()</PRE>
\r
273 <DT><B>Returns:</B><DD>the default Limit for an executable type T</DL>
\r
278 <A NAME="validate(compbio.metadata.PresetManager)"><!-- --></A><H3>
\r
281 public void <B>validate</B>(<A HREF="../../compbio/metadata/PresetManager.html" title="class in compbio.metadata">PresetManager</A><<A HREF="../../compbio/metadata/LimitsManager.html" title="type parameter in LimitsManager">T</A>> presets)
\r
282 throws <A HREF="http://java.sun.com/javase/6/docs/api/javax/xml/bind/ValidationException.html?is-external=true" title="class or interface in javax.xml.bind">ValidationException</A></PRE>
\r
284 <DD>Validate Limits
\r
287 <DT><B>Parameters:</B><DD><CODE>presets</CODE> -
\r
289 <DD><CODE><A HREF="http://java.sun.com/javase/6/docs/api/javax/xml/bind/ValidationException.html?is-external=true" title="class or interface in javax.xml.bind">ValidationException</A></CODE> - if any of the Limit defined is found to be invalid. That is
292 1) No default limit is defined
294 2) More than 1 default limit is defined
296 3) Limit's preset name does not match any presets for type T<DT><B>See Also:</B><DD><A HREF="../../compbio/metadata/Limit.html" title="class in compbio.metadata"><CODE>Limit</CODE></A>,
\r
297 <A HREF="../../compbio/metadata/Preset.html" title="class in compbio.metadata"><CODE>Preset</CODE></A></DL>
\r
300 <!-- ========= END OF CLASS DATA ========= -->
\r
304 <!-- ======= START OF BOTTOM NAVBAR ====== -->
\r
305 <A NAME="navbar_bottom"><!-- --></A>
\r
306 <A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
\r
307 <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
\r
309 <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
\r
310 <A NAME="navbar_bottom_firstrow"><!-- --></A>
\r
311 <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
\r
312 <TR ALIGN="center" VALIGN="top">
\r
313 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD>
\r
314 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD>
\r
315 <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD>
\r
316 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/LimitsManager.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD>
\r
317 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
\r
318 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
\r
319 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../index-files/index-1.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
\r
320 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>
\r
324 <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
\r
330 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
\r
331 <A HREF="../../compbio/metadata/LimitExceededException.html" title="class in compbio.metadata"><B>PREV CLASS</B></A>
\r
332 <A HREF="../../compbio/metadata/Option.html" title="class in compbio.metadata"><B>NEXT CLASS</B></A></FONT></TD>
\r
333 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
\r
334 <A HREF="../../index.html?compbio/metadata/LimitsManager.html" target="_top"><B>FRAMES</B></A>
\r
335 <A HREF="LimitsManager.html" target="_top"><B>NO FRAMES</B></A>
\r
336 <SCRIPT type="text/javascript">
\r
339 document.writeln('<A HREF="../../allclasses-noframe.html"><B>All Classes</B></A>');
\r
344 <A HREF="../../allclasses-noframe.html"><B>All Classes</B></A>
\r
351 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
\r
352 SUMMARY: NESTED | FIELD | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD>
\r
353 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
\r
354 DETAIL: FIELD | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD>
\r
357 <A NAME="skip-navbar_bottom"></A>
\r
358 <!-- ======== END OF BOTTOM NAVBAR ======= -->
\r