progressmailer.html

Geotools是一个开源的Java GIS工具包,可利用它来开发符合标准的地理信息系统。Geotools提供了OGC(Open Geospatial Consortium)规范的一个实现来作为他们的

<PRE>
public <B>ProgressMailer</B>(<A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;host,
                      <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;address)
               throws <A HREF="http://java.sun.com/j2ee/1.4/docs/api/javax/mail/internet/AddressException.html" title="class or interface in javax.mail.internet">AddressException</A></PRE>
<DL>
<DD>Creates an objects reporting progress to the specified email address.
<P>
<DT><B>Parameters:</B><DD><CODE>host</CODE> - The server to use for sending emails.<DD><CODE>address</CODE> - Email adress where to send progress reports.
<DT><B>Throws:</B>
<DD><CODE><A HREF="http://java.sun.com/j2ee/1.4/docs/api/javax/mail/internet/AddressException.html" title="class or interface in javax.mail.internet">AddressException</A></CODE> - if the specified address use an invalid syntax.</DL>
<HR>

<A NAME="ProgressMailer(javax.mail.Session, javax.mail.Address[])"><!-- --></A><H3>
ProgressMailer</H3>
<PRE>
public <B>ProgressMailer</B>(<A HREF="http://java.sun.com/j2ee/1.4/docs/api/javax/mail/Session.html" title="class or interface in javax.mail">Session</A>&nbsp;session,
                      <A HREF="http://java.sun.com/j2ee/1.4/docs/api/javax/mail/Address.html" title="class or interface in javax.mail">Address</A>[]&nbsp;address)</PRE>
<DL>
<DD>Creates an objects reporting progress to the specified email adresses.
<P>
<DT><B>Parameters:</B><DD><CODE>session</CODE> - Session to use for sending emails.<DD><CODE>address</CODE> - </DL>

<!-- ============ METHOD DETAIL ========== -->

<A NAME="method_detail"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TD COLSPAN=1><FONT SIZE="+2">
<B>Method Detail</B></FONT></TD>
</TR>
</TABLE>

<A NAME="getTimeInterval()"><!-- --></A><H3>
getTimeInterval</H3>
<PRE>
public long <B>getTimeInterval</B>()</PRE>
<DL>
<DD>Returns the time laps (in milliseconds) between two emails.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
</DL>
</DD>
</DL>
<HR>

<A NAME="setTimeInterval(long)"><!-- --></A><H3>
setTimeInterval</H3>
<PRE>
public void <B>setTimeInterval</B>(long&nbsp;interval)</PRE>
<DL>
<DD>Set the time laps (in milliseconds) between two emails.
 The default value is 3 hours.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
</DL>
</DD>
</DL>
<HR>

<A NAME="getDescription()"><!-- --></A><H3>
getDescription</H3>
<PRE>
public <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> <B>getDescription</B>()</PRE>
<DL>
<DD>Returns the description for the lengthly operation to be reported, or  if none.
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/geotools/util/ProgressListener.html#getDescription()">getDescription</A></CODE> in interface <CODE><A HREF="../../../../org/geotools/util/ProgressListener.html" title="interface in org.geotools.util">ProgressListener</A></CODE></DL>
</DD>
<DD><DL>
</DL>
</DD>
</DL>
<HR>

<A NAME="setDescription(java.lang.String)"><!-- --></A><H3>
setDescription</H3>
<PRE>
public void <B>setDescription</B>(<A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;description)</PRE>
<DL>
<DD>Set the description for the lenghtly operation to be reported. This method is usually
 invoked before any progress begins. However, it is legal to invoke this method at any
 time during the operation, in which case the description display is updated without
 any change to the percentage accomplished.
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/geotools/util/ProgressListener.html#setDescription(java.lang.String)">setDescription</A></CODE> in interface <CODE><A HREF="../../../../org/geotools/util/ProgressListener.html" title="interface in org.geotools.util">ProgressListener</A></CODE></DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>description</CODE> - The new description, or  if none.</DL>
</DD>
</DL>
<HR>

<A NAME="started()"><!-- --></A><H3>
started</H3>
<PRE>
public void <B>started</B>()</PRE>
<DL>
<DD>Send an emails saying that the operation started.
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/geotools/util/ProgressListener.html#started()">started</A></CODE> in interface <CODE><A HREF="../../../../org/geotools/util/ProgressListener.html" title="interface in org.geotools.util">ProgressListener</A></CODE></DL>
</DD>
<DD><DL>
</DL>
</DD>
</DL>
<HR>

<A NAME="progress(float)"><!-- --></A><H3>
progress</H3>
<PRE>
public void <B>progress</B>(float&nbsp;percent)</PRE>
<DL>
<DD>Notifies progress. This method will send an email only if at least the amount
 of time specified by <A HREF="../../../../org/geotools/gui/headless/ProgressMailer.html#setTimeInterval(long)"><CODE>setTimeInterval(long)</CODE></A> is ellapsed since the last email.
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/geotools/util/ProgressListener.html#progress(float)">progress</A></CODE> in interface <CODE><A HREF="../../../../org/geotools/util/ProgressListener.html" title="interface in org.geotools.util">ProgressListener</A></CODE></DL>
</DD>
<DD><DL>
</DL>
</DD>
</DL>
<HR>

<A NAME="complete()"><!-- --></A><H3>
complete</H3>
<PRE>
public void <B>complete</B>()</PRE>
<DL>
<DD>Send an emails saying that the operation finished.
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/geotools/util/ProgressListener.html#complete()">complete</A></CODE> in interface <CODE><A HREF="../../../../org/geotools/util/ProgressListener.html" title="interface in org.geotools.util">ProgressListener</A></CODE></DL>
</DD>
<DD><DL>
</DL>
</DD>
</DL>
<HR>

<A NAME="dispose()"><!-- --></A><H3>
dispose</H3>
<PRE>
public void <B>dispose</B>()</PRE>
<DL>
<DD>Releases any resource used by this object.
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/geotools/util/ProgressListener.html#dispose()">dispose</A></CODE> in interface <CODE><A HREF="../../../../org/geotools/util/ProgressListener.html" title="interface in org.geotools.util">ProgressListener</A></CODE></DL>
</DD>
<DD><DL>
</DL>
</DD>
</DL>
<HR>

<A NAME="isCanceled()"><!-- --></A><H3>
isCanceled</H3>
<PRE>
public boolean <B>isCanceled</B>()</PRE>
<DL>
<DD>Is this job canceled?
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/geotools/util/ProgressListener.html#isCanceled()">isCanceled</A></CODE> in interface <CODE><A HREF="../../../../org/geotools/util/ProgressListener.html" title="interface in org.geotools.util">ProgressListener</A></CODE></DL>
</DD>
<DD><DL>
</DL>
</DD>
</DL>
<HR>

<A NAME="setCanceled(boolean)"><!-- --></A><H3>
setCanceled</H3>
<PRE>
public void <B>setCanceled</B>(boolean&nbsp;canceled)</PRE>
<DL>
<DD>Indicate that progress should is canceled.
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/geotools/util/ProgressListener.html#setCanceled(boolean)">setCanceled</A></CODE> in interface <CODE><A HREF="../../../../org/geotools/util/ProgressListener.html" title="interface in org.geotools.util">ProgressListener</A></CODE></DL>
</DD>
<DD><DL>
</DL>
</DD>
</DL>
<HR>

<A NAME="warningOccurred(java.lang.String, java.lang.String, java.lang.String)"><!-- --></A><H3>
warningOccurred</H3>
<PRE>
public void <B>warningOccurred</B>(<A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;source,
                            <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;margin,
                            <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;warning)</PRE>
<DL>
<DD>Send a warning by email.
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/geotools/util/ProgressListener.html#warningOccurred(java.lang.String, java.lang.String, java.lang.String)">warningOccurred</A></CODE> in interface <CODE><A HREF="../../../../org/geotools/util/ProgressListener.html" title="interface in org.geotools.util">ProgressListener</A></CODE></DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>source</CODE> - The source of the warning, or  if none. This is typically the
        filename in process of being parsed.<DD><CODE>margin</CODE> - Text to write on the left side of the warning message, or  if none.
        This is typically the line number where the error occured in the  file.<DD><CODE>warning</CODE> - The warning message.</DL>
</DD>
</DL>
<HR>

<A NAME="exceptionOccurred(java.lang.Throwable)"><!-- --></A><H3>
exceptionOccurred</H3>
<PRE>
public void <B>exceptionOccurred</B>(<A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/Throwable.html" title="class or interface in java.lang">Throwable</A>&nbsp;exception)</PRE>
<DL>
<DD>Send an exception stack trace by email.
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/geotools/util/ProgressListener.html#exceptionOccurred(java.lang.Throwable)">exceptionOccurred</A></CODE> in interface <CODE><A HREF="../../../../org/geotools/util/ProgressListener.html" title="interface in org.geotools.util">ProgressListener</A></CODE></DL>
</DD>
<DD><DL>
</DL>
</DD>
</DL>
<!-- ========= END OF CLASS DATA ========= -->
<HR>


<!-- ======= START OF BOTTOM NAVBAR ====== -->
<A NAME="navbar_bottom"><!-- --></A>
<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
<TR>
<TD COLSPAN=3 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
<A NAME="navbar_bottom_firstrow"><!-- --></A>
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
  <TR ALIGN="center" VALIGN="top">
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
  <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="class-use/ProgressMailer.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
  </TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
</EM>
</TD>
</TR>

<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
&nbsp;PREV CLASS&nbsp;
&nbsp;<A HREF="../../../../org/geotools/gui/headless/ProgressPrinter.html" title="class in org.geotools.gui.headless"><B>NEXT CLASS</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
  <A HREF="../../../../index.html" target="_top"><B>FRAMES</B></A>  &nbsp;
&nbsp;<A HREF="ProgressMailer.html" target="_top"><B>NO FRAMES</B></A>  &nbsp;
&nbsp;<SCRIPT type="text/javascript">
  <!--
  if(window==top) {
    document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>');
  }
  //-->
</SCRIPT>
<NOSCRIPT>
  <A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>
</NOSCRIPT>

</FONT></TD>
</TR>
<TR>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
  SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
DETAIL:&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
</TR>
</TABLE>
<A NAME="skip-navbar_bottom"></A>
<!-- ======== END OF BOTTOM NAVBAR ======= -->

<HR>
Copyright &copy; 1996-2007 <a href="http://www.geotools.org">Geotools</a>. All Rights Reserved.
</BODY>
</HTML>