manifoldcf-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From kwri...@apache.org
Subject svn commit: r1345585 [17/33] - in /incubator/lcf/site/publish: ./ en_US/ ja_JP/ release/trunk/ release/trunk/api/activedirectory/ release/trunk/api/activedirectory/org/apache/manifoldcf/authorities/authorities/activedirectory/ release/trunk/api/alfresc...
Date Sat, 02 Jun 2012 21:25:39 GMT
Modified: incubator/lcf/site/publish/release/trunk/api/framework/org/apache/manifoldcf/crawler/interfaces/IJobManager.html
URL: http://svn.apache.org/viewvc/incubator/lcf/site/publish/release/trunk/api/framework/org/apache/manifoldcf/crawler/interfaces/IJobManager.html?rev=1345585&r1=1345584&r2=1345585&view=diff
==============================================================================
--- incubator/lcf/site/publish/release/trunk/api/framework/org/apache/manifoldcf/crawler/interfaces/IJobManager.html (original)
+++ incubator/lcf/site/publish/release/trunk/api/framework/org/apache/manifoldcf/crawler/interfaces/IJobManager.html Sat Jun  2 21:24:51 2012
@@ -2,7 +2,7 @@
 <!--NewPage-->
 <HTML>
 <HEAD>
-<!-- Generated by javadoc (build 1.6.0_21) on Sat Jun 02 16:08:02 EDT 2012 -->
+<!-- Generated by javadoc (build 1.6.0_21) on Sat Jun 02 16:56:34 EDT 2012 -->
 <TITLE>
 IJobManager
 </TITLE>
@@ -99,11 +99,11 @@ Interface IJobManager</H2>
 </PRE>
 
 <P>
-This manager deals with jobs.  Each job is associated with a repository connection, and has a number
- of scheduling options: starting every n hours/days/weeks/months, on specific dates, or "continuous" (which basically
- establishes a priority queue based on modification frequency).
- The job itself also specifies "seeds" (or starting points), which are the places that scanning begins.
- NOTE WELL: Every job is incremental.  This means that the job will check for deletions among all the documents
+This manager deals with jobs.  Each job is associated with a repository connection, and has a number
+ of scheduling options: starting every n hours/days/weeks/months, on specific dates, or "continuous" (which basically
+ establishes a priority queue based on modification frequency).
+ The job itself also specifies "seeds" (or starting points), which are the places that scanning begins.
+ NOTE WELL: Every job is incremental.  This means that the job will check for deletions among all the documents
  that it has scanned in the past, as part of the process of ingesting.
 <P>
 
@@ -481,7 +481,7 @@ This manager deals with jobs.  Each job 
                  java.util.ArrayList&nbsp;modifiedJobs)</CODE>
 
 <BR>
-&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Complete the sequence that resumes jobs, either from a pause or from a scheduling window
+&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Complete the sequence that resumes jobs, either from a pause or from a scheduling window
  wait.</TD>
 </TR>
 <TR BGCOLOR="white" CLASS="TableRowColor">
@@ -499,7 +499,7 @@ This manager deals with jobs.  Each job 
                java.util.ArrayList&nbsp;modifiedJobs)</CODE>
 
 <BR>
-&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Complete the sequence that stops jobs, either for abort, pause, or because of a scheduling
+&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Complete the sequence that stops jobs, either for abort, pause, or because of a scheduling
  window.</TD>
 </TR>
 <TR BGCOLOR="white" CLASS="TableRowColor">
@@ -1063,7 +1063,7 @@ This manager deals with jobs.  Each job 
 <TD><CODE><B><A HREF="../../../../../org/apache/manifoldcf/crawler/interfaces/IJobManager.html#resetNotifyJob(java.lang.Long)">resetNotifyJob</A></B>(java.lang.Long&nbsp;jobID)</CODE>
 
 <BR>
-&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Reset a job that is notifying back to "ready for notify"
+&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Reset a job that is notifying back to "ready for notify"
  state.</TD>
 </TR>
 <TR BGCOLOR="white" CLASS="TableRowColor">
@@ -1088,7 +1088,7 @@ This manager deals with jobs.  Each job 
 <TD><CODE><B><A HREF="../../../../../org/apache/manifoldcf/crawler/interfaces/IJobManager.html#resetStartDeleteJob(java.lang.Long)">resetStartDeleteJob</A></B>(java.lang.Long&nbsp;jobID)</CODE>
 
 <BR>
-&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Reset a job starting for delete back to "ready for delete"
+&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Reset a job starting for delete back to "ready for delete"
  state.</TD>
 </TR>
 <TR BGCOLOR="white" CLASS="TableRowColor">
@@ -1445,7 +1445,7 @@ void <B>deleteJob</B>(java.lang.Long&nbs
 <DD>Delete a job.
 <P>
 <DD><DL>
-<DT><B>Parameters:</B><DD><CODE>id</CODE> - is the job's identifier.  This method will purge all the records belonging to the job from the database, as
+<DT><B>Parameters:</B><DD><CODE>id</CODE> - is the job's identifier.  This method will purge all the records belonging to the job from the database, as
  well as remove all documents indexed by the job from the index.
 <DT><B>Throws:</B>
 <DD><CODE><A HREF="../../../../../org/apache/manifoldcf/core/interfaces/ManifoldCFException.html" title="class in org.apache.manifoldcf.core.interfaces">ManifoldCFException</A></CODE></DL>
@@ -1561,10 +1561,10 @@ prepareForStart</H3>
 void <B>prepareForStart</B>()
                      throws <A HREF="../../../../../org/apache/manifoldcf/core/interfaces/ManifoldCFException.html" title="class in org.apache.manifoldcf.core.interfaces">ManifoldCFException</A></PRE>
 <DL>
-<DD>Reset the job queue immediately before starting up.
- If the system was shut down in the middle of a job, sufficient information should
- be around in the database to allow it to restart.  However, BEFORE all the job threads
- are spun up, there needs to be a pass over the queue to bring things back to a "normal"
+<DD>Reset the job queue immediately before starting up.
+ If the system was shut down in the middle of a job, sufficient information should
+ be around in the database to allow it to restart.  However, BEFORE all the job threads
+ are spun up, there needs to be a pass over the queue to bring things back to a "normal"
  state.
 <P>
 <DD><DL>
@@ -1694,11 +1694,11 @@ getNextAlreadyProcessedReprioritizationD
                                                                        int&nbsp;n)
                                                                        throws <A HREF="../../../../../org/apache/manifoldcf/core/interfaces/ManifoldCFException.html" title="class in org.apache.manifoldcf.core.interfaces">ManifoldCFException</A></PRE>
 <DL>
-<DD>Get a list of already-processed documents to reprioritize.  Documents in all jobs will be
+<DD>Get a list of already-processed documents to reprioritize.  Documents in all jobs will be
  returned by this method.  Up to n document descriptions will be returned.
 <P>
 <DD><DL>
-<DT><B>Parameters:</B><DD><CODE>currentTime</CODE> - is the current time stamp for this prioritization pass.  Avoid
+<DT><B>Parameters:</B><DD><CODE>currentTime</CODE> - is the current time stamp for this prioritization pass.  Avoid
   picking up any documents that are labeled with this timestamp or after.<DD><CODE>n</CODE> - is the maximum number of document descriptions desired.
 <DT><B>Returns:</B><DD>the document descriptions.
 <DT><B>Throws:</B>
@@ -1714,11 +1714,11 @@ getNextNotYetProcessedReprioritizationDo
                                                                       int&nbsp;n)
                                                                       throws <A HREF="../../../../../org/apache/manifoldcf/core/interfaces/ManifoldCFException.html" title="class in org.apache.manifoldcf.core.interfaces">ManifoldCFException</A></PRE>
 <DL>
-<DD>Get a list of not-yet-processed documents to reprioritize.  Documents in all jobs will be
+<DD>Get a list of not-yet-processed documents to reprioritize.  Documents in all jobs will be
  returned by this method.  Up to n document descriptions will be returned.
 <P>
 <DD><DL>
-<DT><B>Parameters:</B><DD><CODE>currentTime</CODE> - is the current time stamp for this prioritization pass.  Avoid
+<DT><B>Parameters:</B><DD><CODE>currentTime</CODE> - is the current time stamp for this prioritization pass.  Avoid
   picking up any documents that are labeled with this timestamp or after.<DD><CODE>n</CODE> - is the maximum number of document descriptions desired.
 <DT><B>Returns:</B><DD>the document descriptions.
 <DT><B>Throws:</B>
@@ -1735,7 +1735,7 @@ void <B>writeDocumentPriorities</B>(long
                              double[]&nbsp;priorities)
                              throws <A HREF="../../../../../org/apache/manifoldcf/core/interfaces/ManifoldCFException.html" title="class in org.apache.manifoldcf.core.interfaces">ManifoldCFException</A></PRE>
 <DL>
-<DD>Save a set of document priorities.  In the case where a document was eligible to have its
+<DD>Save a set of document priorities.  In the case where a document was eligible to have its
  priority set, but it no longer is eligible, then the provided priority will not be written.
 <P>
 <DD><DL>
@@ -1753,9 +1753,9 @@ getExpiredDocuments</H3>
                                         long&nbsp;currentTime)
                                         throws <A HREF="../../../../../org/apache/manifoldcf/core/interfaces/ManifoldCFException.html" title="class in org.apache.manifoldcf.core.interfaces">ManifoldCFException</A></PRE>
 <DL>
-<DD>Get up to the next n documents to be expired.
- This method marks the documents whose descriptions have been returned as "being processed", or active.
- The same marking is used as is used for documents that have been queued for worker threads.  The model
+<DD>Get up to the next n documents to be expired.
+ This method marks the documents whose descriptions have been returned as "being processed", or active.
+ The same marking is used as is used for documents that have been queued for worker threads.  The model
  is thus identical.
 <P>
 <DD><DL>
@@ -1778,16 +1778,16 @@ getNextDocuments</H3>
                                        <A HREF="../../../../../org/apache/manifoldcf/crawler/interfaces/DepthStatistics.html" title="class in org.apache.manifoldcf.crawler.interfaces">DepthStatistics</A>&nbsp;scanRecord)
                                        throws <A HREF="../../../../../org/apache/manifoldcf/core/interfaces/ManifoldCFException.html" title="class in org.apache.manifoldcf.core.interfaces">ManifoldCFException</A></PRE>
 <DL>
-<DD>Get up to the next n document(s) to be fetched and processed.
- This fetch returns records that contain the document identifier, plus all instructions
- pertaining to the document's handling (e.g. whether it should be refetched if the version
- has not changed).
+<DD>Get up to the next n document(s) to be fetched and processed.
+ This fetch returns records that contain the document identifier, plus all instructions
+ pertaining to the document's handling (e.g. whether it should be refetched if the version
+ has not changed).
  This method also marks the documents whose descriptions have be returned as "being processed".
 <P>
 <DD><DL>
-<DT><B>Parameters:</B><DD><CODE>n</CODE> - is the number of documents desired.<DD><CODE>currentTime</CODE> - is the current time; some fetches do not occur until a specific time.<DD><CODE>interval</CODE> - is the number of milliseconds that this set of documents should represent (for throttling).<DD><CODE>blockingDocuments</CODE> - is the place to record documents that were encountered, are eligible for reprioritization,
-  but could not be queued due to throttling considerations.<DD><CODE>statistics</CODE> - are the current performance statistics per connection, which are used to balance the queue stuffing
-  so that individual connections are not overwhelmed.<DD><CODE>scanRecord</CODE> - retains the bins from all documents encountered from the query, even those that were skipped due
+<DT><B>Parameters:</B><DD><CODE>n</CODE> - is the number of documents desired.<DD><CODE>currentTime</CODE> - is the current time; some fetches do not occur until a specific time.<DD><CODE>interval</CODE> - is the number of milliseconds that this set of documents should represent (for throttling).<DD><CODE>blockingDocuments</CODE> - is the place to record documents that were encountered, are eligible for reprioritization,
+  but could not be queued due to throttling considerations.<DD><CODE>statistics</CODE> - are the current performance statistics per connection, which are used to balance the queue stuffing
+  so that individual connections are not overwhelmed.<DD><CODE>scanRecord</CODE> - retains the bins from all documents encountered from the query, even those that were skipped due
  to being overcommitted.
 <DT><B>Returns:</B><DD>the array of document descriptions to fetch and process.
 <DT><B>Throws:</B>
@@ -1802,7 +1802,7 @@ checkJobActive</H3>
 boolean <B>checkJobActive</B>(java.lang.Long&nbsp;jobID)
                        throws <A HREF="../../../../../org/apache/manifoldcf/core/interfaces/ManifoldCFException.html" title="class in org.apache.manifoldcf.core.interfaces">ManifoldCFException</A></PRE>
 <DL>
-<DD>Verify that a specific job is indeed still active.  This is used to permit abort or pause to be relatively speedy.
+<DD>Verify that a specific job is indeed still active.  This is used to permit abort or pause to be relatively speedy.
  The query done within MUST be cached in order to not cause undue performance degradation.
 <P>
 <DD><DL>
@@ -1836,7 +1836,7 @@ markDocumentCompletedMultiple</H3>
 void <B>markDocumentCompletedMultiple</B>(<A HREF="../../../../../org/apache/manifoldcf/crawler/interfaces/DocumentDescription.html" title="class in org.apache.manifoldcf.crawler.interfaces">DocumentDescription</A>[]&nbsp;documentDescriptions)
                                    throws <A HREF="../../../../../org/apache/manifoldcf/core/interfaces/ManifoldCFException.html" title="class in org.apache.manifoldcf.core.interfaces">ManifoldCFException</A></PRE>
 <DL>
-<DD>Note completion of document processing by a job thread of a document.
+<DD>Note completion of document processing by a job thread of a document.
  This method causes the state of the document to be marked as "completed".
 <P>
 <DD><DL>
@@ -1853,7 +1853,7 @@ markDocumentCompleted</H3>
 void <B>markDocumentCompleted</B>(<A HREF="../../../../../org/apache/manifoldcf/crawler/interfaces/DocumentDescription.html" title="class in org.apache.manifoldcf.crawler.interfaces">DocumentDescription</A>&nbsp;documentDescription)
                            throws <A HREF="../../../../../org/apache/manifoldcf/core/interfaces/ManifoldCFException.html" title="class in org.apache.manifoldcf.core.interfaces">ManifoldCFException</A></PRE>
 <DL>
-<DD>Note completion of document processing by a job thread of a document.
+<DD>Note completion of document processing by a job thread of a document.
  This method causes the state of the document to be marked as "completed".
 <P>
 <DD><DL>
@@ -1877,7 +1877,7 @@ markDocumentDeletedMultiple</H3>
 <P>
 <DD><DL>
 <DT><B>Parameters:</B><DD><CODE>documentDescriptions</CODE> - are the set of description objects for the documents that were processed.<DD><CODE>hopcountMethod</CODE> - is one of complete, partial, or nevercomplete.
-<DT><B>Returns:</B><DD>the set of documents for which carrydown data was changed by this operation.  These documents are likely
+<DT><B>Returns:</B><DD>the set of documents for which carrydown data was changed by this operation.  These documents are likely
   to be requeued as a result of the change.
 <DT><B>Throws:</B>
 <DD><CODE><A HREF="../../../../../org/apache/manifoldcf/core/interfaces/ManifoldCFException.html" title="class in org.apache.manifoldcf.core.interfaces">ManifoldCFException</A></CODE></DL>
@@ -1898,7 +1898,7 @@ markDocumentDeleted</H3>
 <P>
 <DD><DL>
 <DT><B>Parameters:</B><DD><CODE>documentDescription</CODE> - is the description object for the document that was processed.<DD><CODE>hopcountMethod</CODE> - is one of complete, partial, or nevercomplete.
-<DT><B>Returns:</B><DD>the set of documents for which carrydown data was changed by this operation.  These documents are likely
+<DT><B>Returns:</B><DD>the set of documents for which carrydown data was changed by this operation.  These documents are likely
   to be requeued as a result of the change.
 <DT><B>Throws:</B>
 <DD><CODE><A HREF="../../../../../org/apache/manifoldcf/core/interfaces/ManifoldCFException.html" title="class in org.apache.manifoldcf.core.interfaces">ManifoldCFException</A></CODE></DL>
@@ -1914,8 +1914,8 @@ boolean[] <B>carrydownChangeDocumentMult
                                           double[]&nbsp;docPriorities)
                                           throws <A HREF="../../../../../org/apache/manifoldcf/core/interfaces/ManifoldCFException.html" title="class in org.apache.manifoldcf.core.interfaces">ManifoldCFException</A></PRE>
 <DL>
-<DD>Requeue a document set because of carrydown changes.
- This method is called when carrydown data is modified for a set of documents.  The documents must be requeued for immediate reprocessing, even to the
+<DD>Requeue a document set because of carrydown changes.
+ This method is called when carrydown data is modified for a set of documents.  The documents must be requeued for immediate reprocessing, even to the
  extent that if one is *already* being processed, it will need to be done over again.
 <P>
 <DD><DL>
@@ -1935,8 +1935,8 @@ boolean <B>carrydownChangeDocument</B>(<
                                 double&nbsp;docPriority)
                                 throws <A HREF="../../../../../org/apache/manifoldcf/core/interfaces/ManifoldCFException.html" title="class in org.apache.manifoldcf.core.interfaces">ManifoldCFException</A></PRE>
 <DL>
-<DD>Requeue a document because of carrydown changes.
- This method is called when carrydown data is modified for a document.  The document must be requeued for immediate reprocessing, even to the
+<DD>Requeue a document because of carrydown changes.
+ This method is called when carrydown data is modified for a document.  The document must be requeued for immediate reprocessing, even to the
  extent that if it is *already* being processed, it will need to be done over again.
 <P>
 <DD><DL>
@@ -1956,9 +1956,9 @@ void <B>requeueDocumentMultiple</B>(<A H
                              int[]&nbsp;actions)
                              throws <A HREF="../../../../../org/apache/manifoldcf/core/interfaces/ManifoldCFException.html" title="class in org.apache.manifoldcf.core.interfaces">ManifoldCFException</A></PRE>
 <DL>
-<DD>Requeue a document for further processing in the future.
- This method is called after a document is processed, when the job is a "continuous" one.
- It is essentially equivalent to noting that the document processing is complete, except the
+<DD>Requeue a document for further processing in the future.
+ This method is called after a document is processed, when the job is a "continuous" one.
+ It is essentially equivalent to noting that the document processing is complete, except the
  document remains on the queue.
 <P>
 <DD><DL>
@@ -1977,9 +1977,9 @@ void <B>requeueDocument</B>(<A HREF="../
                      int&nbsp;action)
                      throws <A HREF="../../../../../org/apache/manifoldcf/core/interfaces/ManifoldCFException.html" title="class in org.apache.manifoldcf.core.interfaces">ManifoldCFException</A></PRE>
 <DL>
-<DD>Requeue a document for further processing in the future.
- This method is called after a document is processed, when the job is a "continuous" one.
- It is essentially equivalent to noting that the document processing is complete, except the
+<DD>Requeue a document for further processing in the future.
+ This method is called after a document is processed, when the job is a "continuous" one.
+ It is essentially equivalent to noting that the document processing is complete, except the
  document remains on the queue.
 <P>
 <DD><DL>
@@ -2000,8 +2000,8 @@ void <B>resetDocumentMultiple</B>(<A HRE
                            int&nbsp;failCount)
                            throws <A HREF="../../../../../org/apache/manifoldcf/core/interfaces/ManifoldCFException.html" title="class in org.apache.manifoldcf.core.interfaces">ManifoldCFException</A></PRE>
 <DL>
-<DD>Reset documents for further processing in the future.
- This method is called after a service interruption is thrown.
+<DD>Reset documents for further processing in the future.
+ This method is called after a service interruption is thrown.
  It is essentially equivalent to resetting the time for documents to be reprocessed.
 <P>
 <DD><DL>
@@ -2022,11 +2022,11 @@ void <B>resetDocument</B>(<A HREF="../..
                    int&nbsp;failCount)
                    throws <A HREF="../../../../../org/apache/manifoldcf/core/interfaces/ManifoldCFException.html" title="class in org.apache.manifoldcf.core.interfaces">ManifoldCFException</A></PRE>
 <DL>
-<DD>Reset an active document back to its former state.
+<DD>Reset an active document back to its former state.
  This gets done when there's a service interruption and the document cannot be processed yet.
 <P>
 <DD><DL>
-<DT><B>Parameters:</B><DD><CODE>documentDescription</CODE> - is the description object for the document that was processed.<DD><CODE>executeTime</CODE> - is the time that the document should be rescanned.<DD><CODE>failTime</CODE> - is the time that the document should be considered to have failed, if it has not been
+<DT><B>Parameters:</B><DD><CODE>documentDescription</CODE> - is the description object for the document that was processed.<DD><CODE>executeTime</CODE> - is the time that the document should be rescanned.<DD><CODE>failTime</CODE> - is the time that the document should be considered to have failed, if it has not been
  successfully read until then.<DD><CODE>failCount</CODE> - is the number of permitted failures before a hard error is signalled.
 <DT><B>Throws:</B>
 <DD><CODE><A HREF="../../../../../org/apache/manifoldcf/core/interfaces/ManifoldCFException.html" title="class in org.apache.manifoldcf.core.interfaces">ManifoldCFException</A></CODE></DL>
@@ -2041,11 +2041,11 @@ void <B>resetDeletingDocumentMultiple</B
                                    long&nbsp;checkTime)
                                    throws <A HREF="../../../../../org/apache/manifoldcf/core/interfaces/ManifoldCFException.html" title="class in org.apache.manifoldcf.core.interfaces">ManifoldCFException</A></PRE>
 <DL>
-<DD>Reset a set of deleting documents for further processing in the future.
- This method is called after some unknown number of the documents were deleted, but then an ingestion service interruption occurred.
- Note well: The logic here basically presumes that we cannot know whether the documents were indeed processed or not.
- If we knew for a fact that none of the documents had been handled, it would be possible to look at the document's
- current status and decide what the new status ought to be, based on a true rollback scenario.  Such cases, however, are rare enough so that
+<DD>Reset a set of deleting documents for further processing in the future.
+ This method is called after some unknown number of the documents were deleted, but then an ingestion service interruption occurred.
+ Note well: The logic here basically presumes that we cannot know whether the documents were indeed processed or not.
+ If we knew for a fact that none of the documents had been handled, it would be possible to look at the document's
+ current status and decide what the new status ought to be, based on a true rollback scenario.  Such cases, however, are rare enough so that
  special logic is probably not worth it.
 <P>
 <DD><DL>
@@ -2063,7 +2063,7 @@ void <B>resetDeletingDocument</B>(<A HRE
                            long&nbsp;checkTime)
                            throws <A HREF="../../../../../org/apache/manifoldcf/core/interfaces/ManifoldCFException.html" title="class in org.apache.manifoldcf.core.interfaces">ManifoldCFException</A></PRE>
 <DL>
-<DD>Reset a deleting document back to its former state.
+<DD>Reset a deleting document back to its former state.
  This gets done when a deleting thread sees a service interruption, etc., from the ingestion system.
 <P>
 <DD><DL>
@@ -2081,7 +2081,7 @@ void <B>resetCleaningDocument</B>(<A HRE
                            long&nbsp;checkTime)
                            throws <A HREF="../../../../../org/apache/manifoldcf/core/interfaces/ManifoldCFException.html" title="class in org.apache.manifoldcf.core.interfaces">ManifoldCFException</A></PRE>
 <DL>
-<DD>Reset a cleaning document back to its former state.
+<DD>Reset a cleaning document back to its former state.
  This gets done when a cleaning thread sees a service interruption, etc., from the ingestion system.
 <P>
 <DD><DL>
@@ -2099,11 +2099,11 @@ void <B>resetCleaningDocumentMultiple</B
                                    long&nbsp;checkTime)
                                    throws <A HREF="../../../../../org/apache/manifoldcf/core/interfaces/ManifoldCFException.html" title="class in org.apache.manifoldcf.core.interfaces">ManifoldCFException</A></PRE>
 <DL>
-<DD>Reset a set of cleaning documents for further processing in the future.
- This method is called after some unknown number of the documents were cleaned, but then an ingestion service interruption occurred.
- Note well: The logic here basically presumes that we cannot know whether the documents were indeed cleaned or not.
- If we knew for a fact that none of the documents had been handled, it would be possible to look at the document's
- current status and decide what the new status ought to be, based on a true rollback scenario.  Such cases, however, are rare enough so that
+<DD>Reset a set of cleaning documents for further processing in the future.
+ This method is called after some unknown number of the documents were cleaned, but then an ingestion service interruption occurred.
+ Note well: The logic here basically presumes that we cannot know whether the documents were indeed cleaned or not.
+ If we knew for a fact that none of the documents had been handled, it would be possible to look at the document's
+ current status and decide what the new status ought to be, based on a true rollback scenario.  Such cases, however, are rare enough so that
  special logic is probably not worth it.
 <P>
 <DD><DL>
@@ -2128,9 +2128,9 @@ boolean[] <B>addDocumentsInitial</B>(jav
                               java.lang.String[][]&nbsp;prereqEventNames)
                               throws <A HREF="../../../../../org/apache/manifoldcf/core/interfaces/ManifoldCFException.html" title="class in org.apache.manifoldcf.core.interfaces">ManifoldCFException</A></PRE>
 <DL>
-<DD>Add an initial set of documents to the queue.
- This method is called during job startup, when the queue is being loaded.
- A set of document references is passed to this method, which updates the status of the document
+<DD>Add an initial set of documents to the queue.
+ This method is called during job startup, when the queue is being loaded.
+ A set of document references is passed to this method, which updates the status of the document
  in the specified job's queue, according to specific state rules.
 <P>
 <DD><DL>
@@ -2151,9 +2151,9 @@ void <B>addRemainingDocumentsInitial</B>
                                   int&nbsp;hopcountMethod)
                                   throws <A HREF="../../../../../org/apache/manifoldcf/core/interfaces/ManifoldCFException.html" title="class in org.apache.manifoldcf.core.interfaces">ManifoldCFException</A></PRE>
 <DL>
-<DD>Add an initial set of remaining documents to the queue.
- This method is called during job startup, when the queue is being loaded, to list documents that
- were NOT included by calling addDocumentsInitial().  Documents listed here are simply designed to
+<DD>Add an initial set of remaining documents to the queue.
+ This method is called during job startup, when the queue is being loaded, to list documents that
+ were NOT included by calling addDocumentsInitial().  Documents listed here are simply designed to
  enable the framework to get rid of old, invalid seeds.  They are not queued for processing.
 <P>
 <DD><DL>
@@ -2173,12 +2173,12 @@ void <B>doneDocumentsInitial</B>(java.la
                           int&nbsp;hopcountMethod)
                           throws <A HREF="../../../../../org/apache/manifoldcf/core/interfaces/ManifoldCFException.html" title="class in org.apache.manifoldcf.core.interfaces">ManifoldCFException</A></PRE>
 <DL>
-<DD>Signal that a seeding pass has been done.
- Call this method at the end of a seeding pass.  It is used to perform the bookkeeping necessary to
+<DD>Signal that a seeding pass has been done.
+ Call this method at the end of a seeding pass.  It is used to perform the bookkeeping necessary to
  maintain the hopcount table.
 <P>
 <DD><DL>
-<DT><B>Parameters:</B><DD><CODE>jobID</CODE> - is the job identifier.<DD><CODE>legalLinkTypes</CODE> - is the set of legal link types that this connector generates.<DD><CODE>isPartial</CODE> - is set if the seeds provided are only a partial list.  Some connectors cannot
+<DT><B>Parameters:</B><DD><CODE>jobID</CODE> - is the job identifier.<DD><CODE>legalLinkTypes</CODE> - is the set of legal link types that this connector generates.<DD><CODE>isPartial</CODE> - is set if the seeds provided are only a partial list.  Some connectors cannot
        supply a full list of seeds on every seeding iteration; this acknowledges that limitation.<DD><CODE>hopcountMethod</CODE> - describes how to handle deletions for hopcount purposes.
 <DT><B>Throws:</B>
 <DD><CODE><A HREF="../../../../../org/apache/manifoldcf/core/interfaces/ManifoldCFException.html" title="class in org.apache.manifoldcf.core.interfaces">ManifoldCFException</A></CODE></DL>
@@ -2234,7 +2234,7 @@ boolean[] <B>findHopCounts</B>(java.lang
 <P>
 <DD><DL>
 <DT><B>Parameters:</B><DD><CODE>jobID</CODE> - is the job identifier.<DD><CODE>legalLinkTypes</CODE> - is the set of legal link types that this connector generates.<DD><CODE>docIDHashes</CODE> - is the set of document hashes to find the hopcount for.<DD><CODE>linkType</CODE> - is the kind of link to find the hopcount for.<DD><CODE>limit</CODE> - is the limit, beyond which a negative distance may be returned.<DD><CODE>hopcountMethod</CODE> - describes how to handle deletions for hopcount purposes.
-<DT><B>Returns:</B><DD>a vector of booleans corresponding to the documents requested.  A true value is returned
+<DT><B>Returns:</B><DD>a vector of booleans corresponding to the documents requested.  A true value is returned
  if the document is within the specified limit, false otherwise.
 <DT><B>Throws:</B>
 <DD><CODE><A HREF="../../../../../org/apache/manifoldcf/core/interfaces/ManifoldCFException.html" title="class in org.apache.manifoldcf.core.interfaces">ManifoldCFException</A></CODE></DL>
@@ -2248,7 +2248,7 @@ getAllSeeds</H3>
 java.lang.String[] <B>getAllSeeds</B>(java.lang.Long&nbsp;jobID)
                                throws <A HREF="../../../../../org/apache/manifoldcf/core/interfaces/ManifoldCFException.html" title="class in org.apache.manifoldcf.core.interfaces">ManifoldCFException</A></PRE>
 <DL>
-<DD>Get all the current seeds.
+<DD>Get all the current seeds.
  Returns the seed document identifiers for a job.
 <P>
 <DD><DL>
@@ -2277,14 +2277,14 @@ boolean <B>addDocument</B>(java.lang.Lon
                     java.lang.String[]&nbsp;prereqEventNames)
                     throws <A HREF="../../../../../org/apache/manifoldcf/core/interfaces/ManifoldCFException.html" title="class in org.apache.manifoldcf.core.interfaces">ManifoldCFException</A></PRE>
 <DL>
-<DD>Add a document to the queue.
- This method is called during document processing, when a document reference is discovered.
- The document reference is passed to this method, which updates the status of the document
+<DD>Add a document to the queue.
+ This method is called during document processing, when a document reference is discovered.
+ The document reference is passed to this method, which updates the status of the document
  in the specified job's queue, according to specific state rules.
 <P>
 <DD><DL>
-<DT><B>Parameters:</B><DD><CODE>jobID</CODE> - is the job identifier.<DD><CODE>legalLinkTypes</CODE> - is the set of legal link types that this connector generates.<DD><CODE>docIDHash</CODE> - is the local document identifier hash value.<DD><CODE>parentIdentifierHash</CODE> - is the optional parent identifier hash value for this document.  Pass null if none.<DD><CODE>relationshipType</CODE> - is the optional link type between this document and its parent.  Pass null if there
-       is no relationship with a parent.<DD><CODE>hopcountMethod</CODE> - is either accurate, nodelete, or neverdelete.<DD><CODE>dataNames</CODE> - are the names of the data to carry down to the child from this parent.<DD><CODE>dataValues</CODE> - are the values to carry down to the child from this parent, corresponding to dataNames above.  If CharacterInput objects are passed in here,
+<DT><B>Parameters:</B><DD><CODE>jobID</CODE> - is the job identifier.<DD><CODE>legalLinkTypes</CODE> - is the set of legal link types that this connector generates.<DD><CODE>docIDHash</CODE> - is the local document identifier hash value.<DD><CODE>parentIdentifierHash</CODE> - is the optional parent identifier hash value for this document.  Pass null if none.<DD><CODE>relationshipType</CODE> - is the optional link type between this document and its parent.  Pass null if there
+       is no relationship with a parent.<DD><CODE>hopcountMethod</CODE> - is either accurate, nodelete, or neverdelete.<DD><CODE>dataNames</CODE> - are the names of the data to carry down to the child from this parent.<DD><CODE>dataValues</CODE> - are the values to carry down to the child from this parent, corresponding to dataNames above.  If CharacterInput objects are passed in here,
        it is the caller's responsibility to clean these up.<DD><CODE>currentTime</CODE> - is the time in milliseconds since epoch that will be recorded for this operation.<DD><CODE>priority</CODE> - is the desired document priority for the document.<DD><CODE>prereqEventNames</CODE> - are the events that must be completed before the document can be processed.
 <DT><B>Returns:</B><DD>true if the priority value was used, false otherwise.
 <DT><B>Throws:</B>
@@ -2310,14 +2310,14 @@ boolean[] <B>addDocuments</B>(java.lang.
                        java.lang.String[][]&nbsp;prereqEventNames)
                        throws <A HREF="../../../../../org/apache/manifoldcf/core/interfaces/ManifoldCFException.html" title="class in org.apache.manifoldcf.core.interfaces">ManifoldCFException</A></PRE>
 <DL>
-<DD>Add documents to the queue in bulk.
- This method is called during document processing, when a set of document references are discovered.
- The document references are passed to this method, which updates the status of the document(s)
+<DD>Add documents to the queue in bulk.
+ This method is called during document processing, when a set of document references are discovered.
+ The document references are passed to this method, which updates the status of the document(s)
  in the specified job's queue, according to specific state rules.
 <P>
 <DD><DL>
-<DT><B>Parameters:</B><DD><CODE>jobID</CODE> - is the job identifier.<DD><CODE>legalLinkTypes</CODE> - is the set of legal link types that this connector generates.<DD><CODE>docIDHashes</CODE> - are the hashes of the local document identifiers.<DD><CODE>docIDs</CODE> - are the local document identifiers.<DD><CODE>parentIdentifierHash</CODE> - is the optional parent identifier hash of these documents.  Pass null if none.<DD><CODE>relationshipType</CODE> - is the optional link type between this document and its parent.  Pass null if there
-       is no relationship with a parent.<DD><CODE>hopcountMethod</CODE> - is either accurate, nodelete, or neverdelete.<DD><CODE>dataNames</CODE> - are the names of the data to carry down to the child from this parent.<DD><CODE>dataValues</CODE> - are the values to carry down to the child from this parent, corresponding to dataNames above.  If CharacterInput objects are passed in here,
+<DT><B>Parameters:</B><DD><CODE>jobID</CODE> - is the job identifier.<DD><CODE>legalLinkTypes</CODE> - is the set of legal link types that this connector generates.<DD><CODE>docIDHashes</CODE> - are the hashes of the local document identifiers.<DD><CODE>docIDs</CODE> - are the local document identifiers.<DD><CODE>parentIdentifierHash</CODE> - is the optional parent identifier hash of these documents.  Pass null if none.<DD><CODE>relationshipType</CODE> - is the optional link type between this document and its parent.  Pass null if there
+       is no relationship with a parent.<DD><CODE>hopcountMethod</CODE> - is either accurate, nodelete, or neverdelete.<DD><CODE>dataNames</CODE> - are the names of the data to carry down to the child from this parent.<DD><CODE>dataValues</CODE> - are the values to carry down to the child from this parent, corresponding to dataNames above.  If CharacterInput objects are passed in here,
        it is the caller's responsibility to clean these up.<DD><CODE>currentTime</CODE> - is the time in milliseconds since epoch that will be recorded for this operation.<DD><CODE>priorities</CODE> - are the desired document priorities for the documents.<DD><CODE>prereqEventNames</CODE> - are the events that must be completed before each document can be processed.
 <DT><B>Returns:</B><DD>an array of boolean values indicating whether or not the passed-in priority value was used or not for each doc id (true if used).
 <DT><B>Throws:</B>
@@ -2335,12 +2335,12 @@ finishDocuments</H3>
                                       int&nbsp;hopcountMethod)
                                       throws <A HREF="../../../../../org/apache/manifoldcf/core/interfaces/ManifoldCFException.html" title="class in org.apache.manifoldcf.core.interfaces">ManifoldCFException</A></PRE>
 <DL>
-<DD>Complete adding child documents to the queue, for a set of documents.
+<DD>Complete adding child documents to the queue, for a set of documents.
  This method is called at the end of document processing, to help the hopcount tracking engine do its bookkeeping.
 <P>
 <DD><DL>
 <DT><B>Parameters:</B><DD><CODE>jobID</CODE> - is the job identifier.<DD><CODE>legalLinkTypes</CODE> - is the set of legal link types that this connector generates.<DD><CODE>parentIdentifierHashes</CODE> - are the hashes of the document identifiers for whom child link extraction just took place.<DD><CODE>hopcountMethod</CODE> - describes how to handle deletions for hopcount purposes.
-<DT><B>Returns:</B><DD>the set of documents for which carrydown data was changed by this operation.  These documents are likely
+<DT><B>Returns:</B><DD>the set of documents for which carrydown data was changed by this operation.  These documents are likely
   to be requeued as a result of the change.
 <DT><B>Throws:</B>
 <DD><CODE><A HREF="../../../../../org/apache/manifoldcf/core/interfaces/ManifoldCFException.html" title="class in org.apache.manifoldcf.core.interfaces">ManifoldCFException</A></CODE></DL>
@@ -2392,8 +2392,8 @@ manualStart</H3>
 void <B>manualStart</B>(java.lang.Long&nbsp;jobID)
                  throws <A HREF="../../../../../org/apache/manifoldcf/core/interfaces/ManifoldCFException.html" title="class in org.apache.manifoldcf.core.interfaces">ManifoldCFException</A></PRE>
 <DL>
-<DD>Manually start a job.  The specified job will be run REGARDLESS of the timed windows, and
- will not cease until complete.  If the job is already running, this operation will assure that
+<DD>Manually start a job.  The specified job will be run REGARDLESS of the timed windows, and
+ will not cease until complete.  If the job is already running, this operation will assure that
  the job does not pause when its window ends.  The job can be manually paused, or manually aborted.
 <P>
 <DD><DL>
@@ -2410,7 +2410,7 @@ manualAbort</H3>
 void <B>manualAbort</B>(java.lang.Long&nbsp;jobID)
                  throws <A HREF="../../../../../org/apache/manifoldcf/core/interfaces/ManifoldCFException.html" title="class in org.apache.manifoldcf.core.interfaces">ManifoldCFException</A></PRE>
 <DL>
-<DD>Manually abort a running job.  The job will be permanently stopped, and will not run again until
+<DD>Manually abort a running job.  The job will be permanently stopped, and will not run again until
  automatically started based on schedule, or manually started.
 <P>
 <DD><DL>
@@ -2427,7 +2427,7 @@ manualAbortRestart</H3>
 void <B>manualAbortRestart</B>(java.lang.Long&nbsp;jobID)
                         throws <A HREF="../../../../../org/apache/manifoldcf/core/interfaces/ManifoldCFException.html" title="class in org.apache.manifoldcf.core.interfaces">ManifoldCFException</A></PRE>
 <DL>
-<DD>Manually restart a running job.  The job will be stopped and restarted.  Any schedule affinity will be lost,
+<DD>Manually restart a running job.  The job will be stopped and restarted.  Any schedule affinity will be lost,
  until the job finishes on its own.
 <P>
 <DD><DL>
@@ -2476,7 +2476,7 @@ resetJobSchedule</H3>
 void <B>resetJobSchedule</B>(java.lang.Long&nbsp;jobID)
                       throws <A HREF="../../../../../org/apache/manifoldcf/core/interfaces/ManifoldCFException.html" title="class in org.apache.manifoldcf.core.interfaces">ManifoldCFException</A></PRE>
 <DL>
-<DD>Reset job schedule.  This re-evaluates whether the job should be started now.  This method would typically
+<DD>Reset job schedule.  This re-evaluates whether the job should be started now.  This method would typically
  be called after a job's scheduling window has been changed.
 <P>
 <DD><DL>
@@ -2494,8 +2494,8 @@ void <B>startJobs</B>(long&nbsp;currentT
                java.util.ArrayList&nbsp;unwaitList)
                throws <A HREF="../../../../../org/apache/manifoldcf/core/interfaces/ManifoldCFException.html" title="class in org.apache.manifoldcf.core.interfaces">ManifoldCFException</A></PRE>
 <DL>
-<DD>Start jobs based on schedule.
- This method marks all the appropriate jobs as "in progress", which is all that should be
+<DD>Start jobs based on schedule.
+ This method marks all the appropriate jobs as "in progress", which is all that should be
  needed to start them.
 <P>
 <DD><DL>
@@ -2533,7 +2533,7 @@ getJobsReadyForSeeding</H3>
 <P>
 <DD><DL>
 <DT><B>Parameters:</B><DD><CODE>currentTime</CODE> - is the current time in milliseconds since epoch.
-<DT><B>Returns:</B><DD>jobs that are active and are running in adaptive mode.  These will be seeded
+<DT><B>Returns:</B><DD>jobs that are active and are running in adaptive mode.  These will be seeded
  based on what the connector says should be added to the queue.
 <DT><B>Throws:</B>
 <DD><CODE><A HREF="../../../../../org/apache/manifoldcf/core/interfaces/ManifoldCFException.html" title="class in org.apache.manifoldcf.core.interfaces">ManifoldCFException</A></CODE></DL>
@@ -2630,7 +2630,7 @@ resetStartDeleteJob</H3>
 void <B>resetStartDeleteJob</B>(java.lang.Long&nbsp;jobID)
                          throws <A HREF="../../../../../org/apache/manifoldcf/core/interfaces/ManifoldCFException.html" title="class in org.apache.manifoldcf.core.interfaces">ManifoldCFException</A></PRE>
 <DL>
-<DD>Reset a job starting for delete back to "ready for delete"
+<DD>Reset a job starting for delete back to "ready for delete"
  state.
 <P>
 <DD><DL>
@@ -2647,7 +2647,7 @@ resetNotifyJob</H3>
 void <B>resetNotifyJob</B>(java.lang.Long&nbsp;jobID)
                     throws <A HREF="../../../../../org/apache/manifoldcf/core/interfaces/ManifoldCFException.html" title="class in org.apache.manifoldcf.core.interfaces">ManifoldCFException</A></PRE>
 <DL>
-<DD>Reset a job that is notifying back to "ready for notify"
+<DD>Reset a job that is notifying back to "ready for notify"
  state.
 <P>
 <DD><DL>
@@ -2783,8 +2783,8 @@ noteConnectorDeregistration</H3>
 void <B>noteConnectorDeregistration</B>(java.lang.String[]&nbsp;connectionNames)
                                  throws <A HREF="../../../../../org/apache/manifoldcf/core/interfaces/ManifoldCFException.html" title="class in org.apache.manifoldcf.core.interfaces">ManifoldCFException</A></PRE>
 <DL>
-<DD>Note the deregistration of a connector used by the specified connections.
- This method will be called when the connector is deregistered.  Jobs that use these connections
+<DD>Note the deregistration of a connector used by the specified connections.
+ This method will be called when the connector is deregistered.  Jobs that use these connections
   must therefore enter appropriate states.
 <P>
 <DD><DL>
@@ -2801,8 +2801,8 @@ noteConnectorRegistration</H3>
 void <B>noteConnectorRegistration</B>(java.lang.String[]&nbsp;connectionNames)
                                throws <A HREF="../../../../../org/apache/manifoldcf/core/interfaces/ManifoldCFException.html" title="class in org.apache.manifoldcf.core.interfaces">ManifoldCFException</A></PRE>
 <DL>
-<DD>Note the registration of a connector used by the specified connections.
- This method will be called when a connector is registered, on which the specified
+<DD>Note the registration of a connector used by the specified connections.
+ This method will be called when a connector is registered, on which the specified
  connections depend.
 <P>
 <DD><DL>
@@ -2819,8 +2819,8 @@ noteConnectionChange</H3>
 void <B>noteConnectionChange</B>(java.lang.String&nbsp;connectionName)
                           throws <A HREF="../../../../../org/apache/manifoldcf/core/interfaces/ManifoldCFException.html" title="class in org.apache.manifoldcf.core.interfaces">ManifoldCFException</A></PRE>
 <DL>
-<DD>Note a change in connection configuration.
- This method will be called whenever a connection's configuration is modified, or when an external repository change
+<DD>Note a change in connection configuration.
+ This method will be called whenever a connection's configuration is modified, or when an external repository change
  is signalled.
 <P>
 <DD><DL>
@@ -2837,8 +2837,8 @@ noteOutputConnectorDeregistration</H3>
 void <B>noteOutputConnectorDeregistration</B>(java.lang.String[]&nbsp;connectionNames)
                                        throws <A HREF="../../../../../org/apache/manifoldcf/core/interfaces/ManifoldCFException.html" title="class in org.apache.manifoldcf.core.interfaces">ManifoldCFException</A></PRE>
 <DL>
-<DD>Note the deregistration of an output connector used by the specified connections.
- This method will be called when the connector is deregistered.  Jobs that use these connections
+<DD>Note the deregistration of an output connector used by the specified connections.
+ This method will be called when the connector is deregistered.  Jobs that use these connections
   must therefore enter appropriate states.
 <P>
 <DD><DL>
@@ -2855,8 +2855,8 @@ noteOutputConnectorRegistration</H3>
 void <B>noteOutputConnectorRegistration</B>(java.lang.String[]&nbsp;connectionNames)
                                      throws <A HREF="../../../../../org/apache/manifoldcf/core/interfaces/ManifoldCFException.html" title="class in org.apache.manifoldcf.core.interfaces">ManifoldCFException</A></PRE>
 <DL>
-<DD>Note the registration of an output connector used by the specified connections.
- This method will be called when a connector is registered, on which the specified
+<DD>Note the registration of an output connector used by the specified connections.
+ This method will be called when a connector is registered, on which the specified
  connections depend.
 <P>
 <DD><DL>
@@ -2873,8 +2873,8 @@ noteOutputConnectionChange</H3>
 void <B>noteOutputConnectionChange</B>(java.lang.String&nbsp;connectionName)
                                 throws <A HREF="../../../../../org/apache/manifoldcf/core/interfaces/ManifoldCFException.html" title="class in org.apache.manifoldcf.core.interfaces">ManifoldCFException</A></PRE>
 <DL>
-<DD>Note a change in output connection configuration.
- This method will be called whenever a connection's configuration is modified, or when an external output target change
+<DD>Note a change in output connection configuration.
+ This method will be called whenever a connection's configuration is modified, or when an external output target change
  is signalled.
 <P>
 <DD><DL>
@@ -2891,7 +2891,7 @@ deleteJobsReadyForDelete</H3>
 void <B>deleteJobsReadyForDelete</B>()
                               throws <A HREF="../../../../../org/apache/manifoldcf/core/interfaces/ManifoldCFException.html" title="class in org.apache.manifoldcf.core.interfaces">ManifoldCFException</A></PRE>
 <DL>
-<DD>Delete jobs in need of being deleted (which are marked "ready for delete").
+<DD>Delete jobs in need of being deleted (which are marked "ready for delete").
  This method is meant to be called periodically to perform delete processing on jobs.
 <P>
 <DD><DL>
@@ -2909,7 +2909,7 @@ getNextDeletableDocuments</H3>
                                                 long&nbsp;currentTime)
                                                 throws <A HREF="../../../../../org/apache/manifoldcf/core/interfaces/ManifoldCFException.html" title="class in org.apache.manifoldcf.core.interfaces">ManifoldCFException</A></PRE>
 <DL>
-<DD>Get list of deletable document descriptions.  This list will take into account
+<DD>Get list of deletable document descriptions.  This list will take into account
  multiple jobs that may own the same document.
 <P>
 <DD><DL>
@@ -2928,7 +2928,7 @@ getNextCleanableDocuments</H3>
                                               long&nbsp;currentTime)
                                               throws <A HREF="../../../../../org/apache/manifoldcf/core/interfaces/ManifoldCFException.html" title="class in org.apache.manifoldcf.core.interfaces">ManifoldCFException</A></PRE>
 <DL>
-<DD>Get list of cleanable document descriptions.  This list will take into account
+<DD>Get list of cleanable document descriptions.  This list will take into account
  multiple jobs that may own the same document.
 <P>
 <DD><DL>
@@ -2946,8 +2946,8 @@ deleteIngestedDocumentIdentifiers</H3>
 void <B>deleteIngestedDocumentIdentifiers</B>(<A HREF="../../../../../org/apache/manifoldcf/crawler/interfaces/DocumentDescription.html" title="class in org.apache.manifoldcf.crawler.interfaces">DocumentDescription</A>[]&nbsp;identifiers)
                                        throws <A HREF="../../../../../org/apache/manifoldcf/core/interfaces/ManifoldCFException.html" title="class in org.apache.manifoldcf.core.interfaces">ManifoldCFException</A></PRE>
 <DL>
-<DD>Delete ingested document identifiers (as part of deleting the owning job).
- The number of identifiers specified is guaranteed to be less than the maxInClauseCount
+<DD>Delete ingested document identifiers (as part of deleting the owning job).
+ The number of identifiers specified is guaranteed to be less than the maxInClauseCount
  for the database.
 <P>
 <DD><DL>
@@ -2983,8 +2983,8 @@ void <B>finishJobStops</B>(long&nbsp;tim
                     java.util.ArrayList&nbsp;modifiedJobs)
                     throws <A HREF="../../../../../org/apache/manifoldcf/core/interfaces/ManifoldCFException.html" title="class in org.apache.manifoldcf.core.interfaces">ManifoldCFException</A></PRE>
 <DL>
-<DD>Complete the sequence that stops jobs, either for abort, pause, or because of a scheduling
- window.  The logic will move the job to its next state (INACTIVE, PAUSED, ACTIVEWAIT),
+<DD>Complete the sequence that stops jobs, either for abort, pause, or because of a scheduling
+ window.  The logic will move the job to its next state (INACTIVE, PAUSED, ACTIVEWAIT),
  and will record the jobs that have been so modified.
 <P>
 <DD><DL>
@@ -3002,8 +3002,8 @@ void <B>finishJobResumes</B>(long&nbsp;t
                       java.util.ArrayList&nbsp;modifiedJobs)
                       throws <A HREF="../../../../../org/apache/manifoldcf/core/interfaces/ManifoldCFException.html" title="class in org.apache.manifoldcf.core.interfaces">ManifoldCFException</A></PRE>
 <DL>
-<DD>Complete the sequence that resumes jobs, either from a pause or from a scheduling window
- wait.  The logic will restore the job to an active state (many possibilities depending on
+<DD>Complete the sequence that resumes jobs, either from a pause or from a scheduling window
+ wait.  The logic will restore the job to an active state (many possibilities depending on
  connector status), and will record the jobs that have been so modified.
 <P>
 <DD><DL>
@@ -3037,10 +3037,10 @@ void <B>resetJobs</B>(long&nbsp;currentT
                java.util.ArrayList&nbsp;resetJobs)
                throws <A HREF="../../../../../org/apache/manifoldcf/core/interfaces/ManifoldCFException.html" title="class in org.apache.manifoldcf.core.interfaces">ManifoldCFException</A></PRE>
 <DL>
-<DD>Reset eligible jobs either back to the "inactive" state, or make them active again.  The
- latter will occur if the cleanup phase of the job generated more pending documents.
-
-  This method is used to pick up all jobs in the shutting down state
+<DD>Reset eligible jobs either back to the "inactive" state, or make them active again.  The
+ latter will occur if the cleanup phase of the job generated more pending documents.
+
+  This method is used to pick up all jobs in the shutting down state
  whose purgatory or being-cleaned records have been all processed.
 <P>
 <DD><DL>
@@ -3202,7 +3202,7 @@ genDocumentStatus</H3>
 <P>
 <DD><DL>
 <DT><B>Parameters:</B><DD><CODE>connectionName</CODE> - is the name of the connection.<DD><CODE>filterCriteria</CODE> - are the criteria used to limit the records considered for the report.<DD><CODE>sortOrder</CODE> - is the specified sort order of the final report.<DD><CODE>startRow</CODE> - is the first row to include.<DD><CODE>rowCount</CODE> - is the number of rows to include.
-<DT><B>Returns:</B><DD>the results, with the following columns: identifier, job, state, status, scheduled, action, retrycount, retrylimit.  The "scheduled" column and the
+<DT><B>Returns:</B><DD>the results, with the following columns: identifier, job, state, status, scheduled, action, retrycount, retrylimit.  The "scheduled" column and the
  "retrylimit" column are long values representing a time; all other values will be user-friendly strings.
 <DT><B>Throws:</B>
 <DD><CODE><A HREF="../../../../../org/apache/manifoldcf/core/interfaces/ManifoldCFException.html" title="class in org.apache.manifoldcf.core.interfaces">ManifoldCFException</A></CODE></DL>
@@ -3225,7 +3225,7 @@ genQueueStatus</H3>
 <P>
 <DD><DL>
 <DT><B>Parameters:</B><DD><CODE>connectionName</CODE> - is the name of the connection.<DD><CODE>filterCriteria</CODE> - are the criteria used to limit the records considered for the report.<DD><CODE>sortOrder</CODE> - is the specified sort order of the final report.<DD><CODE>idBucketDescription</CODE> - is the bucket description for generating the identifier class.<DD><CODE>startRow</CODE> - is the first row to include.<DD><CODE>rowCount</CODE> - is the number of rows to include.
-<DT><B>Returns:</B><DD>the results, with the following columns: idbucket, inactive, processing, expiring, deleting,
+<DT><B>Returns:</B><DD>the results, with the following columns: idbucket, inactive, processing, expiring, deleting,
   processready, expireready, processwaiting, expirewaiting
 <DT><B>Throws:</B>
 <DD><CODE><A HREF="../../../../../org/apache/manifoldcf/core/interfaces/ManifoldCFException.html" title="class in org.apache.manifoldcf.core.interfaces">ManifoldCFException</A></CODE></DL>

Modified: incubator/lcf/site/publish/release/trunk/api/framework/org/apache/manifoldcf/crawler/interfaces/INamingActivity.html
URL: http://svn.apache.org/viewvc/incubator/lcf/site/publish/release/trunk/api/framework/org/apache/manifoldcf/crawler/interfaces/INamingActivity.html?rev=1345585&r1=1345584&r2=1345585&view=diff
==============================================================================
--- incubator/lcf/site/publish/release/trunk/api/framework/org/apache/manifoldcf/crawler/interfaces/INamingActivity.html (original)
+++ incubator/lcf/site/publish/release/trunk/api/framework/org/apache/manifoldcf/crawler/interfaces/INamingActivity.html Sat Jun  2 21:24:51 2012
@@ -2,7 +2,7 @@
 <!--NewPage-->
 <HTML>
 <HEAD>
-<!-- Generated by javadoc (build 1.6.0_21) on Sat Jun 02 16:08:02 EDT 2012 -->
+<!-- Generated by javadoc (build 1.6.0_21) on Sat Jun 02 16:56:34 EDT 2012 -->
 <TITLE>
 INamingActivity
 </TITLE>

Modified: incubator/lcf/site/publish/release/trunk/api/framework/org/apache/manifoldcf/crawler/interfaces/IProcessActivity.html
URL: http://svn.apache.org/viewvc/incubator/lcf/site/publish/release/trunk/api/framework/org/apache/manifoldcf/crawler/interfaces/IProcessActivity.html?rev=1345585&r1=1345584&r2=1345585&view=diff
==============================================================================
--- incubator/lcf/site/publish/release/trunk/api/framework/org/apache/manifoldcf/crawler/interfaces/IProcessActivity.html (original)
+++ incubator/lcf/site/publish/release/trunk/api/framework/org/apache/manifoldcf/crawler/interfaces/IProcessActivity.html Sat Jun  2 21:24:51 2012
@@ -2,7 +2,7 @@
 <!--NewPage-->
 <HTML>
 <HEAD>
-<!-- Generated by javadoc (build 1.6.0_21) on Sat Jun 02 16:08:02 EDT 2012 -->
+<!-- Generated by javadoc (build 1.6.0_21) on Sat Jun 02 16:56:34 EDT 2012 -->
 <TITLE>
 IProcessActivity
 </TITLE>
@@ -207,7 +207,7 @@ This interface abstracts from the activi
                java.lang.String&nbsp;version)</CODE>
 
 <BR>
-&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Delete the current document from the search engine index, while keeping track of the version information
+&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Delete the current document from the search engine index, while keeping track of the version information
  for it (to reduce churn).</TD>
 </TR>
 <TR BGCOLOR="white" CLASS="TableRowColor">
@@ -356,11 +356,11 @@ void <B>addDocumentReference</B>(java.la
 </DL>
 </DD>
 <DD><DL>
-<DT><B>Parameters:</B><DD><CODE>localIdentifier</CODE> - is the local document identifier to add (for the connector that
- fetched the document).<DD><CODE>parentIdentifier</CODE> - is the document identifier that is considered to be the "parent"
- of this identifier.  May be null, if no hopcount filtering desired for this kind of relationship.<DD><CODE>relationshipType</CODE> - is the string describing the kind of relationship described by this
- reference.  This must be one of the strings returned by the IRepositoryConnector method
- "getRelationshipTypes()".  May be null.<DD><CODE>dataNames</CODE> - is the list of carry-down data from the parent to the child.  May be null.  Each name is limited to 255 characters!<DD><CODE>dataValues</CODE> - are the values that correspond to the data names in the dataNames parameter.  May be null only if dataNames is null.
+<DT><B>Parameters:</B><DD><CODE>localIdentifier</CODE> - is the local document identifier to add (for the connector that
+ fetched the document).<DD><CODE>parentIdentifier</CODE> - is the document identifier that is considered to be the "parent"
+ of this identifier.  May be null, if no hopcount filtering desired for this kind of relationship.<DD><CODE>relationshipType</CODE> - is the string describing the kind of relationship described by this
+ reference.  This must be one of the strings returned by the IRepositoryConnector method
+ "getRelationshipTypes()".  May be null.<DD><CODE>dataNames</CODE> - is the list of carry-down data from the parent to the child.  May be null.  Each name is limited to 255 characters!<DD><CODE>dataValues</CODE> - are the values that correspond to the data names in the dataNames parameter.  May be null only if dataNames is null.
           The type of each object must either be a String, or a CharacterInput.<DD><CODE>originationTime</CODE> - is the time, in ms since epoch, that the document originated.  Pass null if none or unknown.<DD><CODE>prereqEventNames</CODE> - are the names of the prerequisite events which this document requires prior to processing.  Pass null if none.
 <DT><B>Throws:</B>
 <DD><CODE><A HREF="../../../../../org/apache/manifoldcf/core/interfaces/ManifoldCFException.html" title="class in org.apache.manifoldcf.core.interfaces">ManifoldCFException</A></CODE></DL>
@@ -385,11 +385,11 @@ void <B>addDocumentReference</B>(java.la
 </DL>
 </DD>
 <DD><DL>
-<DT><B>Parameters:</B><DD><CODE>localIdentifier</CODE> - is the local document identifier to add (for the connector that
- fetched the document).<DD><CODE>parentIdentifier</CODE> - is the document identifier that is considered to be the "parent"
- of this identifier.  May be null, if no hopcount filtering desired for this kind of relationship.<DD><CODE>relationshipType</CODE> - is the string describing the kind of relationship described by this
- reference.  This must be one of the strings returned by the IRepositoryConnector method
- "getRelationshipTypes()".  May be null.<DD><CODE>dataNames</CODE> - is the list of carry-down data from the parent to the child.  May be null.  Each name is limited to 255 characters!<DD><CODE>dataValues</CODE> - are the values that correspond to the data names in the dataNames parameter.  May be null only if dataNames is null.
+<DT><B>Parameters:</B><DD><CODE>localIdentifier</CODE> - is the local document identifier to add (for the connector that
+ fetched the document).<DD><CODE>parentIdentifier</CODE> - is the document identifier that is considered to be the "parent"
+ of this identifier.  May be null, if no hopcount filtering desired for this kind of relationship.<DD><CODE>relationshipType</CODE> - is the string describing the kind of relationship described by this
+ reference.  This must be one of the strings returned by the IRepositoryConnector method
+ "getRelationshipTypes()".  May be null.<DD><CODE>dataNames</CODE> - is the list of carry-down data from the parent to the child.  May be null.  Each name is limited to 255 characters!<DD><CODE>dataValues</CODE> - are the values that correspond to the data names in the dataNames parameter.  May be null only if dataNames is null.
           The type of each object must either be a String, or a CharacterInput.<DD><CODE>originationTime</CODE> - is the time, in ms since epoch, that the document originated.  Pass null if none or unknown.
 <DT><B>Throws:</B>
 <DD><CODE><A HREF="../../../../../org/apache/manifoldcf/core/interfaces/ManifoldCFException.html" title="class in org.apache.manifoldcf.core.interfaces">ManifoldCFException</A></CODE></DL>
@@ -413,11 +413,11 @@ void <B>addDocumentReference</B>(java.la
 </DL>
 </DD>
 <DD><DL>
-<DT><B>Parameters:</B><DD><CODE>localIdentifier</CODE> - is the local document identifier to add (for the connector that
- fetched the document).<DD><CODE>parentIdentifier</CODE> - is the document identifier that is considered to be the "parent"
- of this identifier.  May be null, if no hopcount filtering desired for this kind of relationship.<DD><CODE>relationshipType</CODE> - is the string describing the kind of relationship described by this
- reference.  This must be one of the strings returned by the IRepositoryConnector method
- "getRelationshipTypes()".  May be null.<DD><CODE>dataNames</CODE> - is the list of carry-down data from the parent to the child.  May be null.  Each name is limited to 255 characters!<DD><CODE>dataValues</CODE> - are the values that correspond to the data names in the dataNames parameter.  May be null only if dataNames is null.
+<DT><B>Parameters:</B><DD><CODE>localIdentifier</CODE> - is the local document identifier to add (for the connector that
+ fetched the document).<DD><CODE>parentIdentifier</CODE> - is the document identifier that is considered to be the "parent"
+ of this identifier.  May be null, if no hopcount filtering desired for this kind of relationship.<DD><CODE>relationshipType</CODE> - is the string describing the kind of relationship described by this
+ reference.  This must be one of the strings returned by the IRepositoryConnector method
+ "getRelationshipTypes()".  May be null.<DD><CODE>dataNames</CODE> - is the list of carry-down data from the parent to the child.  May be null.  Each name is limited to 255 characters!<DD><CODE>dataValues</CODE> - are the values that correspond to the data names in the dataNames parameter.  May be null only if dataNames is null.
           The type of each object must either be a String, or a CharacterInput.
 <DT><B>Throws:</B>
 <DD><CODE><A HREF="../../../../../org/apache/manifoldcf/core/interfaces/ManifoldCFException.html" title="class in org.apache.manifoldcf.core.interfaces">ManifoldCFException</A></CODE></DL>
@@ -439,10 +439,10 @@ void <B>addDocumentReference</B>(java.la
 </DL>
 </DD>
 <DD><DL>
-<DT><B>Parameters:</B><DD><CODE>localIdentifier</CODE> - is the local document identifier to add (for the connector that
- fetched the document).<DD><CODE>parentIdentifier</CODE> - is the document identifier that is considered to be the "parent"
- of this identifier.  May be null, if no hopcount filtering desired for this kind of relationship.<DD><CODE>relationshipType</CODE> - is the string describing the kind of relationship described by this
- reference.  This must be one of the strings returned by the IRepositoryConnector method
+<DT><B>Parameters:</B><DD><CODE>localIdentifier</CODE> - is the local document identifier to add (for the connector that
+ fetched the document).<DD><CODE>parentIdentifier</CODE> - is the document identifier that is considered to be the "parent"
+ of this identifier.  May be null, if no hopcount filtering desired for this kind of relationship.<DD><CODE>relationshipType</CODE> - is the string describing the kind of relationship described by this
+ reference.  This must be one of the strings returned by the IRepositoryConnector method
  "getRelationshipTypes()".  May be null.
 <DT><B>Throws:</B>
 <DD><CODE><A HREF="../../../../../org/apache/manifoldcf/core/interfaces/ManifoldCFException.html" title="class in org.apache.manifoldcf.core.interfaces">ManifoldCFException</A></CODE></DL>
@@ -456,14 +456,14 @@ addDocumentReference</H3>
 void <B>addDocumentReference</B>(java.lang.String&nbsp;localIdentifier)
                           throws <A HREF="../../../../../org/apache/manifoldcf/core/interfaces/ManifoldCFException.html" title="class in org.apache.manifoldcf.core.interfaces">ManifoldCFException</A></PRE>
 <DL>
-<DD>Add a document description to the current job's queue.  This method is equivalent to
+<DD>Add a document description to the current job's queue.  This method is equivalent to
  addDocumentReference(localIdentifier,null,null).
 <P>
 <DD><DL>
 </DL>
 </DD>
 <DD><DL>
-<DT><B>Parameters:</B><DD><CODE>localIdentifier</CODE> - is the local document identifier to add (for the connector that
+<DT><B>Parameters:</B><DD><CODE>localIdentifier</CODE> - is the local document identifier to add (for the connector that
  fetched the document).
 <DT><B>Throws:</B>
 <DD><CODE><A HREF="../../../../../org/apache/manifoldcf/core/interfaces/ManifoldCFException.html" title="class in org.apache.manifoldcf.core.interfaces">ManifoldCFException</A></CODE></DL>
@@ -509,8 +509,8 @@ void <B>ingestDocument</B>(java.lang.Str
 </DL>
 </DD>
 <DD><DL>
-<DT><B>Parameters:</B><DD><CODE>localIdentifier</CODE> - is the document's local identifier.<DD><CODE>version</CODE> - is the version of the document, as reported by the getDocumentVersions() method of the
-       corresponding repository connector.<DD><CODE>documentURI</CODE> - is the URI to use to retrieve this document from the search interface (and is
+<DT><B>Parameters:</B><DD><CODE>localIdentifier</CODE> - is the document's local identifier.<DD><CODE>version</CODE> - is the version of the document, as reported by the getDocumentVersions() method of the
+       corresponding repository connector.<DD><CODE>documentURI</CODE> - is the URI to use to retrieve this document from the search interface (and is
        also the unique key in the index).<DD><CODE>data</CODE> - is the document data.  The data is closed after ingestion is complete.
 <DT><B>Throws:</B>
 <DD><CODE><A HREF="../../../../../org/apache/manifoldcf/core/interfaces/ManifoldCFException.html" title="class in org.apache.manifoldcf.core.interfaces">ManifoldCFException</A></CODE>
@@ -527,14 +527,14 @@ void <B>deleteDocument</B>(java.lang.Str
                     throws <A HREF="../../../../../org/apache/manifoldcf/core/interfaces/ManifoldCFException.html" title="class in org.apache.manifoldcf.core.interfaces">ManifoldCFException</A>,
                            <A HREF="../../../../../org/apache/manifoldcf/agents/interfaces/ServiceInterruption.html" title="class in org.apache.manifoldcf.agents.interfaces">ServiceInterruption</A></PRE>
 <DL>
-<DD>Delete the current document from the search engine index, while keeping track of the version information
+<DD>Delete the current document from the search engine index, while keeping track of the version information
  for it (to reduce churn).
 <P>
 <DD><DL>
 </DL>
 </DD>
 <DD><DL>
-<DT><B>Parameters:</B><DD><CODE>localIdentifier</CODE> - is the document's local identifier.<DD><CODE>version</CODE> - is the version of the document, as reported by the getDocumentVersions() method of the
+<DT><B>Parameters:</B><DD><CODE>localIdentifier</CODE> - is the document's local identifier.<DD><CODE>version</CODE> - is the version of the document, as reported by the getDocumentVersions() method of the
        corresponding repository connector.
 <DT><B>Throws:</B>
 <DD><CODE><A HREF="../../../../../org/apache/manifoldcf/core/interfaces/ManifoldCFException.html" title="class in org.apache.manifoldcf.core.interfaces">ManifoldCFException</A></CODE>
@@ -550,9 +550,9 @@ void <B>deleteDocument</B>(java.lang.Str
                     throws <A HREF="../../../../../org/apache/manifoldcf/core/interfaces/ManifoldCFException.html" title="class in org.apache.manifoldcf.core.interfaces">ManifoldCFException</A>,
                            <A HREF="../../../../../org/apache/manifoldcf/agents/interfaces/ServiceInterruption.html" title="class in org.apache.manifoldcf.agents.interfaces">ServiceInterruption</A></PRE>
 <DL>
-<DD>Delete the current document from the search engine index.  This method does NOT keep track of version
- information for the document and thus can lead to "churn", whereby the same document is queued, versioned,
- and removed on subsequent crawls.  It therefore should be considered to be deprecated, in favor of
+<DD>Delete the current document from the search engine index.  This method does NOT keep track of version
+ information for the document and thus can lead to "churn", whereby the same document is queued, versioned,
+ and removed on subsequent crawls.  It therefore should be considered to be deprecated, in favor of
  deleteDocument(String localIdentifier, String version).
 <P>
 <DD><DL>
@@ -577,9 +577,9 @@ void <B>setDocumentScheduleBounds</B>(ja
                                java.lang.Long&nbsp;upperExpireBoundTime)
                                throws <A HREF="../../../../../org/apache/manifoldcf/core/interfaces/ManifoldCFException.html" title="class in org.apache.manifoldcf.core.interfaces">ManifoldCFException</A></PRE>
 <DL>
-<DD>Override the schedule for the next time a document is crawled.
- Calling this method allows you to set an upper recrawl bound, lower recrawl bound, upper expire bound, lower expire bound,
- or a combination of these, on a specific document.  This method is only effective if the job is a continuous one, and if the
+<DD>Override the schedule for the next time a document is crawled.
+ Calling this method allows you to set an upper recrawl bound, lower recrawl bound, upper expire bound, lower expire bound,
+ or a combination of these, on a specific document.  This method is only effective if the job is a continuous one, and if the
  identifier you pass in is being processed.
 <P>
 <DD><DL>
@@ -600,7 +600,7 @@ void <B>setDocumentOriginationTime</B>(j
                                 java.lang.Long&nbsp;originationTime)
                                 throws <A HREF="../../../../../org/apache/manifoldcf/core/interfaces/ManifoldCFException.html" title="class in org.apache.manifoldcf.core.interfaces">ManifoldCFException</A></PRE>
 <DL>
-<DD>Override a document's origination time.
+<DD>Override a document's origination time.
  Use this method to signal the framework that a document's origination time is something other than the first time it was crawled.
 <P>
 <DD><DL>

Modified: incubator/lcf/site/publish/release/trunk/api/framework/org/apache/manifoldcf/crawler/interfaces/IRepositoryConnection.html
URL: http://svn.apache.org/viewvc/incubator/lcf/site/publish/release/trunk/api/framework/org/apache/manifoldcf/crawler/interfaces/IRepositoryConnection.html?rev=1345585&r1=1345584&r2=1345585&view=diff
==============================================================================
--- incubator/lcf/site/publish/release/trunk/api/framework/org/apache/manifoldcf/crawler/interfaces/IRepositoryConnection.html (original)
+++ incubator/lcf/site/publish/release/trunk/api/framework/org/apache/manifoldcf/crawler/interfaces/IRepositoryConnection.html Sat Jun  2 21:24:51 2012
@@ -2,7 +2,7 @@
 <!--NewPage-->
 <HTML>
 <HEAD>
-<!-- Generated by javadoc (build 1.6.0_21) on Sat Jun 02 16:08:02 EDT 2012 -->
+<!-- Generated by javadoc (build 1.6.0_21) on Sat Jun 02 16:56:34 EDT 2012 -->
 <TITLE>
 IRepositoryConnection
 </TITLE>
@@ -99,7 +99,7 @@ Interface IRepositoryConnection</H2>
 </PRE>
 
 <P>
-An instance of this interface represents a paper object that describes a repository connection.
+An instance of this interface represents a paper object that describes a repository connection.
  This is the paper object meant for editing and manipulation.
 <P>
 
@@ -558,7 +558,7 @@ getThrottles</H3>
 <PRE>
 java.lang.String[] <B>getThrottles</B>()</PRE>
 <DL>
-<DD>Get throttles.  This will return a list of match strings, ordered by description and then
+<DD>Get throttles.  This will return a list of match strings, ordered by description and then
  match string.
 <P>
 <DD><DL>



Mime
View raw message