updated javadoc for the system as well as new redirect address for download app
[jabaws.git] / website / dm_javadoc / compbio / metadata / LimitsManager.html
diff --git a/website/dm_javadoc/compbio/metadata/LimitsManager.html b/website/dm_javadoc/compbio/metadata/LimitsManager.html
new file mode 100644 (file)
index 0000000..cbf7e5e
--- /dev/null
@@ -0,0 +1,363 @@
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">\r
+<!--NewPage-->\r
+<HTML>\r
+<HEAD>\r
+<!-- Generated by javadoc (build 1.6.0_24) on Wed Dec 07 12:08:24 GMT 2011 -->\r
+<TITLE>\r
+LimitsManager\r
+</TITLE>\r
+\r
+<META NAME="date" CONTENT="2011-12-07">\r
+\r
+<LINK REL ="stylesheet" TYPE="text/css" HREF="../../stylesheet.css" TITLE="Style">\r
+\r
+<SCRIPT type="text/javascript">\r
+function windowTitle()\r
+{\r
+    if (location.href.indexOf('is-external=true') == -1) {\r
+        parent.document.title="LimitsManager";\r
+    }\r
+}\r
+</SCRIPT>\r
+<NOSCRIPT>\r
+</NOSCRIPT>\r
+\r
+</HEAD>\r
+\r
+<BODY BGCOLOR="white" onload="windowTitle();">\r
+<HR>\r
+\r
+\r
+<!-- ========= START OF TOP NAVBAR ======= -->\r
+<A NAME="navbar_top"><!-- --></A>\r
+<A HREF="#skip-navbar_top" title="Skip navigation links"></A>\r
+<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">\r
+<TR>\r
+<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">\r
+<A NAME="navbar_top_firstrow"><!-- --></A>\r
+<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">\r
+  <TR ALIGN="center" VALIGN="top">\r
+  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>\r
+  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>\r
+  <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>\r
+  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="class-use/LimitsManager.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>\r
+  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>\r
+  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>\r
+  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../index-files/index-1.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>\r
+  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>\r
+  </TR>\r
+</TABLE>\r
+</TD>\r
+<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>\r
+</EM>\r
+</TD>\r
+</TR>\r
+\r
+<TR>\r
+<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">\r
+&nbsp;<A HREF="../../compbio/metadata/LimitExceededException.html" title="class in compbio.metadata"><B>PREV CLASS</B></A>&nbsp;\r
+&nbsp;<A HREF="../../compbio/metadata/Option.html" title="class in compbio.metadata"><B>NEXT CLASS</B></A></FONT></TD>\r
+<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">\r
+  <A HREF="../../index.html?compbio/metadata/LimitsManager.html" target="_top"><B>FRAMES</B></A>  &nbsp;\r
+&nbsp;<A HREF="LimitsManager.html" target="_top"><B>NO FRAMES</B></A>  &nbsp;\r
+&nbsp;<SCRIPT type="text/javascript">\r
+  <!--\r
+  if(window==top) {\r
+    document.writeln('<A HREF="../../allclasses-noframe.html"><B>All Classes</B></A>');\r
+  }\r
+  //-->\r
+</SCRIPT>\r
+<NOSCRIPT>\r
+  <A HREF="../../allclasses-noframe.html"><B>All Classes</B></A>\r
+</NOSCRIPT>\r
+\r
+\r
+</FONT></TD>\r
+</TR>\r
+<TR>\r
+<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">\r
+  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
+<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">\r
+DETAIL:&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>\r
+</TR>\r
+</TABLE>\r
+<A NAME="skip-navbar_top"></A>\r
+<!-- ========= END OF TOP NAVBAR ========= -->\r
+\r
+<HR>\r
+<!-- ======== START OF CLASS DATA ======== -->\r
+<H2>\r
+<FONT SIZE="-1">\r
+compbio.metadata</FONT>\r
+<BR>\r
+Class LimitsManager&lt;T&gt;</H2>\r
+<PRE>\r
+java.lang.Object\r
+  <IMG SRC="../../resources/inherit.gif" ALT="extended by "><B>compbio.metadata.LimitsManager&lt;T&gt;</B>\r
+</PRE>\r
+<DL>\r
+<DT><DT><B>Type Parameters:</B><DD><CODE>T</CODE> - executable type</DL>\r
+<HR>\r
+<DL>\r
+<DT><PRE>public class <B>LimitsManager&lt;T&gt;</B><DT>extends java.lang.Object</DL>\r
+</PRE>\r
+\r
+<P>\r
+A collection of Limits\r
+<P>\r
+\r
+<P>\r
+<DL>\r
+<DT><B>Version:</B></DT>\r
+  <DD>1.0 January 2010</DD>\r
+<DT><B>Author:</B></DT>\r
+  <DD>pvtroshin</DD>\r
+<DT><B>See Also:</B><DD><A HREF="../../compbio/metadata/Limit.html" title="class in compbio.metadata"><CODE>Limit</CODE></A></DL>\r
+<HR>\r
+\r
+<P>\r
+\r
+<!-- ======== CONSTRUCTOR SUMMARY ======== -->\r
+\r
+<A NAME="constructor_summary"><!-- --></A>\r
+<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">\r
+<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">\r
+<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">\r
+<B>Constructor Summary</B></FONT></TH>\r
+</TR>\r
+<TR BGCOLOR="white" CLASS="TableRowColor">\r
+<TD><CODE><B><A HREF="../../compbio/metadata/LimitsManager.html#LimitsManager()">LimitsManager</A></B>()</CODE>\r
+\r
+<BR>\r
+&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>\r
+</TR>\r
+</TABLE>\r
+&nbsp;\r
+<!-- ========== METHOD SUMMARY =========== -->\r
+\r
+<A NAME="method_summary"><!-- --></A>\r
+<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">\r
+<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">\r
+<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">\r
+<B>Method Summary</B></FONT></TH>\r
+</TR>\r
+<TR BGCOLOR="white" CLASS="TableRowColor">\r
+<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
+<CODE>&nbsp;<A HREF="../../compbio/metadata/Limit.html" title="class in compbio.metadata">Limit</A>&lt;<A HREF="../../compbio/metadata/LimitsManager.html" title="type parameter in LimitsManager">T</A>&gt;</CODE></FONT></TD>\r
+<TD><CODE><B><A HREF="../../compbio/metadata/LimitsManager.html#getDefaultLimit()">getDefaultLimit</A></B>()</CODE>\r
+\r
+<BR>\r
+&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>\r
+</TR>\r
+<TR BGCOLOR="white" CLASS="TableRowColor">\r
+<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
+<CODE>&nbsp;<A HREF="../../compbio/metadata/Limit.html" title="class in compbio.metadata">Limit</A>&lt;<A HREF="../../compbio/metadata/LimitsManager.html" title="type parameter in LimitsManager">T</A>&gt;</CODE></FONT></TD>\r
+<TD><CODE><B><A HREF="../../compbio/metadata/LimitsManager.html#getLimitByName(java.lang.String)">getLimitByName</A></B>(java.lang.String&nbsp;presetName)</CODE>\r
+\r
+<BR>\r
+&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>\r
+</TR>\r
+<TR BGCOLOR="white" CLASS="TableRowColor">\r
+<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
+<CODE>&nbsp;java.util.List&lt;<A HREF="../../compbio/metadata/Limit.html" title="class in compbio.metadata">Limit</A>&lt;<A HREF="../../compbio/metadata/LimitsManager.html" title="type parameter in LimitsManager">T</A>&gt;&gt;</CODE></FONT></TD>\r
+<TD><CODE><B><A HREF="../../compbio/metadata/LimitsManager.html#getLimits()">getLimits</A></B>()</CODE>\r
+\r
+<BR>\r
+&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>\r
+</TR>\r
+<TR BGCOLOR="white" CLASS="TableRowColor">\r
+<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
+<CODE>&nbsp;java.lang.String</CODE></FONT></TD>\r
+<TD><CODE><B><A HREF="../../compbio/metadata/LimitsManager.html#toString()">toString</A></B>()</CODE>\r
+\r
+<BR>\r
+&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>\r
+</TR>\r
+<TR BGCOLOR="white" CLASS="TableRowColor">\r
+<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
+<CODE>&nbsp;void</CODE></FONT></TD>\r
+<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>&lt;<A HREF="../../compbio/metadata/LimitsManager.html" title="type parameter in LimitsManager">T</A>&gt;&nbsp;presets)</CODE>\r
+\r
+<BR>\r
+&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Validate Limits</TD>\r
+</TR>\r
+</TABLE>\r
+&nbsp;<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>\r
+<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">\r
+<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">\r
+<TH ALIGN="left"><B>Methods inherited from class java.lang.Object</B></TH>\r
+</TR>\r
+<TR BGCOLOR="white" CLASS="TableRowColor">\r
+<TD><CODE>equals, getClass, hashCode, notify, notifyAll, wait, wait, wait</CODE></TD>\r
+</TR>\r
+</TABLE>\r
+&nbsp;\r
+<P>\r
+\r
+<!-- ========= CONSTRUCTOR DETAIL ======== -->\r
+\r
+<A NAME="constructor_detail"><!-- --></A>\r
+<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">\r
+<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">\r
+<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">\r
+<B>Constructor Detail</B></FONT></TH>\r
+</TR>\r
+</TABLE>\r
+\r
+<A NAME="LimitsManager()"><!-- --></A><H3>\r
+LimitsManager</H3>\r
+<PRE>\r
+public <B>LimitsManager</B>()</PRE>\r
+<DL>\r
+</DL>\r
+\r
+<!-- ============ METHOD DETAIL ========== -->\r
+\r
+<A NAME="method_detail"><!-- --></A>\r
+<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">\r
+<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">\r
+<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">\r
+<B>Method Detail</B></FONT></TH>\r
+</TR>\r
+</TABLE>\r
+\r
+<A NAME="getLimits()"><!-- --></A><H3>\r
+getLimits</H3>\r
+<PRE>\r
+public java.util.List&lt;<A HREF="../../compbio/metadata/Limit.html" title="class in compbio.metadata">Limit</A>&lt;<A HREF="../../compbio/metadata/LimitsManager.html" title="type parameter in LimitsManager">T</A>&gt;&gt; <B>getLimits</B>()</PRE>\r
+<DL>\r
+<DD><DL>\r
+\r
+<DT><B>Returns:</B><DD>all limits defined for an executable T</DL>\r
+</DD>\r
+</DL>\r
+<HR>\r
+\r
+<A NAME="toString()"><!-- --></A><H3>\r
+toString</H3>\r
+<PRE>\r
+public java.lang.String <B>toString</B>()</PRE>\r
+<DL>\r
+<DD><DL>\r
+<DT><B>Overrides:</B><DD><CODE>toString</CODE> in class <CODE>java.lang.Object</CODE></DL>\r
+</DD>\r
+<DD><DL>\r
+</DL>\r
+</DD>\r
+</DL>\r
+<HR>\r
+\r
+<A NAME="getLimitByName(java.lang.String)"><!-- --></A><H3>\r
+getLimitByName</H3>\r
+<PRE>\r
+public <A HREF="../../compbio/metadata/Limit.html" title="class in compbio.metadata">Limit</A>&lt;<A HREF="../../compbio/metadata/LimitsManager.html" title="type parameter in LimitsManager">T</A>&gt; <B>getLimitByName</B>(java.lang.String&nbsp;presetName)</PRE>\r
+<DL>\r
+<DD><DL>\r
+<DT><B>Parameters:</B><DD><CODE>presetName</CODE> - \r
+<DT><B>Returns:</B><DD>Limit defined for the executable T and presetName. If no limit is
+         defined for the presetName then default Limit is returned. If
+         presetName is empty or null than the default Limit will be
+         returned. If not limit defined for the type T than NULL will be
+         returned</DL>\r
+</DD>\r
+</DL>\r
+<HR>\r
+\r
+<A NAME="getDefaultLimit()"><!-- --></A><H3>\r
+getDefaultLimit</H3>\r
+<PRE>\r
+public <A HREF="../../compbio/metadata/Limit.html" title="class in compbio.metadata">Limit</A>&lt;<A HREF="../../compbio/metadata/LimitsManager.html" title="type parameter in LimitsManager">T</A>&gt; <B>getDefaultLimit</B>()</PRE>\r
+<DL>\r
+<DD><DL>\r
+\r
+<DT><B>Returns:</B><DD>the default Limit for an executable type T</DL>\r
+</DD>\r
+</DL>\r
+<HR>\r
+\r
+<A NAME="validate(compbio.metadata.PresetManager)"><!-- --></A><H3>\r
+validate</H3>\r
+<PRE>\r
+public void <B>validate</B>(<A HREF="../../compbio/metadata/PresetManager.html" title="class in compbio.metadata">PresetManager</A>&lt;<A HREF="../../compbio/metadata/LimitsManager.html" title="type parameter in LimitsManager">T</A>&gt;&nbsp;presets)\r
+              throws javax.xml.bind.ValidationException</PRE>\r
+<DL>\r
+<DD>Validate Limits\r
+<P>\r
+<DD><DL>\r
+<DT><B>Parameters:</B><DD><CODE>presets</CODE> - \r
+<DT><B>Throws:</B>\r
+<DD><CODE>javax.xml.bind.ValidationException</CODE> - if any of the Limit defined is found to be invalid. That is
+             when
+             1) No default limit is defined
+             2) More than 1 default limit is defined
+             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
+<A HREF="../../compbio/metadata/Preset.html" title="class in compbio.metadata"><CODE>Preset</CODE></A></DL>\r
+</DD>\r
+</DL>\r
+<!-- ========= END OF CLASS DATA ========= -->\r
+<HR>\r
+\r
+\r
+<!-- ======= START OF BOTTOM NAVBAR ====== -->\r
+<A NAME="navbar_bottom"><!-- --></A>\r
+<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>\r
+<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">\r
+<TR>\r
+<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">\r
+<A NAME="navbar_bottom_firstrow"><!-- --></A>\r
+<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">\r
+  <TR ALIGN="center" VALIGN="top">\r
+  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>\r
+  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>\r
+  <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>\r
+  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="class-use/LimitsManager.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>\r
+  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>\r
+  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>\r
+  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../index-files/index-1.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>\r
+  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>\r
+  </TR>\r
+</TABLE>\r
+</TD>\r
+<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>\r
+</EM>\r
+</TD>\r
+</TR>\r
+\r
+<TR>\r
+<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">\r
+&nbsp;<A HREF="../../compbio/metadata/LimitExceededException.html" title="class in compbio.metadata"><B>PREV CLASS</B></A>&nbsp;\r
+&nbsp;<A HREF="../../compbio/metadata/Option.html" title="class in compbio.metadata"><B>NEXT CLASS</B></A></FONT></TD>\r
+<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">\r
+  <A HREF="../../index.html?compbio/metadata/LimitsManager.html" target="_top"><B>FRAMES</B></A>  &nbsp;\r
+&nbsp;<A HREF="LimitsManager.html" target="_top"><B>NO FRAMES</B></A>  &nbsp;\r
+&nbsp;<SCRIPT type="text/javascript">\r
+  <!--\r
+  if(window==top) {\r
+    document.writeln('<A HREF="../../allclasses-noframe.html"><B>All Classes</B></A>');\r
+  }\r
+  //-->\r
+</SCRIPT>\r
+<NOSCRIPT>\r
+  <A HREF="../../allclasses-noframe.html"><B>All Classes</B></A>\r
+</NOSCRIPT>\r
+\r
+\r
+</FONT></TD>\r
+</TR>\r
+<TR>\r
+<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">\r
+  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
+<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">\r
+DETAIL:&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>\r
+</TR>\r
+</TABLE>\r
+<A NAME="skip-navbar_bottom"></A>\r
+<!-- ======== END OF BOTTOM NAVBAR ======= -->\r
+\r
+<HR>\r
+\r
+</BODY>\r
+</HTML>\r