You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@labs.apache.org by th...@apache.org on 2008/08/24 01:44:36 UTC

svn commit: r688432 [3/12] - in /labs/droids/trunk/docs: ./ api/ api/org/apache/droids/ api/org/apache/droids/api/ api/org/apache/droids/api/class-use/ api/org/apache/droids/class-use/ api/org/apache/droids/delay/ api/org/apache/droids/delay/class-use/...

Modified: labs/droids/trunk/docs/api/index.html
URL: http://svn.apache.org/viewvc/labs/droids/trunk/docs/api/index.html?rev=688432&r1=688431&r2=688432&view=diff
==============================================================================
--- labs/droids/trunk/docs/api/index.html (original)
+++ labs/droids/trunk/docs/api/index.html Sat Aug 23 16:44:31 2008
@@ -2,7 +2,7 @@
 <!--NewPage-->
 <HTML>
 <HEAD>
-<!-- Generated by javadoc on Tue Mar 18 01:10:57 CET 2008-->
+<!-- Generated by javadoc on Sun Aug 24 01:37:49 CEST 2008-->
 <TITLE>
 Droids initial API
 </TITLE>

Added: labs/droids/trunk/docs/api/org/apache/droids/AbstractDroid.html
URL: http://svn.apache.org/viewvc/labs/droids/trunk/docs/api/org/apache/droids/AbstractDroid.html?rev=688432&view=auto
==============================================================================
--- labs/droids/trunk/docs/api/org/apache/droids/AbstractDroid.html (added)
+++ labs/droids/trunk/docs/api/org/apache/droids/AbstractDroid.html Sat Aug 23 16:44:31 2008
@@ -0,0 +1,763 @@
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
+<!--NewPage-->
+<HTML>
+<HEAD>
+<!-- Generated by javadoc (build 1.5.0_12) on Sun Aug 24 01:37:45 CEST 2008 -->
+<TITLE>
+AbstractDroid (Droids initial API)
+</TITLE>
+
+<META NAME="keywords" CONTENT="org.apache.droids.AbstractDroid class">
+
+<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../stylesheet.css" TITLE="Style">
+
+<SCRIPT type="text/javascript">
+function windowTitle()
+{
+    parent.document.title="AbstractDroid (Droids initial API)";
+}
+</SCRIPT>
+<NOSCRIPT>
+</NOSCRIPT>
+
+</HEAD>
+
+<BODY BGCOLOR="white" onload="windowTitle();">
+
+
+<!-- ========= START OF TOP NAVBAR ======= -->
+<A NAME="navbar_top"><!-- --></A>
+<A HREF="#skip-navbar_top" title="Skip navigation links"></A>
+<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
+<TR>
+<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
+<A NAME="navbar_top_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/AbstractDroid.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/apache/droids/Cli.html" title="class in org.apache.droids"><B>NEXT CLASS</B></A></FONT></TD>
+<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
+  <A HREF="../../../index.html?org/apache/droids/AbstractDroid.html" target="_top"><B>FRAMES</B></A>  &nbsp;
+&nbsp;<A HREF="AbstractDroid.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_top"></A>
+<!-- ========= END OF TOP NAVBAR ========= -->
+
+<HR>
+<!-- ======== START OF CLASS DATA ======== -->
+<H2>
+<FONT SIZE="-1">
+org.apache.droids</FONT>
+<BR>
+Class AbstractDroid</H2>
+<PRE>
+<A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/Object.html" title="class or interface in java.lang">java.lang.Object</A>
+  <IMG SRC="../../../resources/inherit.gif" ALT="extended by "><B>org.apache.droids.AbstractDroid</B>
+</PRE>
+<DL>
+<DT><B>All Implemented Interfaces:</B> <DD><A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/Runnable.html" title="class or interface in java.lang">Runnable</A>, <A HREF="../../../org/apache/droids/api/Droid.html" title="interface in org.apache.droids.api">Droid</A></DD>
+</DL>
+<DL>
+<DT><B>Direct Known Subclasses:</B> <DD><A HREF="../../../org/apache/droids/DefaultCrawler.html" title="class in org.apache.droids">DefaultCrawler</A></DD>
+</DL>
+<HR>
+<DL>
+<DT><PRE>public abstract class <B>AbstractDroid</B><DT>extends <A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/Object.html" title="class or interface in java.lang">Object</A><DT>implements <A HREF="../../../org/apache/droids/api/Droid.html" title="interface in org.apache.droids.api">Droid</A></DL>
+</PRE>
+
+<P>
+<DL>
+<DT><B>Version:</B></DT>
+  <DD>1.0</DD>
+<DT><B>Author:</B></DT>
+  <DD>thorsten</DD>
+</DL>
+<HR>
+
+<P>
+
+<!-- ======== CONSTRUCTOR SUMMARY ======== -->
+
+<A NAME="constructor_summary"><!-- --></A>
+<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
+<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
+<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
+<B>Constructor Summary</B></FONT></TH>
+</TR>
+<TR BGCOLOR="white" CLASS="TableRowColor">
+<TD><CODE><B><A HREF="../../../org/apache/droids/AbstractDroid.html#AbstractDroid()">AbstractDroid</A></B>()</CODE>
+
+<BR>
+&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
+</TR>
+</TABLE>
+&nbsp;
+<!-- ========== METHOD SUMMARY =========== -->
+
+<A NAME="method_summary"><!-- --></A>
+<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
+<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
+<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
+<B>Method Summary</B></FONT></TH>
+</TR>
+<TR BGCOLOR="white" CLASS="TableRowColor">
+<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
+<CODE>&nbsp;void</CODE></FONT></TD>
+<TD><CODE><B><A HREF="../../../org/apache/droids/AbstractDroid.html#finishedWorker(long)">finishedWorker</A></B>(long&nbsp;id)</CODE>
+
+<BR>
+&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Notification that we finished a given worker.</TD>
+</TR>
+<TR BGCOLOR="white" CLASS="TableRowColor">
+<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
+<CODE>&nbsp;<A HREF="../../../org/apache/droids/Core.html" title="class in org.apache.droids">Core</A></CODE></FONT></TD>
+<TD><CODE><B><A HREF="../../../org/apache/droids/AbstractDroid.html#getCore()">getCore</A></B>()</CODE>
+
+<BR>
+&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Return the core configuration for the current Droid.</TD>
+</TR>
+<TR BGCOLOR="white" CLASS="TableRowColor">
+<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
+<CODE>&nbsp;int</CODE></FONT></TD>
+<TD><CODE><B><A HREF="../../../org/apache/droids/AbstractDroid.html#getFreeSlots()">getFreeSlots</A></B>()</CODE>
+
+<BR>
+&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Get number of slots that we have currently
+ open to accept new workers.</TD>
+</TR>
+<TR BGCOLOR="white" CLASS="TableRowColor">
+<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
+<CODE>&nbsp;int</CODE></FONT></TD>
+<TD><CODE><B><A HREF="../../../org/apache/droids/AbstractDroid.html#getMaxThreads()">getMaxThreads</A></B>()</CODE>
+
+<BR>
+&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Get number of maximum allowed threads</TD>
+</TR>
+<TR BGCOLOR="white" CLASS="TableRowColor">
+<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
+<CODE>&nbsp;<A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/util/concurrent.ThreadPoolExecutor.html" title="class or interface in java.util">java.util.concurrent.ThreadPoolExecutor</A></CODE></FONT></TD>
+<TD><CODE><B><A HREF="../../../org/apache/droids/AbstractDroid.html#getPool()">getPool</A></B>()</CODE>
+
+<BR>
+&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Get our pool.</TD>
+</TR>
+<TR BGCOLOR="white" CLASS="TableRowColor">
+<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
+<CODE>protected &nbsp;<A HREF="../../../org/apache/droids/api/Queue.html" title="interface in org.apache.droids.api">Queue</A></CODE></FONT></TD>
+<TD><CODE><B><A HREF="../../../org/apache/droids/AbstractDroid.html#getQueue()">getQueue</A></B>()</CODE>
+
+<BR>
+&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Get the queue implementation that we want to use.</TD>
+</TR>
+<TR BGCOLOR="white" CLASS="TableRowColor">
+<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
+<CODE>&nbsp;int</CODE></FONT></TD>
+<TD><CODE><B><A HREF="../../../org/apache/droids/AbstractDroid.html#getRunningThreads()">getRunningThreads</A></B>()</CODE>
+
+<BR>
+&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Get number of currently running threads</TD>
+</TR>
+<TR BGCOLOR="white" CLASS="TableRowColor">
+<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
+<CODE>&nbsp;<A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/util/concurrent.ConcurrentHashMap.html" title="class or interface in java.util">java.util.concurrent.ConcurrentHashMap</A>&lt;<A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/Long.html" title="class or interface in java.lang">Long</A>,<A HREF="../../../org/apache/droids/api/Worker.html" title="interface in org.apache.droids.api">Worker</A>&gt;</CODE></FONT></TD>
+<TD><CODE><B><A HREF="../../../org/apache/droids/AbstractDroid.html#getRunningWorker()">getRunningWorker</A></B>()</CODE>
+
+<BR>
+&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Return the map of running workers</TD>
+</TR>
+<TR BGCOLOR="white" CLASS="TableRowColor">
+<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
+<CODE>&nbsp;<A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A></CODE></FONT></TD>
+<TD><CODE><B><A HREF="../../../org/apache/droids/AbstractDroid.html#getTaskDate()">getTaskDate</A></B>()</CODE>
+
+<BR>
+&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;When did the task showed up the first time in the queue</TD>
+</TR>
+<TR BGCOLOR="white" CLASS="TableRowColor">
+<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
+<CODE>abstract &nbsp;<A HREF="../../../org/apache/droids/api/Worker.html" title="interface in org.apache.droids.api">Worker</A></CODE></FONT></TD>
+<TD><CODE><B><A HREF="../../../org/apache/droids/AbstractDroid.html#getWorker()">getWorker</A></B>()</CODE>
+
+<BR>
+&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Get the default worker for the class.</TD>
+</TR>
+<TR BGCOLOR="white" CLASS="TableRowColor">
+<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
+<CODE>&nbsp;void</CODE></FONT></TD>
+<TD><CODE><B><A HREF="../../../org/apache/droids/AbstractDroid.html#setCore(org.apache.droids.Core)">setCore</A></B>(<A HREF="../../../org/apache/droids/Core.html" title="class in org.apache.droids">Core</A>&nbsp;core)</CODE>
+
+<BR>
+&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Set the fully configured core and inject it in the</TD>
+</TR>
+<TR BGCOLOR="white" CLASS="TableRowColor">
+<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
+<CODE>&nbsp;void</CODE></FONT></TD>
+<TD><CODE><B><A HREF="../../../org/apache/droids/AbstractDroid.html#setFreeSlots(int)">setFreeSlots</A></B>(int&nbsp;freeSlots)</CODE>
+
+<BR>
+&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Set number of slots that we have currently
+ open to accept new workers</TD>
+</TR>
+<TR BGCOLOR="white" CLASS="TableRowColor">
+<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
+<CODE>&nbsp;void</CODE></FONT></TD>
+<TD><CODE><B><A HREF="../../../org/apache/droids/AbstractDroid.html#setMaxThreads(int)">setMaxThreads</A></B>(int&nbsp;maxThreads)</CODE>
+
+<BR>
+&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Adjust number of allowed threads</TD>
+</TR>
+<TR BGCOLOR="white" CLASS="TableRowColor">
+<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
+<CODE>&nbsp;void</CODE></FONT></TD>
+<TD><CODE><B><A HREF="../../../org/apache/droids/AbstractDroid.html#setPool(java.util.concurrent.ThreadPoolExecutor)">setPool</A></B>(<A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/util/concurrent.ThreadPoolExecutor.html" title="class or interface in java.util">java.util.concurrent.ThreadPoolExecutor</A>&nbsp;pool)</CODE>
+
+<BR>
+&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Set our pool.</TD>
+</TR>
+<TR BGCOLOR="white" CLASS="TableRowColor">
+<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
+<CODE>&nbsp;void</CODE></FONT></TD>
+<TD><CODE><B><A HREF="../../../org/apache/droids/AbstractDroid.html#setQueue(org.apache.droids.api.Queue)">setQueue</A></B>(<A HREF="../../../org/apache/droids/api/Queue.html" title="interface in org.apache.droids.api">Queue</A>&nbsp;queue)</CODE>
+
+<BR>
+&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Which implementation of a queue are we using.</TD>
+</TR>
+<TR BGCOLOR="white" CLASS="TableRowColor">
+<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
+<CODE>&nbsp;void</CODE></FONT></TD>
+<TD><CODE><B><A HREF="../../../org/apache/droids/AbstractDroid.html#setRunningThreads(int)">setRunningThreads</A></B>(int&nbsp;runningThreads)</CODE>
+
+<BR>
+&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;To set the number of running threads.</TD>
+</TR>
+<TR BGCOLOR="white" CLASS="TableRowColor">
+<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
+<CODE>&nbsp;void</CODE></FONT></TD>
+<TD><CODE><B><A HREF="../../../org/apache/droids/AbstractDroid.html#setRunningWorker(java.util.concurrent.ConcurrentHashMap)">setRunningWorker</A></B>(<A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/util/concurrent.ConcurrentHashMap.html" title="class or interface in java.util">java.util.concurrent.ConcurrentHashMap</A>&lt;<A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/Long.html" title="class or interface in java.lang">Long</A>,<A HREF="../../../org/apache/droids/api/Worker.html" title="interface in org.apache.droids.api">Worker</A>&gt;&nbsp;runningWorker)</CODE>
+
+<BR>
+&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Set the map of running workers</TD>
+</TR>
+<TR BGCOLOR="white" CLASS="TableRowColor">
+<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
+<CODE>&nbsp;void</CODE></FONT></TD>
+<TD><CODE><B><A HREF="../../../org/apache/droids/AbstractDroid.html#setTaskDate(java.lang.String)">setTaskDate</A></B>(<A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;taskDate)</CODE>
+
+<BR>
+&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;When did the task showed up the first time in the queue</TD>
+</TR>
+<TR BGCOLOR="white" CLASS="TableRowColor">
+<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
+<CODE>protected &nbsp;void</CODE></FONT></TD>
+<TD><CODE><B><A HREF="../../../org/apache/droids/AbstractDroid.html#shutdownAndAwaitTermination()">shutdownAndAwaitTermination</A></B>()</CODE>
+
+<BR>
+&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Shutdown all threads, close the pools and leave.</TD>
+</TR>
+<TR BGCOLOR="white" CLASS="TableRowColor">
+<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
+<CODE>abstract &nbsp;long</CODE></FONT></TD>
+<TD><CODE><B><A HREF="../../../org/apache/droids/AbstractDroid.html#startWorkers()">startWorkers</A></B>()</CODE>
+
+<BR>
+&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Will start a new worker.</TD>
+</TR>
+</TABLE>
+&nbsp;<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
+<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
+<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
+<TH ALIGN="left"><B>Methods inherited from class java.lang.<A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/Object.html" title="class or interface in java.lang">Object</A></B></TH>
+</TR>
+<TR BGCOLOR="white" CLASS="TableRowColor">
+<TD><CODE><A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/Object.html#clone()" title="class or interface in java.lang">clone</A>, <A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/Object.html#equals(java.lang.Object)" title="class or interface in java.lang">equals</A>, <A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/Object.html#finalize()" title="class or interface in java.lang">finalize</A>, <A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/Object.html#getClass()" title="class or interface in java.lang">getClass</A>, <A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/Object.html#hashCode()" title="class or interface in java.lang">hashCode</A>, <A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/Object.html#notify()" title="class or interface in java.lang">notify</A>, <A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/Object.html#notifyAll()" title="class or interface in java.lang">notifyAll</A>, <A HREF="http://
 java.sun.com/j2se/1.4.2/docs/api/java/lang/Object.html#toString()" title="class or interface in java.lang">toString</A>, <A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/Object.html#wait()" title="class or interface in java.lang">wait</A>, <A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/Object.html#wait(long)" title="class or interface in java.lang">wait</A>, <A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/Object.html#wait(long, int)" title="class or interface in java.lang">wait</A></CODE></TD>
+</TR>
+</TABLE>
+&nbsp;<A NAME="methods_inherited_from_class_org.apache.droids.api.Droid"><!-- --></A>
+<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
+<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
+<TH ALIGN="left"><B>Methods inherited from interface org.apache.droids.api.<A HREF="../../../org/apache/droids/api/Droid.html" title="interface in org.apache.droids.api">Droid</A></B></TH>
+</TR>
+<TR BGCOLOR="white" CLASS="TableRowColor">
+<TD><CODE><A HREF="../../../org/apache/droids/api/Droid.html#initQueue()">initQueue</A>, <A HREF="../../../org/apache/droids/api/Droid.html#run()">run</A></CODE></TD>
+</TR>
+</TABLE>
+&nbsp;
+<P>
+
+<!-- ========= CONSTRUCTOR DETAIL ======== -->
+
+<A NAME="constructor_detail"><!-- --></A>
+<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
+<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
+<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
+<B>Constructor Detail</B></FONT></TH>
+</TR>
+</TABLE>
+
+<A NAME="AbstractDroid()"><!-- --></A><H3>
+AbstractDroid</H3>
+<PRE>
+public <B>AbstractDroid</B>()</PRE>
+<DL>
+</DL>
+
+<!-- ============ METHOD DETAIL ========== -->
+
+<A NAME="method_detail"><!-- --></A>
+<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
+<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
+<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
+<B>Method Detail</B></FONT></TH>
+</TR>
+</TABLE>
+
+<A NAME="finishedWorker(long)"><!-- --></A><H3>
+finishedWorker</H3>
+<PRE>
+public void <B>finishedWorker</B>(long&nbsp;id)
+                    throws <A HREF="../../../org/apache/droids/exception/DroidsException.html" title="class in org.apache.droids.exception">DroidsException</A></PRE>
+<DL>
+<DD><B>Description copied from interface: <CODE><A HREF="../../../org/apache/droids/api/Droid.html#finishedWorker(long)">Droid</A></CODE></B></DD>
+<DD>Notification that we finished a given worker. The implementation would
+ normally remove the worker from the pool and start a new worker instead (if
+ needed). If not needed this method normally invokes/requests the shutdown
+ of the main process.
+<P>
+<DD><DL>
+<DT><B>Specified by:</B><DD><CODE><A HREF="../../../org/apache/droids/api/Droid.html#finishedWorker(long)">finishedWorker</A></CODE> in interface <CODE><A HREF="../../../org/apache/droids/api/Droid.html" title="interface in org.apache.droids.api">Droid</A></CODE></DL>
+</DD>
+<DD><DL>
+<DT><B>Parameters:</B><DD><CODE>id</CODE> - the id of the worker that has finished
+<DT><B>Throws:</B>
+<DD><CODE><A HREF="../../../org/apache/droids/exception/DroidsException.html" title="class in org.apache.droids.exception">DroidsException</A></CODE></DL>
+</DD>
+</DL>
+<HR>
+
+<A NAME="startWorkers()"><!-- --></A><H3>
+startWorkers</H3>
+<PRE>
+public abstract long <B>startWorkers</B>()</PRE>
+<DL>
+<DD>Will start a new worker.
+<P>
+<DD><DL>
+</DL>
+</DD>
+<DD><DL>
+
+<DT><B>Returns:</B><DD>the id of the worker we just started.</DL>
+</DD>
+</DL>
+<HR>
+
+<A NAME="getWorker()"><!-- --></A><H3>
+getWorker</H3>
+<PRE>
+public abstract <A HREF="../../../org/apache/droids/api/Worker.html" title="interface in org.apache.droids.api">Worker</A> <B>getWorker</B>()
+                          throws <A HREF="../../../org/apache/droids/exception/DroidsException.html" title="class in org.apache.droids.exception">DroidsException</A></PRE>
+<DL>
+<DD>Get the default worker for the class.
+<P>
+<DD><DL>
+</DL>
+</DD>
+<DD><DL>
+
+<DT><B>Returns:</B><DD>Worker that should do the job.
+<DT><B>Throws:</B>
+<DD><CODE><A HREF="../../../org/apache/droids/exception/DroidsException.html" title="class in org.apache.droids.exception">DroidsException</A></CODE></DL>
+</DD>
+</DL>
+<HR>
+
+<A NAME="getCore()"><!-- --></A><H3>
+getCore</H3>
+<PRE>
+public <A HREF="../../../org/apache/droids/Core.html" title="class in org.apache.droids">Core</A> <B>getCore</B>()</PRE>
+<DL>
+<DD><B>Description copied from interface: <CODE><A HREF="../../../org/apache/droids/api/Droid.html#getCore()">Droid</A></CODE></B></DD>
+<DD>Return the core configuration for the current Droid. The core contains all
+ configured objects ready to use.
+<P>
+<DD><DL>
+<DT><B>Specified by:</B><DD><CODE><A HREF="../../../org/apache/droids/api/Droid.html#getCore()">getCore</A></CODE> in interface <CODE><A HREF="../../../org/apache/droids/api/Droid.html" title="interface in org.apache.droids.api">Droid</A></CODE></DL>
+</DD>
+<DD><DL>
+
+<DT><B>Returns:</B><DD>ready to use configured core</DL>
+</DD>
+</DL>
+<HR>
+
+<A NAME="setCore(org.apache.droids.Core)"><!-- --></A><H3>
+setCore</H3>
+<PRE>
+public void <B>setCore</B>(<A HREF="../../../org/apache/droids/Core.html" title="class in org.apache.droids">Core</A>&nbsp;core)</PRE>
+<DL>
+<DD>Set the fully configured core and inject it in the
+<P>
+<DD><DL>
+</DL>
+</DD>
+<DD><DL>
+<DT><B>Parameters:</B><DD><CODE>core</CODE> - </DL>
+</DD>
+</DL>
+<HR>
+
+<A NAME="getPool()"><!-- --></A><H3>
+getPool</H3>
+<PRE>
+public <A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/util/concurrent.ThreadPoolExecutor.html" title="class or interface in java.util">java.util.concurrent.ThreadPoolExecutor</A> <B>getPool</B>()</PRE>
+<DL>
+<DD>Get our pool.
+<P>
+<DD><DL>
+</DL>
+</DD>
+<DD><DL>
+
+<DT><B>Returns:</B><DD>our pool</DL>
+</DD>
+</DL>
+<HR>
+
+<A NAME="setPool(java.util.concurrent.ThreadPoolExecutor)"><!-- --></A><H3>
+setPool</H3>
+<PRE>
+public void <B>setPool</B>(<A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/util/concurrent.ThreadPoolExecutor.html" title="class or interface in java.util">java.util.concurrent.ThreadPoolExecutor</A>&nbsp;pool)</PRE>
+<DL>
+<DD>Set our pool.
+<P>
+<DD><DL>
+</DL>
+</DD>
+<DD><DL>
+<DT><B>Parameters:</B><DD><CODE>pool</CODE> - the new pool.</DL>
+</DD>
+</DL>
+<HR>
+
+<A NAME="getRunningWorker()"><!-- --></A><H3>
+getRunningWorker</H3>
+<PRE>
+public <A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/util/concurrent.ConcurrentHashMap.html" title="class or interface in java.util">java.util.concurrent.ConcurrentHashMap</A>&lt;<A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/Long.html" title="class or interface in java.lang">Long</A>,<A HREF="../../../org/apache/droids/api/Worker.html" title="interface in org.apache.droids.api">Worker</A>&gt; <B>getRunningWorker</B>()</PRE>
+<DL>
+<DD>Return the map of running workers
+<P>
+<DD><DL>
+</DL>
+</DD>
+<DD><DL>
+
+<DT><B>Returns:</B><DD>map of running workers</DL>
+</DD>
+</DL>
+<HR>
+
+<A NAME="setRunningWorker(java.util.concurrent.ConcurrentHashMap)"><!-- --></A><H3>
+setRunningWorker</H3>
+<PRE>
+public void <B>setRunningWorker</B>(<A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/util/concurrent.ConcurrentHashMap.html" title="class or interface in java.util">java.util.concurrent.ConcurrentHashMap</A>&lt;<A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/Long.html" title="class or interface in java.lang">Long</A>,<A HREF="../../../org/apache/droids/api/Worker.html" title="interface in org.apache.droids.api">Worker</A>&gt;&nbsp;runningWorker)</PRE>
+<DL>
+<DD>Set the map of running workers
+<P>
+<DD><DL>
+</DL>
+</DD>
+<DD><DL>
+<DT><B>Parameters:</B><DD><CODE>runningWorker</CODE> - new map of running workers</DL>
+</DD>
+</DL>
+<HR>
+
+<A NAME="setRunningThreads(int)"><!-- --></A><H3>
+setRunningThreads</H3>
+<PRE>
+public void <B>setRunningThreads</B>(int&nbsp;runningThreads)</PRE>
+<DL>
+<DD>To set the number of running threads.
+<P>
+<DD><DL>
+</DL>
+</DD>
+<DD><DL>
+<DT><B>Parameters:</B><DD><CODE>runningThreads</CODE> - </DL>
+</DD>
+</DL>
+<HR>
+
+<A NAME="getRunningThreads()"><!-- --></A><H3>
+getRunningThreads</H3>
+<PRE>
+public int <B>getRunningThreads</B>()</PRE>
+<DL>
+<DD>Get number of currently running threads
+<P>
+<DD><DL>
+</DL>
+</DD>
+<DD><DL>
+
+<DT><B>Returns:</B><DD>number of currently running threads</DL>
+</DD>
+</DL>
+<HR>
+
+<A NAME="getTaskDate()"><!-- --></A><H3>
+getTaskDate</H3>
+<PRE>
+public <A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> <B>getTaskDate</B>()</PRE>
+<DL>
+<DD>When did the task showed up the first time in the queue
+<P>
+<DD><DL>
+</DL>
+</DD>
+<DD><DL>
+
+<DT><B>Returns:</B><DD>the date when the task registered with the queue</DL>
+</DD>
+</DL>
+<HR>
+
+<A NAME="setTaskDate(java.lang.String)"><!-- --></A><H3>
+setTaskDate</H3>
+<PRE>
+public void <B>setTaskDate</B>(<A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;taskDate)</PRE>
+<DL>
+<DD>When did the task showed up the first time in the queue
+<P>
+<DD><DL>
+</DL>
+</DD>
+<DD><DL>
+<DT><B>Parameters:</B><DD><CODE>taskDate</CODE> - the date when the task registered with the queue</DL>
+</DD>
+</DL>
+<HR>
+
+<A NAME="getFreeSlots()"><!-- --></A><H3>
+getFreeSlots</H3>
+<PRE>
+public int <B>getFreeSlots</B>()</PRE>
+<DL>
+<DD>Get number of slots that we have currently
+ open to accept new workers.
+<P>
+<DD><DL>
+</DL>
+</DD>
+<DD><DL>
+
+<DT><B>Returns:</B><DD>number of slots that are waiting to serve</DL>
+</DD>
+</DL>
+<HR>
+
+<A NAME="setFreeSlots(int)"><!-- --></A><H3>
+setFreeSlots</H3>
+<PRE>
+public void <B>setFreeSlots</B>(int&nbsp;freeSlots)</PRE>
+<DL>
+<DD>Set number of slots that we have currently
+ open to accept new workers
+<P>
+<DD><DL>
+</DL>
+</DD>
+<DD><DL>
+<DT><B>Parameters:</B><DD><CODE>freeSlots</CODE> - number of slots that are waiting to serve</DL>
+</DD>
+</DL>
+<HR>
+
+<A NAME="setMaxThreads(int)"><!-- --></A><H3>
+setMaxThreads</H3>
+<PRE>
+public void <B>setMaxThreads</B>(int&nbsp;maxThreads)</PRE>
+<DL>
+<DD>Adjust number of allowed threads
+<P>
+<DD><DL>
+</DL>
+</DD>
+<DD><DL>
+<DT><B>Parameters:</B><DD><CODE>maxThreads</CODE> - </DL>
+</DD>
+</DL>
+<HR>
+
+<A NAME="getMaxThreads()"><!-- --></A><H3>
+getMaxThreads</H3>
+<PRE>
+public int <B>getMaxThreads</B>()</PRE>
+<DL>
+<DD>Get number of maximum allowed threads
+<P>
+<DD><DL>
+</DL>
+</DD>
+<DD><DL>
+
+<DT><B>Returns:</B><DD>the number of maximum threads that we allow</DL>
+</DD>
+</DL>
+<HR>
+
+<A NAME="setQueue(org.apache.droids.api.Queue)"><!-- --></A><H3>
+setQueue</H3>
+<PRE>
+public void <B>setQueue</B>(<A HREF="../../../org/apache/droids/api/Queue.html" title="interface in org.apache.droids.api">Queue</A>&nbsp;queue)</PRE>
+<DL>
+<DD><B>Description copied from interface: <CODE><A HREF="../../../org/apache/droids/api/Droid.html#setQueue(org.apache.droids.api.Queue)">Droid</A></CODE></B></DD>
+<DD>Which implementation of a queue are we using. Setter method to make sure
+ different implementation can override the method.
+ <p>
+ Not all implementations are using a queue at all.
+<P>
+<DD><DL>
+<DT><B>Specified by:</B><DD><CODE><A HREF="../../../org/apache/droids/api/Droid.html#setQueue(org.apache.droids.api.Queue)">setQueue</A></CODE> in interface <CODE><A HREF="../../../org/apache/droids/api/Droid.html" title="interface in org.apache.droids.api">Droid</A></CODE></DL>
+</DD>
+<DD><DL>
+<DT><B>Parameters:</B><DD><CODE>queue</CODE> - queue implementation</DL>
+</DD>
+</DL>
+<HR>
+
+<A NAME="getQueue()"><!-- --></A><H3>
+getQueue</H3>
+<PRE>
+protected <A HREF="../../../org/apache/droids/api/Queue.html" title="interface in org.apache.droids.api">Queue</A> <B>getQueue</B>()</PRE>
+<DL>
+<DD>Get the queue implementation that we want to use.
+<P>
+<DD><DL>
+</DL>
+</DD>
+<DD><DL>
+
+<DT><B>Returns:</B><DD></DL>
+</DD>
+</DL>
+<HR>
+
+<A NAME="shutdownAndAwaitTermination()"><!-- --></A><H3>
+shutdownAndAwaitTermination</H3>
+<PRE>
+protected void <B>shutdownAndAwaitTermination</B>()</PRE>
+<DL>
+<DD>Shutdown all threads, close the pools and leave.
+ If it is not working by asking nice to shutdown just kill all
+ threads.
+<P>
+<DD><DL>
+</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=2 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/AbstractDroid.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/apache/droids/Cli.html" title="class in org.apache.droids"><B>NEXT CLASS</B></A></FONT></TD>
+<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
+  <A HREF="../../../index.html?org/apache/droids/AbstractDroid.html" target="_top"><B>FRAMES</B></A>  &nbsp;
+&nbsp;<A HREF="AbstractDroid.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; 2008 The Apache Software Foundation
+</BODY>
+</HTML>

Propchange: labs/droids/trunk/docs/api/org/apache/droids/AbstractDroid.html
------------------------------------------------------------------------------
    svn:eol-style = native

Modified: labs/droids/trunk/docs/api/org/apache/droids/Cli.html
URL: http://svn.apache.org/viewvc/labs/droids/trunk/docs/api/org/apache/droids/Cli.html?rev=688432&r1=688431&r2=688432&view=diff
==============================================================================
--- labs/droids/trunk/docs/api/org/apache/droids/Cli.html (original)
+++ labs/droids/trunk/docs/api/org/apache/droids/Cli.html Sat Aug 23 16:44:31 2008
@@ -2,7 +2,7 @@
 <!--NewPage-->
 <HTML>
 <HEAD>
-<!-- Generated by javadoc (build 1.5.0_12) on Tue Mar 18 01:10:55 CET 2008 -->
+<!-- Generated by javadoc (build 1.5.0_12) on Sun Aug 24 01:37:46 CEST 2008 -->
 <TITLE>
 Cli (Droids initial API)
 </TITLE>
@@ -52,7 +52,7 @@
 
 <TR>
 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
-&nbsp;PREV CLASS&nbsp;
+&nbsp;<A HREF="../../../org/apache/droids/AbstractDroid.html" title="class in org.apache.droids"><B>PREV CLASS</B></A>&nbsp;
 &nbsp;<A HREF="../../../org/apache/droids/Core.html" title="class in org.apache.droids"><B>NEXT CLASS</B></A></FONT></TD>
 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
   <A HREF="../../../index.html?org/apache/droids/Cli.html" target="_top"><B>FRAMES</B></A>  &nbsp;
@@ -73,9 +73,9 @@
 </TR>
 <TR>
 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
-  SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;<A HREF="#field_summary">FIELD</A>&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
+  SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
-DETAIL:&nbsp;<A HREF="#field_detail">FIELD</A>&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
+DETAIL:&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
 </TR>
 </TABLE>
 <A NAME="skip-navbar_top"></A>
@@ -98,43 +98,21 @@
 </PRE>
 
 <P>
-<HR>
-
+The principal class to start droids. The commandline prepares the context 
+ and starts the droid that is specified in the arguments.
 <P>
-<!-- =========== FIELD SUMMARY =========== -->
 
-<A NAME="field_summary"><!-- --></A>
-<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
-<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
-<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
-<B>Field Summary</B></FONT></TH>
-</TR>
-<TR BGCOLOR="white" CLASS="TableRowColor">
-<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
-<CODE>static&nbsp;org.apache.commons.logging.Log</CODE></FONT></TD>
-<TD><CODE><B><A HREF="../../../org/apache/droids/Cli.html#LOG">LOG</A></B></CODE>
-
-<BR>
-&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
-</TR>
-</TABLE>
-&nbsp;
-<!-- ======== CONSTRUCTOR SUMMARY ======== -->
+<P>
+<DL>
+<DT><B>Version:</B></DT>
+  <DD>1.0</DD>
+<DT><B>Author:</B></DT>
+  <DD>thorsten</DD>
+</DL>
+<HR>
 
-<A NAME="constructor_summary"><!-- --></A>
-<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
-<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
-<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
-<B>Constructor Summary</B></FONT></TH>
-</TR>
-<TR BGCOLOR="white" CLASS="TableRowColor">
-<TD><CODE><B><A HREF="../../../org/apache/droids/Cli.html#Cli()">Cli</A></B>()</CODE>
+<P>
 
-<BR>
-&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
-</TR>
-</TABLE>
-&nbsp;
 <!-- ========== METHOD SUMMARY =========== -->
 
 <A NAME="method_summary"><!-- --></A>
@@ -149,7 +127,7 @@
 <TD><CODE><B><A HREF="../../../org/apache/droids/Cli.html#main(java.lang.String[])">main</A></B>(<A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>[]&nbsp;args)</CODE>
 
 <BR>
-&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
+&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Invoke the processing with droids.</TD>
 </TR>
 </TABLE>
 &nbsp;<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
@@ -164,42 +142,6 @@
 &nbsp;
 <P>
 
-<!-- ============ FIELD DETAIL =========== -->
-
-<A NAME="field_detail"><!-- --></A>
-<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
-<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
-<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
-<B>Field Detail</B></FONT></TH>
-</TR>
-</TABLE>
-
-<A NAME="LOG"><!-- --></A><H3>
-LOG</H3>
-<PRE>
-public static final org.apache.commons.logging.Log <B>LOG</B></PRE>
-<DL>
-<DL>
-</DL>
-</DL>
-
-<!-- ========= CONSTRUCTOR DETAIL ======== -->
-
-<A NAME="constructor_detail"><!-- --></A>
-<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
-<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
-<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
-<B>Constructor Detail</B></FONT></TH>
-</TR>
-</TABLE>
-
-<A NAME="Cli()"><!-- --></A><H3>
-Cli</H3>
-<PRE>
-public <B>Cli</B>()</PRE>
-<DL>
-</DL>
-
 <!-- ============ METHOD DETAIL ========== -->
 
 <A NAME="method_detail"><!-- --></A>
@@ -214,18 +156,14 @@
 main</H3>
 <PRE>
 public static void <B>main</B>(<A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>[]&nbsp;args)
-                 throws <A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/net/MalformedURLException.html" title="class or interface in java.net">MalformedURLException</A>,
-                        <A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/io/IOException.html" title="class or interface in java.io">IOException</A>,
-                        <A HREF="../../../org/apache/droids/exception/DroidsException.html" title="class in org.apache.droids.exception">DroidsException</A></PRE>
+                 throws <A HREF="../../../org/apache/droids/exception/DroidsException.html" title="class in org.apache.droids.exception">DroidsException</A></PRE>
 <DL>
+<DD>Invoke the processing with droids.
+<P>
 <DD><DL>
-<DT><B>Parameters:</B><DD><CODE>args</CODE> - 
+<DT><B>Parameters:</B><DD><CODE>args</CODE> - You need to provide the droid name (e.g. crawler-x-m02y07) and optional the config file.
 <DT><B>Throws:</B>
-<DD><CODE><A HREF="../../../org/apache/droids/exception/DroidsException.html" title="class in org.apache.droids.exception">DroidsException</A></CODE>
-<DD><CODE><A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/io/IOException.html" title="class or interface in java.io">IOException</A></CODE>
-<DD><CODE><A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/net/MalformedURLException.html" title="class or interface in java.net">MalformedURLException</A></CODE>
-<DD><CODE>ProtocolNotFound</CODE>
-<DD><CODE>ParserNotFound</CODE></DL>
+<DD><CODE><A HREF="../../../org/apache/droids/exception/DroidsException.html" title="class in org.apache.droids.exception">DroidsException</A></CODE></DL>
 </DD>
 </DL>
 <!-- ========= END OF CLASS DATA ========= -->
@@ -259,7 +197,7 @@
 
 <TR>
 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
-&nbsp;PREV CLASS&nbsp;
+&nbsp;<A HREF="../../../org/apache/droids/AbstractDroid.html" title="class in org.apache.droids"><B>PREV CLASS</B></A>&nbsp;
 &nbsp;<A HREF="../../../org/apache/droids/Core.html" title="class in org.apache.droids"><B>NEXT CLASS</B></A></FONT></TD>
 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
   <A HREF="../../../index.html?org/apache/droids/Cli.html" target="_top"><B>FRAMES</B></A>  &nbsp;
@@ -280,15 +218,15 @@
 </TR>
 <TR>
 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
-  SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;<A HREF="#field_summary">FIELD</A>&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
+  SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
-DETAIL:&nbsp;<A HREF="#field_detail">FIELD</A>&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
+DETAIL:&nbsp;FIELD&nbsp;|&nbsp;CONSTR&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; 2007 The Apache Software Foundation
+Copyright &copy; 2008 The Apache Software Foundation
 </BODY>
 </HTML>

Modified: labs/droids/trunk/docs/api/org/apache/droids/Core.html
URL: http://svn.apache.org/viewvc/labs/droids/trunk/docs/api/org/apache/droids/Core.html?rev=688432&r1=688431&r2=688432&view=diff
==============================================================================
--- labs/droids/trunk/docs/api/org/apache/droids/Core.html (original)
+++ labs/droids/trunk/docs/api/org/apache/droids/Core.html Sat Aug 23 16:44:31 2008
@@ -2,7 +2,7 @@
 <!--NewPage-->
 <HTML>
 <HEAD>
-<!-- Generated by javadoc (build 1.5.0_12) on Tue Mar 18 01:10:55 CET 2008 -->
+<!-- Generated by javadoc (build 1.5.0_12) on Sun Aug 24 01:37:46 CEST 2008 -->
 <TITLE>
 Core (Droids initial API)
 </TITLE>
@@ -98,6 +98,16 @@
 </PRE>
 
 <P>
+Core configuration mainly holding the different factories we are using.
+<P>
+
+<P>
+<DL>
+<DT><B>Version:</B></DT>
+  <DD>1.0</DD>
+<DT><B>Author:</B></DT>
+  <DD>thorsten</DD>
+</DL>
 <HR>
 
 <P>
@@ -132,7 +142,8 @@
 <TD><CODE><B><A HREF="../../../org/apache/droids/Core.html#getDroid(java.lang.String)">getDroid</A></B>(<A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;name)</CODE>
 
 <BR>
-&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
+&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Return the droid we want to use identified
+ by the given name.</TD>
 </TR>
 <TR BGCOLOR="white" CLASS="TableRowColor">
 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
@@ -140,7 +151,8 @@
 <TD><CODE><B><A HREF="../../../org/apache/droids/Core.html#getFiltersFactory()">getFiltersFactory</A></B>()</CODE>
 
 <BR>
-&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
+&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns the filtersFactory that knows all registered 
+ filters.</TD>
 </TR>
 <TR BGCOLOR="white" CLASS="TableRowColor">
 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
@@ -148,7 +160,7 @@
 <TD><CODE><B><A HREF="../../../org/apache/droids/Core.html#getHandlerFactory()">getHandlerFactory</A></B>()</CODE>
 
 <BR>
-&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
+&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns the handlerFactory that knows all registered handlers.</TD>
 </TR>
 <TR BGCOLOR="white" CLASS="TableRowColor">
 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
@@ -156,7 +168,8 @@
 <TD><CODE><B><A HREF="../../../org/apache/droids/Core.html#getParserFactory()">getParserFactory</A></B>()</CODE>
 
 <BR>
-&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
+&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns the parserFactory that knows all registered 
+ parser.</TD>
 </TR>
 <TR BGCOLOR="white" CLASS="TableRowColor">
 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
@@ -164,7 +177,8 @@
 <TD><CODE><B><A HREF="../../../org/apache/droids/Core.html#getProtocolFactory()">getProtocolFactory</A></B>()</CODE>
 
 <BR>
-&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
+&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns the protocolFactory that knows all registered 
+ protocol.</TD>
 </TR>
 <TR BGCOLOR="white" CLASS="TableRowColor">
 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
@@ -172,7 +186,7 @@
 <TD><CODE><B><A HREF="../../../org/apache/droids/Core.html#setDroids(org.apache.droids.helper.factories.DroidFactory)">setDroids</A></B>(<A HREF="../../../org/apache/droids/helper/factories/DroidFactory.html" title="class in org.apache.droids.helper.factories">DroidFactory</A>&nbsp;droids)</CODE>
 
 <BR>
-&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
+&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Set the droidsFactory we are using.</TD>
 </TR>
 <TR BGCOLOR="white" CLASS="TableRowColor">
 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
@@ -180,7 +194,7 @@
 <TD><CODE><B><A HREF="../../../org/apache/droids/Core.html#setFiltersFactory(org.apache.droids.helper.factories.URLFiltersFactory)">setFiltersFactory</A></B>(<A HREF="../../../org/apache/droids/helper/factories/URLFiltersFactory.html" title="class in org.apache.droids.helper.factories">URLFiltersFactory</A>&nbsp;filtersFactory)</CODE>
 
 <BR>
-&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
+&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Set the pre-configured filtersFactory that knows all registered filters.</TD>
 </TR>
 <TR BGCOLOR="white" CLASS="TableRowColor">
 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
@@ -188,7 +202,7 @@
 <TD><CODE><B><A HREF="../../../org/apache/droids/Core.html#setHandlerFactory(org.apache.droids.helper.factories.HandlerFactory)">setHandlerFactory</A></B>(<A HREF="../../../org/apache/droids/helper/factories/HandlerFactory.html" title="class in org.apache.droids.helper.factories">HandlerFactory</A>&nbsp;handlerFactory)</CODE>
 
 <BR>
-&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
+&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Set the pre-configured handlerFactory that knows all registered handlers.</TD>
 </TR>
 <TR BGCOLOR="white" CLASS="TableRowColor">
 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
@@ -196,7 +210,8 @@
 <TD><CODE><B><A HREF="../../../org/apache/droids/Core.html#setParserFactory(org.apache.droids.helper.factories.ParserFactory)">setParserFactory</A></B>(<A HREF="../../../org/apache/droids/helper/factories/ParserFactory.html" title="class in org.apache.droids.helper.factories">ParserFactory</A>&nbsp;parserFactory)</CODE>
 
 <BR>
-&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
+&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Set the pre-configured parserFactory that knows all registered 
+ parser.</TD>
 </TR>
 <TR BGCOLOR="white" CLASS="TableRowColor">
 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
@@ -204,7 +219,8 @@
 <TD><CODE><B><A HREF="../../../org/apache/droids/Core.html#setProtocolFactory(org.apache.droids.helper.factories.ProtocolFactory)">setProtocolFactory</A></B>(<A HREF="../../../org/apache/droids/helper/factories/ProtocolFactory.html" title="class in org.apache.droids.helper.factories">ProtocolFactory</A>&nbsp;protocolFactory)</CODE>
 
 <BR>
-&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
+&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Set the pre-configured protocolFactory that knows all registered 
+ protocol.</TD>
 </TR>
 <TR BGCOLOR="white" CLASS="TableRowColor">
 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
@@ -212,7 +228,7 @@
 <TD><CODE><B><A HREF="../../../org/apache/droids/Core.html#start(java.lang.String)">start</A></B>(<A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;name)</CODE>
 
 <BR>
-&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
+&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Start a given Droid.</TD>
 </TR>
 <TR BGCOLOR="white" CLASS="TableRowColor">
 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
@@ -220,7 +236,8 @@
 <TD><CODE><B><A HREF="../../../org/apache/droids/Core.html#threadMessage(java.lang.String)">threadMessage</A></B>(<A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;message)</CODE>
 
 <BR>
-&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
+&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Since we are using for now exclusively the command line, the 
+ method should be use to send message to the user.</TD>
 </TR>
 </TABLE>
 &nbsp;<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
@@ -267,8 +284,12 @@
 <PRE>
 public void <B>setDroids</B>(<A HREF="../../../org/apache/droids/helper/factories/DroidFactory.html" title="class in org.apache.droids.helper.factories">DroidFactory</A>&nbsp;droids)</PRE>
 <DL>
+<DD>Set the droidsFactory we are using. 
+ This is the core component that knows all registered droids
+ that the application offers.
+<P>
 <DD><DL>
-</DL>
+<DT><B>Parameters:</B><DD><CODE>droids</CODE> - <DT><B>See Also:</B><DD><A HREF="../../../org/apache/droids/helper/factories/DroidFactory.html" title="class in org.apache.droids.helper.factories"><CODE>DroidFactory</CODE></A></DL>
 </DD>
 </DL>
 <HR>
@@ -278,8 +299,13 @@
 <PRE>
 public <A HREF="../../../org/apache/droids/api/Droid.html" title="interface in org.apache.droids.api">Droid</A> <B>getDroid</B>(<A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;name)</PRE>
 <DL>
+<DD>Return the droid we want to use identified
+ by the given name. Will contact the droidsFactory
+ and looks up the droid.
+<P>
 <DD><DL>
-</DL>
+<DT><B>Parameters:</B><DD><CODE>name</CODE> - the name of the droid we want to use
+<DT><B>Returns:</B><DD>The droid that is identified by the name<DT><B>See Also:</B><DD><A HREF="../../../org/apache/droids/helper/factories/DroidFactory.html" title="class in org.apache.droids.helper.factories"><CODE>DroidFactory</CODE></A></DL>
 </DD>
 </DL>
 <HR>
@@ -289,8 +315,13 @@
 <PRE>
 public <A HREF="../../../org/apache/droids/helper/factories/ProtocolFactory.html" title="class in org.apache.droids.helper.factories">ProtocolFactory</A> <B>getProtocolFactory</B>()</PRE>
 <DL>
+<DD>Returns the protocolFactory that knows all registered 
+ protocol.
+<P>
 <DD><DL>
-</DL>
+
+<DT><B>Returns:</B><DD>protocolFactory that knows all registered 
+ protocol.<DT><B>See Also:</B><DD><A HREF="../../../org/apache/droids/helper/factories/ProtocolFactory.html" title="class in org.apache.droids.helper.factories"><CODE>ProtocolFactory</CODE></A></DL>
 </DD>
 </DL>
 <HR>
@@ -300,8 +331,11 @@
 <PRE>
 public void <B>setProtocolFactory</B>(<A HREF="../../../org/apache/droids/helper/factories/ProtocolFactory.html" title="class in org.apache.droids.helper.factories">ProtocolFactory</A>&nbsp;protocolFactory)</PRE>
 <DL>
+<DD>Set the pre-configured protocolFactory that knows all registered 
+ protocol.
+<P>
 <DD><DL>
-</DL>
+<DT><B>Parameters:</B><DD><CODE>protocolFactory</CODE> - pre-configured protocolFactory<DT><B>See Also:</B><DD><A HREF="../../../org/apache/droids/helper/factories/ProtocolFactory.html" title="class in org.apache.droids.helper.factories"><CODE>ProtocolFactory</CODE></A></DL>
 </DD>
 </DL>
 <HR>
@@ -309,13 +343,13 @@
 <A NAME="start(java.lang.String)"><!-- --></A><H3>
 start</H3>
 <PRE>
-public void <B>start</B>(<A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;name)
-           throws <A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/InterruptedException.html" title="class or interface in java.lang">InterruptedException</A></PRE>
+public void <B>start</B>(<A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;name)</PRE>
 <DL>
+<DD>Start a given Droid. First we will look up the droid
+ identified by the given name and then start it.
+<P>
 <DD><DL>
-
-<DT><B>Throws:</B>
-<DD><CODE><A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/InterruptedException.html" title="class or interface in java.lang">InterruptedException</A></CODE></DL>
+<DT><B>Parameters:</B><DD><CODE>name</CODE> - the name of the droid we want to use</DL>
 </DD>
 </DL>
 <HR>
@@ -325,8 +359,11 @@
 <PRE>
 public static void <B>threadMessage</B>(<A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;message)</PRE>
 <DL>
+<DD>Since we are using for now exclusively the command line, the 
+ method should be use to send message to the user.
+<P>
 <DD><DL>
-</DL>
+<DT><B>Parameters:</B><DD><CODE>message</CODE> - the message you want to send</DL>
 </DD>
 </DL>
 <HR>
@@ -336,8 +373,13 @@
 <PRE>
 public <A HREF="../../../org/apache/droids/helper/factories/ParserFactory.html" title="class in org.apache.droids.helper.factories">ParserFactory</A> <B>getParserFactory</B>()</PRE>
 <DL>
+<DD>Returns the parserFactory that knows all registered 
+ parser.
+<P>
 <DD><DL>
-</DL>
+
+<DT><B>Returns:</B><DD>parserFactory that knows all registered 
+ parser.<DT><B>See Also:</B><DD><A HREF="../../../org/apache/droids/helper/factories/ParserFactory.html" title="class in org.apache.droids.helper.factories"><CODE>ParserFactory</CODE></A></DL>
 </DD>
 </DL>
 <HR>
@@ -347,8 +389,11 @@
 <PRE>
 public void <B>setParserFactory</B>(<A HREF="../../../org/apache/droids/helper/factories/ParserFactory.html" title="class in org.apache.droids.helper.factories">ParserFactory</A>&nbsp;parserFactory)</PRE>
 <DL>
+<DD>Set the pre-configured parserFactory that knows all registered 
+ parser.
+<P>
 <DD><DL>
-</DL>
+<DT><B>Parameters:</B><DD><CODE>parserFactory</CODE> - pre-configured parserFactory<DT><B>See Also:</B><DD><A HREF="../../../org/apache/droids/helper/factories/ParserFactory.html" title="class in org.apache.droids.helper.factories"><CODE>ParserFactory</CODE></A></DL>
 </DD>
 </DL>
 <HR>
@@ -358,8 +403,13 @@
 <PRE>
 public <A HREF="../../../org/apache/droids/helper/factories/URLFiltersFactory.html" title="class in org.apache.droids.helper.factories">URLFiltersFactory</A> <B>getFiltersFactory</B>()</PRE>
 <DL>
+<DD>Returns the filtersFactory that knows all registered 
+ filters.
+<P>
 <DD><DL>
-</DL>
+
+<DT><B>Returns:</B><DD>filtersFactory that knows all registered 
+ filters.<DT><B>See Also:</B><DD><A HREF="../../../org/apache/droids/helper/factories/URLFiltersFactory.html" title="class in org.apache.droids.helper.factories"><CODE>URLFiltersFactory</CODE></A></DL>
 </DD>
 </DL>
 <HR>
@@ -369,8 +419,11 @@
 <PRE>
 public void <B>setFiltersFactory</B>(<A HREF="../../../org/apache/droids/helper/factories/URLFiltersFactory.html" title="class in org.apache.droids.helper.factories">URLFiltersFactory</A>&nbsp;filtersFactory)</PRE>
 <DL>
+<DD>Set the pre-configured filtersFactory that knows all registered filters.
+<P>
 <DD><DL>
-</DL>
+<DT><B>Parameters:</B><DD><CODE>filtersFactory</CODE> - filtersFactory that knows all registered 
+ filters.<DT><B>See Also:</B><DD><A HREF="../../../org/apache/droids/helper/factories/URLFiltersFactory.html" title="class in org.apache.droids.helper.factories"><CODE>URLFiltersFactory</CODE></A></DL>
 </DD>
 </DL>
 <HR>
@@ -380,8 +433,11 @@
 <PRE>
 public <A HREF="../../../org/apache/droids/helper/factories/HandlerFactory.html" title="class in org.apache.droids.helper.factories">HandlerFactory</A> <B>getHandlerFactory</B>()</PRE>
 <DL>
+<DD>Returns the handlerFactory that knows all registered handlers.
+<P>
 <DD><DL>
-</DL>
+
+<DT><B>Returns:</B><DD>handlerFactory that knows all registered handlers.<DT><B>See Also:</B><DD><A HREF="../../../org/apache/droids/helper/factories/HandlerFactory.html" title="class in org.apache.droids.helper.factories"><CODE>HandlerFactory</CODE></A></DL>
 </DD>
 </DL>
 <HR>
@@ -391,8 +447,10 @@
 <PRE>
 public void <B>setHandlerFactory</B>(<A HREF="../../../org/apache/droids/helper/factories/HandlerFactory.html" title="class in org.apache.droids.helper.factories">HandlerFactory</A>&nbsp;handlerFactory)</PRE>
 <DL>
+<DD>Set the pre-configured handlerFactory that knows all registered handlers.
+<P>
 <DD><DL>
-</DL>
+<DT><B>Parameters:</B><DD><CODE>handlerFactory</CODE> - pre-configured handlerFactory that knows all registered handlers.<DT><B>See Also:</B><DD><A HREF="../../../org/apache/droids/helper/factories/HandlerFactory.html" title="class in org.apache.droids.helper.factories"><CODE>HandlerFactory</CODE></A></DL>
 </DD>
 </DL>
 <!-- ========= END OF CLASS DATA ========= -->
@@ -456,6 +514,6 @@
 <!-- ======== END OF BOTTOM NAVBAR ======= -->
 
 <HR>
-Copyright &copy; 2007 The Apache Software Foundation
+Copyright &copy; 2008 The Apache Software Foundation
 </BODY>
 </HTML>

Modified: labs/droids/trunk/docs/api/org/apache/droids/DefaultCrawler.html
URL: http://svn.apache.org/viewvc/labs/droids/trunk/docs/api/org/apache/droids/DefaultCrawler.html?rev=688432&r1=688431&r2=688432&view=diff
==============================================================================
--- labs/droids/trunk/docs/api/org/apache/droids/DefaultCrawler.html (original)
+++ labs/droids/trunk/docs/api/org/apache/droids/DefaultCrawler.html Sat Aug 23 16:44:31 2008
@@ -2,7 +2,7 @@
 <!--NewPage-->
 <HTML>
 <HEAD>
-<!-- Generated by javadoc (build 1.5.0_12) on Tue Mar 18 01:10:55 CET 2008 -->
+<!-- Generated by javadoc (build 1.5.0_12) on Sun Aug 24 01:37:46 CEST 2008 -->
 <TITLE>
 DefaultCrawler (Droids initial API)
 </TITLE>
@@ -73,9 +73,9 @@
 </TR>
 <TR>
 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
-  SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;<A HREF="#field_summary">FIELD</A>&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
+  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;<A HREF="#field_detail">FIELD</A>&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
+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_top"></A>
@@ -90,14 +90,15 @@
 Class DefaultCrawler</H2>
 <PRE>
 <A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/Object.html" title="class or interface in java.lang">java.lang.Object</A>
-  <IMG SRC="../../../resources/inherit.gif" ALT="extended by "><B>org.apache.droids.DefaultCrawler</B>
+  <IMG SRC="../../../resources/inherit.gif" ALT="extended by "><A HREF="../../../org/apache/droids/AbstractDroid.html" title="class in org.apache.droids">org.apache.droids.AbstractDroid</A>
+      <IMG SRC="../../../resources/inherit.gif" ALT="extended by "><B>org.apache.droids.DefaultCrawler</B>
 </PRE>
 <DL>
 <DT><B>All Implemented Interfaces:</B> <DD><A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/Runnable.html" title="class or interface in java.lang">Runnable</A>, <A HREF="../../../org/apache/droids/api/Droid.html" title="interface in org.apache.droids.api">Droid</A></DD>
 </DL>
 <HR>
 <DL>
-<DT><PRE>public class <B>DefaultCrawler</B><DT>extends <A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/Object.html" title="class or interface in java.lang">Object</A><DT>implements <A HREF="../../../org/apache/droids/api/Droid.html" title="interface in org.apache.droids.api">Droid</A></DL>
+<DT><PRE>public class <B>DefaultCrawler</B><DT>extends <A HREF="../../../org/apache/droids/AbstractDroid.html" title="class in org.apache.droids">AbstractDroid</A></DL>
 </PRE>
 
 <P>
@@ -111,54 +112,15 @@
 
 <P>
 <DL>
+<DT><B>Version:</B></DT>
+  <DD>1.0</DD>
 <DT><B>Author:</B></DT>
   <DD>thorsten</DD>
 </DL>
 <HR>
 
 <P>
-<!-- =========== FIELD SUMMARY =========== -->
 
-<A NAME="field_summary"><!-- --></A>
-<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
-<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
-<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
-<B>Field Summary</B></FONT></TH>
-</TR>
-<TR BGCOLOR="white" CLASS="TableRowColor">
-<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
-<CODE>protected &nbsp;int</CODE></FONT></TD>
-<TD><CODE><B><A HREF="../../../org/apache/droids/DefaultCrawler.html#freeSlots">freeSlots</A></B></CODE>
-
-<BR>
-&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
-</TR>
-<TR BGCOLOR="white" CLASS="TableRowColor">
-<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
-<CODE>protected &nbsp;<A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/util/concurrent.ThreadPoolExecutor.html" title="class or interface in java.util">java.util.concurrent.ThreadPoolExecutor</A></CODE></FONT></TD>
-<TD><CODE><B><A HREF="../../../org/apache/droids/DefaultCrawler.html#pool">pool</A></B></CODE>
-
-<BR>
-&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
-</TR>
-<TR BGCOLOR="white" CLASS="TableRowColor">
-<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
-<CODE>protected &nbsp;<A HREF="../../../org/apache/droids/api/Queue.html" title="interface in org.apache.droids.api">Queue</A></CODE></FONT></TD>
-<TD><CODE><B><A HREF="../../../org/apache/droids/DefaultCrawler.html#queue">queue</A></B></CODE>
-
-<BR>
-&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
-</TR>
-<TR BGCOLOR="white" CLASS="TableRowColor">
-<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
-<CODE>protected &nbsp;<A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A></CODE></FONT></TD>
-<TD><CODE><B><A HREF="../../../org/apache/droids/DefaultCrawler.html#taskDate">taskDate</A></B></CODE>
-
-<BR>
-&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
-</TR>
-</TABLE>
-&nbsp;
 <!-- ======== CONSTRUCTOR SUMMARY ======== -->
 
 <A NAME="constructor_summary"><!-- --></A>
@@ -185,43 +147,11 @@
 </TR>
 <TR BGCOLOR="white" CLASS="TableRowColor">
 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
-<CODE>&nbsp;void</CODE></FONT></TD>
-<TD><CODE><B><A HREF="../../../org/apache/droids/DefaultCrawler.html#finishedWorker(long)">finishedWorker</A></B>(long&nbsp;id)</CODE>
-
-<BR>
-&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
-</TR>
-<TR BGCOLOR="white" CLASS="TableRowColor">
-<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
-<CODE>&nbsp;<A HREF="../../../org/apache/droids/Core.html" title="class in org.apache.droids">Core</A></CODE></FONT></TD>
-<TD><CODE><B><A HREF="../../../org/apache/droids/DefaultCrawler.html#getCore()">getCore</A></B>()</CODE>
-
-<BR>
-&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
-</TR>
-<TR BGCOLOR="white" CLASS="TableRowColor">
-<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
-<CODE>&nbsp;int</CODE></FONT></TD>
-<TD><CODE><B><A HREF="../../../org/apache/droids/DefaultCrawler.html#getMaxThreads()">getMaxThreads</A></B>()</CODE>
-
-<BR>
-&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Get number of maximum allowed threads</TD>
-</TR>
-<TR BGCOLOR="white" CLASS="TableRowColor">
-<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
-<CODE>protected &nbsp;<A HREF="../../../org/apache/droids/api/Queue.html" title="interface in org.apache.droids.api">Queue</A></CODE></FONT></TD>
-<TD><CODE><B><A HREF="../../../org/apache/droids/DefaultCrawler.html#getQueue()">getQueue</A></B>()</CODE>
-
-<BR>
-&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
-</TR>
-<TR BGCOLOR="white" CLASS="TableRowColor">
-<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
-<CODE>&nbsp;int</CODE></FONT></TD>
-<TD><CODE><B><A HREF="../../../org/apache/droids/DefaultCrawler.html#getRunningThreads()">getRunningThreads</A></B>()</CODE>
+<CODE>&nbsp;<A HREF="../../../org/apache/droids/api/DelayTimer.html" title="interface in org.apache.droids.api">DelayTimer</A></CODE></FONT></TD>
+<TD><CODE><B><A HREF="../../../org/apache/droids/DefaultCrawler.html#getDelayTimer()">getDelayTimer</A></B>()</CODE>
 
 <BR>
-&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Get number of currently running threads</TD>
+&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Get the DelayTimer implementation that we want to use.</TD>
 </TR>
 <TR BGCOLOR="white" CLASS="TableRowColor">
 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
@@ -229,7 +159,7 @@
 <TD><CODE><B><A HREF="../../../org/apache/droids/DefaultCrawler.html#getUrl()">getUrl</A></B>()</CODE>
 
 <BR>
-&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
+&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Return the initial url</TD>
 </TR>
 <TR BGCOLOR="white" CLASS="TableRowColor">
 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
@@ -245,7 +175,7 @@
 <TD><CODE><B><A HREF="../../../org/apache/droids/DefaultCrawler.html#initQueue()">initQueue</A></B>()</CODE>
 
 <BR>
-&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Start the queue.</TD>
+&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Initialize the queue.</TD>
 </TR>
 <TR BGCOLOR="white" CLASS="TableRowColor">
 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
@@ -259,7 +189,7 @@
 <TR BGCOLOR="white" CLASS="TableRowColor">
 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
 <CODE>&nbsp;void</CODE></FONT></TD>
-<TD><CODE><B><A HREF="../../../org/apache/droids/DefaultCrawler.html#setCore(org.apache.droids.Core)">setCore</A></B>(<A HREF="../../../org/apache/droids/Core.html" title="class in org.apache.droids">Core</A>&nbsp;core)</CODE>
+<TD><CODE><B><A HREF="../../../org/apache/droids/DefaultCrawler.html#setDelayTimer(org.apache.droids.api.DelayTimer)">setDelayTimer</A></B>(<A HREF="../../../org/apache/droids/api/DelayTimer.html" title="interface in org.apache.droids.api">DelayTimer</A>&nbsp;delayTimer)</CODE>
 
 <BR>
 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
@@ -267,34 +197,27 @@
 <TR BGCOLOR="white" CLASS="TableRowColor">
 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
 <CODE>&nbsp;void</CODE></FONT></TD>
-<TD><CODE><B><A HREF="../../../org/apache/droids/DefaultCrawler.html#setMaxThreads(int)">setMaxThreads</A></B>(int&nbsp;maxThreads)</CODE>
+<TD><CODE><B><A HREF="../../../org/apache/droids/DefaultCrawler.html#setUrl(java.lang.String)">setUrl</A></B>(<A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;url)</CODE>
 
 <BR>
-&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Adjust number of allowed threads</TD>
+&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Set the initial url</TD>
 </TR>
 <TR BGCOLOR="white" CLASS="TableRowColor">
 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
-<CODE>&nbsp;void</CODE></FONT></TD>
-<TD><CODE><B><A HREF="../../../org/apache/droids/DefaultCrawler.html#setQueue(org.apache.droids.api.Queue)">setQueue</A></B>(<A HREF="../../../org/apache/droids/api/Queue.html" title="interface in org.apache.droids.api">Queue</A>&nbsp;queue)</CODE>
+<CODE>&nbsp;long</CODE></FONT></TD>
+<TD><CODE><B><A HREF="../../../org/apache/droids/DefaultCrawler.html#startWorkers()">startWorkers</A></B>()</CODE>
 
 <BR>
-&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
+&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Will start a new worker.</TD>
 </TR>
-<TR BGCOLOR="white" CLASS="TableRowColor">
-<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
-<CODE>&nbsp;void</CODE></FONT></TD>
-<TD><CODE><B><A HREF="../../../org/apache/droids/DefaultCrawler.html#setUrl(java.lang.String)">setUrl</A></B>(<A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;url)</CODE>
-
-<BR>
-&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
+</TABLE>
+&nbsp;<A NAME="methods_inherited_from_class_org.apache.droids.AbstractDroid"><!-- --></A>
+<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
+<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
+<TH ALIGN="left"><B>Methods inherited from class org.apache.droids.<A HREF="../../../org/apache/droids/AbstractDroid.html" title="class in org.apache.droids">AbstractDroid</A></B></TH>
 </TR>
 <TR BGCOLOR="white" CLASS="TableRowColor">
-<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
-<CODE>protected &nbsp;void</CODE></FONT></TD>
-<TD><CODE><B><A HREF="../../../org/apache/droids/DefaultCrawler.html#shutdownAndAwaitTermination()">shutdownAndAwaitTermination</A></B>()</CODE>
-
-<BR>
-&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Shutdown all threads, close the pools and leave.</TD>
+<TD><CODE><A HREF="../../../org/apache/droids/AbstractDroid.html#finishedWorker(long)">finishedWorker</A>, <A HREF="../../../org/apache/droids/AbstractDroid.html#getCore()">getCore</A>, <A HREF="../../../org/apache/droids/AbstractDroid.html#getFreeSlots()">getFreeSlots</A>, <A HREF="../../../org/apache/droids/AbstractDroid.html#getMaxThreads()">getMaxThreads</A>, <A HREF="../../../org/apache/droids/AbstractDroid.html#getPool()">getPool</A>, <A HREF="../../../org/apache/droids/AbstractDroid.html#getQueue()">getQueue</A>, <A HREF="../../../org/apache/droids/AbstractDroid.html#getRunningThreads()">getRunningThreads</A>, <A HREF="../../../org/apache/droids/AbstractDroid.html#getRunningWorker()">getRunningWorker</A>, <A HREF="../../../org/apache/droids/AbstractDroid.html#getTaskDate()">getTaskDate</A>, <A HREF="../../../org/apache/droids/AbstractDroid.html#setCore(org.apache.droids.Core)">setCore</A>, <A HREF="../../../org/apache/droids/AbstractDroid.html#setFreeSlots(int)">setFr
 eeSlots</A>, <A HREF="../../../org/apache/droids/AbstractDroid.html#setMaxThreads(int)">setMaxThreads</A>, <A HREF="../../../org/apache/droids/AbstractDroid.html#setPool(java.util.concurrent.ThreadPoolExecutor)">setPool</A>, <A HREF="../../../org/apache/droids/AbstractDroid.html#setQueue(org.apache.droids.api.Queue)">setQueue</A>, <A HREF="../../../org/apache/droids/AbstractDroid.html#setRunningThreads(int)">setRunningThreads</A>, <A HREF="../../../org/apache/droids/AbstractDroid.html#setRunningWorker(java.util.concurrent.ConcurrentHashMap)">setRunningWorker</A>, <A HREF="../../../org/apache/droids/AbstractDroid.html#setTaskDate(java.lang.String)">setTaskDate</A>, <A HREF="../../../org/apache/droids/AbstractDroid.html#shutdownAndAwaitTermination()">shutdownAndAwaitTermination</A></CODE></TD>
 </TR>
 </TABLE>
 &nbsp;<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
@@ -309,55 +232,6 @@
 &nbsp;
 <P>
 
-<!-- ============ FIELD DETAIL =========== -->
-
-<A NAME="field_detail"><!-- --></A>
-<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
-<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
-<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
-<B>Field Detail</B></FONT></TH>
-</TR>
-</TABLE>
-
-<A NAME="queue"><!-- --></A><H3>
-queue</H3>
-<PRE>
-protected <A HREF="../../../org/apache/droids/api/Queue.html" title="interface in org.apache.droids.api">Queue</A> <B>queue</B></PRE>
-<DL>
-<DL>
-</DL>
-</DL>
-<HR>
-
-<A NAME="taskDate"><!-- --></A><H3>
-taskDate</H3>
-<PRE>
-protected <A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> <B>taskDate</B></PRE>
-<DL>
-<DL>
-</DL>
-</DL>
-<HR>
-
-<A NAME="freeSlots"><!-- --></A><H3>
-freeSlots</H3>
-<PRE>
-protected int <B>freeSlots</B></PRE>
-<DL>
-<DL>
-</DL>
-</DL>
-<HR>
-
-<A NAME="pool"><!-- --></A><H3>
-pool</H3>
-<PRE>
-protected <A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/util/concurrent.ThreadPoolExecutor.html" title="class or interface in java.util">java.util.concurrent.ThreadPoolExecutor</A> <B>pool</B></PRE>
-<DL>
-<DL>
-</DL>
-</DL>
-
 <!-- ========= CONSTRUCTOR DETAIL ======== -->
 
 <A NAME="constructor_detail"><!-- --></A>
@@ -394,137 +268,47 @@
  in the Droid and their workers)
 <P>
 <DD><DL>
-<DT><B>Specified by:</B><DD><CODE><A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/Runnable.html#run()" title="class or interface in java.lang">run</A></CODE> in interface <CODE><A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/Runnable.html" title="class or interface in java.lang">Runnable</A></CODE><DT><B>Specified by:</B><DD><CODE><A HREF="../../../org/apache/droids/api/Droid.html#run()">run</A></CODE> in interface <CODE><A HREF="../../../org/apache/droids/api/Droid.html" title="interface in org.apache.droids.api">Droid</A></CODE></DL>
-</DD>
-<DD><DL>
 </DL>
 </DD>
 </DL>
 <HR>
 
-<A NAME="initQueue()"><!-- --></A><H3>
-initQueue</H3>
+<A NAME="startWorkers()"><!-- --></A><H3>
+startWorkers</H3>
 <PRE>
-public void <B>initQueue</B>()</PRE>
+public long <B>startWorkers</B>()</PRE>
 <DL>
-<DD>Start the queue.
+<DD><B>Description copied from class: <CODE><A HREF="../../../org/apache/droids/AbstractDroid.html#startWorkers()">AbstractDroid</A></CODE></B></DD>
+<DD>Will start a new worker.
 <P>
 <DD><DL>
-<DT><B>Specified by:</B><DD><CODE><A HREF="../../../org/apache/droids/api/Droid.html#initQueue()">initQueue</A></CODE> in interface <CODE><A HREF="../../../org/apache/droids/api/Droid.html" title="interface in org.apache.droids.api">Droid</A></CODE></DL>
-</DD>
-<DD><DL>
-</DL>
-</DD>
-</DL>
-<HR>
-
-<A NAME="getWorker()"><!-- --></A><H3>
-getWorker</H3>
-<PRE>
-public <A HREF="../../../org/apache/droids/api/Worker.html" title="interface in org.apache.droids.api">Worker</A> <B>getWorker</B>()</PRE>
-<DL>
-<DD>Get the default worker for the class.
-<P>
-<DD><DL>
-</DL>
-</DD>
-<DD><DL>
-
-<DT><B>Returns:</B><DD></DL>
-</DD>
-</DL>
-<HR>
-
-<A NAME="setQueue(org.apache.droids.api.Queue)"><!-- --></A><H3>
-setQueue</H3>
-<PRE>
-public void <B>setQueue</B>(<A HREF="../../../org/apache/droids/api/Queue.html" title="interface in org.apache.droids.api">Queue</A>&nbsp;queue)</PRE>
-<DL>
-<DD><DL>
-<DT><B>Specified by:</B><DD><CODE><A HREF="../../../org/apache/droids/api/Droid.html#setQueue(org.apache.droids.api.Queue)">setQueue</A></CODE> in interface <CODE><A HREF="../../../org/apache/droids/api/Droid.html" title="interface in org.apache.droids.api">Droid</A></CODE></DL>
+<DT><B>Specified by:</B><DD><CODE><A HREF="../../../org/apache/droids/AbstractDroid.html#startWorkers()">startWorkers</A></CODE> in class <CODE><A HREF="../../../org/apache/droids/AbstractDroid.html" title="class in org.apache.droids">AbstractDroid</A></CODE></DL>
 </DD>
 <DD><DL>
-</DL>
-</DD>
-</DL>
-<HR>
 
-<A NAME="getQueue()"><!-- --></A><H3>
-getQueue</H3>
-<PRE>
-protected <A HREF="../../../org/apache/droids/api/Queue.html" title="interface in org.apache.droids.api">Queue</A> <B>getQueue</B>()</PRE>
-<DL>
-<DD><DL>
-</DL>
-</DD>
-<DD><DL>
-</DL>
+<DT><B>Returns:</B><DD>the id of the worker we just started.</DL>
 </DD>
 </DL>
 <HR>
 
-<A NAME="getRunningThreads()"><!-- --></A><H3>
-getRunningThreads</H3>
-<PRE>
-public int <B>getRunningThreads</B>()</PRE>
-<DL>
-<DD>Get number of currently running threads
-<P>
-<DD><DL>
-</DL>
-</DD>
-<DD><DL>
-</DL>
-</DD>
-</DL>
-<HR>
-
-<A NAME="setMaxThreads(int)"><!-- --></A><H3>
-setMaxThreads</H3>
-<PRE>
-public void <B>setMaxThreads</B>(int&nbsp;maxThreads)</PRE>
-<DL>
-<DD>Adjust number of allowed threads
-<P>
-<DD><DL>
-</DL>
-</DD>
-<DD><DL>
-</DL>
-</DD>
-</DL>
-<HR>
-
-<A NAME="getMaxThreads()"><!-- --></A><H3>
-getMaxThreads</H3>
+<A NAME="initQueue()"><!-- --></A><H3>
+initQueue</H3>
 <PRE>
-public int <B>getMaxThreads</B>()</PRE>
+public void <B>initQueue</B>()
+               throws <A HREF="../../../org/apache/droids/exception/DroidsException.html" title="class in org.apache.droids.exception">DroidsException</A></PRE>
 <DL>
-<DD>Get number of maximum allowed threads
+<DD><B>Description copied from interface: <CODE><A HREF="../../../org/apache/droids/api/Droid.html#initQueue()">Droid</A></CODE></B></DD>
+<DD>Initialize the queue. Can have different implementation but the main groups
+ normally are
+ <ol>
+ <li>add only one url, from which we then start crawling
+ <li>add an array of start urls and then crawl them
+ <li>add an array of urls as fixed subset (no further crawling done)
 <P>
 <DD><DL>
-</DL>
-</DD>
-<DD><DL>
-</DL>
-</DD>
-</DL>
-<HR>
 
-<A NAME="shutdownAndAwaitTermination()"><!-- --></A><H3>
-shutdownAndAwaitTermination</H3>
-<PRE>
-protected void <B>shutdownAndAwaitTermination</B>()</PRE>
-<DL>
-<DD>Shutdown all threads, close the pools and leave.
- If it is not working by asking nice to shutdown just kill all
- threads.
-<P>
-<DD><DL>
-</DL>
-</DD>
-<DD><DL>
-</DL>
+<DT><B>Throws:</B>
+<DD><CODE><A HREF="../../../org/apache/droids/exception/DroidsException.html" title="class in org.apache.droids.exception">DroidsException</A></CODE></DL>
 </DD>
 </DL>
 <HR>
@@ -534,11 +318,11 @@
 <PRE>
 public <A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> <B>getUrl</B>()</PRE>
 <DL>
+<DD>Return the initial url
+<P>
 <DD><DL>
-</DL>
-</DD>
-<DD><DL>
-</DL>
+
+<DT><B>Returns:</B><DD>the initial url</DL>
 </DD>
 </DL>
 <HR>
@@ -548,53 +332,59 @@
 <PRE>
 public void <B>setUrl</B>(<A HREF="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A>&nbsp;url)</PRE>
 <DL>
+<DD>Set the initial url
+<P>
 <DD><DL>
-</DL>
-</DD>
-<DD><DL>
-</DL>
+<DT><B>Parameters:</B><DD><CODE>url</CODE> - the initial url</DL>
 </DD>
 </DL>
 <HR>
 
-<A NAME="finishedWorker(long)"><!-- --></A><H3>
-finishedWorker</H3>
+<A NAME="getDelayTimer()"><!-- --></A><H3>
+getDelayTimer</H3>
 <PRE>
-public void <B>finishedWorker</B>(long&nbsp;id)</PRE>
+public <A HREF="../../../org/apache/droids/api/DelayTimer.html" title="interface in org.apache.droids.api">DelayTimer</A> <B>getDelayTimer</B>()</PRE>
 <DL>
+<DD>Get the DelayTimer implementation that we want to use.
+<P>
 <DD><DL>
-<DT><B>Specified by:</B><DD><CODE><A HREF="../../../org/apache/droids/api/Droid.html#finishedWorker(long)">finishedWorker</A></CODE> in interface <CODE><A HREF="../../../org/apache/droids/api/Droid.html" title="interface in org.apache.droids.api">Droid</A></CODE></DL>
-</DD>
-<DD><DL>
-</DL>
+
+<DT><B>Returns:</B><DD></DL>
 </DD>
 </DL>
 <HR>
 
-<A NAME="getCore()"><!-- --></A><H3>
-getCore</H3>
+<A NAME="setDelayTimer(org.apache.droids.api.DelayTimer)"><!-- --></A><H3>
+setDelayTimer</H3>
 <PRE>
-public <A HREF="../../../org/apache/droids/Core.html" title="class in org.apache.droids">Core</A> <B>getCore</B>()</PRE>
+public void <B>setDelayTimer</B>(<A HREF="../../../org/apache/droids/api/DelayTimer.html" title="interface in org.apache.droids.api">DelayTimer</A>&nbsp;delayTimer)
+                   throws <A HREF="../../../org/apache/droids/exception/DroidsException.html" title="class in org.apache.droids.exception">DroidsException</A></PRE>
 <DL>
 <DD><DL>
-<DT><B>Specified by:</B><DD><CODE><A HREF="../../../org/apache/droids/api/Droid.html#getCore()">getCore</A></CODE> in interface <CODE><A HREF="../../../org/apache/droids/api/Droid.html" title="interface in org.apache.droids.api">Droid</A></CODE></DL>
-</DD>
-<DD><DL>
-</DL>
+
+<DT><B>Throws:</B>
+<DD><CODE><A HREF="../../../org/apache/droids/exception/DroidsException.html" title="class in org.apache.droids.exception">DroidsException</A></CODE></DL>
 </DD>
 </DL>
 <HR>
 
-<A NAME="setCore(org.apache.droids.Core)"><!-- --></A><H3>
-setCore</H3>
+<A NAME="getWorker()"><!-- --></A><H3>
+getWorker</H3>
 <PRE>
-public void <B>setCore</B>(<A HREF="../../../org/apache/droids/Core.html" title="class in org.apache.droids">Core</A>&nbsp;core)</PRE>
+public <A HREF="../../../org/apache/droids/api/Worker.html" title="interface in org.apache.droids.api">Worker</A> <B>getWorker</B>()
+                 throws <A HREF="../../../org/apache/droids/exception/DroidsException.html" title="class in org.apache.droids.exception">DroidsException</A></PRE>
 <DL>
+<DD><B>Description copied from class: <CODE><A HREF="../../../org/apache/droids/AbstractDroid.html#getWorker()">AbstractDroid</A></CODE></B></DD>
+<DD>Get the default worker for the class.
+<P>
 <DD><DL>
-</DL>
+<DT><B>Specified by:</B><DD><CODE><A HREF="../../../org/apache/droids/AbstractDroid.html#getWorker()">getWorker</A></CODE> in class <CODE><A HREF="../../../org/apache/droids/AbstractDroid.html" title="class in org.apache.droids">AbstractDroid</A></CODE></DL>
 </DD>
 <DD><DL>
-</DL>
+
+<DT><B>Returns:</B><DD>Worker that should do the job.
+<DT><B>Throws:</B>
+<DD><CODE><A HREF="../../../org/apache/droids/exception/DroidsException.html" title="class in org.apache.droids.exception">DroidsException</A></CODE></DL>
 </DD>
 </DL>
 <!-- ========= END OF CLASS DATA ========= -->
@@ -649,15 +439,15 @@
 </TR>
 <TR>
 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
-  SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;<A HREF="#field_summary">FIELD</A>&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
+  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;<A HREF="#field_detail">FIELD</A>&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
+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; 2007 The Apache Software Foundation
+Copyright &copy; 2008 The Apache Software Foundation
 </BODY>
 </HTML>



---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@labs.apache.org
For additional commands, e-mail: commits-help@labs.apache.org