website/full_javadoc/compbio/engine/ProgressGetter.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_24) on Fri Aug 12 14:32:35 BST 2011 -->\r
   6 <TITLE>\r
   7 ProgressGetter\r
   8 </TITLE>\r
   9 \r
  10 <META NAME="date" CONTENT="2011-08-12">\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="ProgressGetter";\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/ProgressGetter.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/engine/LoadBalancer.html" title="class in compbio.engine"><B>PREV CLASS</B></A>&nbsp;\r
  59 &nbsp;<A HREF="../../compbio/engine/PulledFileCache.html" title="class in compbio.engine"><B>NEXT CLASS</B></A></FONT></TD>\r
  60 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">\r
  61   <A HREF="../../index.html?compbio/engine/ProgressGetter.html" target="_top"><B>FRAMES</B></A>  &nbsp;\r
  62 &nbsp;<A HREF="ProgressGetter.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.engine</FONT>\r
  92 <BR>\r
  93 Class ProgressGetter</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.engine.ProgressGetter</B>\r
  97 </PRE>\r
  98 <HR>\r
  99 <DL>\r
 100 <DT><PRE>public class <B>ProgressGetter</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
 101 </PRE>\r
 102 \r
 103 <P>\r
 104 <HR>\r
 105 \r
 106 <P>\r
 107 \r
 108 <!-- ======== CONSTRUCTOR SUMMARY ======== -->\r
 109 \r
 110 <A NAME="constructor_summary"><!-- --></A>\r
 111 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">\r
 112 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">\r
 113 <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">\r
 114 <B>Constructor Summary</B></FONT></TH>\r
 115 </TR>\r
 116 <TR BGCOLOR="white" CLASS="TableRowColor">\r
 117 <TD><CODE><B><A HREF="../../compbio/engine/ProgressGetter.html#ProgressGetter()">ProgressGetter</A></B>()</CODE>\r
 118 \r
 119 <BR>\r
 120 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>\r
 121 </TR>\r
 122 </TABLE>\r
 123 &nbsp;\r
 124 <!-- ========== METHOD SUMMARY =========== -->\r
 125 \r
 126 <A NAME="method_summary"><!-- --></A>\r
 127 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">\r
 128 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">\r
 129 <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">\r
 130 <B>Method Summary</B></FONT></TH>\r
 131 </TR>\r
 132 <TR BGCOLOR="white" CLASS="TableRowColor">\r
 133 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
 134 <CODE>static&nbsp;byte</CODE></FONT></TD>\r
 135 <TD><CODE><B><A HREF="../../compbio/engine/ProgressGetter.html#getProgress(java.lang.String)">getProgress</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;progressFile)</CODE>\r
 136 \r
 137 <BR>\r
 138 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>\r
 139 </TR>\r
 140 <TR BGCOLOR="white" CLASS="TableRowColor">\r
 141 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
 142 <CODE>static&nbsp;<A HREF="../../compbio/metadata/ChunkHolder.html" title="class in compbio.metadata">ChunkHolder</A></CODE></FONT></TD>\r
 143 <TD><CODE><B><A HREF="../../compbio/engine/ProgressGetter.html#pull(java.lang.String, long)">pull</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;file,\r
 144      long&nbsp;position)</CODE>\r
 145 \r
 146 <BR>\r
 147 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>\r
 148 </TR>\r
 149 </TABLE>\r
 150 &nbsp;<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>\r
 151 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">\r
 152 <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">\r
 153 <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
 154 </TR>\r
 155 <TR BGCOLOR="white" CLASS="TableRowColor">\r
 156 <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#toString()" title="class or interface in java.lang">toString</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
 157 </TR>\r
 158 </TABLE>\r
 159 &nbsp;\r
 160 <P>\r
 161 \r
 162 <!-- ========= CONSTRUCTOR DETAIL ======== -->\r
 163 \r
 164 <A NAME="constructor_detail"><!-- --></A>\r
 165 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">\r
 166 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">\r
 167 <TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">\r
 168 <B>Constructor Detail</B></FONT></TH>\r
 169 </TR>\r
 170 </TABLE>\r
 171 \r
 172 <A NAME="ProgressGetter()"><!-- --></A><H3>\r
 173 ProgressGetter</H3>\r
 174 <PRE>\r
 175 public <B>ProgressGetter</B>()</PRE>\r
 176 <DL>\r
 177 </DL>\r
 178 \r
 179 <!-- ============ METHOD DETAIL ========== -->\r
 180 \r
 181 <A NAME="method_detail"><!-- --></A>\r
 182 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">\r
 183 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">\r
 184 <TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">\r
 185 <B>Method Detail</B></FONT></TH>\r
 186 </TR>\r
 187 </TABLE>\r
 188 \r
 189 <A NAME="pull(java.lang.String, long)"><!-- --></A><H3>\r
 190 pull</H3>\r
 191 <PRE>\r
 192 public static final <A HREF="../../compbio/metadata/ChunkHolder.html" title="class in compbio.metadata">ChunkHolder</A> <B>pull</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;file,\r
 193                                      long&nbsp;position)</PRE>\r
 194 <DL>\r
 195 <DD><DL>\r
 196 </DL>\r
 197 </DD>\r
 198 </DL>\r
 199 <HR>\r
 200 \r
 201 <A NAME="getProgress(java.lang.String)"><!-- --></A><H3>\r
 202 getProgress</H3>\r
 203 <PRE>\r
 204 public static final byte <B>getProgress</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;progressFile)</PRE>\r
 205 <DL>\r
 206 <DD><DL>\r
 207 </DL>\r
 208 </DD>\r
 209 </DL>\r
 210 <!-- ========= END OF CLASS DATA ========= -->\r
 211 <HR>\r
 212 \r
 213 \r
 214 <!-- ======= START OF BOTTOM NAVBAR ====== -->\r
 215 <A NAME="navbar_bottom"><!-- --></A>\r
 216 <A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>\r
 217 <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">\r
 218 <TR>\r
 219 <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">\r
 220 <A NAME="navbar_bottom_firstrow"><!-- --></A>\r
 221 <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">\r
 222   <TR ALIGN="center" VALIGN="top">\r
 223   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>\r
 224   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>\r
 225   <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>\r
 226   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="class-use/ProgressGetter.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>\r
 227   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>\r
 228   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>\r
 229   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../index-files/index-1.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>\r
 230   <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>\r
 231   </TR>\r
 232 </TABLE>\r
 233 </TD>\r
 234 <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>\r
 235 </EM>\r
 236 </TD>\r
 237 </TR>\r
 238 \r
 239 <TR>\r
 240 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">\r
 241 &nbsp;<A HREF="../../compbio/engine/LoadBalancer.html" title="class in compbio.engine"><B>PREV CLASS</B></A>&nbsp;\r
 242 &nbsp;<A HREF="../../compbio/engine/PulledFileCache.html" title="class in compbio.engine"><B>NEXT CLASS</B></A></FONT></TD>\r
 243 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">\r
 244   <A HREF="../../index.html?compbio/engine/ProgressGetter.html" target="_top"><B>FRAMES</B></A>  &nbsp;\r
 245 &nbsp;<A HREF="ProgressGetter.html" target="_top"><B>NO FRAMES</B></A>  &nbsp;\r
 246 &nbsp;<SCRIPT type="text/javascript">\r
 247   <!--\r
 248   if(window==top) {\r
 249     document.writeln('<A HREF="../../allclasses-noframe.html"><B>All Classes</B></A>');\r
 250   }\r
 251   //-->\r
 252 </SCRIPT>\r
 253 <NOSCRIPT>\r
 254   <A HREF="../../allclasses-noframe.html"><B>All Classes</B></A>\r
 255 </NOSCRIPT>\r
 256 \r
 257 \r
 258 </FONT></TD>\r
 259 </TR>\r
 260 <TR>\r
 261 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">\r
 262   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
 263 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">\r
 264 DETAIL:&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>\r
 265 </TR>\r
 266 </TABLE>\r
 267 <A NAME="skip-navbar_bottom"></A>\r
 268 <!-- ======== END OF BOTTOM NAVBAR ======= -->\r
 269 \r
 270 <HR>\r
 271 \r
 272 </BODY>\r
 273 </HTML>\r